Initial pyright config #4192

Avasam · 2024-01-25T02:42:33Z

Summary of changes

Work towards step 2 of #2345 (comment) . Non-trivial fixes should go in different PRs.
Merge #3979 and #4257 first.
npx -y pyright@latest . --pythonversion=3.8|3.12 --pythonplatform=Linux|Windows results:
0 errors, 418 warnings, 0 informations

Pull Request Checklist

Changes have tests (this is the test!)
News fragment added in newsfragments/.
(See documentation for details)

.github/workflows/main.yml

Avasam · 2024-01-25T03:39:56Z

setuptools/command/build.py

@@ -138,3 +143,4 @@ def get_output_mapping(self) -> Dict[str, str]:
        Destination files should be strings in the form of
        ``"{build_lib}/destination/file/path"``.
        """
+        ...


Refer to microsoft/pyright#6487

Python should not require ellipsis when the docstring is provided. I am not 100% inline with the comment of the pyright maintainer... The reason why the linters don't complain about it, is because there is nothing wrong 😅

Does mypy also complains about it?
Should we just stick with mypy for now?

I see the problem here is because we are talking specifically about prototypes, and the spec says:

Bodies of protocol methods are type checked.

That is a bit disappointing... These pesky ellipsis can be annoying

Further discussion: astral-sh/ruff#8756 (comment) . It does seem to be more accurate to spec. Ruff was also updated to not strip ellipses in Protocols in https://github.com/astral-sh/ruff/releases/tag/v0.1.6

abravalheri

Hi @Avasam , thank you very much for the efforts in this field. I understand that this is a wipe, but I left a few comments, hopefully that is fine with you.

abravalheri · 2024-01-25T08:54:18Z

setuptools/command/build.py

@@ -138,3 +143,4 @@ def get_output_mapping(self) -> Dict[str, str]:
        Destination files should be strings in the form of
        ``"{build_lib}/destination/file/path"``.
        """
+        ...


Python should not require ellipsis when the docstring is provided. I am not 100% inline with the comment of the pyright maintainer... The reason why the linters don't complain about it, is because there is nothing wrong 😅

Does mypy also complains about it?
Should we just stick with mypy for now?

setuptools/command/easy_install.py

Avasam · 2024-01-25T21:44:46Z

I understand that this is a [wip] but I left a few comments, hopefully that is fine with you.

Perfectly fine! I'm just waiting for a merge on #3979 (there's some overlap) before publishing the PR.
I especially need guidance on running type-checkers (mypy/pyright) on the CI (tox/pytest setup) to prevent regressions.

mypy.ini

setup.cfg

pyrightconfig.json

setuptools/config/_apply_pyprojecttoml.py

abravalheri · 2024-08-22T09:42:52Z

tox.ini

@@ -6,6 +6,7 @@ setenv =
 	PYTHONWARNDEFAULTENCODING = 1
 	SETUPTOOLS_ENFORCE_DEPRECATION = {env:SETUPTOOLS_ENFORCE_DEPRECATION:1}
 commands =
+	pyright --threads


I am really sorry @Avasam, I had a change of heart at this.

It seems that when you install pyright, it automatically install NodeJS. That is a huge undertake: it is a separated programming language/environment and it does seem excessive to automatically add that to the contributors' machines (or mine).

In this scenario, I am reconsidering the first approach that you suggested (adding a new workflow to the CI). That might work better.

I am thinking that if we have a separated workflow file, it would not interfere with skeleton. That might be the best scenario.

I am reconsidering the first approach that you suggested (adding a new workflow to the CI). That might work better.
I am thinking that if we have a separated workflow file, it would not interfere with skeleton. That might be the best scenario.

I am 100% for this solution and is my preference as well ! I'll re-request your review once that's done.

Ok so here's a workflow file without touching tox.ini or .github/workflows/main.yml, or referencing pyright in pyproject.toml.

Incidentally it also won't be picked-up by the collateral job.

…t-initial-config

…tuptools into pyright-initial-config

.github/workflows/pyright.yml

Co-authored-by: Anderson Bravalheri <[email protected]>

…t-initial-config

abravalheri · 2024-08-27T10:07:34Z

Thank you very much, let's get this one going.

Avasam commented Jan 25, 2024

View reviewed changes

.github/workflows/main.yml Outdated Show resolved Hide resolved

Avasam changed the title ~~Pyright initial config~~ Initial pyright config and turn on type-checking in CI Jan 25, 2024

Avasam mentioned this pull request Jan 25, 2024

Add type hints to setuptools #2345

Open

Avasam force-pushed the pyright-initial-config branch from 6450313 to e7c0804 Compare January 25, 2024 03:39

Avasam commented Jan 25, 2024

View reviewed changes

abravalheri reviewed Jan 25, 2024

View reviewed changes

This was referenced Feb 22, 2024

Fix all mypy issues #3979

Merged

Avoid using private _config_vars #4228

Closed

Use pathlib instead of py #4237

Merged

Avasam force-pushed the pyright-initial-config branch from bbb379f to d9f74a7 Compare February 27, 2024 17:41

Avasam mentioned this pull request Mar 5, 2024

Enable mypy on CI #4257

Merged

2 tasks

Avasam changed the title ~~Initial pyright config and turn on type-checking in CI~~ Initial pyright config Mar 6, 2024

Avasam force-pushed the pyright-initial-config branch 2 times, most recently from 872fc45 to 257efa3 Compare March 6, 2024 21:07

This comment was marked as resolved.

Sign in to view

Avasam force-pushed the pyright-initial-config branch from 257efa3 to 6519c8d Compare March 6, 2024 21:32

Avasam marked this pull request as ready for review March 8, 2024 05:21

Avasam mentioned this pull request Mar 8, 2024

pkg_resources type the declared global variables #4267

Merged

2 tasks

Avasam commented Mar 11, 2024

View reviewed changes

mypy.ini Outdated Show resolved Hide resolved

Avasam commented Mar 11, 2024

View reviewed changes

mypy.ini Outdated Show resolved Hide resolved

Avasam commented Mar 11, 2024

View reviewed changes

setup.cfg Outdated Show resolved Hide resolved

Avasam commented Mar 11, 2024

View reviewed changes

pyrightconfig.json Outdated Show resolved Hide resolved

jaraco force-pushed the main branch from 9296481 to 6067fa4 Compare April 18, 2024 21:31

Avasam requested a review from abravalheri April 22, 2024 16:29

Avasam force-pushed the pyright-initial-config branch 2 times, most recently from cc9d481 to b33d4a0 Compare May 22, 2024 16:32

This was referenced May 22, 2024

Make shutil.rmtree.onexc parameter optional python/typeshed#12002

Merged

Prevent a TypeError in compat.py311.shutil_rmtree #4382

Merged

Avasam force-pushed the pyright-initial-config branch from c957935 to 6c7ccd4 Compare June 17, 2024 17:41

Initial pyright config

5259c21

Avasam force-pushed the pyright-initial-config branch from 53fd1aa to 5259c21 Compare August 21, 2024 02:11

Avasam mentioned this pull request Aug 21, 2024

Move static-checkers-only dependencies into their dedicated extras #4586

Merged

2 tasks

Avasam force-pushed the pyright-initial-config branch from 5259c21 to bbaada8 Compare August 21, 2024 14:54

Initial pyright config

c4f5c25

Avasam force-pushed the pyright-initial-config branch from bbaada8 to c4f5c25 Compare August 21, 2024 17:06

Avasam mentioned this pull request Aug 21, 2024

Type all context manager dunders #4581

Merged

2 tasks

abravalheri reviewed Aug 22, 2024

View reviewed changes

Avasam added 12 commits August 22, 2024 11:58

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

1727564

…t-initial-config

Bump importlib_metadata in type tests

98951f8

Merge branch 'pyright-initial-config' of https://github.com/Avasam/se…

6481724

…tuptools into pyright-initial-config

New pyright specific workflow

c3c5d64

typo

296f9e8

--threads

a7ea1cb

typo

3399be9

missing semi

92161eb

shell: bash + test conditional with latest

5fb0c4f

Add missing spaces in comparison

69c16a2

Fix requirements

c47a46c

Typo and fix cygwin

5cd06e0

Avasam requested a review from abravalheri August 22, 2024 19:48

abravalheri reviewed Aug 23, 2024

View reviewed changes

.github/workflows/pyright.yml Outdated Show resolved Hide resolved

Avasam and others added 3 commits August 24, 2024 13:50

Update .github/workflows/pyright.yml

11230b1

Co-authored-by: Anderson Bravalheri <[email protected]>

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

62b9cbd

…t-initial-config

get_ext_filename doesn't need to be modified for this PR

e2a6f4a

This was referenced Aug 24, 2024

Make command.build_ext.get_ext_filename typesafe #4592

Merged

Reraise sensible errors from auto_chmod #4593

Merged

Merge branch 'main' into pyright-initial-config

f8faa45

abravalheri merged commit d12330d into pypa:main Aug 27, 2024
21 of 23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial pyright config #4192

Initial pyright config #4192

Avasam commented Jan 25, 2024 •

edited

Loading

Avasam Jan 25, 2024

abravalheri Jan 25, 2024

abravalheri Jan 25, 2024

Avasam Aug 21, 2024

abravalheri left a comment

abravalheri Jan 25, 2024

Avasam commented Jan 25, 2024 •

edited

Loading

This comment was marked as resolved.

abravalheri Aug 22, 2024

Avasam Aug 22, 2024 •

edited

Loading

Avasam Aug 22, 2024

abravalheri commented Aug 27, 2024

Initial pyright config #4192

Initial pyright config #4192

Conversation

Avasam commented Jan 25, 2024 • edited Loading

Summary of changes

Pull Request Checklist

Avasam Jan 25, 2024

Choose a reason for hiding this comment

abravalheri Jan 25, 2024

Choose a reason for hiding this comment

abravalheri Jan 25, 2024

Choose a reason for hiding this comment

Avasam Aug 21, 2024

Choose a reason for hiding this comment

abravalheri left a comment

Choose a reason for hiding this comment

abravalheri Jan 25, 2024

Choose a reason for hiding this comment

Avasam commented Jan 25, 2024 • edited Loading

This comment was marked as resolved.

abravalheri Aug 22, 2024

Choose a reason for hiding this comment

Avasam Aug 22, 2024 • edited Loading

Choose a reason for hiding this comment

Avasam Aug 22, 2024

Choose a reason for hiding this comment

abravalheri commented Aug 27, 2024

Avasam commented Jan 25, 2024 •

edited

Loading

Avasam commented Jan 25, 2024 •

edited

Loading

Avasam Aug 22, 2024 •

edited

Loading