PyPaf 0.5.0__tar.gz → 0.6.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyPaf
-Version: 0.5.0
+Version: 0.6.0
 Summary: Formats the elements of a Royal Mail Postcode Address File entry
 Author-email: John Bard <johnbard@globalnet.co.uk>
 License: MIT
@@ -25,7 +25,7 @@ Install it from PyPI:
 
 ## Usage
 
-May be used to format the PAF Address elements as an array of strings:
+May be used to format the PAF Address elements as a list of strings:
 
 ```python
 import paf
@@ -37,11 +37,28 @@ address = paf.Address({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-address.list() # or list(address)
+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
@@ -54,11 +71,39 @@ address = paf.Address({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-address.str() # or str(address)
+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"
+}
+```
+
+## 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.

{pypaf-0.5.0 → pypaf-0.6.0}/README.md

@@ -10,7 +10,7 @@ Install it from PyPI:
 
 ## Usage
 
-May be used to format the PAF Address elements as an array of strings:
+May be used to format the PAF Address elements as a list of strings:
 
 ```python
 import paf
@@ -22,11 +22,28 @@ address = paf.Address({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-address.list() # or list(address)
+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
@@ -39,11 +56,39 @@ address = paf.Address({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-address.str() # or str(address)
+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"
+}
+```
+
+## 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.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyPaf
-Version: 0.5.0
+Version: 0.6.0
 Summary: Formats the elements of a Royal Mail Postcode Address File entry
 Author-email: John Bard <johnbard@globalnet.co.uk>
 License: MIT
@@ -25,7 +25,7 @@ Install it from PyPI:
 
 ## Usage
 
-May be used to format the PAF Address elements as an array of strings:
+May be used to format the PAF Address elements as a list of strings:
 
 ```python
 import paf
@@ -37,11 +37,28 @@ address = paf.Address({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-address.list() # or list(address)
+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
@@ -54,11 +71,39 @@ address = paf.Address({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-address.str() # or str(address)
+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"
+}
+```
+
+## 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.

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

@@ -22,6 +22,7 @@ src/paf/premises/rule011.py
 src/paf/premises/rule101.py
 src/paf/premises/rule110.py
 src/paf/premises/rule111.py
+tests/test_empty.py
 tests/test_exception_i.py
 tests/test_exception_ii.py
 tests/test_exception_iii.py

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

@@ -34,10 +34,25 @@ class Address(ImmutableMixin, LineableMixin):
         if not self.is_empty('postcode'):
             yield from [getattr(self, 'postcode')].__iter__()
 
-    def str(self):
+    def as_str(self):
         """Return Address as string"""
         return str(self)
 
-    def list(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.6.0/src/paf/lineable.py

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

pypaf-0.6.0/src/paf/version.py

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

pypaf-0.6.0/tests/test_empty.py

@@ -0,0 +1,34 @@
+"""Test Empty Address formatting"""
+
+import unittest
+import paf
+
+class TestEmpty(unittest.TestCase):
+    """Test Address Exception I"""
+
+    def setUp(self):
+        """Set up Address instance"""
+        self.address = paf.Address({})
+
+    def test_list(self):
+        """Test conversion to an list"""
+        address = []
+        self.assertEqual(self.address.as_list(), address, "Incorrect empty list format")
+
+    def test_string(self):
+        """Test conversion to a string"""
+        address = ""
+        self.assertEqual(self.address.as_str(), address, "Incorrect empty string format")
+
+    def test_tuple(self):
+        """Test conversion to a tuple"""
+        address = ()
+        self.assertEqual(self.address.as_tuple(), address, "Incorrect empty tuple format")
+
+    def test_dict(self):
+        """Test conversion to a dict"""
+        address = {}
+        self.assertEqual(self.address.as_dict(), address, "Incorrect empty dict format")
+
+if __name__ == '__main__':
+    unittest.main()

{pypaf-0.5.0 → pypaf-0.6.0}/tests/test_exception_i.py

@@ -20,12 +20,27 @@ class TestExceptionI(unittest.TestCase):
     def test_list(self):
         """Test conversion to an list"""
         address = ["1-2 NURSERY LANE", "PENN", "HIGH WYCOMBE", "HP10 8LS"]
-        self.assertEqual(self.address.list(), address, "Incorrect Exception I list format")
+        self.assertEqual(self.address.as_list(), address, "Incorrect Exception I list format")
 
     def test_string(self):
         """Test conversion to a string"""
         address = "1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS"
-        self.assertEqual(self.address.str(), address, "Incorrect Exception I string format")
+        self.assertEqual(self.address.as_str(), address, "Incorrect Exception I string format")
+
+    def test_tuple(self):
+        """Test conversion to a tuple"""
+        address = ("1-2 NURSERY LANE", "PENN", "HIGH WYCOMBE", "HP10 8LS")
+        self.assertEqual(self.address.as_tuple(), address, "Incorrect Exception I tuple format")
+
+    def test_dict(self):
+        """Test conversion to a dict"""
+        address = {
+            'line_1': "1-2 NURSERY LANE",
+            'line_2': "PENN",
+            'post_town': "HIGH WYCOMBE",
+            'postcode': "HP10 8LS"
+            }
+        self.assertEqual(self.address.as_dict(), address, "Incorrect Exception I dict format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.5.0 → pypaf-0.6.0}/tests/test_exception_ii.py

@@ -18,12 +18,22 @@ class TestExceptionII(unittest.TestCase):
     def test_list(self):
         """Test conversion to an list"""
         address = ["12A UPPERKIRKGATE", "ABERDEEN", "AB10 1BA"]
-        self.assertEqual(self.address.list(), address, "Incorrect Exception II list format")
+        self.assertEqual(self.address.as_list(), address, "Incorrect Exception II list format")
 
     def test_string(self):
         """Test conversion to a string"""
         address = "12A UPPERKIRKGATE, ABERDEEN. AB10 1BA"
-        self.assertEqual(self.address.str(), address, "Incorrect Exception II string format")
+        self.assertEqual(self.address.as_str(), address, "Incorrect Exception II string format")
+
+    def test_tuple(self):
+        """Test conversion to a tuple"""
+        address = ("12A UPPERKIRKGATE", "ABERDEEN", "AB10 1BA")
+        self.assertEqual(self.address.as_tuple(), address, "Incorrect Exception II tuple format")
+
+    def test_dict(self):
+        """Test conversion to a dict"""
+        address = {'line_1': "12A UPPERKIRKGATE", 'post_town': "ABERDEEN", 'postcode': "AB10 1BA"}
+        self.assertEqual(self.address.as_dict(), address, "Incorrect Exception II dict format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.5.0 → pypaf-0.6.0}/tests/test_exception_iii.py

@@ -19,12 +19,22 @@ class TestExceptionIII(unittest.TestCase):
     def test_list(self):
         """Test conversion to an list"""
         address = ["K PORTLAND ROAD", "DORKING", "RH4 1EW"]
-        self.assertEqual(self.address.list(), address, "Incorrect Exception III list format")
+        self.assertEqual(self.address.as_list(), address, "Incorrect Exception III list format")
 
     def test_string(self):
         """Test conversion to a string"""
         address = "K PORTLAND ROAD, DORKING. RH4 1EW"
-        self.assertEqual(self.address.str(), address, "Incorrect Exception III string format")
+        self.assertEqual(self.address.as_str(), address, "Incorrect Exception III string format")
+
+    def test_tuple(self):
+        """Test conversion to a tuple"""
+        address = ("K PORTLAND ROAD", "DORKING", "RH4 1EW")
+        self.assertEqual(self.address.as_tuple(), address, "Incorrect Exception III tuple format")
+
+    def test_dict(self):
+        """Test conversion to a dict"""
+        address = {'line_1': "K PORTLAND ROAD", 'post_town': "DORKING", 'postcode': "RH4 1EW"}
+        self.assertEqual(self.address.as_dict(), address, "Incorrect Exception III dict format")
 
 if __name__ == '__main__':
     unittest.main()

pypaf-0.6.0/tests/test_exception_iv.py

@@ -0,0 +1,190 @@
+"""Test Address Exception IV formatting"""
+
+import unittest
+import paf
+
+class TestExceptionIVUnit(unittest.TestCase):
+    """Test Address Exception IV Unit"""
+
+    def setUp(self):
+        """Set up Address instance"""
+        self.address = paf.Address({
+            'organisation_name': "THE TAMBOURINE WAREHOUSE",
+            'building_name': "UNIT 1-3",
+            'dependent_thoroughfare_name': "INDUSTRIAL",
+            'dependent_thoroughfare_descriptor': "ESTATE",
+            'thoroughfare_name': "TAME",
+            'thoroughfare_descriptor': "ROAD",
+            'post_town': "LONDON",
+            'postcode': "E6 7HS"
+            })
+
+    def test_list(self):
+        """Test conversion to an list"""
+        address = [
+            "THE TAMBOURINE WAREHOUSE",
+            "UNIT 1-3",
+            "INDUSTRIAL ESTATE",
+            "TAME ROAD",
+            "LONDON",
+            "E6 7HS"
+            ]
+        self.assertEqual(self.address.as_list(), address, "Incorrect Exception IV Unit list format")
+
+    def test_string(self):
+        """Test conversion to a string"""
+        address = "THE TAMBOURINE WAREHOUSE, UNIT 1-3, INDUSTRIAL ESTATE, TAME ROAD, LONDON. E6 7HS"
+        self.assertEqual(
+            self.address.as_str(), address, "Incorrect Exception IV Unit string format"
+            )
+
+    def test_tuple(self):
+        """Test conversion to a tuple"""
+        address = (
+            "THE TAMBOURINE WAREHOUSE",
+            "UNIT 1-3",
+            "INDUSTRIAL ESTATE",
+            "TAME ROAD",
+            "LONDON",
+            "E6 7HS"
+            )
+        self.assertEqual(
+            self.address.as_tuple(), address, "Incorrect Exception IV Unit tuple format"
+            )
+
+    def test_dict(self):
+        """Test conversion to a dict"""
+        address = {
+            'line_1': "THE TAMBOURINE WAREHOUSE",
+            'line_2': "UNIT 1-3",
+            'line_3': "INDUSTRIAL ESTATE",
+            'line_4': "TAME ROAD",
+            'post_town': "LONDON",
+            'postcode': "E6 7HS"
+            }
+        self.assertEqual(
+            self.address.as_dict(), address, "Incorrect Exception IV Unit dict format"
+            )
+
+class TestExceptionIVStall(unittest.TestCase):
+    """Test Address Exception IV Stall"""
+
+    def setUp(self):
+        """Set up Address instance"""
+        self.address = paf.Address({
+            'organisation_name': "QUIRKY CANDLES LTD",
+            'building_name': "STALL 4",
+            'thoroughfare_name': "MARKET",
+            'thoroughfare_descriptor': "SQUARE",
+            'post_town': "LIVERPOOL",
+            'postcode': "L8 1LH"
+            })
+
+    def test_list(self):
+        """Test conversion to an list"""
+        address = [
+            "QUIRKY CANDLES LTD",
+            "STALL 4",
+            "MARKET SQUARE",
+            "LIVERPOOL",
+            "L8 1LH"
+            ]
+        self.assertEqual(
+            self.address.as_list(), address, "Incorrect Exception IV Stall list format"
+            )
+
+    def test_string(self):
+        """Test conversion to a string"""
+        address = "QUIRKY CANDLES LTD, STALL 4, MARKET SQUARE, LIVERPOOL. L8 1LH"
+        self.assertEqual(
+            self.address.as_str(), address, "Incorrect Exception IV Stall string format"
+            )
+
+    def test_tuple(self):
+        """Test conversion to a tuple"""
+        address = (
+            "QUIRKY CANDLES LTD",
+            "STALL 4",
+            "MARKET SQUARE",
+            "LIVERPOOL",
+            "L8 1LH"
+            )
+        self.assertEqual(
+            self.address.as_tuple(), address, "Incorrect Exception IV Stall tuple format"
+            )
+
+    def test_dict(self):
+        """Test conversion to a dict"""
+        address = {
+            'line_1': "QUIRKY CANDLES LTD",
+            'line_2': "STALL 4",
+            'line_3': "MARKET SQUARE",
+            'post_town': "LIVERPOOL",
+            'postcode': "L8 1LH"
+            }
+        self.assertEqual(
+            self.address.as_dict(), address, "Incorrect Exception IV Stall dict format"
+            )
+
+class TestExceptionIVRearOf(unittest.TestCase):
+    """Test Address Exception IV Rear Of"""
+
+    def setUp(self):
+        """Set up Address instance"""
+        self.address = paf.Address({
+            'organisation_name': "FIONA'S FLOWERS",
+            'building_name': "REAR OF 5A",
+            'thoroughfare_name': "HIGH",
+            'thoroughfare_descriptor': "STREET",
+            'post_town': "GATESHEAD",
+            'postcode': "NE8 1BH"
+            })
+
+    def test_list(self):
+        """Test conversion to an list"""
+        address = [
+            "FIONA'S FLOWERS",
+            "REAR OF 5A",
+            "HIGH STREET",
+            "GATESHEAD",
+            "NE8 1BH"
+            ]
+        self.assertEqual(
+            self.address.as_list(), address, "Incorrect Exception IV RearOf list format"
+            )
+
+    def test_string(self):
+        """Test conversion to a string"""
+        address = "FIONA'S FLOWERS, REAR OF 5A, HIGH STREET, GATESHEAD. NE8 1BH"
+        self.assertEqual(
+            self.address.as_str(), address, "Incorrect Exception IV RearOf string format"
+            )
+
+    def test_tuple(self):
+        """Test conversion to a tuple"""
+        address = (
+            "FIONA'S FLOWERS",
+            "REAR OF 5A",
+            "HIGH STREET",
+            "GATESHEAD",
+            "NE8 1BH"
+            )
+        self.assertEqual(
+            self.address.as_tuple(), address, "Incorrect Exception IV RearOf tuple format"
+            )
+
+    def test_dict(self):
+        """Test conversion to a dict"""
+        address = {
+            'line_1': "FIONA'S FLOWERS",
+            'line_2': "REAR OF 5A",
+            'line_3': "HIGH STREET",
+            'post_town': "GATESHEAD",
+            'postcode': "NE8 1BH"
+            }
+        self.assertEqual(
+            self.address.as_dict(), address, "Incorrect Exception IV RearOf dict format"
+            )
+
+if __name__ == '__main__':
+    unittest.main()