Merge pull request #82 from questionlp/develop

Migrate from black to ruff, fix location join, add postal abbreviations retrieval function, format code

.vscode/settings.json

@@ -11,6 +11,5 @@
             "source.fixAll": "explicit",
             "source.sortImports": "explicit",
         },
-        "editor.defaultFormatter": "ms-python.black-formatter"
     }
 }

CHANGES.rst

@@ -2,6 +2,22 @@
 Changes
 *******
 
+2.15.0
+======
+
+Application Changes
+-------------------
+
+* Change SQL joins from ``JOIN`` to ``LEFT JOIN`` in :py:class:`wwdtm.location.Location` to properly handle ``NULL`` values in the ``state`` column
+* Add :py:meth:`wwdtm.location.Location.retrieve_postal_abbreviations` that returns postal abbreviations and their corresponding names and countries
+
+Development Changes
+-------------------
+
+* Upgrade ruff from 0.7.0 to 0.9.3
+* Remove black from required development packages as part of migrating entirely to Ruff
+* Ran ```ruff format``` to format Python code files using the Ruff 2025 Style Guide
+
 2.14.0
 ======
 

pyproject.toml

@@ -41,11 +41,6 @@ version = {attr = "wwdtm.VERSION"}
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
 
-[tool.black]
-required-version = "24.10.0"
-target-version = ["py310", "py311", "py312", "py313"]
-line-length = 88
-
 [tool.pytest.ini_options]
 minversion = "8.3"
 filterwarnings = [
@@ -60,6 +55,7 @@ norecursedirs = [
 ]
 
 [tool.ruff]
+required-version = ">= 0.9.0"
 target-version = "py310"
 
 exclude = [
@@ -73,7 +69,7 @@ exclude = [
     ".venv",
 ]
 
-line-length = 88 # Must agree with Black
+line-length = 88
 
 [tool.ruff.lint]
 ignore = [
@@ -93,6 +89,7 @@ ignore = [
     "F401",
     "TRY003", # Avoid specifying messages outside exception class; overly strict, especially for ValueError
     "S608",
+    "ISC001",
 ]
 
 select = [

requirements-dev.txt

@@ -1,5 +1,4 @@
-ruff==0.7.0
-black==24.10.0
+ruff==0.9.3
 pytest==8.3.3
 pytest-cov==5.0.0
 wheel==0.44.0

setup.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Deprecated: Package setup file."""
+
 from setuptools import setup
 
 setup()

tests/guest/test_guest_appearances.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.guest.GuestAppearances`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/guest/test_guest_guest.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.guest.Guest`."""
+
 import json
 from pathlib import Path
 from typing import Any
@@ -43,9 +44,9 @@ def test_guest_retrieve_all_details():
 
     assert guests, "No guests could be retrieved"
     assert "id" in guests[0], "'id' was not returned for first list item"
-    assert (
-        "appearances" in guests[0]
-    ), "'appearances' was not returned for the first list item"
+    assert "appearances" in guests[0], (
+        "'appearances' was not returned for the first list item"
+    )
 
 
 def test_guest_retrieve_all_ids():
@@ -116,6 +117,6 @@ def test_guest_guest_retrieve_details_by_slug(guest_slug: str):
 
     assert info, f"Guest slug {guest_slug} not found"
     assert "name" in info, f"'name' was not returned for slug {guest_slug}"
-    assert (
-        "appearances" in info
-    ), f"'appearances' was not returned for slug {guest_slug}"
+    assert "appearances" in info, (
+        f"'appearances' was not returned for slug {guest_slug}"
+    )

tests/guest/test_guest_utility.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wdtm.guest.GuestUtility`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/host/test_host_appearances.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.host.HostAppearances`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/host/test_host_host.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.host.Host`."""
+
 import json
 from pathlib import Path
 from typing import Any
@@ -49,9 +50,9 @@ def test_host_retrieve_all_details():
     assert "name" in hosts[0], "'name' was not returned for the first list item"
     assert "slug" in hosts[0], "'slug' was not returned for the first list item"
     assert "pronouns" in hosts[0], "'pronouns' was not returned for the first list item"
-    assert (
-        "appearances" in hosts[0]
-    ), "'appearances' was not returned for thefirst list item"
+    assert "appearances" in hosts[0], (
+        "'appearances' was not returned for thefirst list item"
+    )
 
 
 def test_host_retrieve_all_ids():

tests/host/test_host_utility.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.host.HostUtility`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/location/test_location_location.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.location.Location`."""
+
 import json
 from pathlib import Path
 from typing import Any
@@ -86,7 +87,7 @@ def test_location_retrieve_all_slugs():
     assert slugs, "No location slug strings could be retrieved"
 
 
-@pytest.mark.parametrize("location_id", [95])
+@pytest.mark.parametrize("location_id", [95, 148])
 def test_location_retrieve_by_id(location_id: int):
     """Testing for :py:meth:`wwdtm.location.Location.retrieve_by_id`.
 
@@ -108,7 +109,7 @@ def test_location_retrieve_by_id(location_id: int):
         ), f"'longitude' was not returned for ID {location_id}"
 
 
-@pytest.mark.parametrize("location_id", [95])
+@pytest.mark.parametrize("location_id", [95, 148])
 def test_location_retrieve_details_by_id(location_id: int):
     """Testing for :py:meth:`wwdtm.location.location.retrieve_details_by_id`.
 
@@ -179,3 +180,15 @@ def test_location_retrieve_details_by_slug(location_slug: str):
     assert (
         "recordings" in info
     ), f"'recordings' was not returned for slug {location_slug}"
+
+
+def test_location_retrieve_postal_abbreviations():
+    """Testing for :py:meth:`wwdtm.location.Location.retrieve_postal_abbreviations`."""
+    location = Location(connect_dict=get_connect_dict())
+    abbreviations = location.retrieve_postal_abbreviations()
+
+    assert abbreviations, "Postal abbreviations not returned"
+    assert "OR" in abbreviations, "Postal abbreviation 'OR' not found"
+    assert (
+        "name" in abbreviations["OR"]
+    ), "Postal abbreviation 'OR' does not contain a valid name"

tests/location/test_location_recordings.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.location.LocationRecordings`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/location/test_location_utility.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.location.LocationUtility`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/panelist/test_panelist_appearances.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.panelist.PanelistAppearances`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/panelist/test_panelist_decimal_scores.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.panelist.PanelistDecimalScores`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/panelist/test_panelist_panelist.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.panelist.Panelist`."""
+
 import json
 from pathlib import Path
 from typing import Any
@@ -36,9 +37,9 @@ def test_panelist_retrieve_all():
     assert "id" in panelists[0], "'id' was not returned for the first list item"
     assert "name" in panelists[0], "'name' was not returned for the first list item"
     assert "slug" in panelists[0], "'slug' was not returned for the first list item"
-    assert (
-        "pronouns" in panelists[0]
-    ), "'pronouns' was not returned for the first list item"
+    assert "pronouns" in panelists[0], (
+        "'pronouns' was not returned for the first list item"
+    )
 
 
 @pytest.mark.parametrize("use_decimal_scores", [True, False])
@@ -55,12 +56,12 @@ def test_panelist_retrieve_all_details(use_decimal_scores: bool):
     assert "id" in panelists[0], "'id' was not returned for first list item"
     assert "name" in panelists[0], "'name' was not returned for the first list item"
     assert "slug" in panelists[0], "'slug' was not returned for the first list item"
-    assert (
-        "pronouns" in panelists[0]
-    ), "'pronouns' was not returned for the first list item"
-    assert (
-        "appearances" in panelists[0]
-    ), "'appearances' was not returned for the first list item"
+    assert "pronouns" in panelists[0], (
+        "'pronouns' was not returned for the first list item"
+    )
+    assert "appearances" in panelists[0], (
+        "'appearances' was not returned for the first list item"
+    )
 
 
 def test_panelist_retrieve_all_ids():
@@ -154,6 +155,6 @@ def test_panelist_retrieve_details_by_slug(
     assert "name" in info, f"'name' was not returned for slug {panelist_slug}"
     assert "slug" in info, f"'slug' was not returned for ID {panelist_slug}"
     assert "pronouns" in info, f"'pronouns' was not returned for ID {panelist_slug}"
-    assert (
-        "appearances" in info
-    ), f"'appearances' was not returned for slug {panelist_slug}"
+    assert "appearances" in info, (
+        f"'appearances' was not returned for slug {panelist_slug}"
+    )

tests/panelist/test_panelist_scores.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.panelist.PanelistScores`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/panelist/test_panelist_statistics.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.panelist.PanelistStatistics`."""
+
 import json
 from pathlib import Path
 from typing import Any
@@ -101,9 +102,9 @@ def test_panelist_statistics_retrieve_statistics_by_id(
 
     assert "scoring" in stats, f"'scoring' was not returned for ID {panelist_id}"
     if include_decimal_scores:
-        assert (
-            "scoring_decimal" in stats
-        ), f"'scoring' was not returned for ID {panelist_id}"
+        assert "scoring_decimal" in stats, (
+            f"'scoring' was not returned for ID {panelist_id}"
+        )
     assert "ranking" in stats, f"'ranking' was not returned for ID {panelist_id}"
 
 
@@ -128,7 +129,7 @@ def test_panelist_statistics_retrieve_statistics_by_slug(
 
     assert "scoring" in stats, f"'scoring' was not returned for slug {panelist_slug}"
     if include_decimal_scores:
-        assert (
-            "scoring_decimal" in stats
-        ), f"'scoring' was not returned for ID {panelist_slug}"
+        assert "scoring_decimal" in stats, (
+            f"'scoring' was not returned for ID {panelist_slug}"
+        )
     assert "ranking" in stats, f"'ranking' was not returned for slug {panelist_slug}"

tests/panelist/test_panelist_utility.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.panelist.PanelistUtility`."""
+
 import json
 from pathlib import Path
 from typing import Any

tests/pronoun/test_pronoun_pronouns.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.pronoun.Pronouns`."""
+
 import json
 from pathlib import Path
 from typing import Any
@@ -34,9 +35,9 @@ def test_pronouns_retrieve_all():
 
     assert all_pronouns, "No pronouns could be retrieved"
     assert "id" in all_pronouns[0], "'id' was not returned for the first list item"
-    assert (
-        "pronouns" in all_pronouns[0]
-    ), "'pronouns' was not returned for the first list item"
+    assert "pronouns" in all_pronouns[0], (
+        "'pronouns' was not returned for the first list item"
+    )
 
 
 def test_pronouns_retrieve_all_ids():

tests/scorekeeper/test_scorekeeper_appearances.py

@@ -4,6 +4,7 @@
 #
 # vim: set noai syntax=python ts=4 sw=4:
 """Testing for object: :py:class:`wwdtm.scorekeeper.ScorekeeperAppearances`."""
+
 import json
 from pathlib import Path
 from typing import Any
@@ -51,9 +52,9 @@ def test_scorekeeper_appearance_retrieve_appearances_by_slug(scorekeeper_slug: s
     appearances = ScorekeeperAppearances(connect_dict=get_connect_dict())
     appearance = appearances.retrieve_appearances_by_slug(scorekeeper_slug)
 
-    assert (
-        "count" in appearance
-    ), f"'count' was not returned for slug {scorekeeper_slug}"
-    assert (
-        "shows" in appearance
-    ), f"'shows' was not returned for slug {scorekeeper_slug}"
+    assert "count" in appearance, (
+        f"'count' was not returned for slug {scorekeeper_slug}"
+    )
+    assert "shows" in appearance, (
+        f"'shows' was not returned for slug {scorekeeper_slug}"
+    )