custProps: allow iteration on custom proeprties

Author: michael-koeller

docx/opc/customprops.py

@@ -65,6 +65,10 @@ def __setitem__(self, key, value):
     def __len__(self):
         return len(self._element)
 
+    def __iter__(self):
+        for child in self._element:
+            yield child.get("name")
+
     def lookup(self, item):
         for child in self._element:
             if child.get("name") == item:

features/doc-customprops.feature

@@ -26,3 +26,7 @@ Feature: Read and write custom document properties
      Given a document having no custom properties part
       When I assign new values to the custom properties
       Then the custom property values match the new values
+
+  Scenario: iterate the custom properties of a document
+     Given a document having known custom properties
+      Then I can iterate the custom properties object

features/steps/customprops.py

@@ -78,7 +78,6 @@ def then_the_custom_property_values_match_the_known_values(context):
             "got '%s' for custom property '%s'" % (value, name)
         )
 
-
 @then('the custom property values match the new values')
 def then_the_custom_property_values_match_the_new_values(context):
     custom_properties = context.document.custom_properties
@@ -87,3 +86,11 @@ def then_the_custom_property_values_match_the_new_values(context):
         assert value == expected_value, (
             "got '%s' for custom property '%s'" % (value, name)
         )
+
+@then('I can iterate the custom properties object')
+def then_I_can_iterate_the_custom_properties_object(context):
+    exp_names = iter(['AppVersion', 'CustomPropBool', 'CustomPropInt', 'CustomPropString',
+                      'DocSecurity', 'HyperlinksChanged', 'LinksUpToDate', 'ScaleCrop', 'ShareDoc'])
+    custom_properties = context.document.custom_properties
+    for prop_name in custom_properties:
+        assert prop_name == next(exp_names)

features/steps/test_files/.~lock.doc-customprops.docx#

@@ -0,0 +1 @@
+,mko,haendel.local,15.11.2022 08:06,file:///Users/mko/Library/Application%20Support/LibreOffice/4;

tests/opc/test_customprops.py

@@ -21,14 +21,28 @@ def it_can_read_existing_prop_values(self, prop_get_fixture):
         actual_value = custom_properties[prop_name]
         assert actual_value == exp_value
 
-    def it_can_change_existing_prop_values(self):
-        pass
+    def it_can_change_existing_prop_values(self, custom_properties_default, prop_set_fixture):
+        _, prop_name, value, _ = prop_set_fixture
+        assert custom_properties_default[prop_name] != value
+        custom_properties_default[prop_name] = value
+        assert custom_properties_default[prop_name] == value
 
     def it_can_set_new_prop_values(self, prop_set_fixture):
         custom_properties, prop_name, value, exp_xml = prop_set_fixture
         custom_properties[prop_name] = value
         assert custom_properties._element.xml == exp_xml
 
+    def it_can_iterate_existing_props(self, custom_properties_default):
+        exp_names = ['CustomPropBool', 'CustomPropInt', 'CustomPropString']
+
+        # check 1: as list
+        assert list(custom_properties_default) == ['CustomPropBool', 'CustomPropInt', 'CustomPropString']
+
+        # check 2: use iterator
+        exp_names_iter = iter(exp_names)
+        for prop_name in custom_properties_default:
+            assert prop_name == next(exp_names_iter)
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[