PyPaf 0.5.0__tar.gz → 0.7.0__tar.gz

pypaf-0.7.0/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.2
+Name: PyPaf
+Version: 0.7.0
+Summary: Formats the elements of a Royal Mail Postcode Address File entry
+Author-email: John Bard <johnbard@globalnet.co.uk>
+License: MIT
+Project-URL: Homepage, https://github.com/drabjay/pypaf
+Project-URL: Repository, https://github.com/drabjay/pypaf.git
+Project-URL: Issues, https://github.com/drabjay/paf/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# PyPaf
+
+Formats the elements of a Royal Mail Postcode Address File entry according to the rules described in the [Royal Mail Programmer's Guide Edition 7, Version 6.2](https://www.poweredbypaf.com/wp-content/uploads/2024/11/Latest-Programmers_guide_Edition-7-Version-6-2.pdf)
+
+## Installation
+
+Install it from PyPI:
+
+    pip install pypaf
+
+## Usage
+
+### Formatting
+
+May be used to format the PAF Address elements as a list 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.as_list() # or list(address)
+
+['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
+```
+
+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.as_tuple() # or tuple(address)
+
+('1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS')
+```
+
+Or as a single string:
+
+```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.as_str() # or str(address)
+
+'1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
+```
+
+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.as_dict()
+
+{
+    'line_1': "1-2 NURSERY LANE",
+    'line_2': "PENN",
+    'post_town': "HIGH WYCOMBE",
+    'postcode': "HP10 8LS"
+}
+```
+
+### Premises Attributes
+
+The `sub_building_name`, `building_name` and `building_number` supplied in the source PAF Address elements need to be parsed according Programmer's Guide rules in order to correctly identify the premises elements of the address.
+
+The Address class includes a parsed premises dictionary that contains key-values that may be used to identify the premises within the thoroughfare and the sub-premises within the premises.
+
+The parsing decomposes the premises and sub-premises to its constituent parts:
+
+| Key                 | Notes |
+| ------------------- | ----------- |
+| premises_type       | If it is of a known type e.g. BLOCK, BUILDING |
+| premises_number     | Building number or leading digits of building name |
+| premises_suffix     | Non-numeric characters following leading digits of building name |
+| premises_name       | Building name, if it cannot be decomposed |
+| sub_premises_type   | If it is of a known type e.g. FLAT, UNIT |
+| sub_premises_number | Leading digits of sub-building name |
+| sub_premises_suffix | Non-numeric characters following leading digits of sub-building name |
+| sub_premises_name   | Sub-building name, if it cannot be decomposed |
+
+```python
+import paf
+self.address = paf.Address({
+    'sub_building_name': "FLAT 2B",
+    'building_name': "THE TOWER",
+    'building_number': "27",
+    'thoroughfare_name': "JOHN",
+    'thoroughfare_descriptor': "STREET",
+    'post_town': "WINCHESTER",
+    'postcode': "SO23 9AP"
+})
+address.premises()
+
+{
+    'premises_number': 27,
+    'premises_name': 'THE TOWER',
+    'sub_premises_type': 'FLAT',
+    'sub_premises_number': 2,
+    'sub_premises_suffix': 'B',
+}
+```
+
+If there are no `sub_building` or `building` elements supplied the `organisation_name` or `po_box_number` elements will be used populate the premises elements, where available.
+
+If there is no `sub_building_name` element and the `dependent_thoroughfare` elements are populated the `building` elements will be used to populate the `sub_premises` elements and the `dependent_thoroughfare` elements the `premises` elements.
+
+```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"
+})
+address.premises()
+
+{
+    'premises_name': 'SEASTONE COURT',
+    'sub_premises_number': 1,
+    'sub_premises_suffix': 'A'
+}
+```
+
+## Development
+
+After checking out the repo, run `pytest` to run the tests.
+
+To release a new version, update the version number in `version.py`, and then run `python -m build`, which will create a distribution archive. Run `python -m twine upload dist/*`, to upload the distribution archive to [pypi.org](https://pypi.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/drabjay/pypaf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PyPaf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/drabjayc/pypaf/blob/master/CODE_OF_CONDUCT.md).

pypaf-0.7.0/README.md

@@ -0,0 +1,169 @@
+# PyPaf
+
+Formats the elements of a Royal Mail Postcode Address File entry according to the rules described in the [Royal Mail Programmer's Guide Edition 7, Version 6.2](https://www.poweredbypaf.com/wp-content/uploads/2024/11/Latest-Programmers_guide_Edition-7-Version-6-2.pdf)
+
+## Installation
+
+Install it from PyPI:
+
+    pip install pypaf
+
+## Usage
+
+### Formatting
+
+May be used to format the PAF Address elements as a list 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.as_list() # or list(address)
+
+['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
+```
+
+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.as_tuple() # or tuple(address)
+
+('1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS')
+```
+
+Or as a single string:
+
+```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.as_str() # or str(address)
+
+'1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
+```
+
+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.as_dict()
+
+{
+    'line_1': "1-2 NURSERY LANE",
+    'line_2': "PENN",
+    'post_town': "HIGH WYCOMBE",
+    'postcode': "HP10 8LS"
+}
+```
+
+### Premises Attributes
+
+The `sub_building_name`, `building_name` and `building_number` supplied in the source PAF Address elements need to be parsed according Programmer's Guide rules in order to correctly identify the premises elements of the address.
+
+The Address class includes a parsed premises dictionary that contains key-values that may be used to identify the premises within the thoroughfare and the sub-premises within the premises.
+
+The parsing decomposes the premises and sub-premises to its constituent parts:
+
+| Key                 | Notes |
+| ------------------- | ----------- |
+| premises_type       | If it is of a known type e.g. BLOCK, BUILDING |
+| premises_number     | Building number or leading digits of building name |
+| premises_suffix     | Non-numeric characters following leading digits of building name |
+| premises_name       | Building name, if it cannot be decomposed |
+| sub_premises_type   | If it is of a known type e.g. FLAT, UNIT |
+| sub_premises_number | Leading digits of sub-building name |
+| sub_premises_suffix | Non-numeric characters following leading digits of sub-building name |
+| sub_premises_name   | Sub-building name, if it cannot be decomposed |
+
+```python
+import paf
+self.address = paf.Address({
+    'sub_building_name': "FLAT 2B",
+    'building_name': "THE TOWER",
+    'building_number': "27",
+    'thoroughfare_name': "JOHN",
+    'thoroughfare_descriptor': "STREET",
+    'post_town': "WINCHESTER",
+    'postcode': "SO23 9AP"
+})
+address.premises()
+
+{
+    'premises_number': 27,
+    'premises_name': 'THE TOWER',
+    'sub_premises_type': 'FLAT',
+    'sub_premises_number': 2,
+    'sub_premises_suffix': 'B',
+}
+```
+
+If there are no `sub_building` or `building` elements supplied the `organisation_name` or `po_box_number` elements will be used populate the premises elements, where available.
+
+If there is no `sub_building_name` element and the `dependent_thoroughfare` elements are populated the `building` elements will be used to populate the `sub_premises` elements and the `dependent_thoroughfare` elements the `premises` elements.
+
+```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"
+})
+address.premises()
+
+{
+    'premises_name': 'SEASTONE COURT',
+    'sub_premises_number': 1,
+    'sub_premises_suffix': 'A'
+}
+```
+
+## Development
+
+After checking out the repo, run `pytest` to run the tests.
+
+To release a new version, update the version number in `version.py`, and then run `python -m build`, which will create a distribution archive. Run `python -m twine upload dist/*`, to upload the distribution archive to [pypi.org](https://pypi.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/drabjay/pypaf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PyPaf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/drabjayc/pypaf/blob/master/CODE_OF_CONDUCT.md).

pypaf-0.7.0/src/PyPaf.egg-info/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.2
+Name: PyPaf
+Version: 0.7.0
+Summary: Formats the elements of a Royal Mail Postcode Address File entry
+Author-email: John Bard <johnbard@globalnet.co.uk>
+License: MIT
+Project-URL: Homepage, https://github.com/drabjay/pypaf
+Project-URL: Repository, https://github.com/drabjay/pypaf.git
+Project-URL: Issues, https://github.com/drabjay/paf/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# PyPaf
+
+Formats the elements of a Royal Mail Postcode Address File entry according to the rules described in the [Royal Mail Programmer's Guide Edition 7, Version 6.2](https://www.poweredbypaf.com/wp-content/uploads/2024/11/Latest-Programmers_guide_Edition-7-Version-6-2.pdf)
+
+## Installation
+
+Install it from PyPI:
+
+    pip install pypaf
+
+## Usage
+
+### Formatting
+
+May be used to format the PAF Address elements as a list 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.as_list() # or list(address)
+
+['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
+```
+
+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.as_tuple() # or tuple(address)
+
+('1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS')
+```
+
+Or as a single string:
+
+```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.as_str() # or str(address)
+
+'1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
+```
+
+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.as_dict()
+
+{
+    'line_1': "1-2 NURSERY LANE",
+    'line_2': "PENN",
+    'post_town': "HIGH WYCOMBE",
+    'postcode': "HP10 8LS"
+}
+```
+
+### Premises Attributes
+
+The `sub_building_name`, `building_name` and `building_number` supplied in the source PAF Address elements need to be parsed according Programmer's Guide rules in order to correctly identify the premises elements of the address.
+
+The Address class includes a parsed premises dictionary that contains key-values that may be used to identify the premises within the thoroughfare and the sub-premises within the premises.
+
+The parsing decomposes the premises and sub-premises to its constituent parts:
+
+| Key                 | Notes |
+| ------------------- | ----------- |
+| premises_type       | If it is of a known type e.g. BLOCK, BUILDING |
+| premises_number     | Building number or leading digits of building name |
+| premises_suffix     | Non-numeric characters following leading digits of building name |
+| premises_name       | Building name, if it cannot be decomposed |
+| sub_premises_type   | If it is of a known type e.g. FLAT, UNIT |
+| sub_premises_number | Leading digits of sub-building name |
+| sub_premises_suffix | Non-numeric characters following leading digits of sub-building name |
+| sub_premises_name   | Sub-building name, if it cannot be decomposed |
+
+```python
+import paf
+self.address = paf.Address({
+    'sub_building_name': "FLAT 2B",
+    'building_name': "THE TOWER",
+    'building_number': "27",
+    'thoroughfare_name': "JOHN",
+    'thoroughfare_descriptor': "STREET",
+    'post_town': "WINCHESTER",
+    'postcode': "SO23 9AP"
+})
+address.premises()
+
+{
+    'premises_number': 27,
+    'premises_name': 'THE TOWER',
+    'sub_premises_type': 'FLAT',
+    'sub_premises_number': 2,
+    'sub_premises_suffix': 'B',
+}
+```
+
+If there are no `sub_building` or `building` elements supplied the `organisation_name` or `po_box_number` elements will be used populate the premises elements, where available.
+
+If there is no `sub_building_name` element and the `dependent_thoroughfare` elements are populated the `building` elements will be used to populate the `sub_premises` elements and the `dependent_thoroughfare` elements the `premises` elements.
+
+```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"
+})
+address.premises()
+
+{
+    'premises_name': 'SEASTONE COURT',
+    'sub_premises_number': 1,
+    'sub_premises_suffix': 'A'
+}
+```
+
+## Development
+
+After checking out the repo, run `pytest` to run the tests.
+
+To release a new version, update the version number in `version.py`, and then run `python -m build`, which will create a distribution archive. Run `python -m twine upload dist/*`, to upload the distribution archive to [pypi.org](https://pypi.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/drabjay/pypaf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PyPaf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/drabjayc/pypaf/blob/master/CODE_OF_CONDUCT.md).

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

@@ -9,12 +9,19 @@ src/paf/__init__.py
 src/paf/address.py
 src/paf/attribute.py
 src/paf/immutable.py
+src/paf/initiator.py
 src/paf/lineable.py
-src/paf/premises_extender.py
 src/paf/thoroughfare_locality.py
 src/paf/version.py
 src/paf/premises/__init__.py
-src/paf/premises/common.py
+src/paf/premises/attribute.py
+src/paf/premises/building_type.py
+src/paf/premises/dependent_premisable.py
+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
@@ -22,6 +29,8 @@ src/paf/premises/rule011.py
 src/paf/premises/rule101.py
 src/paf/premises/rule110.py
 src/paf/premises/rule111.py
+src/paf/premises/split.py
+tests/test_empty.py
 tests/test_exception_i.py
 tests/test_exception_ii.py
 tests/test_exception_iii.py
@@ -29,6 +38,7 @@ tests/test_exception_iv.py
 tests/test_immutability.py
 tests/test_mainfile.py
 tests/test_po_box.py
+tests/test_premises.py
 tests/test_rule_1.py
 tests/test_rule_2.py
 tests/test_rule_3.py

pypaf-0.7.0/src/paf/address.py

@@ -0,0 +1,58 @@
+"""PAF Address"""
+
+# Tried using dataclasses.dataclass(frozen=True) decorator 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
+
+class Address(ImmutableMixin, AttributeMixin, ThoroughfareLocalityMixin, LineableMixin):
+    """Main PAF Address class"""
+
+    @attribute_init
+    def __init__(self, *args):
+        """Initialise Address elements"""
+        object.__setattr__(self, 'premises', Premises(*args))
+
+    def __repr__(self):
+        """Return full representation of an Address"""
+        args = {k: getattr(self, k) for k in list(self.attrs) if getattr(self, k, None)}
+        return self.__class__.__name__ + '(' + str(args) + ')'
+
+    def __str__(self):
+        """Return Address as string representation"""
+        line = ', '.join(self.lines)
+        if self.is_empty('postcode'):
+            return line
+        return '. '.join([line] + [getattr(self, 'postcode')])
+
+    def __iter__(self):
+        """Return Address as iterable"""
+        yield from list(self.lines)
+        if not self.is_empty('postcode'):
+            yield from list([getattr(self, 'postcode')])
+
+    def as_str(self):
+        """Return Address as string"""
+        return str(self)
+
+    def as_list(self):
+        """Return Address as list of strings"""
+        return list(self)
+
+    def as_tuple(self):
+        """Return Address as tuple of strings"""
+        return tuple(self)
+
+    def as_dict(self):
+        """Return Address as dictionary of strings"""
+        address = {}
+        for counter, line in enumerate(getattr(self, 'optional_lines'), 1):
+            address[f"line_{counter}"] = line
+        if not self.is_empty('post_town'):
+            address['post_town'] = getattr(self, 'post_town')
+        if not self.is_empty('postcode'):
+            address['postcode'] = getattr(self, 'postcode')
+        return address

pypaf-0.7.0/src/paf/attribute.py

@@ -0,0 +1,43 @@
+"""Attribute Mixin"""
+
+class AttributeMixin():
+    """Address elements and derived properties"""
+
+    @classmethod
+    @property
+    def premises_attrs(cls):
+        """Returns Paf premises elements"""
+        return (
+            'organisation_name', 'department_name',
+                'sub_building_name', 'building_name', 'building_number',
+                'po_box_number'
+            )
+
+    @classmethod
+    @property
+    def post_attrs(cls):
+        """Returns Paf post elements"""
+        return ('post_town', 'postcode')
+
+    @classmethod
+    @property
+    def other_attrs(cls):
+        """Returns Paf other elements"""
+        return ('concatenation_indicator', 'udprn')
+
+    @classmethod
+    @property
+    def attrs(cls):
+        """Returns all Paf address elements"""
+        return(
+            cls.premises_attrs
+                + cls.dependent_thoroughfare_attrs
+                + cls.thoroughfare_attrs
+                + cls.locality_attrs
+                + cls.post_attrs
+                + cls.other_attrs
+            )
+
+    def is_empty(self, attr):
+        """Returns if attribute value is empty"""
+        return getattr(self, attr, '') == ''