ruff shenanigans

Author: d-w-moore

irods/access.py

@@ -75,7 +75,7 @@ def items(self):
         return list(zip(self.keys(), self.values()))
 
 
-class _iRODSAccess_base:
+class _iRODSAccess_base:  # noqa: N801
     @classmethod
     def to_int(cls, key):
         return cls.codes[key]
@@ -204,25 +204,30 @@ def __repr__(self):
 
 class iRODSAccess(_iRODSAccess_base, metaclass=_Access_LookupMeta):
     """
-    This class represents an ACL in iRODS and functions as a data container
-    to convey information to the iRODS server (in the `set` call) and back again to the client
-    again (in the `get` call).
+    Represents an ACL in iRODS.
+
+    An instance of this class functions as a data container to convey information to the iRODS
+    server (in the `set` call) and back again to the client again (in the `get` call).
     """
 
     def __init__(self, access_name, path, user_name="", user_zone="", user_type=None):
+        # noqa: D107
         self.codes = self.__class__.codes
         self.strings = self.__class__.strings
         super().__init__(access_name, path, user_name, user_zone, user_type)
 
 
 class ACLOperation(iRODSAccess):
     """
-    Similar to its base class iRODSAccess, this class represents an ACL to be set on an object.
-    but this class is the counterpart used for the atomic ACLs api.  It differs from its base
-    class in that it has no field to store a logical object path.  (For an atomic API call, i
-    here is always a single logical path to which all operations apply, meaning that it is
-    appropriate to conveyed that in a location separate from the operations themselves.)
-    """
+    Represents an operation to be performed in iRODS' atomic ACL api.
+
+    Similar to its base class, iRODSAccess, this class names an ACL to be set on an object.
+    It differs, however, in that it forgoes option to store a logical object path.  (In the atomic
+    API call, there is always a single logical path to which all such operations apply, thus
+    it is appropriate that the path parameter is in a location separate from the operations.)
+    """  # noqa: D400 RUF100
+
+    # ruff: noqa: D105 on
 
     def __init__(self, access_name: str, user_name: str = "", user_zone: str = ""):
         super().__init__(
@@ -244,6 +249,7 @@ def __eq__(self, other):
         )
 
     def __hash__(self):
+
         # Hash in a way consistent with an iRODSAccess having path "".
         return hash((
             self.access_name,
@@ -266,6 +272,8 @@ def __lt__(self, other):
     def __repr__(self):
         return f"<ACLOperation {self.access_name} {self.user_name} {self.user_zone}>"
 
+    # ruff: noqa: D105 off
+
 
 (
     _synonym_mapping := {
@@ -283,6 +291,7 @@ def __repr__(self):
 canonical_permissions = {k: v for k, v in all_permissions.items() if ' ' not in k and k not in ('read', 'write')}
 
 
+# ruff: noqa: RUF012 N801 on
 class _deprecated:
     class _iRODSAccess_pre_4_3_0(_iRODSAccess_base):
         codes = collections.OrderedDict(
@@ -294,13 +303,16 @@ class _iRODSAccess_pre_4_3_0(_iRODSAccess_base):
 
         def __init__(self, *args, **kwargs):
             warnings.warn(
-                "_iRODSAccess_pre_4_3_0 is deprecated and will be removed in a future version. Use iRODSAccess instead.",
+                "_iRODSAccess_pre_4_3_0 is deprecated and will be removed in "
+                "a future version. Use iRODSAccess instead.",
                 DeprecationWarning,
                 stacklevel=2,
             )
             super().__init__(*args, **kwargs)
 
 
+# ruff: noqa: RUF012 N801 SLF001 off
+
 _deprecated_names = {'_iRODSAccess_pre_4_3_0': _deprecated._iRODSAccess_pre_4_3_0}
 
 

irods/exception.py

@@ -650,7 +650,8 @@ class SYS_INVALID_INPUT_PARAM(SystemException):
     code = -130000
 
 
-class SYS_INTERNAL_ERR(SystemException):
+class SYS_INTERNAL_ERR(SystemException):  # noqa: N801
+    # noqa: D101
     code = -154000
 
 

irods/manager/access_manager.py

@@ -1,3 +1,5 @@
+""" The access manager is a collection of methods useful for managing iRODS ACLs.  """
+
 import logging
 from os.path import basename, dirname
 

irods/test/access_test.py

@@ -4,14 +4,14 @@
 import sys
 import unittest
 
-from irods.test import helpers
 from irods.access import ACLOperation, iRODSAccess
 from irods.collection import iRODSCollection
 from irods.column import In, Like
 from irods.exception import UserDoesNotExist
 from irods.models import Collection, DataObject, User
 from irods.path import iRODSPath
 from irods.session import iRODSSession
+from irods.test import helpers
 from irods.user import iRODSUser