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

typecheck-part-1 #1350

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
+465 −437
Open

typecheck-part-1 #1350

Changes from 9 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
55bc286
add some rules to ruff
DinhHuy2010 Dec 21, 2024
669981a
fix pyproject again
DinhHuy2010 Dec 21, 2024
6f65aa4
fix pyproject again
DinhHuy2010 Dec 22, 2024
7db23de
fix pyproject
DinhHuy2010 Dec 22, 2024
130c69c
fix pyproject again
DinhHuy2010 Dec 22, 2024
37f51cd
fix pyproject.toml
DinhHuy2010 Dec 25, 2024
21bdf35
add some rules to ruff
DinhHuy2010 Dec 21, 2024
64fc392
ignore unused imports
DinhHuy2010 Dec 21, 2024
006b591
Merge branch 'master' into typecheck-part-1
DinhHuy2010 Feb 17, 2025
5085e14
turn ruff fix into opt-in
DinhHuy2010 Feb 26, 2025
a93d488
remove all ruff ignore rules
DinhHuy2010 Feb 26, 2025
5ceb724
add noqa across the repository (by running ruff check . --add-noqa)
DinhHuy2010 Feb 26, 2025
b15191d
Merge branch 'master' into typecheck-part-1
DinhHuy2010 Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,53 @@ environment = {LIBGIT2_VERSION="1.9.0", LIBSSH2_VERSION="1.11.1", OPENSSL_VERSIO
repair-wheel-command = "DYLD_LIBRARY_PATH=/Users/runner/work/pygit2/pygit2/ci/lib delocate-wheel --require-archs {delocate_archs} -w {dest_dir} {wheel}"

[tool.ruff]
target-version = "py310" # oldest supported Python version
fix = true
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't fixes be opt-in, instead of opt-out? 🤔 Would you mind elaborating on your reasoning?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops, that should be opt-in, sorry.

extend-exclude = [ ".cache", ".coverage", "build", "site-packages", "venv*"]
target-version = "py310" # oldest supported Python version
lint.select = [
"E",
"W",
"F",
"I",
"B",
"C4",
"ARG",
"SIM",
"PTH",
"PL",
"TID",
]
lint.ignore = [
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How come you're not using this instead, for select and ignore?

[tool.ruff.lint]

As seen (and suggested one might say) in ruff's docs.

"W291", # Trailing whitespace
"E501", # Line too long
"W293", # Blank line contains whitespace
"PLR0912", # Too many branches
"PLR2004", # Magic values
"PLR0915", # Too many statements
"PLW0603", # Global statement
"PLR0913", # Too many arguments
"B010", # setattr
"F401", # unused imports
"ARG002", # unused arguments
"SIM105", # try-except-pass
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you ignoring them because there are many fixes to be made?

If so, the suggested approach is not to ignore them at the configuration level, but run ruff with --add-noqa, as seen here.

When enabling a new rule on an existing codebase, you may want to ignore all existing violations of that rule and instead focus on enforcing it going forward.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, never know that kind of thing, thanks!

]

[tool.ruff.format]
quote-style = "single"

[tool.pyright]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are adding a pyright configuration but pyright is not in the repo in any capacity.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will add pyright soon in another PR

typeCheckingMode = "strict"
pythonVersion = "3.10"
reportPrivateUsage = "none"
reportAttributeAccessIssue = "none"
reportUnknownMemberType = "none"
reportUnusedFunction = "none"
reportUnnecessaryIsInstance = "none"

[tool.codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = '.git*'
check-hidden = true
# ignore-regex = ''
ignore-words-list = 'devault,claus'