PyPaf 0.1.0__tar.gz

pypaf-0.1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 John Bard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

pypaf-0.1.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.2
+Name: PyPaf
+Version: 0.1.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 5.0](http://www.royalmail.com/sites/default/files/docs/pdf/programmers_guide_edition_7_v5.pdf)
+
+## Installation
+
+Install it from PyPI:
+
+    $ pip install pypaf
+
+## Usage
+
+May be used to format the PAF elements as an array of strings:
+
+```python
+from paf import Paf
+paf = Paf({
+    'building_name': "1-2",
+    'thoroughfare_name': "NURSERY",
+    'thoroughfare_descriptor': "LANE",
+    'dependent_locality': "PENN",
+    'post_town': "HIGH WYCOMBE",
+    'postcode': "HP10 8LS"
+})
+paf.list()
+
+['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
+```
+
+Or as a single string:
+
+```python
+from paf import Paf
+paf = Paf({
+    'building_name': "1-2",
+    'thoroughfare_name': "NURSERY",
+    'thoroughfare_descriptor': "LANE",
+    'dependent_locality': "PENN",
+    'post_town': "HIGH WYCOMBE",
+    'postcode': "HP10 8LS"
+})
+str(paf)
+
+'1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
+```
+
+## 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.1.0/README.md

@@ -0,0 +1,57 @@
+# 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 5.0](http://www.royalmail.com/sites/default/files/docs/pdf/programmers_guide_edition_7_v5.pdf)
+
+## Installation
+
+Install it from PyPI:
+
+    $ pip install pypaf
+
+## Usage
+
+May be used to format the PAF elements as an array of strings:
+
+```python
+from paf import Paf
+paf = Paf({
+    'building_name': "1-2",
+    'thoroughfare_name': "NURSERY",
+    'thoroughfare_descriptor': "LANE",
+    'dependent_locality': "PENN",
+    'post_town': "HIGH WYCOMBE",
+    'postcode': "HP10 8LS"
+})
+paf.list()
+
+['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
+```
+
+Or as a single string:
+
+```python
+from paf import Paf
+paf = Paf({
+    'building_name': "1-2",
+    'thoroughfare_name': "NURSERY",
+    'thoroughfare_descriptor': "LANE",
+    'dependent_locality': "PENN",
+    'post_town': "HIGH WYCOMBE",
+    'postcode': "HP10 8LS"
+})
+str(paf)
+
+'1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
+```
+
+## 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.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "PyPaf"
+dynamic = ["version"]
+authors = [
+  { name="John Bard", email="johnbard@globalnet.co.uk" },
+]
+description = "Formats the elements of a Royal Mail Postcode Address File entry"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent"
+]
+license = { text = "MIT", files = ["LICEN[CS]E*"] }
+
+[project.urls]
+Homepage = "https://github.com/drabjay/pypaf"
+Repository = "https://github.com/drabjay/pypaf.git"
+Issues = "https://github.com/drabjay/paf/issues"
+
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+version = { attr = "paf.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"] 

pypaf-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

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

@@ -0,0 +1,72 @@
+Metadata-Version: 2.2
+Name: PyPaf
+Version: 0.1.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 5.0](http://www.royalmail.com/sites/default/files/docs/pdf/programmers_guide_edition_7_v5.pdf)
+
+## Installation
+
+Install it from PyPI:
+
+    $ pip install pypaf
+
+## Usage
+
+May be used to format the PAF elements as an array of strings:
+
+```python
+from paf import Paf
+paf = Paf({
+    'building_name': "1-2",
+    'thoroughfare_name': "NURSERY",
+    'thoroughfare_descriptor': "LANE",
+    'dependent_locality': "PENN",
+    'post_town': "HIGH WYCOMBE",
+    'postcode': "HP10 8LS"
+})
+paf.list()
+
+['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
+```
+
+Or as a single string:
+
+```python
+from paf import Paf
+paf = Paf({
+    'building_name': "1-2",
+    'thoroughfare_name': "NURSERY",
+    'thoroughfare_descriptor': "LANE",
+    'dependent_locality': "PENN",
+    'post_town': "HIGH WYCOMBE",
+    'postcode': "HP10 8LS"
+})
+str(paf)
+
+'1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
+```
+
+## 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.1.0/src/PyPaf.egg-info/SOURCES.txt

@@ -0,0 +1,35 @@
+LICENSE.txt
+README.md
+pyproject.toml
+src/PyPaf.egg-info/PKG-INFO
+src/PyPaf.egg-info/SOURCES.txt
+src/PyPaf.egg-info/dependency_links.txt
+src/PyPaf.egg-info/top_level.txt
+src/paf/__init__.py
+src/paf/attribute.py
+src/paf/lineable.py
+src/paf/paf.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/rule000.py
+src/paf/premises/rule001.py
+src/paf/premises/rule010.py
+src/paf/premises/rule011.py
+src/paf/premises/rule101.py
+src/paf/premises/rule110.py
+src/paf/premises/rule111.py
+tests/test_exception_i.py
+tests/test_exception_ii.py
+tests/test_exception_iii.py
+tests/test_mainfile.py
+tests/test_po_box.py
+tests/test_rule_1.py
+tests/test_rule_2.py
+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

pypaf-0.1.0/src/PyPaf.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pypaf-0.1.0/src/PyPaf.egg-info/top_level.txt

@@ -0,0 +1 @@
+paf

pypaf-0.1.0/src/paf/__init__.py

@@ -0,0 +1,6 @@
+"""__init__ file"""
+
+from .paf import Paf
+from .version import __version__
+
+__all__ = ["Paf", "__version__"]

pypaf-0.1.0/src/paf/attribute.py

@@ -0,0 +1,66 @@
+"""Attribute Mixin"""
+
+class AttributeMixin():
+    """Base Paf address elements and derived properties"""
+
+    @classmethod
+    @property
+    def organisation_attrs(cls):
+        """Returns Paf organisation elements"""
+        return ['organisation_name', 'department_name']
+
+    @classmethod
+    @property
+    def premises_attrs(cls):
+        """Returns Paf premises elements"""
+        return ['sub_building_name', 'building_name', 'building_number']
+
+    @classmethod
+    @property
+    def dependent_thoroughfare_attrs(cls):
+        """Returns Paf dependent thoroughfare elements"""
+        return ['dependent_thoroughfare_name', 'dependent_thoroughfare_descriptor']
+
+    @classmethod
+    @property
+    def thoroughfare_attrs(cls):
+        """Returns Paf thoroughfare elements"""
+        return ['thoroughfare_name', 'thoroughfare_descriptor']
+
+    @classmethod
+    @property
+    def locality_attrs(cls):
+        """Returns Paf localoty elements"""
+        return ['double_dependent_locality', 'dependent_locality']
+
+    @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 ['po_box_number', 'udprn', 'concatenation_indicator']
+
+    @classmethod
+    @property
+    def attrs(cls):
+        """Returns all Paf address elements"""
+        return(
+            cls.organisation_attrs +
+                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"""
+        if getattr(self, attr, '') == '':
+            return True
+        return False

pypaf-0.1.0/src/paf/lineable.py

@@ -0,0 +1,27 @@
+"""Lineable Mixin"""
+
+from itertools import chain
+from .thoroughfare_locality import ThoroughfareLocalityMixin
+
+class LineableMixin(ThoroughfareLocalityMixin):
+    """Converts Paf address elements into list of address lines, excluding postcode"""
+
+    @classmethod
+    @property
+    def lines_attrs(cls):
+        """Returns Paf address line attributes"""
+        return(
+            cls.organisation_attrs +
+                ['po_box', 'premises', 'thoroughfares_and_localities', 'post_town']
+            )
+
+    @property
+    def lines(self):
+        """Returns Paf as list of address lines"""
+        lines = list(filter(None, [getattr(self, k, None) for k in self.__class__.lines_attrs]))
+        return list(chain(*[line if isinstance(line, list) else [line] for line in lines]))
+
+    @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')}"

pypaf-0.1.0/src/paf/paf.py

@@ -0,0 +1,33 @@
+"""Paf"""
+
+from .lineable import LineableMixin
+
+class Paf(LineableMixin):
+    """Main Paf class"""
+
+    def __init__(self, args):
+        """Initialise Paf address elements"""
+        for key in self.__class__.attrs:
+            setattr(self, key, '')
+        for key, val in args.items():
+            if hasattr(self, key):
+                setattr(self, key, val)
+        self.extend_premises()
+
+    def __repr__(self):
+        """Return full representation of Paf"""
+        args = {k: getattr(self, k) for k in self.__class__.attrs if getattr(self, k, None)}
+        return self.__class__.__name__ + '(' + str(args) + ')'
+
+    def __str__(self):
+        """Return Paf as string"""
+        line = ', '.join(self.lines)
+        if self.is_empty('postcode'):
+            return line
+        return '. '.join([line] + [getattr(self, 'postcode')])
+
+    def list(self):
+        """Return Paf as list of strings"""
+        if self.is_empty('postcode'):
+            return self.lines
+        return self.lines + [getattr(self, 'postcode')]

pypaf-0.1.0/src/paf/premises/common.py

@@ -0,0 +1,38 @@
+"""Common"""
+
+import re
+
+class Common:
+    """Common premises processing"""
+
+    @property
+    def premises_rule_attrs(self):
+        """Abstract method to be implemented by the Rule"""
+
+    @property
+    def premises(self):
+        """Returns premises list"""
+        return [getattr(self, k) for k in self.premises_rule_attrs]
+
+    @property
+    def name_and_thoroughfare_or_locality(self):
+        """Returns building number and first thoroughfare or locality"""
+        return self._concatenate(['building_name', '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 sub_name_and_name(self):
+        """Returns sub-building name and building name"""
+        return self._concatenate(['sub_building_name', 'building_name'])
+
+    def is_exception(self, attr):
+        """Returns if value is an exception"""
+        return re.match(r'^(.|[\d][a-zA-Z]|[\d].*?[\d][a-zA-Z]?)$', getattr(self, attr, None))
+
+    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]))

pypaf-0.1.0/src/paf/premises/rule000.py

@@ -0,0 +1,16 @@
+"""Rule 1"""
+
+from .common import Common
+
+class Rule000(Common):
+    """Rule 1 processing"""
+
+    @property
+    def premises_rule_attrs(self):
+        """Returns premises list"""
+        return []
+
+    @property
+    def does_premises_include_first_thoroughfare_or_locality(self):
+        """Returns if premises includes first thoroughfare or locality"""
+        return False

pypaf-0.1.0/src/paf/premises/rule001.py

@@ -0,0 +1,16 @@
+"""Rule 2"""
+
+from .common import Common
+
+class Rule001(Common):
+    """Rule 2 processing"""
+
+    @property
+    def premises_rule_attrs(self):
+        """Returns premises list"""
+        return ['number_and_thoroughfare_or_locality']
+
+    @property
+    def does_premises_include_first_thoroughfare_or_locality(self):
+        """Returns if premises includes first thoroughfare or locality"""
+        return True

pypaf-0.1.0/src/paf/premises/rule010.py

@@ -0,0 +1,46 @@
+"""Rule 3"""
+
+import re
+from .common import Common
+
+class Rule010(Common):
+    """Rule 3 processing"""
+
+    @property
+    def premises_rule_attrs(self):
+        """Returns premises list"""
+        if self.is_exception('building_name'):
+            return ['name_and_thoroughfare_or_locality']
+        if self.is_building_name_split_exception:
+            return ['building_name_but_last_word', 'name_last_word_and_thoroughfare_or_locality']
+        return ['building_name']
+
+    @property
+    def does_premises_include_first_thoroughfare_or_locality(self):
+        """Returns if premises includes first thoroughfare or locality"""
+        return self.is_exception('building_name') or self.is_building_name_split_exception
+
+    @property
+    def is_building_name_split_exception(self):
+        """Returns if building name should be split"""
+        return(
+            self.is_exception('building_name_last_word') and
+                not re.match(r'^\d+$', self.building_name_last_word)
+            )
+
+    @property
+    def building_name_last_word(self):
+        """Returns last word of the building name"""
+        *_, last = getattr(self, 'building_name', '').split()
+        return last
+
+    @property
+    def building_name_but_last_word(self):
+        """Returns all but last word of the building name"""
+        *first, _ = getattr(self, 'building_name', '').split()
+        return ' '.join(first)
+
+    @property
+    def name_last_word_and_thoroughfare_or_locality(self):
+        """Returns last word of building name and first thoroughfare or locality"""
+        return self._concatenate(['building_name_last_word', 'first_thoroughfare_or_locality'])

pypaf-0.1.0/src/paf/premises/rule011.py

@@ -0,0 +1,16 @@
+"""Rule 4"""
+
+from .common import Common
+
+class Rule011(Common):
+    """Rule 4 processing"""
+
+    @property
+    def premises_rule_attrs(self):
+        """Returns premises list"""
+        return ['building_name', 'number_and_thoroughfare_or_locality']
+
+    @property
+    def does_premises_include_first_thoroughfare_or_locality(self):
+        """Returns if premises includes first thoroughfare or locality"""
+        return True

pypaf-0.1.0/src/paf/premises/rule101.py

@@ -0,0 +1,30 @@
+"""Rule 5"""
+
+from .common import Common
+
+class Rule101(Common):
+    """Rule 5 processing"""
+
+    @property
+    def premises_rule_attrs(self):
+        """Returns premises list"""
+        if getattr(self, 'concatenation_indicator', '') == 'Y':
+            return ['number_sub_name_and_thoroughfare_or_locality']
+        return ['sub_building_name', 'number_and_thoroughfare_or_locality']
+
+    @property
+    def does_premises_include_first_thoroughfare_or_locality(self):
+        """Returns if premises includes first thoroughfare or locality"""
+        return True
+
+    @property
+    def building_number_and_sub_building_name(self):
+        """Returns building number and sub-building name"""
+        return self._concatenate(['building_number', 'sub_building_name'], '')
+
+    @property
+    def number_sub_name_and_thoroughfare_or_locality(self):
+        """Returns building number, sub-building name and first thoroughfare or locality"""
+        return(self._concatenate([
+            'building_number_and_sub_building_name', 'first_thoroughfare_or_locality'
+            ]))

pypaf-0.1.0/src/paf/premises/rule110.py

@@ -0,0 +1,20 @@
+"""Rule 6"""
+
+from .common import Common
+
+class Rule110(Common):
+    """Rule 6 processing"""
+
+    @property
+    def premises_rule_attrs(self):
+        """Returns premises list"""
+        if self.is_exception('sub_building_name'):
+            return['sub_name_and_name']
+        if self.is_exception('building_name'):
+            return['sub_building_name', 'name_and_thoroughfare_or_locality']
+        return ['sub_building_name', 'building_name']
+
+    @property
+    def does_premises_include_first_thoroughfare_or_locality(self):
+        """Returns if premises includes first thoroughfare or locality"""
+        return (not self.is_exception('sub_building_name')) and self.is_exception('building_name')

pypaf-0.1.0/src/paf/premises/rule111.py

@@ -0,0 +1,18 @@
+"""Rule 7"""
+
+from .common import Common
+
+class Rule111(Common):
+    """Rule 7 processing"""
+
+    @property
+    def premises_rule_attrs(self):
+        """Returns premises list"""
+        if self.is_exception('sub_building_name'):
+            return['sub_name_and_name', 'number_and_thoroughfare_or_locality']
+        return ['sub_building_name', 'building_name', 'number_and_thoroughfare_or_locality']
+
+    @property
+    def does_premises_include_first_thoroughfare_or_locality(self):
+        """Returns if premises includes first thoroughfare or locality"""
+        return True