Merge remote-tracking branch 'origin/master' into explicit-error-codes

Author: intgr

.editorconfig

@@ -0,0 +1,13 @@
+# Check http://editorconfig.org for more information
+# This is the main config file for this project:
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.{py, pyi}]
+indent_size = 4

.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/p/djangorestframework-stubs
+    permissions:
+      id-token: write
+    steps:
+      - name: Setup python to build package
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+      - name: Install build
+        run: python -m pip install build
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - name: Build package
+        run: python -m build
+      - name: Publish to PyPI
+        uses: pypa/[email protected]

.github/workflows/test.yml

@@ -6,23 +6,34 @@ on:
       - master
   pull_request:
   workflow_dispatch:
+  schedule:
+    # 15:41 UTC every day
+    - cron: "41 15 * * *"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 
 jobs:
   mypy-self-check:
     timeout-minutes: 10
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install -U pip setuptools wheel
+          pip install -U pip "setuptools<79.0.0" wheel
           SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
       - name: Run mypy on plugin code
         run: mypy --strict mypy_drf_plugin
@@ -35,47 +46,67 @@ jobs:
     timeout-minutes: 10
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Setup system dependencies
         run: |
           sudo apt-get update
           sudo apt-get install binutils libproj-dev gdal-bin
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install -U pip setuptools wheel
+          pip install -U pip "setuptools<79.0.0" wheel
           SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
 
       - name: Run tests
-        run: pytest
+        # Suppress errors from other packages due to https://github.com/typeddjango/pytest-mypy-plugins/issues/134
+        run: pytest --mypy-only-local-stub
 
   stubtest:
     timeout-minutes: 10
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.12']
+        python-version: ['3.13']
       fail-fast: false
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Setup system dependencies
         run: |
           sudo apt-get update
           sudo apt-get install binutils libproj-dev gdal-bin
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install -U pip setuptools wheel
+          pip install -U pip "setuptools<79.0.0" wheel
           SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
 
       - name: Run stubtest
         run: bash ./scripts/stubtest.sh
+
+  build-and-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-tags: true
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.13'
+      - name: Install dependencies
+        run: python3 -m pip install --upgrade build twine
+      - name: Build
+        run: |
+          python3 -m build --sdist --wheel .
+      - name: Check package metadata
+        run: |
+          twine check --strict dist/*

.pre-commit-config.yaml

@@ -1,10 +1,8 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
-default_language_version:
-  python: python3.12
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v6.0.0
     hooks:
       - id: check-yaml
       - id: trailing-whitespace
@@ -13,18 +11,15 @@ repos:
       - id: check-merge-conflict
       - id: end-of-file-fixer
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.292
+    rev: v0.13.0
     hooks:
       - id: ruff
         args: ["--fix", "--exit-non-zero-on-fix"]
-  - repo: https://github.com/psf/black
-    rev: 23.9.1
-    hooks:
-      - id: black
+      - id: ruff-format
 
 ci:
-    autofix_commit_msg: '[pre-commit.ci] auto fixes from pre-commit.com hooks'
-    autofix_prs: true
-    autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
-    autoupdate_schedule: weekly
-    submodules: false
+  autofix_commit_msg: "[pre-commit.ci] auto fixes from pre-commit.com hooks"
+  autofix_prs: true
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
+  autoupdate_schedule: weekly
+  submodules: false

CONTRIBUTING.md

@@ -79,14 +79,13 @@ pytest
 Run `bash ./scripts/stubtest.sh` to test that stubs and sources are in-line.
 
 We have two special files to allow errors:
+
 1. `scripts/stubtest/allowlist.txt` where we store things that we really don't care about: hacks, DRF internal utility modules, things that are handled by our plugin, things that are not representable by type system, etc
 2. `scripts/stubtest/allowlist_todo.txt` where we store all errors there are right now. Basically, this is a TODO list: we need to work through this list and fix things (or move entries to real `allowlist.txt`). In the end, ideally we can remove this file
 
 You might also want to disable `incremental` mode while working on `stubtest` changes.
 This mode leads to several known problems (stubs do not show up or have strange errors).
 
-**Important**: right now we only run `stubtest` on Python 3.12 (because it is the latest released version at the moment), any other versions might generate different outputs. Any work to create per-version allowlists is welcome.
-
 ## Submission Guidelines
 
 The workflow for contributions is fairly simple:
@@ -96,3 +95,30 @@ The workflow for contributions is fairly simple:
 3. make whatever changes you want to contribute.
 4. ensure your contribution does not introduce linting issues or breaks the tests by linting and testing the code.
 5. make a pull request with an adequate description.
+
+## Releasing `djangorestframework-stubs`
+
+1. Open a pull request that updates `setup.py` (anyone can open this PR, not just maintainers):
+
+   - Increase `version=` value within `setup(...)`. Version number `major.minor.patch` is formed as follows:
+
+     `major.minor` version must match newest supported `djangorestframework` release.
+
+     `patch` is sequentially increasing for each stubs release. Reset to `0` if `major.minor` was updated.
+
+   - Update `django-stubs>=` dependency to point to latest `django-stubs` release.
+   - Use pull request title "Version x.y.z release" by convention.
+
+2. Ensure the CI succeeds. A maintainer must merge this PR. If it's just a verison bump, no need
+   to wait for a second maintainer's approval.
+
+3. Maintainers need to [сreate a new GitHub release](https://github.com/typeddjango/djangorestframework-stubs/releases/new):
+
+   - Under "Choose a tag" enter the new version number. Do NOT use `v` prefix.
+   - Click "Generate release notes".
+   - Delete all release notes lines containing `by @pre-commit-ci` or `by @dependabot`, as these
+     are irrelevant for our users.
+
+4. Once you feel brave enough, click "Publish release".
+
+5. Check that the [release workflow](https://github.com/typeddjango/djangorestframework-stubs/actions/workflows/release.yml) succeeds.

README.md

@@ -1,14 +1,15 @@
-<img src="http://mypy-lang.org/static/mypy_light.svg" alt="mypy logo" width="300px"/>
+<img src="https://mypy-lang.org/static/mypy_light.svg" alt="mypy logo" width="300px"/>
 
 # pep484 stubs for Django REST framework
 
-[![Build Status](https://travis-ci.com/typeddjango/djangorestframework-stubs.svg?branch=master)](https://travis-ci.com/typeddjango/djangorestframework-stubs)
-[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
+[![test](https://github.com/typeddjango/djangorestframework-stubs/actions/workflows/test.yml/badge.svg?branch=master&event=push)](https://github.com/typeddjango/djangorestframework-stubs/actions/workflows/test.yml)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 [![Gitter](https://badges.gitter.im/mypy-django/Lobby.svg)](https://gitter.im/mypy-django/Lobby)
+[![StackOverflow](https://shields.io/badge/ask-stackoverflow-orange?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/django-stubs?tab=Active)
 
 
 Mypy stubs for [Django REST Framework](https://pypi.org/project/djangorestframework/).
-Supports Python 3.8 and up.
+Supports Python 3.10 and up.
 
 ## Installation
 
@@ -39,7 +40,7 @@ class MyModelSerializer(serializers.ModelSerializer[MyModel]):
         fields = ("id", "example")
 ```
 
-Which means that methods where the model is being passed around will know the actual type of the model instead of being `Any`. The `instance` attribute on the above serializer will be `Union[MyModel, typing.Sequence[MyModel], None]`.
+Which means that methods where the model is being passed around will know the actual type of the model instead of being `Any`. The `instance` attribute on the above serializer will be `MyModel | typing.Sequence[MyModel] | None`.
 
 ## To get help
 

mypy.ini

@@ -1,7 +1,6 @@
 [mypy]
 allow_redefinition = true
 check_untyped_defs = true
-ignore_missing_imports = true
 incremental = true
 strict_optional = true
 show_traceback = true
@@ -13,34 +12,10 @@ disallow_untyped_defs = true
 disallow_incomplete_defs = true
 disable_error_code = empty-body
 enable_error_code = ignore-without-code
-# TODO: update our test error messages to match new mypy output
-force_uppercase_builtins = true
-force_union_syntax = true
 
 plugins =
     mypy_django_plugin.main,
     mypy_drf_plugin.main
 
 [mypy.plugins.django-stubs]
 django_settings_module = scripts.drf_tests_settings
-
-# Suppress errors from site-packages due to https://github.com/typeddjango/pytest-mypy-plugins/issues/134
-[mypy-uritemplate.*]
-warn_unreachable = false
-disable_error_code = ignore-without-code
-
-[mypy-yaml.*]
-disallow_untyped_defs = false
-disallow_incomplete_defs = false
-
-[mypy-urllib3.*]
-disallow_untyped_defs = false
-disallow_incomplete_defs = false
-
-[mypy-requests.*]
-disallow_untyped_defs = false
-disallow_incomplete_defs = false
-
-[mypy-markdown.*]
-disallow_untyped_defs = false
-disallow_incomplete_defs = false

mypy_drf_plugin/lib/helpers.py

@@ -1,7 +1,7 @@
-from typing import Any, Dict
+from typing import Any
 
 from mypy.nodes import TypeInfo
 
 
-def get_drf_metadata(info: TypeInfo) -> Dict[str, Any]:
+def get_drf_metadata(info: TypeInfo) -> dict[str, Any]:
     return info.metadata.setdefault("drf", {})

mypy_drf_plugin/main.py

@@ -1,4 +1,4 @@
-from typing import Callable, Dict, Optional, Type
+from collections.abc import Callable
 
 from mypy.nodes import TypeInfo
 from mypy.plugin import ClassDefContext, Plugin
@@ -16,21 +16,21 @@ def transform_serializer_class(ctx: ClassDefContext) -> None:
 
 
 class NewSemanalDRFPlugin(Plugin):
-    def _get_currently_defined_serializers(self) -> Dict[str, int]:
+    def _get_currently_defined_serializers(self) -> dict[str, int]:
         base_serializer_sym = self.lookup_fully_qualified(fullnames.BASE_SERIALIZER_FULLNAME)
         if base_serializer_sym is not None and isinstance(base_serializer_sym.node, TypeInfo):
-            serializer_bases: Dict[str, int] = base_serializer_sym.node.metadata.setdefault("drf", {}).setdefault(
+            serializer_bases: dict[str, int] = base_serializer_sym.node.metadata.setdefault("drf", {}).setdefault(
                 "serializer_bases", {fullnames.BASE_SERIALIZER_FULLNAME: 1}
             )
             return serializer_bases
         else:
             return {}
 
-    def get_base_class_hook(self, fullname: str) -> Optional[Callable[[ClassDefContext], None]]:
+    def get_base_class_hook(self, fullname: str) -> Callable[[ClassDefContext], None] | None:
         if fullname in self._get_currently_defined_serializers():
             return transform_serializer_class
         return None
 
 
-def plugin(version: str) -> Type[NewSemanalDRFPlugin]:
+def plugin(version: str) -> type[NewSemanalDRFPlugin]:
     return NewSemanalDRFPlugin