amend according to ruff reports

Author: d-w-moore

irods/access.py

@@ -121,7 +121,7 @@ def __hash__(self):
 
     def normal(self, local_zone=""):
         """
-        Create a normalized version of the object for comparison in sorting or determining equavalence.
+        Create a normalized version of the object for comparison in sorting or determining equivalence.
 
         Args:
             local_zone: the name of the home zone, if any, in which client user directly authenticates.
@@ -204,27 +204,31 @@ 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):
+    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
 
-    def __init__(self, access_name: str, user_name: str = "", user_zone: str = ""):
+    # ruff: noqa: D105 on
+
+    def __init__(self, access_name: str, user_name: str = "", user_zone: str = ""):  # noqa: D107
         super().__init__(
             access_name=access_name,
             path="",
@@ -244,6 +248,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 +271,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 +290,9 @@ 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 SLF001 on
+
+
 class _deprecated:
     class _iRODSAccess_pre_4_3_0(_iRODSAccess_base):
         codes = collections.OrderedDict(
@@ -294,7 +304,8 @@ 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,
             )
@@ -309,3 +320,6 @@ def __getattr__(name):
         warnings.warn(f"{name} is deprecated", DeprecationWarning, stacklevel=2)
         return _deprecated_names[name]
     raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+# ruff: noqa: RUF012 N801 SLF001 off

irods/exception.py

@@ -1,14 +1,16 @@
 # if you're copying these from the docs, you might find the following regex helpful:
 # s/\(\w\+\)\s\+\(-\d\+\)/class \1(SystemException):\r    code = \2/g
 
-
 import errno
 import numbers
 import os
 import sys
 from typing import Dict
 
 
+# ruff: noqa: N801 D101 off
+
+
 class PycommandsException(Exception):
     pass
 
@@ -2124,3 +2126,6 @@ class PAM_AUTH_PASSWORD_FAILED(PAMException):
 
 class PAM_AUTH_PASSWORD_INVALID_TTL(PAMException):
     code = -994000
+
+
+# ruff: noqa: N801 D101 on

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
 
@@ -43,6 +45,14 @@ def _to_acl_operation_json(op_input: iRODSAccess):
         }
 
     def apply_atomic_operations(self, logical_path: str, *operations, admin=False):
+        """
+        Apply the requested operations atomically to the object at logical_path.
+
+        Args:
+            logical_path: the fully qualified logical path of the target data object or collection.
+            operations: a sequence of ACLOperation instances.
+            admin: True if the admin flag should be applied for the Atomic ACLs api call.
+        """
         request_text = {
             "logical_path": logical_path,
             "admin_mode": admin,

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