Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Future annotations #440

Merged
merged 5 commits into from
Jan 4, 2025
Merged

Future annotations #440

merged 5 commits into from
Jan 4, 2025

Conversation

tony
Copy link
Owner

@tony tony commented Jan 4, 2025 •
edited
Loading

Changes

chore: Support PEP 563 from __future__ import annotations

Using PEP 563's deferred resolution of annotations avoids the computation cost of symbols we imported solely used for type-checking.

Ruff:

PEP 563: https://peps.python.org/pep-0563/

@codecov Codecov
Copy link

codecov bot commented Jan 4, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 97.36842% with 1 line in your changes missing coverage. Please review.

Project coverage is 73.89%. Comparing base (11446bb) to head (c4fa39f).
Report is 6 commits behind head on master.

Files with missing lines Patch % Lines
src/django_docutils/lib/transforms/code.py 66.66% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #440      +/-   ##
==========================================
+ Coverage   73.79%   73.89%   +0.09%     
==========================================
  Files          43       43              
  Lines        1145     1084      -61     
==========================================
- Hits          845      801      -44     
+ Misses        300      283      -17

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tony tony force-pushed the future-annotations branch from 39f829c to 255ab1d Compare January 4, 2025 12:39
tony added 3 commits January 4, 2025 07:53
@tony
pyproject(tool.coverage.report) Refine exclusions
c71cd75
@tony
chore(ruff) Automated fixes for typing annotations
acb76ca 
Fixed 215 errors:
- docs/conf.py:
     2 × UP007 (non-pep604-annotation)
     2 × UP037 (quoted-annotation)
     1 × I002 (missing-required-import)
     1 × I001 (unsorted-imports)
- src/django_docutils/__about__.py:
     1 × I002 (missing-required-import)
- src/django_docutils/_internal/types.py:
     2 × UP037 (quoted-annotation)
     1 × I002 (missing-required-import)
- src/django_docutils/exc.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/directives/code.py:
     1 × TC003 (typing-only-standard-library-import)
     1 × I002 (missing-required-import)
     1 × UP037 (quoted-annotation)
     1 × I001 (unsorted-imports)
- src/django_docutils/lib/directives/registry.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/metadata/extract.py:
     2 × UP007 (non-pep604-annotation)
     1 × F401 (unused-import)
     1 × I002 (missing-required-import)
     1 × I001 (unsorted-imports)
- src/django_docutils/lib/metadata/process.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/metadata/processors.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/metadata/tests/test_extract.py:
     1 × I001 (unsorted-imports)
     1 × TC003 (typing-only-standard-library-import)
     1 × I002 (missing-required-import)
- src/django_docutils/lib/metadata/tests/test_process.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/publisher.py:
    11 × UP007 (non-pep604-annotation)
     2 × UP037 (quoted-annotation)
     1 × I002 (missing-required-import)
     1 × TC002 (typing-only-third-party-import)
     1 × I001 (unsorted-imports)
- src/django_docutils/lib/roles/common.py:
     3 × UP037 (quoted-annotation)
     2 × UP007 (non-pep604-annotation)
     1 × I002 (missing-required-import)
- src/django_docutils/lib/roles/email.py:
     2 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     1 × TC001 (typing-only-first-party-import)
     1 × I002 (missing-required-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/lib/roles/file.py:
     6 × UP007 (non-pep604-annotation)
     1 × TC002 (typing-only-third-party-import)
     1 × I002 (missing-required-import)
- src/django_docutils/lib/roles/github.py:
     2 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     1 × I002 (missing-required-import)
     1 × TC001 (typing-only-first-party-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/lib/roles/hackernews.py:
     2 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     1 × I002 (missing-required-import)
     1 × TC001 (typing-only-first-party-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/lib/roles/kbd.py:
     2 × UP007 (non-pep604-annotation)
     1 × TC002 (typing-only-third-party-import)
     1 × I002 (missing-required-import)
- src/django_docutils/lib/roles/leanpub.py:
     2 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     1 × I002 (missing-required-import)
     1 × TC001 (typing-only-first-party-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/lib/roles/pypi.py:
     2 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     1 × I002 (missing-required-import)
     1 × TC001 (typing-only-first-party-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/lib/roles/readthedocs.py:
     2 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     1 × TC001 (typing-only-first-party-import)
     1 × I002 (missing-required-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/lib/roles/registry.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/roles/twitter.py:
     2 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     1 × I002 (missing-required-import)
     1 × TC001 (typing-only-first-party-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/lib/roles/types.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/roles/url.py:
     2 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     1 × I002 (missing-required-import)
     1 × TC001 (typing-only-first-party-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/lib/roles/wikipedia.py:
     2 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     1 × TC001 (typing-only-first-party-import)
     1 × I002 (missing-required-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/lib/settings.py:
     1 × UP007 (non-pep604-annotation)
     1 × I002 (missing-required-import)
- src/django_docutils/lib/tests/test_utils.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/tests/test_writers.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/text.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/transforms/code.py:
     8 × UP037 (quoted-annotation)
     1 × UP007 (non-pep604-annotation)
     1 × I002 (missing-required-import)
- src/django_docutils/lib/transforms/toc.py:
     2 × UP007 (non-pep604-annotation)
     1 × I002 (missing-required-import)
- src/django_docutils/lib/types.py:
     1 × I002 (missing-required-import)
- src/django_docutils/lib/utils.py:
     1 × TC003 (typing-only-standard-library-import)
     1 × I002 (missing-required-import)
     1 × UP037 (quoted-annotation)
     1 × I001 (unsorted-imports)
- src/django_docutils/lib/views.py:
     7 × UP007 (non-pep604-annotation)
     2 × I001 (unsorted-imports)
     2 × TC002 (typing-only-third-party-import)
     1 × I002 (missing-required-import)
     1 × TC001 (typing-only-first-party-import)
- src/django_docutils/lib/writers.py:
     4 × UP007 (non-pep604-annotation)
     1 × TC002 (typing-only-third-party-import)
     1 × I002 (missing-required-import)
- src/django_docutils/template.py:
     4 × UP037 (quoted-annotation)
     2 × UP007 (non-pep604-annotation)
     1 × I002 (missing-required-import)
     1 × TC002 (typing-only-third-party-import)
- src/django_docutils/templatetags/django_docutils.py:
     7 × UP007 (non-pep604-annotation)
     1 × F401 (unused-import)
     1 × I002 (missing-required-import)
     1 × I001 (unsorted-imports)
- src/django_docutils/views.py:
    11 × UP007 (non-pep604-annotation)
     2 × TC002 (typing-only-third-party-import)
     1 × I002 (missing-required-import)
     1 × I001 (unsorted-imports)
- tests/constants.py:
     1 × I002 (missing-required-import)
- tests/settings.py:
     1 × I002 (missing-required-import)
     1 × UP037 (quoted-annotation)
- tests/test_docutils_roles.py:
     2 × TC002 (typing-only-third-party-import)
     1 × UP007 (non-pep604-annotation)
     1 × I002 (missing-required-import)
     1 × TC003 (typing-only-standard-library-import)
     1 × I001 (unsorted-imports)
- tests/test_template.py:
     1 × TC003 (typing-only-standard-library-import)
     1 × I002 (missing-required-import)
     1 × UP037 (quoted-annotation)
     1 × I001 (unsorted-imports)
- tests/test_templatetag.py:
     1 × I002 (missing-required-import)

Found 567 errors (215 fixed, 352 remaining).
43 files reformatted, 12 files left unchanged

uv run ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; uv run ruff format .
@tony
chore: Refine imports to use t namespace
9adcea7
@tony tony force-pushed the future-annotations branch from 6e1ceca to 9adcea7 Compare January 4, 2025 13:53
@tony tony force-pushed the future-annotations branch from a8849df to c4fa39f Compare January 4, 2025 15:25
@tony tony merged commit c1753bd into master Jan 4, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@tony