Switch to pyproject.toml + PEP621 (typeddjango#2688)

UnknownPlatypus · jose-reveni · commit 7638eccfe787 · 2025-06-09T10:42:06.000+02:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -30,8 +30,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install -U pip "setuptools<79.0.0" wheel
-          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
+          pip install -U pip
+          pip install -r ./requirements.txt
 
       - name: Run mypy on plugin code
         run: mypy --strict mypy_django_plugin
@@ -63,8 +63,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install -U pip "setuptools<79.0.0" wheel
-          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
+          pip install -U pip
+          pip install -r ./requirements.txt
 
       # Must match `shard` definition in the test matrix:
       - name: Run pytest tests
@@ -91,8 +91,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install -U pip "setuptools<79.0.0" wheel
-          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
+          pip install -U pip
+          pip install -r ./requirements.txt
 
       - name: Run stubtest
         run: ./scripts/stubtest.sh
@@ -112,8 +112,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install -U pip "setuptools<79.0.0" wheel
-          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
+          pip install -U pip
+          pip install -r ./requirements.txt
       - name: Run pyright on the stubs
         uses: jakebailey/pyright-action@v2
         with:
@@ -146,8 +146,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install -U pip "setuptools<79.0.0" wheel
-          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
+          pip install -U pip
+          pip install -r ./requirements.txt
           pip install "Django==${{ matrix.django-version }}"
           pip check
 
@@ -167,8 +167,8 @@ jobs:
         run: python3 -m pip install --upgrade build twine
       - name: Build
         run: |
-          python3 -m build --sdist --wheel .
-          python3 -m build --sdist --wheel ext/
+          python3 -m build .
+          python3 -m build ext/
       - name: Check package metadata
         run: |
           twine check --strict dist/*
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ pip-wheel-metadata/
 stubgen/
 build/
 dist/
+ext/dist/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -44,7 +44,7 @@ source .venv/bin/activate
 Then install the dev requirements:
 
 ```bash
-SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
+pip install -r ./requirements.txt
 ```
 
 Finally, install the pre-commit hooks:
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ We rely on different `django` and `mypy` versions:
 
 | django-stubs   | Mypy version | Django version | Django partial support | Python version |
 |----------------|--------------|----------------|------------------------|----------------|
-| 5.2.0          | 1.13+        | 5.2            | 5.1                    | 3.10 - 3.13    |
+| 5.2.0          | 1.13+        | 5.2            | 5.1, 5.0               | 3.10 - 3.13    |
 | 5.1.3          | 1.13+        | 5.1            | 4.2                    | 3.9 - 3.13     |
 | 5.1.2          | 1.13+        | 5.1            | 4.2                    | 3.9 - 3.13     |
 | 5.1.1          | 1.13.x       | 5.1            | 4.2                    | 3.8 - 3.12     |
diff --git a/ext/pyproject.toml b/ext/pyproject.toml
@@ -0,0 +1,47 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+[project]
+name = "django-stubs-ext"
+# NB! For clarity, keep version major.minor.patch in sync with django-stubs.
+# It's fine to skip django-stubs-ext releases, but when doing a release, update this to newest django-stubs version.
+version = "5.2.0"
+description = "Monkey-patching and extensions for django-stubs"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE.md"]
+maintainers = [
+  { name = "Marti Raudsepp", email = "marti@juffo.org" },
+  { name = "Nikita Sobolev", email = "mail@sobolevn.me" },
+  { name = "Petter Friberg", email = "petter_friberg@hotmail.com" },
+  { name = "Adam Johnson", email = "me@adamj.eu" },
+]
+authors = [
+  { name = "Simula Proxy" },
+]
+requires-python = ">=3.10"
+classifiers = [
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+  "Framework :: Django",
+  "Framework :: Django :: 5.0",
+  "Framework :: Django :: 5.1",
+  "Framework :: Django :: 5.2",
+]
+dependencies = [
+  "django",
+  "typing-extensions",
+]
+
+[project.urls]
+Homepage = "https://github.com/typeddjango/django-stubs"
+Funding = "https://github.com/sponsors/typeddjango"
+"Release notes" = "https://github.com/typeddjango/django-stubs/releases"
+
+[tool.hatch.build]
+packages = ["django_stubs_ext"]
diff --git a/ext/setup.py b/ext/setup.py
diff --git a/mypy.ini b/mypy.ini
@@ -35,9 +35,6 @@ plugins =
 disallow_untyped_defs = false
 disallow_incomplete_defs = false
 
-[mypy-cryptography.*]
-ignore_errors = true
-
 # Our settings:
 [mypy.plugins.django-stubs]
 django_settings_module = scripts.django_tests_settings
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,3 +1,59 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "django-stubs"
+version = "5.2.0"
+description = "Mypy stubs for Django"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE.md"]
+requires-python = ">=3.10"
+authors = [
+  { name = "Maksim Kurnikov", email = "maxim.kurnikov@gmail.com" },
+]
+maintainers = [
+  { name = "Marti Raudsepp", email = "marti@juffo.org" },
+  { name = "Nikita Sobolev", email = "mail@sobolevn.me" },
+  { name = "Petter Friberg", email = "petter_friberg@hotmail.com" },
+  { name = "Adam Johnson", email = "me@adamj.eu" },
+]
+classifiers = [
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+  "Framework :: Django",
+  "Framework :: Django :: 5.0",
+  "Framework :: Django :: 5.1",
+  "Framework :: Django :: 5.2",
+]
+dependencies = [
+  "django",
+  "django-stubs-ext>=5.2.0",
+  "tomli; python_version < '3.11'",
+  # Types:
+  "types-pyyaml",
+  "typing-extensions>=4.11.0",
+]
+
+[project.optional-dependencies]
+compatible-mypy = ["mypy>=1.13,<1.16"]
+oracle = ["oracledb"]
+redis = ["redis", "types-redis"]
+
+[project.urls]
+Homepage = "https://github.com/typeddjango/django-stubs"
+Funding = "https://github.com/sponsors/typeddjango"
+"Release notes" = "https://github.com/typeddjango/django-stubs/releases"
+
+[tool.hatch.build]
+packages = ["django-stubs", "mypy_django_plugin"]
+
+
 [tool.codespell]
 ignore-words-list = "aadd,acount,nam,asend"
 
@@ -9,35 +65,35 @@ target-version = "py310"
 [tool.ruff.lint]
 # See Rules in Ruff documentation: https://beta.ruff.rs/docs/rules/
 select = [
-    "B",        # bugbear
-    "E",        # pycodestyle
-    "F",        # pyflakes
-    "INP",      # flake8-tidy-imports
-    "W",        # pycodestyle
-    "I",        # isort
-    "UP",       # pyupgrade
-    "TID251",   # Disallowed imports (flake8-tidy-imports.banned-api)
-    "PYI",      # flake8-pyi
-    "RUF100",   # Equivalent to flake8-noqa NQA103
-    "PGH004",   # Equivalent to flake8-noqa NQA104
-    "PGH003",   # Disallowed blanket `type: ignore` annotations.
+  "B",        # bugbear
+  "E",        # pycodestyle
+  "F",        # pyflakes
+  "INP",      # flake8-tidy-imports
+  "W",        # pycodestyle
+  "I",        # isort
+  "UP",       # pyupgrade
+  "TID251",   # Disallowed imports (flake8-tidy-imports.banned-api)
+  "PYI",      # flake8-pyi
+  "RUF100",   # Equivalent to flake8-noqa NQA103
+  "PGH004",   # Equivalent to flake8-noqa NQA104
+  "PGH003",   # Disallowed blanket `type: ignore` annotations.
 ]
 ignore = [
-    "PYI021", # We have a few meaningful docstrings for stubs only constructs/utilities.
-    "PYI041", # This might not be obvious that `float | int` is mostly equivalent to `float` typing wise | int | str
-    "PYI043",
+  "PYI021", # We have a few meaningful docstrings for stubs only constructs/utilities.
+  "PYI041", # This might not be obvious that `float | int` is mostly equivalent to `float` typing wise | int | str
+  "PYI043",
 ]
 
 [tool.ruff.lint.per-file-ignores]
 "*.pyi" = [
-    "B",
-    "E501",
-    "E741",
-    "E743",
-    "F403", # Use wildcard import
-    "F405",
-    "F822",
-    "F821",
+  "B",
+  "E501",
+  "E741",
+  "E743",
+  "F403", # Use wildcard import
+  "F405",
+  "F822",
+  "F821",
 ]
 "tests/*.py" = ["INP001", "PGH003"]
 "ext/tests/*.py" = ["INP001"]
@@ -50,6 +106,3 @@ ignore = [
 [tool.ruff.lint.isort]
 known-first-party = ["django_stubs_ext", "mypy_django_plugin"]
 split-on-trailing-comma = false
-
-[build-system]
-requires = ["setuptools<79.0.0", "wheel"]
diff --git a/setup.py b/setup.py
