Merge branch 'main' into develop

Author: MarTrepodi

.github/workflows/commitlint.yml

@@ -27,7 +27,7 @@ jobs:
             "rules": {
               "type-enum": [2, "always", [
                 "feat", "fix", "refactor", "build", "deps", "bug",
-                "chore", "docs", "test", "style", "ci", "perf"
+                "chore", "docs", "test", "tests", "style", "ci", "perf"
               ]],
               "scope-enum": [1, "always", [
                 "core", "helpers", "deps", "release", "ci",

.github/workflows/labeler.yml

@@ -1,7 +1,7 @@
 name: Auto Label PR
 
 on:
-  pull_request:
+  pull_request_target:
     types: [opened, synchronize]
 
 permissions:
@@ -13,6 +13,7 @@ jobs:
     name: Auto Label
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v6
       - uses: actions/labeler@v6
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}

pyproject.toml

@@ -23,6 +23,7 @@ classifiers = [
 ]
 dependencies = [
     "httpx>=0.28",
+    "typing-extensions>=4.15.0",
 ]
 
 [project.scripts]

src/swgoh_comlink/_base.py

@@ -15,6 +15,8 @@
 from typing import Any
 from urllib.parse import urlparse, urlunparse
 
+from typing_extensions import Self
+
 from .exceptions import SwgohComlinkValueError
 from .helpers import Constants
 
@@ -92,11 +94,11 @@ def __repr__(self) -> str:
             f"secret_key={self._mask(self.secret_key)!r})"
         )
 
-    def __new__(cls, *args: Any, **kwargs: Any) -> SwgohComlinkBase:
+    def __new__(cls, *args: Any, **kwargs: Any) -> Self:
         """Prevent instances of this base class from being created directly."""
         if cls is SwgohComlinkBase:
             raise TypeError(f"Only subclasses of '{cls.__name__}' may be instantiated.")
-        return object.__new__(cls)
+        return super().__new__(cls)
 
     def __init__(
         self,

tests/integration/test_async_client.py

@@ -3,7 +3,6 @@
 import pytest
 
 from swgoh_comlink import SwgohComlinkAsync
-from swgoh_comlink.helpers import DataItems
 
 from .conftest import COMLINK_URL, TEST_ALLYCODE
 
@@ -71,8 +70,8 @@ async def test_get_guilds_by_name(async_comlink):
 
 
 async def test_get_game_data_filtered(async_comlink):
-    """POST /data with DataItems filter returns game data subset."""
-    result = await async_comlink.get_game_data(items=DataItems.SEGMENT1)
+    """POST /data with request_segment=1 returns a non-empty game data subset."""
+    result = await async_comlink.get_game_data(request_segment=1)
     assert isinstance(result, dict)
     assert len(result) > 0
 

tests/integration/test_sync_client.py

@@ -3,7 +3,6 @@
 import pytest
 
 from swgoh_comlink import SwgohComlink
-from swgoh_comlink.helpers import DataItems
 
 from .conftest import COMLINK_URL, TEST_ALLYCODE
 
@@ -71,8 +70,8 @@ def test_get_guilds_by_name(comlink):
 
 
 def test_get_game_data_filtered(comlink):
-    """POST /data with DataItems filter returns game data subset."""
-    result = comlink.get_game_data(items=DataItems.SEGMENT1)
+    """POST /data with request_segment=1 returns a non-empty game data subset."""
+    result = comlink.get_game_data(request_segment=1)
     assert isinstance(result, dict)
     assert len(result) > 0
 

tests/test_base_client.py

@@ -0,0 +1,28 @@
+from typing import get_type_hints
+
+import pytest
+from typing_extensions import Self
+
+from swgoh_comlink import SwgohComlink
+from swgoh_comlink._base import SwgohComlinkBase
+
+
+def test_base_class_new_typing():
+    """Test that SwgohComlinkBase __new__ returns correct type."""
+    type_hints = get_type_hints(obj=SwgohComlinkBase.__new__)
+    assert type_hints.get("return") == Self
+
+
+def test_base_class_instantiation():
+    """Test that SwgohComlinkBase prevents direct instantiation."""
+    with pytest.raises(TypeError, match="Only subclasses of 'SwgohComlinkBase' may be instantiated"):
+        SwgohComlinkBase()
+
+    class ChildSwgohClient(SwgohComlinkBase):
+        pass
+
+    child_instance = ChildSwgohClient()
+    assert isinstance(child_instance, ChildSwgohClient)
+
+    client = SwgohComlink()
+    assert isinstance(client, SwgohComlink)

tests/unit/test_base.py

@@ -5,13 +5,21 @@
 import hashlib
 import logging
 from json import dumps
+from typing import TYPE_CHECKING
 
 import pytest
 
 from swgoh_comlink import SwgohComlink
 from swgoh_comlink._base import _SENSITIVE_KEYS, SwgohComlinkBase, param_alias, sanitize_url
 from swgoh_comlink.exceptions import SwgohComlinkValueError
 
+if TYPE_CHECKING:
+    # `typing.assert_type` is 3.11+; `typing_extensions` works on every
+    # supported Python version and is already in the dev dependency closure.
+    from typing_extensions import assert_type
+
+    from swgoh_comlink import SwgohComlinkAsync
+
 # ── sanitize_url ─────────────────────────────────────────────────────────
 
 
@@ -79,6 +87,30 @@ def test_cannot_instantiate_base_directly(self):
             SwgohComlinkBase()
 
 
+# ── Constructor type inference (PR #98 regression guard) ─────────────────
+#
+# `SwgohComlinkBase.__new__` must return `Self` so that subclass constructor
+# calls infer as the concrete subclass, not the base. Without this, type
+# checkers reject subclass-only attribute access such as
+# `SwgohComlink(...).get_player(...)`.
+#
+# The function below is intentionally never invoked at runtime — it lives
+# under `if TYPE_CHECKING:` so the static type checker (mypy / ty) validates
+# the `assert_type` calls without spinning up real httpx clients.
+
+if TYPE_CHECKING:
+
+    def _typecheck_constructor_returns_concrete_subclass() -> None:
+        sync_client = SwgohComlink()
+        assert_type(sync_client, SwgohComlink)
+        # Subclass-only attribute access — must resolve without error.
+        _ = sync_client.get_player
+
+        async_client = SwgohComlinkAsync()
+        assert_type(async_client, SwgohComlinkAsync)
+        _ = async_client.get_player
+
+
 # ── Constructor ──────────────────────────────────────────────────────────