numerous ruff revisions (squashed)

Author: d-w-moore

irods/manager/metadata_manager.py

@@ -29,12 +29,8 @@ class InvalidAtomicAVURequest(Exception):
 
 # This was necessarily made separate from the MetadataManager definition
 # in order to avoid infinite recursion in iRODSMetaCollection.__getattr__
-_MetadataManager_opts_initializer = {
-    'admin':False,
-    'timestamps':False,
-    'iRODSMeta_type':iRODSMeta,
-    'reload':True
-}
+_MetadataManager_opts_initializer = {'admin': False, 'timestamps': False, 'iRODSMeta_type': iRODSMeta, 'reload': True}
+
 
 class MetadataManager(Manager):
 

irods/meta.py

@@ -131,16 +131,58 @@ def __init__(self, operation, avu, **kw):
 
 
 class iRODSMetaCollection:
+    def __setattr__(self, name, value):
+        """
+        Protect the virtual, read-only attributes such as 'admin', 'timestamps', etc.,
+        from being written or created as concrete attributes, which would interfere with
+        __getattr__'s intended operation for these cases.
+
+        Args:
+            name: the name of the attribute to be written.
+            value: the value to be written to the attribute.
+
+        Raises:
+            AttributeError: on any attempt to write to these special attributes.
+        """
+        from irods.manager.metadata_manager import _MetadataManager_opts_initializer
+
+        if name in _MetadataManager_opts_initializer:
+            msg = (
+                f"""The "{name}" attribute is a special one, settable only via a """
+                f"""call on the object.  For example: admin_view = data_obj.metadata({name}=<value>)"""
+            )
+            raise AttributeError(msg)
+
+        super().__setattr__(name, value)
+
     def __getattr__(self, name):
+        """
+        Expose certain settable flags (e.g. "admin", "timestamps") as virtual, read-only
+        "attributes."  The names of these special attributes appear as the keys of the
+        _MetadataManager_opts_initializer dictionary.
+
+        Args:
+            name: the name of the attribute to be fetched.
+
+        Returns:
+            the value of the named attribute.
+
+        Raises:
+            AttributeError: because this is the protocol for deferring to __getattr__'s
+            default behavior for the case in which none of the special attribute keys are
+            a match for 'name'.
+        """
         from irods.manager.metadata_manager import _MetadataManager_opts_initializer
+
         # Separating _MetadataManager_opts_initializer from the MetadataManager class
-        # prevents # the possibility of arbitrary access by copy.copy() to parts of
+        # prevents the possibility of arbitrary access by copy.copy() to parts of
         # our object's state before they have been initialized, as it is known to do
         # by calling hasattr on the "__setstate__" attribute. The result of such
         # unfettered access is infinite recursion.  See:
         # https://nedbatchelder.com/blog/201010/surprising_getattr_recursion
+
         if name in _MetadataManager_opts_initializer:
-            return self._manager._opts[name]
+            return self._manager._opts[name]  # noqa: SLF001
         raise AttributeError
 
     def __call__(self, **opts):

irods/test/meta_test.py

@@ -21,6 +21,7 @@
     iRODSMeta,
 )
 from irods.models import Collection, CollectionMeta, DataObject, ModelBase, Resource
+from irods.path import iRODSPath
 from irods.session import iRODSSession
 from irods.test import helpers
 
@@ -820,8 +821,6 @@ def test_binary_avu_fields__issue_707(self):
     def test_cascading_changes_of_metadata_manager_options__issue_709(self):
         d = None
 
-#       def get_option(metacoll, key):
-#           return metacoll._manager._opts[key]
         try:
             d = self.sess.data_objects.create(f'{self.coll.path}/issue_709_test_1')
             m = d.metadata
@@ -863,7 +862,16 @@ def test_reload_can_be_deactivated__issue_768(self):
         self.assertIn(item_1, items_reloaded)
         self.assertIn(item_2, items_reloaded)
 
+    def test_prevention_of_attribute_creation__issue_795(self):
+        data_path = iRODSPath(self.coll_path, helpers.unique_name(datetime.datetime.now()))  # noqa: DTZ005
+        data = self.sess.data_objects.create(data_path)
+        with self.assertRaises(AttributeError):
+            # This should cause an error since "admin" is considered as a read-only attribute; whereas
+            # data.metadata(admin = True) generates a cloned object but for the one change to "admin".
+            data.metadata.admin = True
+
+
 if __name__ == "__main__":
     # let the tests find the parent irods lib
     sys.path.insert(0, os.path.abspath("../.."))
-    unittest.main()
+