Merge simple type annotations from typeshed #4504

Avasam · 2024-07-22T01:49:16Z

Summary of changes

~~Please review and merge first: #4505~~ Done
~~Merging #4581 and #4584 first will reduce changes in this PR~~ Done
It's important to validate this PR with mypy, let's re-enable it first and fix existing failures: #4604

Not done in this PR:

Abstract methods and classes: Mark abstract base classes and methods #4503
@overload: Merge overloaded method definitions from typeshed #4506
return types
AbstractSandbox's dynamically created methods: Add fake __getattribute__ to AbstractSandbox to let type-checkers know it has a bunch of dynamic methods #4708
expanded *args & **kwargs
@type_check_only, and other TypedDict from typeshed: Merge TypedDicts from typeshed #4707

Step 6.1 of #2345 (comment)

Pull Request Checklist

Changes have tests (no new tests, existing static tests should pass)
News fragment added in newsfragments/. (nothing user-facing as static typing users would still be using types-setuptools)
(See documentation for details)

setuptools/config/pyprojecttoml.py

Avasam · 2024-08-08T16:01:59Z

setuptools/extension.py

+    def __init__(
+        self, name: str, sources: list[str], *args, py_limited_api: bool = False, **kw
+    ):


From @abravalheri https://github.com/pypa/setuptools/pull/4505/files#r1709465928

Jason might have added support for PathLikesources recently in pypa/distutils#237 (v72.2.0/setuptools/_distutils/extension.py#L29).

(PS.: granted they are incompatible with SETUPTOOLS_USE_DISTUTILS=stdlib but that is a deprecated code path).

_distutils_hack/__init__.py

setuptools/build_meta.py

abravalheri · 2024-08-09T09:43:50Z

setuptools/build_meta.py

@@ -289,7 +297,7 @@ def _arbitrary_args(self, config_settings: _ConfigSettings) -> Iterator[str]:


 class _BuildMetaBackend(_ConfigSettingsTranslator):
-    def _get_build_requires(self, config_settings, requirements):
+    def _get_build_requires(self, config_settings: _ConfigSettings, requirements):


It is likely here that requirements and the return value are both list[str]. Not sure how the type-checking would react to that though...

Doesn't cause any issue. I didn't add annotations to _get_build_requires because it's not typed in typeshed. config_settings param being typed is incidental to adding all _ConfigSettings.

But since you're mentioning it here and it's not an issue, I've added the type annotation to requirements param

setuptools/warnings.py

setuptools/sandbox.py

setuptools/dist.py

setuptools/extension.py

setuptools/package_index.py

setuptools/dist.py

setuptools/__init__.py

Avasam · 2024-08-09T15:47:31Z

@abravalheri I'll answer a couple comments at once:

I have a handful of TypeAliases unnecessarily duplicated behind TYPE_CHECKING check whilst a from __future__ import annotations is sufficient to use an annotation that doesn't exist at runtime. So those should be simplified now.
As quickly mentioned in the PR description, and described in my step-by-step plan in Add type hints to setuptools #2345 (comment), I purposefully avoided adding return type annotations here. I plan on merging return annotations from typeshed as a direct follow-up. Then re-enabling ANN2 checks for setuptools.

setuptools/__init__.py

setuptools/build_meta.py

Avasam · 2024-08-09T17:18:07Z

setuptools/discovery.py

 if TYPE_CHECKING:
    from setuptools import Distribution
+    from typing_extensions import TypeAlias
+
+StrIter: TypeAlias = Iterator[str]


I don't feel like this alias brings anything of value:

It doesn't work around any runtime issue

It doesn't abstract away any complexity

It's not clearer than the type it's aliasing, or doesn't help explain it

It's barely any more concise (because it's using a shorthand instead of being clear and explicit)

In fact, it might actually hurt understandability as a dev can reasonably assume that the alias might be abstracting a more complex type and have to check what it is, rather than immediately understanding it's Iterator[str]

But it's not private. Could we maybe deprecate it ?

I think we can be a bit bold here and replace it directly... people should not be importing StrIter from this module... A search on GitHub seems to indicate they are not: https://github.com/search?q=%2Fsetuptools.discovery.*StrIter%2F&type=code.

(the whole module should have been introduced as a private module... but at that point in time I did not know better).

setuptools/command/sdist.py

…ools-simple-typeshed-params

Avasam · 2024-10-17T16:34:26Z

setuptools/command/easy_install.py

        # Installation is also needed if file in tmpdir or is not an egg
-        install_needed = install_needed or self.always_copy
+        install_needed = install_needed or bool(self.always_copy)


Either this, or:

default always_copy to False (I wasn't sure if None was used as a special meaning "not set by user");

allow install_needed param to be None;

use a differently named variable in install_item (like _install_needed);

setuptools/command/editable_wheel.py

…m/Avasam/setuptools into setuptools-simple-typeshed-params

…ools-simple-typeshed-params

Avasam · 2024-10-21T20:41:13Z

I've added more distutils workaround so that this can be merged w/o #4691, but I'd ask to consider making distutils stubs available for all Python versions so that it stops being an issue.

abravalheri

Thank you very much @Avasam.

I added 2 more questions, but I think we can merge the PR as it is, after we apply the rebase and test. Worst case scenario we can have follow ups.

abravalheri · 2024-10-25T14:21:03Z

setuptools/discovery.py

 if TYPE_CHECKING:
    from setuptools import Distribution
+    from typing_extensions import TypeAlias
+
+StrIter: TypeAlias = Iterator[str]


I think we can be a bit bold here and replace it directly... people should not be importing StrIter from this module... A search on GitHub seems to indicate they are not: https://github.com/search?q=%2Fsetuptools.discovery.*StrIter%2F&type=code.

(the whole module should have been introduced as a private module... but at that point in time I did not know better).

abravalheri · 2024-10-25T15:13:10Z

setuptools/command/build_py.py

+        preserve_mode: bool = True,
+        preserve_times: bool = True,
+        link: str | None = None,
+        level: object = 1,


level: object = 1,

This one looks odd, but I suppose that is because it assumes either int or boolean values elsewhere.

object can be used to mean "any parameter type" for unused params, (Typeshed has the alias _typeshed.Unused), but that might lead to LSP violations since subclasses should now support any object.

I should maybe change it to int (Unless you tell me that subclasses of these classes should not support ~~an "optimization level"~~ a depth level on this method)

Edit: uh that probably represent a depth level, not optimization ^^" Anyway, it's currently unused all the way down to the base Command class in distutils.

I'll need to go fix it in typeshed first (or #4689) I'll leave it "as-is" for this PR. You can squash-merge the whole thing once green.

Thank you @Avasam, once the CI finishes running I will squash it.

…m/Avasam/setuptools into setuptools-simple-typeshed-params

abravalheri · 2024-10-25T16:20:45Z

So there was a problem in the tests with the latest version of ruff, and clash with the version of ruff in the .pre-commit-hooks.yaml.

I bumped the hook version just to keep the ball rolling. Hopefully it will not clash in the next merge with skeleton.

Avasam · 2024-10-25T16:47:10Z

Ah yes, the formatter just added merging of short multiline implicit string concatenation in preview mode (along with a few other small changes).

Might be worth a standalone run on main, as to not "pollute" this PR with unrelated changes.

abravalheri · 2024-10-25T16:58:37Z

Might be worth a standalone run on main, as to not "pollute" this PR with unrelated changes.

WIP in #4705.

…ypeshed-params

Avasam · 2024-10-25T17:43:16Z

Wooh! A big one done!

This was referenced Jul 22, 2024

Add type hints to setuptools #2345

Open

Setuptools stubs update from merging upstream python/typeshed#12400

Merged

Avasam commented Jul 22, 2024

View reviewed changes

setuptools/config/pyprojecttoml.py Outdated Show resolved Hide resolved

Avasam commented Jul 22, 2024

View reviewed changes

setuptools/config/pyprojecttoml.py Outdated Show resolved Hide resolved

Avasam commented Jul 22, 2024

View reviewed changes

setuptools/config/pyprojecttoml.py Outdated Show resolved Hide resolved

Avasam mentioned this pull request Jul 22, 2024

Runtime changes for typeshed parameter annotations merge #4505

Merged

2 tasks

Avasam changed the title ~~[WIP] Merge simple type annotations from typeshed~~ Merge simple type annotations from typeshed Jul 22, 2024

Avasam commented Aug 8, 2024

View reviewed changes

_distutils_hack/__init__.py Outdated Show resolved Hide resolved

Avasam marked this pull request as ready for review August 8, 2024 19:10

abravalheri reviewed Aug 9, 2024

View reviewed changes

Avasam requested a review from abravalheri August 9, 2024 17:08

Avasam commented Aug 9, 2024

View reviewed changes

setuptools/__init__.py Outdated Show resolved Hide resolved

Avasam commented Aug 9, 2024

View reviewed changes

setuptools/build_meta.py Outdated Show resolved Hide resolved

Avasam commented Aug 9, 2024

View reviewed changes

setuptools/build_meta.py Outdated Show resolved Hide resolved

Avasam commented Aug 9, 2024

View reviewed changes

Avasam commented Aug 10, 2024

View reviewed changes

setuptools/command/sdist.py Outdated Show resolved Hide resolved

Avasam commented Aug 10, 2024

View reviewed changes

setuptools/command/sdist.py Outdated Show resolved Hide resolved

Avasam mentioned this pull request Aug 13, 2024

Bump setuptools to 72.2.* python/typeshed#12461

Merged

Avasam force-pushed the setuptools-simple-typeshed-params branch from 8f34df1 to f319cc5 Compare August 20, 2024 18:44

This was referenced Aug 20, 2024

Type all get/set dunders #4584

Merged

Type all context manager dunders #4581

Merged

Avasam force-pushed the setuptools-simple-typeshed-params branch from f319cc5 to d4143c0 Compare August 20, 2024 21:44

Avasam mentioned this pull request Aug 21, 2024

Type-check on all Python versions #4352

Merged

2 tasks

Avasam force-pushed the setuptools-simple-typeshed-params branch 2 times, most recently from 9e0cc8d to 3113380 Compare August 27, 2024 15:27

Merge simple type annotations from typeshed

4eef53a

Avasam force-pushed the setuptools-simple-typeshed-params branch from 3113380 to 4eef53a Compare August 27, 2024 15:58

Merge branch 'main' of https://github.com/pypa/setuptools into setupt…

6badc78

…ools-simple-typeshed-params

Merge branch 'main' into setuptools-simple-typeshed-params

5432664

Avasam marked this pull request as ready for review October 17, 2024 16:24

Wrap self.always_copy in bool

8f2678e

Avasam commented Oct 17, 2024

View reviewed changes

setuptools/command/editable_wheel.py Outdated Show resolved Hide resolved

Update setuptools/command/editable_wheel.py

ac03f3e

Avasam mentioned this pull request Oct 17, 2024

[FR] Vendor distutils stubs #4689

Open

1 task

Avasam added 5 commits October 17, 2024 14:08

Add jaraco ignore_missing_imports

8f26a1e

Merge branch 'setuptools-simple-typeshed-params' of https://github.co…

23412b8

…m/Avasam/setuptools into setuptools-simple-typeshed-params

Merge branch 'main' of https://github.com/pypa/setuptools into setupt…

6e8e63e

…ools-simple-typeshed-params

Fix type-errors post-merge

2b3112e

More distutils workarounds

c5fa403

abravalheri approved these changes Oct 25, 2024

View reviewed changes

abravalheri and others added 3 commits October 25, 2024 16:20

Merge branch 'main' into setuptools-simple-typeshed-params

bd694d3

Remove StrIter

33106f1

Merge branch 'setuptools-simple-typeshed-params' of https://github.co…

c8959bd

…m/Avasam/setuptools into setuptools-simple-typeshed-params

abravalheri force-pushed the setuptools-simple-typeshed-params branch from c8756df to 35e3ed4 Compare October 25, 2024 16:26

Merge remote-tracking branch 'upstream/main' into setuptools-simple-t…

96453cb

…ypeshed-params

abravalheri force-pushed the setuptools-simple-typeshed-params branch from 35e3ed4 to 96453cb Compare October 25, 2024 17:20

abravalheri merged commit 0bc3248 into pypa:main Oct 25, 2024
25 checks passed

This was referenced Oct 28, 2024

Merge TypedDicts from typeshed #4707

Merged

Add fake __getattribute__ to AbstractSandbox to let type-checkers know it has a bunch of dynamic methods #4708

Merged

Re-enable ANN2 for setuptools #4709

Merged

Sync with typeshed post-#4504 #4719

Merged

abravalheri added a commit that referenced this pull request Oct 31, 2024

Sync with typeshed post-#4504 (#4719)

b88d0a1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge simple type annotations from typeshed #4504

Merge simple type annotations from typeshed #4504

Avasam commented Jul 22, 2024 •

edited

Loading

Avasam Aug 8, 2024

abravalheri Aug 9, 2024

Avasam Aug 9, 2024

Avasam commented Aug 9, 2024

Avasam Aug 9, 2024 •

edited

Loading

abravalheri Oct 25, 2024

Avasam Oct 17, 2024

Avasam commented Oct 21, 2024

abravalheri left a comment

abravalheri Oct 25, 2024

abravalheri Oct 25, 2024

Avasam Oct 25, 2024 •

edited

Loading

Avasam Oct 25, 2024 •

edited

Loading

abravalheri Oct 25, 2024

abravalheri commented Oct 25, 2024

Avasam commented Oct 25, 2024 •

edited

Loading

abravalheri commented Oct 25, 2024

Avasam commented Oct 25, 2024

Merge simple type annotations from typeshed #4504

Merge simple type annotations from typeshed #4504

Conversation

Avasam commented Jul 22, 2024 • edited Loading

Summary of changes

Pull Request Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Avasam commented Aug 9, 2024

Avasam Aug 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Avasam commented Oct 21, 2024

abravalheri left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Avasam Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

Avasam Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abravalheri commented Oct 25, 2024

Avasam commented Oct 25, 2024 • edited Loading

abravalheri commented Oct 25, 2024

Avasam commented Oct 25, 2024

Avasam commented Jul 22, 2024 •

edited

Loading

Avasam Aug 9, 2024 •

edited

Loading

Avasam Oct 25, 2024 •

edited

Loading

Avasam Oct 25, 2024 •

edited

Loading

Avasam commented Oct 25, 2024 •

edited

Loading