PyPaf 0.7.0__tar.gz → 1.0.0__tar.gz

{pypaf-0.7.0/src/PyPaf.egg-info → PyPaf-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.1
 Name: PyPaf
-Version: 0.7.0
+Version: 1.0.0
 Summary: Formats the elements of a Royal Mail Postcode Address File entry
 Author-email: John Bard <johnbard@globalnet.co.uk>
 License: MIT
@@ -27,7 +27,7 @@ Install it from PyPI:
 
 ### Formatting
 
-May be used to format the PAF Address elements as a list of strings:
+May be used to format the PAF Address elements - passed as either a single dictionary or as a series of keyword arguments - as a list of strings:
 
 ```python
 import paf
@@ -48,14 +48,14 @@ Or as a tuple of strings:
 
 ```python
 import paf
-address = paf.Address({
-    'building_name': "1-2",
-    'thoroughfare_name': "NURSERY",
-    'thoroughfare_descriptor': "LANE",
-    'dependent_locality': "PENN",
-    'post_town': "HIGH WYCOMBE",
-    'postcode': "HP10 8LS"
-})
+address = paf.Address(
+    building_name="1-2",
+    thoroughfare_name="NURSERY",
+    thoroughfare_descriptor="LANE",
+    dependent_locality="PENN",
+    post_town="HIGH WYCOMBE",
+    postcode="HP10 8LS"
+)
 address.as_tuple() # or tuple(address)
 
 ('1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS')
@@ -82,14 +82,14 @@ Or as a dictionary:
 
 ```python
 import paf
-address = paf.Address({
-    'building_name': "1-2",
-    'thoroughfare_name': "NURSERY",
-    'thoroughfare_descriptor': "LANE",
-    'dependent_locality': "PENN",
-    'post_town': "HIGH WYCOMBE",
-    'postcode': "HP10 8LS"
-})
+address = paf.Address(
+    building_name="1-2",
+    thoroughfare_name="NURSERY",
+    thoroughfare_descriptor="LANE",
+    dependent_locality="PENN",
+    post_town="HIGH WYCOMBE",
+    postcode="HP10 8LS"
+)
 address.as_dict()
 
 {
@@ -147,15 +147,15 @@ If there is no `sub_building_name` element and the `dependent_thoroughfare` elem
 
 ```python
 import paf
-self.address = paf.Address({
-    'building_name': "1A",
-    'dependent_thoroughfare_name': "SEASTONE",
-    'dependent_thoroughfare_descriptor': "COURT",
-    'thoroughfare_name': "STATION",
-    'thoroughfare_descriptor': "ROAD",
-    'post_town': "HOLT",
-    'postcode': "NR25 7HG"
-})
+self.address = paf.Address(
+    building_name="1A",
+    dependent_thoroughfare_name="SEASTONE",
+    dependent_thoroughfare_descriptor="COURT",
+    thoroughfare_name="STATION",
+    thoroughfare_descriptor="ROAD",
+    post_town="HOLT",
+    postcode="NR25 7HG"
+)
 address.premises()
 
 {

{pypaf-0.7.0 → PyPaf-1.0.0}/README.md

@@ -12,7 +12,7 @@ Install it from PyPI:
 
 ### Formatting
 
-May be used to format the PAF Address elements as a list of strings:
+May be used to format the PAF Address elements - passed as either a single dictionary or as a series of keyword arguments - as a list of strings:
 
 ```python
 import paf
@@ -33,14 +33,14 @@ Or as a tuple of strings:
 
 ```python
 import paf
-address = paf.Address({
-    'building_name': "1-2",
-    'thoroughfare_name': "NURSERY",
-    'thoroughfare_descriptor': "LANE",
-    'dependent_locality': "PENN",
-    'post_town': "HIGH WYCOMBE",
-    'postcode': "HP10 8LS"
-})
+address = paf.Address(
+    building_name="1-2",
+    thoroughfare_name="NURSERY",
+    thoroughfare_descriptor="LANE",
+    dependent_locality="PENN",
+    post_town="HIGH WYCOMBE",
+    postcode="HP10 8LS"
+)
 address.as_tuple() # or tuple(address)
 
 ('1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS')
@@ -67,14 +67,14 @@ Or as a dictionary:
 
 ```python
 import paf
-address = paf.Address({
-    'building_name': "1-2",
-    'thoroughfare_name': "NURSERY",
-    'thoroughfare_descriptor': "LANE",
-    'dependent_locality': "PENN",
-    'post_town': "HIGH WYCOMBE",
-    'postcode': "HP10 8LS"
-})
+address = paf.Address(
+    building_name="1-2",
+    thoroughfare_name="NURSERY",
+    thoroughfare_descriptor="LANE",
+    dependent_locality="PENN",
+    post_town="HIGH WYCOMBE",
+    postcode="HP10 8LS"
+)
 address.as_dict()
 
 {
@@ -132,15 +132,15 @@ If there is no `sub_building_name` element and the `dependent_thoroughfare` elem
 
 ```python
 import paf
-self.address = paf.Address({
-    'building_name': "1A",
-    'dependent_thoroughfare_name': "SEASTONE",
-    'dependent_thoroughfare_descriptor': "COURT",
-    'thoroughfare_name': "STATION",
-    'thoroughfare_descriptor': "ROAD",
-    'post_town': "HOLT",
-    'postcode': "NR25 7HG"
-})
+self.address = paf.Address(
+    building_name="1A",
+    dependent_thoroughfare_name="SEASTONE",
+    dependent_thoroughfare_descriptor="COURT",
+    thoroughfare_name="STATION",
+    thoroughfare_descriptor="ROAD",
+    post_town="HOLT",
+    postcode="NR25 7HG"
+)
 address.premises()
 
 {

{pypaf-0.7.0 → PyPaf-1.0.0/src/PyPaf.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.1
 Name: PyPaf
-Version: 0.7.0
+Version: 1.0.0
 Summary: Formats the elements of a Royal Mail Postcode Address File entry
 Author-email: John Bard <johnbard@globalnet.co.uk>
 License: MIT
@@ -27,7 +27,7 @@ Install it from PyPI:
 
 ### Formatting
 
-May be used to format the PAF Address elements as a list of strings:
+May be used to format the PAF Address elements - passed as either a single dictionary or as a series of keyword arguments - as a list of strings:
 
 ```python
 import paf
@@ -48,14 +48,14 @@ Or as a tuple of strings:
 
 ```python
 import paf
-address = paf.Address({
-    'building_name': "1-2",
-    'thoroughfare_name': "NURSERY",
-    'thoroughfare_descriptor': "LANE",
-    'dependent_locality': "PENN",
-    'post_town': "HIGH WYCOMBE",
-    'postcode': "HP10 8LS"
-})
+address = paf.Address(
+    building_name="1-2",
+    thoroughfare_name="NURSERY",
+    thoroughfare_descriptor="LANE",
+    dependent_locality="PENN",
+    post_town="HIGH WYCOMBE",
+    postcode="HP10 8LS"
+)
 address.as_tuple() # or tuple(address)
 
 ('1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS')
@@ -82,14 +82,14 @@ Or as a dictionary:
 
 ```python
 import paf
-address = paf.Address({
-    'building_name': "1-2",
-    'thoroughfare_name': "NURSERY",
-    'thoroughfare_descriptor': "LANE",
-    'dependent_locality': "PENN",
-    'post_town': "HIGH WYCOMBE",
-    'postcode': "HP10 8LS"
-})
+address = paf.Address(
+    building_name="1-2",
+    thoroughfare_name="NURSERY",
+    thoroughfare_descriptor="LANE",
+    dependent_locality="PENN",
+    post_town="HIGH WYCOMBE",
+    postcode="HP10 8LS"
+)
 address.as_dict()
 
 {
@@ -147,15 +147,15 @@ If there is no `sub_building_name` element and the `dependent_thoroughfare` elem
 
 ```python
 import paf
-self.address = paf.Address({
-    'building_name': "1A",
-    'dependent_thoroughfare_name': "SEASTONE",
-    'dependent_thoroughfare_descriptor': "COURT",
-    'thoroughfare_name': "STATION",
-    'thoroughfare_descriptor': "ROAD",
-    'post_town': "HOLT",
-    'postcode': "NR25 7HG"
-})
+self.address = paf.Address(
+    building_name="1A",
+    dependent_thoroughfare_name="SEASTONE",
+    dependent_thoroughfare_descriptor="COURT",
+    thoroughfare_name="STATION",
+    thoroughfare_descriptor="ROAD",
+    post_town="HOLT",
+    postcode="NR25 7HG"
+)
 address.premises()
 
 {

{pypaf-0.7.0 → PyPaf-1.0.0}/src/PyPaf.egg-info/SOURCES.txt

@@ -21,11 +21,11 @@ src/paf/premises/exception.py
 src/paf/premises/extender.py
 src/paf/premises/lineable.py
 src/paf/premises/premisable.py
-src/paf/premises/premises.py
 src/paf/premises/rule000.py
 src/paf/premises/rule001.py
 src/paf/premises/rule010.py
 src/paf/premises/rule011.py
+src/paf/premises/rule100.py
 src/paf/premises/rule101.py
 src/paf/premises/rule110.py
 src/paf/premises/rule111.py
@@ -36,6 +36,7 @@ tests/test_exception_ii.py
 tests/test_exception_iii.py
 tests/test_exception_iv.py
 tests/test_immutability.py
+tests/test_kwargs.py
 tests/test_mainfile.py
 tests/test_po_box.py
 tests/test_premises.py
@@ -45,4 +46,5 @@ tests/test_rule_3.py
 tests/test_rule_4.py
 tests/test_rule_5.py
 tests/test_rule_6.py
-tests/test_rule_7.py
+tests/test_rule_7.py
+tests/test_rule_x.py

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/address.py

@@ -1,20 +1,21 @@
 """PAF Address"""
 
-# Tried using dataclasses.dataclass(frozen=True) decorator for immutablity but did not work"""
+# Tried dataclasses.dataclass(frozen=True) for immutablity but did not work"""
 from .initiator import attribute_init
 from .attribute import AttributeMixin
 from .immutable import ImmutableMixin
 from .lineable import LineableMixin
 from .thoroughfare_locality import ThoroughfareLocalityMixin
-from .premises.premises import Premises
+from .premises import Premises
+
 
 class Address(ImmutableMixin, AttributeMixin, ThoroughfareLocalityMixin, LineableMixin):
     """Main PAF Address class"""
 
     @attribute_init
-    def __init__(self, *args):
+    def __init__(self, *args, **kwargs):
         """Initialise Address elements"""
-        object.__setattr__(self, 'premises', Premises(*args))
+        object.__setattr__(self, 'premises', Premises(*args, **kwargs))
 
     def __repr__(self):
         """Return full representation of an Address"""

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/attribute.py

@@ -1,5 +1,6 @@
 """Attribute Mixin"""
 
+
 class AttributeMixin():
     """Address elements and derived properties"""
 
@@ -9,8 +10,8 @@ class AttributeMixin():
         """Returns Paf premises elements"""
         return (
             'organisation_name', 'department_name',
-                'sub_building_name', 'building_name', 'building_number',
-                'po_box_number'
+            'sub_building_name', 'building_name', 'building_number',
+            'po_box_number'
             )
 
     @classmethod
@@ -29,13 +30,13 @@ class AttributeMixin():
     @property
     def attrs(cls):
         """Returns all Paf address elements"""
-        return(
+        return (
             cls.premises_attrs
-                + cls.dependent_thoroughfare_attrs
-                + cls.thoroughfare_attrs
-                + cls.locality_attrs
-                + cls.post_attrs
-                + cls.other_attrs
+            + cls.dependent_thoroughfare_attrs
+            + cls.thoroughfare_attrs
+            + cls.locality_attrs
+            + cls.post_attrs
+            + cls.other_attrs
             )
 
     def is_empty(self, attr):

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/immutable.py

@@ -2,6 +2,7 @@
 
 from dataclasses import FrozenInstanceError
 
+
 class ImmutableMixin():
     """Prevent manipulation of object attributes"""
 

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/initiator.py

@@ -2,6 +2,7 @@
 
 import functools
 
+
 def attribute_init(func):
     """Decorator to initiate an object based on a list of attributes"""
 
@@ -10,7 +11,11 @@ def attribute_init(func):
         """Initiate properties from specified dict"""
         for key in list(getattr(self, 'attrs', [])):
             object.__setattr__(self, key, '')
-        for key, val in args[0].items():
+        if kwargs:
+            elements = kwargs
+        else:
+            elements = args[0]
+        for key, val in elements.items():
             if hasattr(self, key):
                 object.__setattr__(self, key, str(val))
         return func(self, *args, **kwargs)

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/lineable.py

@@ -2,6 +2,7 @@
 
 from itertools import chain
 
+
 class LineableMixin():
     """Converts Paf address elements into list of address lines"""
 

pypaf-0.7.0/src/paf/premises/premises.py → PyPaf-1.0.0/src/paf/premises/__init__.py

@@ -8,14 +8,15 @@ from .extender import ExtenderMixin
 from .lineable import LineableMixin
 from .split import SplitMixin
 
+
 class Premises(
-    ImmutableMixin, ExtenderMixin, AttributeMixin,
+        ImmutableMixin, ExtenderMixin, AttributeMixin,
         ThoroughfareLocalityMixin, LineableMixin, SplitMixin
-    ):
+        ):
     """PAF Address Premises class"""
 
     @attribute_init
-    def __init__(self, *args): # pylint: disable=unused-argument
+    def __init__(self, *args, **kwargs):  # pylint: disable=unused-argument
         """Initialise Premises elements"""
         self.extend()
 
@@ -34,7 +35,7 @@ class Premises(
 
     def __call__(self):
         """Return Premises as dictionary"""
-        return self.as_premisable() # pylint: disable=no-member
+        return self.as_premisable()  # pylint: disable=no-member
 
     @property
     def building_number_and_sub_building_name(self):
@@ -48,16 +49,17 @@ class Premises(
 
     @property
     def name_last_word_and_thoroughfare_or_locality(self):
-        """Returns last word of building name and first thoroughfare or locality"""
+        """Returns last word of building name and first thoroughfare"""
         return self._concatenate(('building_name_last_word', 'first_thoroughfare_or_locality'))
 
     @property
     def number_and_thoroughfare_or_locality(self):
         """Returns building number and first thoroughfare or locality"""
         return self._concatenate(('building_number', 'first_thoroughfare_or_locality'))
+
     @property
     def number_sub_name_and_thoroughfare_or_locality(self):
-        """Returns building number, sub-building name and first thoroughfare or locality"""
+        """Returns building number, sub-building name and first thoroughfare"""
         return self._concatenate(
             ('building_number_and_sub_building_name', 'first_thoroughfare_or_locality')
             )
@@ -69,9 +71,14 @@ class Premises(
 
     @property
     def sub_name_comma_name(self):
-        """Returns sub-building name and building name concatenated with a comma"""
+        """Returns sub-building name and building name joined with a comma"""
         return self._concatenate(('sub_building_name', 'building_name'), ', ')
 
+    @property
+    def sub_name_and_thoroughfare_or_locality(self):
+        """Returns sub-building number and first thoroughfare or locality"""
+        return self._concatenate(('sub_building_name', 'first_thoroughfare_or_locality'))
+
     @property
     def building_name_but_last_word(self):
         """Returns all but last word of the building name"""
@@ -93,5 +100,7 @@ class Premises(
         return self.last_word('sub_building_name')
 
     def _concatenate(self, keys, concatenator=' '):
-        """Returns specified attributes concatenated with a specified separator"""
-        return concatenator.join(filter(None, [getattr(self, k, None) for k in keys]))
+        """Returns specified attributes concatenated with a separator"""
+        return concatenator.join(
+            filter(None, [getattr(self, k, None) for k in keys])
+            )

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/attribute.py

@@ -1,5 +1,6 @@
 """Attribute Mixin"""
 
+
 class AttributeMixin():
     """Premises elements and derived properties"""
 
@@ -25,13 +26,13 @@ class AttributeMixin():
     @property
     def attrs(cls):
         """Returns all Paf premises elements"""
-        return(
+        return (
             cls.organisation_attrs
-                + cls.building_attrs
-                + cls.dependent_thoroughfare_attrs
-                + cls.thoroughfare_attrs
-                + cls.locality_attrs
-                + cls.other_attrs
+            + cls.building_attrs
+            + cls.dependent_thoroughfare_attrs
+            + cls.thoroughfare_attrs
+            + cls.locality_attrs
+            + cls.other_attrs
             )
 
     def is_empty(self, attr):

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/building_type.py

@@ -2,6 +2,7 @@
 
 from .split import SplitMixin
 
+
 class BuildingTypeMixin(SplitMixin):
     """Determines if a string represents a known building type"""
 
@@ -10,8 +11,11 @@ class BuildingTypeMixin(SplitMixin):
     def known_building_types(cls):
         """Returns known building types"""
         return (
-            "BACK OF", "BLOCK", "BLOCKS", "BUILDING", "MAISONETTE", "MAISONETTES", "REAR OF",
-            "SHOP", "SHOPS", "STALL", "STALLS", "SUITE", "SUITES", "UNIT", "UNITS", "PO BOX"
+            "BACK OF", "BLOCK", "BLOCKS", "BUILDING",
+            "MAISONETTE", "MAISONETTES", "REAR OF",
+            "SHOP", "SHOPS", "STALL", "STALLS",
+            "SUITE", "SUITES", "UNIT", "UNITS",
+            "PO BOX"
             )
 
     @classmethod

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/dependent_premisable.py

@@ -2,6 +2,7 @@
 
 from .premisable import PremisableMixin
 
+
 class DependentPremisableMixin(PremisableMixin):
     """Returns the values for the premises properties"""
 

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/exception.py

@@ -4,6 +4,7 @@ import re
 from .building_type import BuildingTypeMixin
 from .split import SplitMixin
 
+
 class ExceptionMixin(BuildingTypeMixin, SplitMixin):
     """Exceptions"""
 
@@ -27,8 +28,8 @@ class ExceptionMixin(BuildingTypeMixin, SplitMixin):
         """Returns if value is an exception"""
         return (
             cls.__is_exception_i(val)
-                or cls.__is_exception_ii(val)
-                or cls.__is_exception_iii(val)
+            or cls.__is_exception_ii(val)
+            or cls.__is_exception_iii(val)
             )
 
     def __is_exception_iv(self, attr):  # pylint: disable=unused-argument
@@ -36,7 +37,7 @@ class ExceptionMixin(BuildingTypeMixin, SplitMixin):
            and ends with numeric range or numeric alpha suffix"""
         # Do not include suffix check as does not account for values such as BLOCK B
         return self.is_known_building_type(attr)
-        # and re.match(r'^\d', splitstring.last_word(getattr(self, attr, None)))
+        # and re.match(r'^\d', self.last_word(attr))
 
     def is_exception(self, attr):
         """Returns if attribute is an exception"""
@@ -46,6 +47,6 @@ class ExceptionMixin(BuildingTypeMixin, SplitMixin):
         """Returns if attribute should be split"""
         return (
             self.__is_exception(self.last_word(attr))
-                and not self.last_word(attr).isdigit()
-                and not self.__is_exception_iv(attr)
+            and not self.last_word(attr).isdigit()
+            and not self.__is_exception_iv(attr)
             )

PyPaf-1.0.0/src/paf/premises/extender.py

@@ -0,0 +1,26 @@
+"""Premises Extender Mixin"""
+
+import sys
+from .rule000 import Rule000  # pylint: disable=unused-import # noqa: F401
+from .rule001 import Rule001  # pylint: disable=unused-import # noqa: F401
+from .rule010 import Rule010  # pylint: disable=unused-import # noqa: F401
+from .rule100 import Rule100  # pylint: disable=unused-import # noqa: F401
+from .rule011 import Rule011  # pylint: disable=unused-import # noqa: F401
+from .rule101 import Rule101  # pylint: disable=unused-import # noqa: F401
+from .rule110 import Rule110  # pylint: disable=unused-import # noqa: F401
+from .rule111 import Rule111  # pylint: disable=unused-import # noqa: F401
+
+
+class ExtenderMixin():
+    """Dynamic Premises processing"""
+
+    @property
+    def rule(self):
+        """Returns premises rule class"""
+        rule = ''.join(['0' if self.is_empty(k) else '1' for k in self.building_attrs])
+        return getattr(sys.modules[__name__], 'Rule' + rule)
+
+    def extend(self):
+        """Dynamically extends instance with appropriate rule"""
+        base_cls = self.__class__
+        object.__setattr__(self, '__class__', type(base_cls.__name__, (base_cls, self.rule), {}))

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/lineable.py

@@ -2,6 +2,7 @@
 
 from itertools import chain
 
+
 class LineableMixin():
     """Converts Paf address premises elements into list of lines"""
 
@@ -18,7 +19,10 @@ class LineableMixin():
     @property
     def po_box(self):
         """Returns PO Box"""
-        return '' if self.is_empty('po_box_number') else f"PO BOX {getattr(self, 'po_box_number')}"
+        return (
+            '' if self.is_empty('po_box_number')
+            else f"PO BOX {getattr(self, 'po_box_number')}"
+            )
 
     def _lines(self, attrs):
         """Returns list of premises lines from specified attributes"""

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/premisable.py

@@ -2,6 +2,7 @@
 
 from .exception import ExceptionMixin
 
+
 class PremisableMixin(ExceptionMixin):
     """Returns the values for the premises properties"""
 

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/rule000.py

@@ -2,6 +2,7 @@
 
 from .premisable import PremisableMixin
 
+
 class Rule000(PremisableMixin):
     """Rule 1 processing"""
 

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/rule001.py

@@ -2,6 +2,7 @@
 
 from .dependent_premisable import DependentPremisableMixin
 
+
 class Rule001(DependentPremisableMixin):
     """Rule 2 processing"""
 

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/rule010.py

@@ -2,6 +2,7 @@
 
 from .dependent_premisable import DependentPremisableMixin
 
+
 class Rule010(DependentPremisableMixin):
     """Rule 3 processing"""
 
@@ -17,4 +18,7 @@ class Rule010(DependentPremisableMixin):
     @property
     def includes_first_thoroughfare_or_locality(self):
         """Returns if premises includes first thoroughfare or locality"""
-        return self.is_exception('building_name') or self.is_split_exception('building_name')
+        return (
+            self.is_exception('building_name')
+            or self.is_split_exception('building_name')
+            )

{pypaf-0.7.0 → PyPaf-1.0.0}/src/paf/premises/rule011.py

@@ -2,6 +2,7 @@
 
 from .dependent_premisable import DependentPremisableMixin
 
+
 class Rule011(DependentPremisableMixin):
     """Rule 4 processing"""