chore: add support for Python 3.13 in CI and testing configurations

Author: Pythonian

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - name: Check out the code
@@ -56,10 +56,10 @@ jobs:
       - name: Check out the code
         uses: actions/checkout@v4
 
-      - name: Set up Python 3.12
+      - name: Set up Python 3.13
         uses: actions/setup-python@v5
         with:
-          python-version: 3.12
+          python-version: 3.13
 
       - name: Install dependencies
         run: python3 -m pip install -U pip tox
@@ -73,10 +73,10 @@ jobs:
       - name: Check out the code
         uses: actions/checkout@v4
 
-      - name: Set up Python 3.12
+      - name: Set up Python 3.13
         uses: actions/setup-python@v5
         with:
-          python-version: 3.12
+          python-version: 3.13
 
       - name: Install dependencies
         run: python3 -m pip install -U pip tox

fakernaija/tests/providers/test_state_provider.py

@@ -6,6 +6,7 @@
 """
 
 import unittest
+from unittest.mock import patch
 
 from fakernaija.providers import StateProvider
 
@@ -67,3 +68,102 @@ def test_get_state_error(self) -> None:
             "Invalid state: InvalidState.",
             str(context.exception),
         )
+
+
+class TestStateProviderExtended(unittest.TestCase):
+    """Extended tests for the StateProvider class to cover additional code paths."""
+
+    def setUp(self) -> None:
+        """Sample states data for testing."""
+        self.sample_states = [
+            {
+                "name": "Lagos",
+                "code": "LA",
+                "capital": "Ikeja",
+                "slogan": "Power of the Sea",
+                "lgas": [
+                    {"name": "Ikeja", "code": "001"},
+                    {"name": "Epe", "code": "002"},
+                ],
+                "region": "South West",
+                "postal_code": "100001",
+            },
+            {
+                "name": "Kaduna",
+                "code": "KD",
+                "capital": "Kaduna",
+                "slogan": "Centre of Learning",
+                "lgas": [
+                    {"name": "Kaduna North", "code": "003"},
+                    {"name": "Kaduna South", "code": "004"},
+                ],
+                "region": "North West",
+                "postal_code": "200001",
+            },
+        ]
+        # Patch load_json in the state provider module so that our sample data is used.
+        patcher = patch(
+            "fakernaija.providers.state.load_json", return_value=self.sample_states
+        )
+        self.mock_load_json = patcher.start()
+        self.addCleanup(patcher.stop)
+        self.state_provider = (
+            StateProvider()
+        )  # Uses patched data and runs _generate_region_abbrs()
+
+    def test_get_lgas(self) -> None:
+        """Test that get_lgas returns all LGAs from all states."""
+        lgas = self.state_provider.get_lgas()
+        expected = [
+            {"name": "Ikeja", "code": "001"},
+            {"name": "Epe", "code": "002"},
+            {"name": "Kaduna North", "code": "003"},
+            {"name": "Kaduna South", "code": "004"},
+        ]
+        self.assertEqual(lgas, expected)
+
+    def test_get_state_lgas_valid(self) -> None:
+        """Test that get_state_lgas returns LGAs for a valid state."""
+        lgas = self.state_provider.get_state_lgas("Lagos")
+        expected = [{"name": "Ikeja", "code": "001"}, {"name": "Epe", "code": "002"}]
+        self.assertEqual(lgas, expected)
+
+    def test_get_state_lgas_invalid(self) -> None:
+        """Test that get_state_lgas raises a ValueError for an invalid state."""
+        with self.assertRaises(ValueError) as context:
+            self.state_provider.get_state_lgas("InvalidState")
+        # Verify that the error message mentions the invalid state.
+        self.assertIn("Invalid state: InvalidState.", str(context.exception))
+
+    def test_get_lga_codes_all(self) -> None:
+        """Test that get_lga_codes returns LGA codes for all states when no state is specified."""
+        lga_codes = self.state_provider.get_lga_codes()
+        expected = {
+            "Lagos": ["001", "002"],
+            "Kaduna": ["003", "004"],
+        }
+        self.assertEqual(lga_codes, expected)
+
+    def test_get_lga_codes_specific(self) -> None:
+        """Test that get_lga_codes returns LGA codes for a specific state."""
+        lga_codes = self.state_provider.get_lga_codes("Kaduna")
+        expected = {"Kaduna": ["003", "004"]}
+        self.assertEqual(lga_codes, expected)
+
+    def test_get_state_suggestions(self) -> None:
+        """Test that _get_state returns suggestions when a near-match is provided."""
+        # Patch difflib.get_close_matches to simulate suggestions.
+        with patch(
+            "fakernaija.providers.state.difflib.get_close_matches",
+            return_value=["Lagos"],
+        ) as mock_get_close_matches:
+            with self.assertRaises(ValueError) as context:
+                self.state_provider.get_postal_code_by_state("Lago")
+            error_message = str(context.exception)
+            # Verify that the error message contains a suggestion.
+            self.assertIn("Did you mean: Lagos?", error_message)
+            # Check that get_close_matches was called with expected arguments.
+            available_states = ", ".join(self.state_provider.get_state_names())
+            mock_get_close_matches.assert_called_with(
+                "Lago", available_states, n=3, cutoff=0.6
+            )

pyproject.toml

@@ -20,6 +20,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: Implementation :: PyPy",
     "Operating System :: OS Independent",
     "Topic :: Software Development :: Libraries :: Python Modules",

tox.ini

@@ -29,6 +29,10 @@ basepython = python3.11
 [testenv:py312]
 description = Test with Python 3.12
 basepython = python3.12
+
+[testenv:py313]
+description = Test with Python 3.13
+basepython = python3.13
 commands_pre =
     coverage erase
 commands_post =