You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a follow-up to release 0.10.0. Because of a mistake in the release process, the requires-python inference changes were not included in that release. Ruff 0.11.0 now includes this change as well as the stabilization of the preview behavior for PGH004.
Breaking changes
Changes to how the Python version is inferred when a target-version is not specified (#16319)
In previous versions of Ruff, you could specify your Python version with:
The target-version option in a ruff.toml file or the [tool.ruff] section of a pyproject.toml file.
The project.requires-python field in a pyproject.toml file with a [tool.ruff] section.
These options worked well in most cases, and are still recommended for fine control of the Python version. However, because of the way Ruff discovers config files, pyproject.toml files without a [tool.ruff] section would be ignored, including the requires-python setting. Ruff would then use the default Python version (3.9 as of this writing) instead, which is surprising when you've attempted to request another version.
In v0.10, config discovery has been updated to address this issue:
If Ruff finds a ruff.toml file without a target-version, it will check
for a pyproject.toml file in the same directory and respect its requires-python version, even if it does not contain a [tool.ruff]
section.
If Ruff finds a user-level configuration, the requires-python field of the closest pyproject.toml in a parent directory will take precedence.
If there is no config file (ruff.tomlor pyproject.toml with a [tool.ruff] section) in the directory of the file being checked, Ruff will
search for the closest pyproject.toml in the parent directories and use its requires-python setting.
Stabilization
The following behaviors have been stabilized:
blanket-noqa (PGH004): Also detect blanked file-level noqa comments (and not just line level comments).
Preview features
[syntax-errors] Tuple unpacking in for statement iterator clause before Python 3.9 (#16558)
Check out the blog post for a migration guide and overview of the changes!
Breaking changes
See also, the "Remapped rules" section which may result in disabled rules.
Changes to how the Python version is inferred when a target-version is not specified (#16319)
Because of a mistake in the release process, the requires-python inference changes are not included in this release and instead shipped as part of 0.11.0.
You can find a description of this change in the 0.11.0 section.
Previously, Ruff only recognized typechecking blocks that tested the typing.TYPE_CHECKING symbol. Now, Ruff recognizes any local variable named TYPE_CHECKING. This release also removes support for the legacy if 0: and if False: typechecking checks. Use a local TYPE_CHECKING variable instead.
The syntax for both file-level and in-line suppression comments has been unified and made more robust to certain errors. In most cases, this will result in more suppression comments being read by Ruff, but there are a few instances where previously read comments will now log an error to the user instead. Please refer to the documentation on Error suppression for the full specification.
Avoid unnecessary parentheses around with statements with a single context manager and a trailing comment (#14005)
This change fixes a bug in the formatter where it introduced unnecessary parentheses around with statements with a single context manager and a trailing comment. This change may result in a change in formatting for some users.
Bump alpine default tag to 3.21 for derived Docker images (#16456)
Alpine 3.21 was released in Dec 2024 and is used in the official Alpine-based Python images. Now the ruff:alpine image will use 3.21 instead of 3.20 and ruff:alpine3.20 will no longer be updated.
bad-str-strip-call (PLE1310): The rule now applies to objects which are known to have type str or bytes.
custom-type-var-for-self (PYI019): More accurate detection of custom TypeVars replaceable by Self. The range of the diagnostic is now the full function header rather than just the return annotation.
invalid-argument-name (N803): Ignore argument names of functions decorated with typing.override
invalid-envvar-default (PLW1508): Detect default value arguments to os.environ.get with invalid type.
redundant-open-modes (UP015): The diagnostic range is now the range of the redundant mode argument where it previously was the range of the entire open call. You may have to replace your noqa comments when suppressing UP015.
stdlib-module-shadowing (A005): Changes the default value of lint.flake8-builtins.strict-checking from true to false.
type-none-comparison (FURB169): Now also recognizes type(expr) is type(None) comparisons where expr isn't a name expression.
The following fixes or improvements to fixes have been stabilized:
Remove logging output for ruff.printDebugInformation (#16617)
Configuration
[flake8-builtins] Deprecate the builtins- prefixed options in favor of the unprefixed options (e.g. builtins-allowed-modules is now deprecated in favor of allowed-modules) (#16092)
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.9.9->0.11.0Release Notes
astral-sh/ruff (ruff)
v0.11.0Compare Source
This is a follow-up to release 0.10.0. Because of a mistake in the release process, the
requires-pythoninference changes were not included in that release. Ruff 0.11.0 now includes this change as well as the stabilization of the preview behavior forPGH004.Breaking changes
Changes to how the Python version is inferred when a
target-versionis not specified (#16319)In previous versions of Ruff, you could specify your Python version with:
target-versionoption in aruff.tomlfile or the[tool.ruff]section of a pyproject.toml file.project.requires-pythonfield in apyproject.tomlfile with a[tool.ruff]section.These options worked well in most cases, and are still recommended for fine control of the Python version. However, because of the way Ruff discovers config files,
pyproject.tomlfiles without a[tool.ruff]section would be ignored, including therequires-pythonsetting. Ruff would then use the default Python version (3.9 as of this writing) instead, which is surprising when you've attempted to request another version.In v0.10, config discovery has been updated to address this issue:
ruff.tomlfile without atarget-version, it will checkfor a
pyproject.tomlfile in the same directory and respect itsrequires-pythonversion, even if it does not contain a[tool.ruff]section.
requires-pythonfield of the closestpyproject.tomlin a parent directory will take precedence.ruff.tomlorpyproject.tomlwith a[tool.ruff]section) in the directory of the file being checked, Ruff willsearch for the closest
pyproject.tomlin the parent directories and use itsrequires-pythonsetting.Stabilization
The following behaviors have been stabilized:
blanket-noqa(PGH004): Also detect blanked file-level noqa comments (and not just line level comments).Preview features
forstatement iterator clause before Python 3.9 (#16558)v0.10.0Compare Source
Check out the blog post for a migration guide and overview of the changes!
Breaking changes
See also, the "Remapped rules" section which may result in disabled rules.
Changes to how the Python version is inferred when a
target-versionis not specified (#16319)Because of a mistake in the release process, the
requires-pythoninference changes are not included in this release and instead shipped as part of 0.11.0.You can find a description of this change in the 0.11.0 section.
Updated
TYPE_CHECKINGbehavior (#16669)Previously, Ruff only recognized typechecking blocks that tested the
typing.TYPE_CHECKINGsymbol. Now, Ruff recognizes any local variable namedTYPE_CHECKING. This release also removes support for the legacyif 0:andif False:typechecking checks. Use a localTYPE_CHECKINGvariable instead.More robust noqa parsing (#16483)
The syntax for both file-level and in-line suppression comments has been unified and made more robust to certain errors. In most cases, this will result in more suppression comments being read by Ruff, but there are a few instances where previously read comments will now log an error to the user instead. Please refer to the documentation on Error suppression for the full specification.
Avoid unnecessary parentheses around with statements with a single context manager and a trailing comment (#14005)
This change fixes a bug in the formatter where it introduced unnecessary parentheses around with statements with a single context manager and a trailing comment. This change may result in a change in formatting for some users.
Bump alpine default tag to 3.21 for derived Docker images (#16456)
Alpine 3.21 was released in Dec 2024 and is used in the official Alpine-based Python images. Now the ruff:alpine image will use 3.21 instead of 3.20 and ruff:alpine3.20 will no longer be updated.
Deprecated Rules
The following rules have been deprecated:
non-pep604-isinstance(UP038)suspicious-xmle-tree-usage(S320)Remapped rules
The following rules have been remapped to new rule codes:
unsafe-markup-use]:RUF035toS704Stabilization
The following rules have been stabilized and are no longer in preview:
batched-without-explicit-strict(B911)unnecessary-dict-comprehension-for-iterable(C420)datetime-min-max(DTZ901)fast-api-unused-path-parameter(FAST003)root-logger-call(LOG015)len-test(PLC1802)shallow-copy-environ(PLW1507)os-listdir(PTH208)invalid-pathlib-with-suffix(PTH210)invalid-assert-message-literal-argument(RUF040)unnecessary-nested-literal(RUF041)unnecessary-cast-to-int(RUF046)map-int-version-parsing(RUF048)if-key-in-dict-del(RUF051)unsafe-markup-use(S704). This rule has also been renamed fromRUF035.split-static-string(SIM905)runtime-cast-value(TC006)unquoted-type-alias(TC007)non-pep646-unpack(UP044)The following behaviors have been stabilized:
bad-staticmethod-argument(PLW0211)invalid-first-argument-name-for-class-method(N804):__new__methods are now no longer flagged byinvalid-first-argument-name-for-class-method(N804) but instead bybad-staticmethod-argument(PLW0211)bad-str-strip-call(PLE1310): The rule now applies to objects which are known to have typestrorbytes.custom-type-var-for-self(PYI019): More accurate detection of customTypeVarsreplaceable bySelf. The range of the diagnostic is now the full function header rather than just the return annotation.invalid-argument-name(N803): Ignore argument names of functions decorated withtyping.overrideinvalid-envvar-default(PLW1508): Detect default value arguments toos.environ.getwith invalid type.pytest-raises-with-multiple-statements(PT012)pytest-warns-with-multiple-statements(PT031): Allowforstatements with an empty body inpytest.raisesandpytest.warnswithstatements.redundant-open-modes(UP015): The diagnostic range is now the range of the redundant mode argument where it previously was the range of the entire open call. You may have to replace yournoqacomments when suppressingUP015.stdlib-module-shadowing(A005): Changes the default value oflint.flake8-builtins.strict-checkingfromtruetofalse.type-none-comparison(FURB169): Now also recognizestype(expr) is type(None)comparisons whereexprisn't a name expression.The following fixes or improvements to fixes have been stabilized:
repeated-equality-comparison(PLR1714) (#16685)needless-bool(SIM103) (#16684)unused-private-type-var(PYI018) (#16682)Server
ruff.printDebugInformation(#16617)Configuration
flake8-builtins] Deprecate thebuiltins-prefixed options in favor of the unprefixed options (e.g.builtins-allowed-modulesis now deprecated in favor ofallowed-modules) (#16092)Bug fixes
CLI
last_tag/commits_since_last_tagforversioncommand (#16686)v0.9.10Compare Source
Preview features
ruff] Add new ruleRUF059: Unused unpacked assignment (#16449)syntax-errors] Detect assignment expressions before Python 3.8 (#16383)syntax-errors] Named expressions in decorators before Python 3.9 (#16386)syntax-errors] Parenthesized keyword argument names after Python 3.8 (#16482)syntax-errors] Positional-only parameters before Python 3.8 (#16481)syntax-errors] Tuple unpacking inreturnandyieldbefore Python 3.8 (#16485)syntax-errors] Type parameter defaults before Python 3.13 (#16447)syntax-errors] Type parameter lists before Python 3.12 (#16479)syntax-errors]except*before Python 3.11 (#16446)syntax-errors]typestatements before Python 3.12 (#16478)Bug fixes
flake8-simplify] Exempt unittest context methods forSIM115rule (#16439)pyupgrade] Do not offer fix when at least one target isglobal/nonlocal(UP028) (#16451)flake8-builtins] Ignore variables matching module attribute names (A001) (#16454)pylint] Convertcodekeyword argument to a positional argument in fix for (PLR1722) (#16424)CLI
descriptiontocheck_namein GitLab output serializer (#16437)Documentation
pydocstyle] Clarify thatD417only checks docstrings with an arguments section (#16494)Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.