PyPaf 0.4.0__tar.gz → 0.5.0__tar.gz

{pypaf-0.4.0/src/PyPaf.egg-info → pypaf-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyPaf
-Version: 0.4.0
+Version: 0.5.0
 Summary: Formats the elements of a Royal Mail Postcode Address File entry
 Author-email: John Bard <johnbard@globalnet.co.uk>
 License: MIT

{pypaf-0.4.0 → pypaf-0.5.0/src/PyPaf.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyPaf
-Version: 0.4.0
+Version: 0.5.0
 Summary: Formats the elements of a Royal Mail Postcode Address File entry
 Author-email: John Bard <johnbard@globalnet.co.uk>
 License: MIT

{pypaf-0.4.0 → pypaf-0.5.0}/src/PyPaf.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ src/PyPaf.egg-info/top_level.txt
 src/paf/__init__.py
 src/paf/address.py
 src/paf/attribute.py
+src/paf/immutable.py
 src/paf/lineable.py
 src/paf/premises_extender.py
 src/paf/thoroughfare_locality.py
@@ -25,6 +26,7 @@ tests/test_exception_i.py
 tests/test_exception_ii.py
 tests/test_exception_iii.py
 tests/test_exception_iv.py
+tests/test_immutability.py
 tests/test_mainfile.py
 tests/test_po_box.py
 tests/test_rule_1.py

{pypaf-0.4.0 → pypaf-0.5.0}/src/paf/address.py

@@ -1,22 +1,24 @@
 """PAF Address"""
 
+# Tried using dataclasses.dataclass(frozen=True) decorator for immutablity but did not work"""
+from .immutable import ImmutableMixin
 from .lineable import LineableMixin
 
-class Address(LineableMixin):
+class Address(ImmutableMixin, LineableMixin):
     """Main PAF Address class"""
 
     def __init__(self, args):
         """Initialise Address elements"""
-        for key in self.__class__.attrs:
-            setattr(self, key, '')
+        for key in self.__class__.attrs: # pylint: disable=not-an-iterable
+            object.__setattr__(self, key, '')
         for key, val in args.items():
             if hasattr(self, key):
-                setattr(self, key, val)
+                object.__setattr__(self, key, val)
         self.extend_premises()
 
     def __repr__(self):
         """Return full representation of an Address"""
-        args = {k: getattr(self, k) for k in self.__class__.attrs if getattr(self, k, None)}
+        args = {k: getattr(self, k) for k in self.__class__.attrs if getattr(self, k, None)} # pylint: disable=not-an-iterable
         return self.__class__.__name__ + '(' + str(args) + ')'
 
     def __str__(self):

pypaf-0.5.0/src/paf/immutable.py

@@ -0,0 +1,12 @@
+"""Immutable Mixin"""
+
+from dataclasses import FrozenInstanceError
+
+class ImmutableMixin():
+    """Prevent manipulation of object attributes"""
+
+    def __setattr__(self, *_):
+        raise FrozenInstanceError
+
+    def __delattr__(self, *_):
+        raise FrozenInstanceError

{pypaf-0.4.0 → pypaf-0.5.0}/src/paf/premises/rule010.py

@@ -26,12 +26,12 @@ class Rule010(Common):
         return(
             self.is_exception('building_name_last_word') and
                 not re.match(r'^\d+$', self.building_name_last_word) and
-                not self.is_non_split_building_name
+                not self.is_known_building_type
             )
 
     @property
-    def is_non_split_building_name(self):
-        """Returns if building name should not be split based on all but last word"""
+    def is_known_building_type(self):
+        """Returns if building name starts with a known building type"""
         return self.building_name_but_last_word in [
             "BACK OF", "BLOCK", "BLOCKS", "BUILDING", "MAISONETTE", "MAISONETTES", "REAR OF",
             "SHOP", "SHOPS", "STALL", "STALLS", "SUITE", "SUITES", "UNIT", "UNITS"

{pypaf-0.4.0 → pypaf-0.5.0}/src/paf/premises_extender.py

@@ -22,4 +22,6 @@ class PremisesExtenderMixin(AttributeMixin):
     def extend_premises(self):
         """Dynamically extends instance with appropriate premises rule"""
         base_cls = self.__class__
-        self.__class__ = type(base_cls.__name__, (base_cls, self.premises_rule), {})
+        object.__setattr__(
+            self, '__class__', type(base_cls.__name__, (base_cls, self.premises_rule), {})
+            )

pypaf-0.5.0/src/paf/version.py

@@ -0,0 +1,3 @@
+"""Version"""
+
+__version__ = '0.5.0'

pypaf-0.5.0/tests/test_immutability.py

@@ -0,0 +1,38 @@
+"""Test Immutability"""
+
+import unittest
+from dataclasses import FrozenInstanceError
+import paf
+
+class TestImmutability(unittest.TestCase):
+    """Test Immutable"""
+
+    def setUp(self):
+        """Set up Address instance"""
+        self.address = paf.Address({
+            'building_number': "16",
+            'thoroughfare_name': "VIXEN",
+            'thoroughfare_descriptor': "ROAD",
+            'post_town': "BRADOCK",
+            'postcode': "KT6 5BT"
+            })
+
+    def test_assignment(self):
+        """Test setting attribute by direct assignment"""
+        with self.assertRaises(FrozenInstanceError):
+            self.address.building_name = "THE HOUSE"
+
+    def test_setattr(self):
+        """Test setting new attribute"""
+        self.assertRaises(FrozenInstanceError, setattr, self.address, 'building_name', "THE HOUSE")
+
+    def test_resetattr(self):
+        """Test re-setting existing attribute"""
+        self.assertRaises(FrozenInstanceError, setattr, self.address, 'building_number', "20")
+
+    def test_delattr(self):
+        """Test deleting attribute"""
+        self.assertRaises(FrozenInstanceError, delattr, self.address, 'post_town')
+
+if __name__ == '__main__':
+    unittest.main()

pypaf-0.4.0/src/paf/version.py

@@ -1,3 +0,0 @@
-"""Version"""
-
-__version__ = '0.4.0'