PyPaf 0.1.0__tar.gz → 0.3.0__tar.gz

{pypaf-0.1.0/src/PyPaf.egg-info → pypaf-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyPaf
-Version: 0.1.0
+Version: 0.3.0
 Summary: Formats the elements of a Royal Mail Postcode Address File entry
 Author-email: John Bard <johnbard@globalnet.co.uk>
 License: MIT
@@ -15,13 +15,13 @@ 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)
+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
+    pip install pypaf
 
 ## Usage
 
@@ -37,7 +37,7 @@ paf = Paf({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-paf.list()
+paf.list() # or list(paf)
 
 ['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
 ```
@@ -54,7 +54,7 @@ paf = Paf({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-str(paf)
+paf.str() # or str(paf)
 
 '1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
 ```

{pypaf-0.1.0 → pypaf-0.3.0}/README.md

@@ -1,12 +1,12 @@
 # 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)
+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
+    pip install pypaf
 
 ## Usage
 
@@ -22,7 +22,7 @@ paf = Paf({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-paf.list()
+paf.list() # or list(paf)
 
 ['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
 ```
@@ -39,7 +39,7 @@ paf = Paf({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-str(paf)
+paf.str() # or str(paf)
 
 '1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
 ```

{pypaf-0.1.0 → pypaf-0.3.0/src/PyPaf.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyPaf
-Version: 0.1.0
+Version: 0.3.0
 Summary: Formats the elements of a Royal Mail Postcode Address File entry
 Author-email: John Bard <johnbard@globalnet.co.uk>
 License: MIT
@@ -15,13 +15,13 @@ 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)
+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
+    pip install pypaf
 
 ## Usage
 
@@ -37,7 +37,7 @@ paf = Paf({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-paf.list()
+paf.list() # or list(paf)
 
 ['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
 ```
@@ -54,7 +54,7 @@ paf = Paf({
     'post_town': "HIGH WYCOMBE",
     'postcode': "HP10 8LS"
 })
-str(paf)
+paf.str() # or str(paf)
 
 '1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
 ```

{pypaf-0.1.0 → pypaf-0.3.0}/src/PyPaf.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ src/paf/premises/rule111.py
 tests/test_exception_i.py
 tests/test_exception_ii.py
 tests/test_exception_iii.py
+tests/test_exception_iv.py
 tests/test_mainfile.py
 tests/test_po_box.py
 tests/test_rule_1.py

{pypaf-0.1.0 → pypaf-0.3.0}/src/paf/paf.py

@@ -20,14 +20,22 @@ class Paf(LineableMixin):
         return self.__class__.__name__ + '(' + str(args) + ')'
 
     def __str__(self):
-        """Return Paf as string"""
+        """Return Paf as string representation"""
         line = ', '.join(self.lines)
         if self.is_empty('postcode'):
             return line
         return '. '.join([line] + [getattr(self, 'postcode')])
 
+    def __iter__(self):
+        """Return Paf as iterable"""
+        yield from self.lines.__iter__()
+        if not self.is_empty('postcode'):
+            yield from [getattr(self, 'postcode')].__iter__()
+
+    def str(self):
+        """Return Paf as string"""
+        return str(self)
+
     def list(self):
         """Return Paf as list of strings"""
-        if self.is_empty('postcode'):
-            return self.lines
-        return self.lines + [getattr(self, 'postcode')]
+        return list(self)

{pypaf-0.1.0 → pypaf-0.3.0}/src/paf/premises/rule010.py

@@ -25,9 +25,18 @@ class Rule010(Common):
         """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)
+                not re.match(r'^\d+$', self.building_name_last_word) and
+                not self.is_non_split_building_name
             )
 
+    @property
+    def is_non_split_building_name(self):
+        """Returns if building name should not be split based on all but last word"""
+        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"
+            ]
+
     @property
     def building_name_last_word(self):
         """Returns last word of the building name"""

{pypaf-0.1.0 → pypaf-0.3.0}/src/paf/premises/rule111.py

@@ -8,6 +8,8 @@ class Rule111(Common):
     @property
     def premises_rule_attrs(self):
         """Returns premises list"""
+        if self.is_zero_building_number:
+            return['sub_name_comma_name']
         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']
@@ -15,4 +17,14 @@ class Rule111(Common):
     @property
     def does_premises_include_first_thoroughfare_or_locality(self):
         """Returns if premises includes first thoroughfare or locality"""
-        return True
+        return not self.is_zero_building_number
+
+    @property
+    def is_zero_building_number(self):
+        """Returns if building number is a 0"""
+        return getattr(self, 'building_number', '') == "0"
+
+    @property
+    def sub_name_comma_name(self):
+        """Returns sub-building name and building name concatenated with a comma"""
+        return self._concatenate(['sub_building_name', 'building_name'], ', ')

pypaf-0.3.0/src/paf/version.py

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

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_exception_i.py

@@ -25,7 +25,7 @@ class TestExceptionI(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS"
-        self.assertEqual(str(self.paf), address, "Incorrect Exception I string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Exception I string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_exception_ii.py

@@ -23,7 +23,7 @@ class TestExceptionII(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "12A UPPERKIRKGATE, ABERDEEN. AB10 1BA"
-        self.assertEqual(str(self.paf), address, "Incorrect Exception II string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Exception II string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_exception_iii.py

@@ -24,7 +24,7 @@ class TestExceptionIII(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "K PORTLAND ROAD, DORKING. RH4 1EW"
-        self.assertEqual(str(self.paf), address, "Incorrect Exception III string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Exception III string format")
 
 if __name__ == '__main__':
     unittest.main()

pypaf-0.3.0/tests/test_exception_iv.py

@@ -0,0 +1,100 @@
+"""Test Paf Exception IV formatting"""
+
+import unittest
+from paf import Paf
+
+class TestExceptionIVUnit(unittest.TestCase):
+    """Test Paf Exception IV Unit"""
+
+    def setUp(self):
+        """Set up Paf instance"""
+        self.paf = Paf({
+            '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.paf.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.paf.str(), address, "Incorrect Exception IV Unit string format")
+
+class TestExceptionIVStall(unittest.TestCase):
+    """Test Paf Exception IV Stall"""
+
+    def setUp(self):
+        """Set up Paf instance"""
+        self.paf = Paf({
+            '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.paf.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.paf.str(), address, "Incorrect Exception IV Stall string format")
+
+class TestExceptionIVRearOf(unittest.TestCase):
+    """Test Paf Exception IV Rear Of"""
+
+    def setUp(self):
+        """Set up Paf instance"""
+        self.paf = Paf({
+            '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.paf.list(), address, "Incorrect Exception IV Rear Of 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.paf.str(), address, "Incorrect Exception IV Rear Of string format")
+
+if __name__ == '__main__':
+    unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_mainfile.py

@@ -49,7 +49,7 @@ class TestMainfile(unittest.TestCase):
             "GLASGOW. "
             "G72 0UP"
             )
-        self.assertEqual(str(self.paf), address, "Incorrect Mainfile string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Mainfile string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_po_box.py

@@ -22,7 +22,7 @@ class TestPoBox(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "PO BOX 61, FAREHAM. PO14 1UX"
-        self.assertEqual(str(self.paf), address, "Incorrect PO Box string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect PO Box string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_rule_1.py

@@ -23,7 +23,7 @@ class TestRule1(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "LEDA ENGINEERING LTD, APPLEFORD, ABINGDON. OX14 4PG"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 1 string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 1 string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_rule_2.py

@@ -24,7 +24,7 @@ class TestRule2(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "1 ACACIA AVENUE, ABINGDON. OX14 4PG"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 2 string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 2 string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_rule_3.py

@@ -26,7 +26,7 @@ class TestRule3WithBuildingName(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "1A SEASTONE COURT, STATION ROAD, HOLT. NR25 7HG"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 3 with building string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 3 with building string format")
 
 class TestRule3WithoutBuildingName(unittest.TestCase):
     """Test Paf Rule 3 without Building Name Exception"""
@@ -49,7 +49,7 @@ class TestRule3WithoutBuildingName(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "THE MANOR, UPPER ROAD, HORLEY. RH6 0HP"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 3 without building string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 3 without building string format")
 
 class TestRule3WithSplit(unittest.TestCase):
     """Test Paf Rule 3 with Split Exception"""
@@ -79,7 +79,7 @@ class TestRule3WithSplit(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "S D ALCOTT FLORISTS, FLOWER HOUSE, 189A PYE GREEN ROAD, CANNOCK. WS11 5SB"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 3 with split string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 3 with split string format")
 
 class TestRule3WithoutSplit(unittest.TestCase):
     """Test Paf Rule 3 without Split Exception"""
@@ -103,7 +103,7 @@ class TestRule3WithoutSplit(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "JAMES VILLA HOLIDAYS, CENTRE 30, ST LAURENCE AVENUE, GRAFTON. ME16 0LP"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 3 without split string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 3 without split string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_rule_4.py

@@ -25,7 +25,7 @@ class TestRule4(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "VICTORIA HOUSE, 15 THE STREET, CHRISTCHURCH. BH23 6AA"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 4 string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 4 string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_rule_5.py

@@ -25,7 +25,7 @@ class TestRule5(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "FLAT 1, 12 LIME TREE AVENUE, BRISTOL. BS8 4AB"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 5 string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 5 string format")
 
 class TestRule5WithConcatenation(unittest.TestCase):
     """Test Paf Rule 5 with Concatenation"""
@@ -51,7 +51,7 @@ class TestRule5WithConcatenation(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "12A HIGH STREET NORTH, COOMBE BISSETT, SALISBURY. SP5 4NA"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 5 with concatenate string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 5 with concatenate string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_rule_6.py

@@ -25,7 +25,7 @@ class TestRule6WithSubBuildingName(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "10B BARRY JACKSON TOWER, ESTONE WALK, BIRMINGHAM. B6 5BA"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 6 with sub-building string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 6 w/ sub-building string format")
 
 class TestRule6WithBuildingName(unittest.TestCase):
     """Test Paf Rule 6 with Building Name Exception"""
@@ -49,7 +49,7 @@ class TestRule6WithBuildingName(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "CARETAKERS FLAT, 110-114 HIGH STREET WEST, BRISTOL. BS1 2AW"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 6 with building string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 6 with building string format")
 
 class TestRule6(unittest.TestCase):
     """Test Paf Rule 6 without Exception"""
@@ -73,7 +73,7 @@ class TestRule6(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "STABLES FLAT, THE MANOR, UPPER HILL, HORLEY. RH6 0HP"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 6 string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 6 string format")
 
 if __name__ == '__main__':
     unittest.main()

{pypaf-0.1.0 → pypaf-0.3.0}/tests/test_rule_7.py

@@ -3,6 +3,32 @@
 import unittest
 from paf import Paf
 
+class TestRule7WithZeroBuildingNumber(unittest.TestCase):
+    """Test Paf Rule 7 with a 0 Building Number"""
+
+    def setUp(self):
+        """Set up Paf instance"""
+        self.paf = Paf({
+            'sub_building_name': "FLAT 1",
+            'building_name': "HOLLY HOUSE",
+            'building_number': "0",
+            'thoroughfare_name': "OAK",
+            'thoroughfare_descriptor': "AVENUE",
+            'dependent_locality': "BIDDENDEN",
+            'post_town': "ASHFORD",
+            'postcode': "TN27 8BT"
+            })
+
+    def test_list(self):
+        """Test conversion to an list"""
+        address = ["FLAT 1, HOLLY HOUSE", "OAK AVENUE", "BIDDENDEN", "ASHFORD", "TN27 8BT"]
+        self.assertEqual(self.paf.list(), address, "Incorrect Rule 7 with 0 building number format")
+
+    def test_string(self):
+        """Test conversion to a string"""
+        address = "FLAT 1, HOLLY HOUSE, OAK AVENUE, BIDDENDEN, ASHFORD. TN27 8BT"
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 7 w/ 0 building number format")
+
 class TestRule7WithSubBuildingName(unittest.TestCase):
     """Test Paf Rule 7 with Sub-Building Name Exception"""
 
@@ -26,7 +52,7 @@ class TestRule7WithSubBuildingName(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "2B THE TOWER, 27 JOHN STREET, WINCHESTER. SO23 9AP"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 7 with sub-building string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 7 w/ sub-building string format")
 
 class TestRule7(unittest.TestCase):
     """Test Paf Rule 7 without Exception"""
@@ -51,7 +77,7 @@ class TestRule7(unittest.TestCase):
     def test_string(self):
         """Test conversion to a string"""
         address = "BASEMENT FLAT, VICTORIA HOUSE, 15 THE STREET, CORYTON. BP23 6AA"
-        self.assertEqual(str(self.paf), address, "Incorrect Rule 7 string format")
+        self.assertEqual(self.paf.str(), address, "Incorrect Rule 7 string format")
 
 if __name__ == '__main__':
     unittest.main()

pypaf-0.1.0/src/paf/version.py

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