PEP 561 py.typed marker

Author: jayqi

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ on:
 
 jobs:
   code-quality:
-    name: Code Quality
+    name: Code quality
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -29,6 +29,9 @@ jobs:
         run: |
           ruff format --check
           ruff check
+
+      - name: Type check
+        run: |
           mypy --install-types --non-interactive
 
   tests:
@@ -64,11 +67,28 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
         if: ${{ matrix.os == 'ubuntu-latest' }}
 
+  test-build-and-install:
+    name: "Test build and install"
+    needs: code-quality
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python and uv
+        uses: drivendataorg/setup-python-uv-action@v1
+        with:
+          python-version: "3.12"
+
+      - name: Install build
+        run: |
+          uv pip install build
+
       - name: Build distribution and test installation
         shell: bash
         run: |
           python -m build
-          if [[ ${{ matrix.os }} == "windows-latest" ]]; then
+          if [[ ${{ runner.os }} == "Windows" ]]; then
             PYTHON_BIN=Scripts/python
           else
             PYTHON_BIN=bin/python

example.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Tuple
+from typing import Tuple
 
 from pydantic import BaseModel
 
@@ -12,7 +12,7 @@ class MyModel(BaseModel):
 
 
 m = MyModel(
-    sorted_dict={"charlie": 2, "alpha": 3, "bravo": 1},
+    sorted_dict={"carol": 2, "alice": 3, "bob": 1},
     sorted_list=[3.0, 2.0, 1.0],
     sorted_set={(2, 9), (3, 5), (1, 3)},
 )
@@ -25,8 +25,3 @@ class MyModel(BaseModel):
 assert m == m2
 print(repr(m2))
 #> MyModel(sorted_dict=SortedDict({'alpha': 3, 'bravo': 1, 'charlie': 2}), sorted_list=SortedList([1.0, 2.0, 3.0]), sorted_set=SortedSet([(1, 3), (2, 9), (3, 5)]))
-
-if TYPE_CHECKING:
-    reveal_type(m.sorted_dict)  # noqa: F821
-    reveal_type(m.sorted_list)  # noqa: F821
-    reveal_type(m.sorted_set)  # noqa: F821

pyproject.toml

@@ -33,7 +33,7 @@ tests = ["pytest>=6"]
 "Bug Tracker" = "https://github.com/jayqi/sortedcontainers-pydantic/issues"
 
 [tool.hatch.version]
-path = "sortedcontainers_pydantic.py"
+path = "sortedcontainers_pydantic/__init__.py"
 
 ## TOOLS ##
 
@@ -54,11 +54,10 @@ known-first-party = ["sortedcontainers_pydantic"]
 force-sort-within-sections = true
 
 [tool.mypy]
-files = ["sortedcontainers_pydantic.py", "example.py"]
-ignore_missing_imports = true
+files = ["sortedcontainers_pydantic", "tests/typechecks.py", "example.py"]
 plugins = ["pydantic.mypy"]
 
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = "--cov=sortedcontainers_pydantic --cov-report=term --cov-report=html --cov-report=xml -v"
-testpaths = ["tests.py"]
+testpaths = ["tests"]

sortedcontainers_pydantic.py sortedcontainers_pydantic/__init__.py

@@ -0,0 +1,33 @@
+from typing import TYPE_CHECKING
+
+from pydantic import BaseModel
+
+from sortedcontainers_pydantic import SortedDict, SortedList, SortedSet
+
+
+class MyModel(BaseModel):
+    dct: SortedDict[str, int] = SortedDict()
+    lst: SortedList[int] = SortedList()
+    st: SortedSet[int] = SortedSet()
+
+
+if TYPE_CHECKING:
+    m = MyModel()
+
+    reveal_type(m.dct)  # noqa: F821
+    reveal_type(m.lst)  # noqa: F821
+    reveal_type(m.st)  # noqa: F821
+
+MyModel(dct={"c": 1, "a": 2, "b": 3})
+MyModel(dct=[("c", 1), ("a", 2), ("b", 3)])
+MyModel(dct=(pair for pair in [("c", 1), ("a", 2), ("b", 3)]))
+
+MyModel(lst=[3, 1, 2])
+MyModel(lst=(3, 1, 2))
+MyModel(lst={3, 1, 2})
+MyModel(lst=(i for i in [3, 1, 2]))
+
+MyModel(st=[3, 1, 2])
+MyModel(st=(3, 1, 2))
+MyModel(st={3, 1, 2})
+MyModel(st=(i for i in [3, 1, 2]))