[`flake8-pyi`] Implement PYI026 #5844

LaBatata101 · 2023-07-17T22:52:00Z

Summary

Checks for typehint.TypeAlias annotation in type aliases. See original source.

$ flake8 --select Y026 crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:4:1: Y026 Use typing_extensions.TypeAlias for type aliases, e.g. "NewAny: TypeAlias = Any"
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:5:1: Y026 Use typing_extensions.TypeAlias for type aliases, e.g. "OptinalStr: TypeAlias = typing.Optional[str]"
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:6:1: Y026 Use typing_extensions.TypeAlias for type aliases, e.g. "Foo: TypeAlias = Literal['foo']"
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:7:1: Y026 Use typing_extensions.TypeAlias for type aliases, e.g. "IntOrStr: TypeAlias = int | str"
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:8:1: Y026 Use typing_extensions.TypeAlias for type aliases, e.g. "AliasNone: TypeAlias = None"

$ ./target/debug/ruff --select PYI026 crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi --no-cache
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:4:1: PYI026 Use `typing.TypeAlias` for type aliases in `NewAny`, e.g. "NewAny: typing.TypeAlias = Any"
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:5:1: PYI026 Use `typing.TypeAlias` for type aliases in `OptinalStr`, e.g. "OptinalStr: typing.TypeAlias = typing.Optional[str]"
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:6:1: PYI026 Use `typing.TypeAlias` for type aliases in `Foo`, e.g. "Foo: typing.TypeAlias = Literal["foo"]"
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:7:1: PYI026 Use `typing.TypeAlias` for type aliases in `IntOrStr`, e.g. "IntOrStr: typing.TypeAlias = int | str"
crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi:8:1: PYI026 Use `typing.TypeAlias` for type aliases in `AliasNone`, e.g. "AliasNone: typing.TypeAlias = None"
Found 5 errors.

ref: #848

Test Plan

Snapshots, manual runs of flake8.

## What it does Checks for `typehint.TypeAlias` annotation in type aliases. ## Why is this bad? It makes harder for someone reading the code to differentiate between a value assignment and a type alias. ## Example ```python IntOrStr = int | str ``` Use instead: ```python IntOrStr: TypeAlias = int | str ```

github-actions · 2023-07-17T23:37:52Z

PR Check Results

Ecosystem

ℹ️ ecosystem check detected changes. (+2, -0, 0 error(s))

typeshed (+2, -0)

+ stdlib/builtins.pyi:1664:1: PYI026 Use `typing.TypeAlias` for type alias, e.g., `_SupportsSomeKindOfPow: typing.TypeAlias = _SupportsPow2[Any, Any] | _SupportsPow3NoneOnly[Any, Any] | _SupportsPow3[Any, Any, Any]`
+ stdlib/builtins.pyi:220:1: PYI026 Use `typing.TypeAlias` for type alias, e.g., `_LiteralInteger: typing.TypeAlias = _PositiveInteger | _NegativeInteger | Literal[0]`

Rules changed: 1

Rule	Changes	Additions	Removals
PYI026	2	2	0

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00     11.0±0.03ms     3.7 MB/sec    1.00     10.9±0.03ms     3.7 MB/sec
formatter/numpy/ctypeslib.py               1.00      2.2±0.00ms     7.5 MB/sec    1.01      2.2±0.06ms     7.5 MB/sec
formatter/numpy/globals.py                 1.04   256.3±11.23µs    11.5 MB/sec    1.00    246.9±0.78µs    12.0 MB/sec
formatter/pydantic/types.py                1.00      4.8±0.01ms     5.4 MB/sec    1.01      4.8±0.01ms     5.3 MB/sec
linter/all-rules/large/dataset.py          1.00     15.4±0.04ms     2.6 MB/sec    1.00     15.3±0.03ms     2.7 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.01      3.9±0.00ms     4.2 MB/sec    1.00      3.9±0.00ms     4.3 MB/sec
linter/all-rules/numpy/globals.py          1.01    518.2±0.82µs     5.7 MB/sec    1.00    515.2±1.17µs     5.7 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.0±0.01ms     3.6 MB/sec    1.00      7.0±0.01ms     3.7 MB/sec
linter/default-rules/large/dataset.py      1.01      7.9±0.02ms     5.1 MB/sec    1.00      7.9±0.02ms     5.2 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.01   1687.6±7.22µs     9.9 MB/sec    1.00   1676.1±4.23µs     9.9 MB/sec
linter/default-rules/numpy/globals.py      1.00    185.1±0.35µs    15.9 MB/sec    1.00    184.5±0.32µs    16.0 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.6±0.03ms     7.1 MB/sec    1.00      3.6±0.02ms     7.2 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00     11.4±0.33ms     3.6 MB/sec    1.08     12.4±0.27ms     3.3 MB/sec
formatter/numpy/ctypeslib.py               1.00      2.2±0.05ms     7.4 MB/sec    1.07      2.4±0.04ms     6.9 MB/sec
formatter/numpy/globals.py                 1.00    251.0±7.05µs    11.8 MB/sec    1.04    261.4±7.59µs    11.3 MB/sec
formatter/pydantic/types.py                1.00      4.8±0.08ms     5.3 MB/sec    1.11      5.4±0.08ms     4.8 MB/sec
linter/all-rules/large/dataset.py          1.00     16.2±0.33ms     2.5 MB/sec    1.00     16.2±0.36ms     2.5 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.01      4.3±0.09ms     3.8 MB/sec    1.00      4.3±0.07ms     3.9 MB/sec
linter/all-rules/numpy/globals.py          1.01   505.4±10.55µs     5.8 MB/sec    1.00    499.1±9.31µs     5.9 MB/sec
linter/all-rules/pydantic/types.py         1.02      7.5±0.21ms     3.4 MB/sec    1.00      7.4±0.17ms     3.5 MB/sec
linter/default-rules/large/dataset.py      1.00      8.3±0.16ms     4.9 MB/sec    1.01      8.4±0.17ms     4.9 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00  1714.4±21.75µs     9.7 MB/sec    1.02  1741.5±29.81µs     9.6 MB/sec
linter/default-rules/numpy/globals.py      1.00    191.4±3.44µs    15.4 MB/sec    1.02    194.9±5.02µs    15.1 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.7±0.06ms     6.9 MB/sec    1.01      3.7±0.09ms     6.8 MB/sec

crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.py

crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi

zanieb

Welcome and thanks for contributing!

This seems like a good candidate for a suggested or automatic fix if your up for it :)

crates/ruff/src/rules/flake8_pyi/rules/simple_defaults.rs

LaBatata101 · 2023-07-18T00:07:04Z

Welcome and thanks for contributing!

This seems like a good candidate for a suggested or automatic fix if your up for it :)

I'll try to add the automatic fix. Do you have any examples for this?

zanieb · 2023-07-18T00:09:33Z

@LaBatata101 here's an example that changes one type annotation to another https://github.com/astral-sh/ruff/pull/4695/files#diff-f72967b46be9c2c0fed6dc2bf98259327c03cc36dd28839e72cc106a60f552dbR83-R91

crates/ruff/resources/test/fixtures/flake8_pyi/PYI026.pyi

crates/ruff/src/rules/flake8_pyi/rules/simple_defaults.rs

- fix a bug in `is_valid_pep_604_union` where it was returning `true` when only receiving an `Expr::Name`, `Expr::Subscript`, `Expr::Attribute` or `Expr::Constant(ast::ExprConstant {value: Constant::None, ..})` - don't run rule for multiple targets, e.g., `x = y = 1` - change the verification for when the rule should run to match the flake8-pyi implementation - implement autofix

charliermarsh · 2023-07-20T01:34:23Z

crates/ruff/src/rules/flake8_pyi/rules/simple_defaults.rs

+
+    if !is_annotatable_type_alias(value, checker.semantic()) {
+        return;
+    }


I reordered these operations from least- to most-expensive.

charliermarsh · 2023-07-20T01:34:44Z

crates/ruff/src/rules/flake8_pyi/rules/simple_defaults.rs

@@ -523,3 +599,40 @@ pub(crate) fn unassigned_special_variable_in_stub(
        stmt.range(),
    ));
 }
+
+/// PIY026
+pub(crate) fn type_alias_without_annotation(checker: &mut Checker, value: &Expr, targets: &[Expr]) {


I renamed the method and rule to be a little more in-line with our conventions ("describe the bad case").

charliermarsh

Looks great -- nice work, thank you!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://beta.ruff.rs/docs) ([source](https://togithub.com/astral-sh/ruff), [changelog](https://togithub.com/astral-sh/ruff/releases)) | `0.0.278` -> `0.0.280` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/ruff/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/ruff/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/ruff/0.0.278/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/ruff/0.0.278/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>astral-sh/ruff (ruff)</summary> ### [`v0.0.280`](https://togithub.com/astral-sh/ruff/compare/v0.0.279...v0.0.280) [Compare Source](https://togithub.com/astral-sh/ruff/compare/v0.0.279...v0.0.280) ### [`v0.0.279`](https://togithub.com/astral-sh/ruff/releases/tag/v0.0.279) [Compare Source](https://togithub.com/astral-sh/ruff/compare/v0.0.278...v0.0.279)  #### What's Changed ##### Rules - \[`flake8-pyi`] Implement flake8-pyi's PYI026 by [@LaBatata101](https://togithub.com/LaBatata101) in [astral-sh/ruff#5844 - \[`flake8-pyi`] Implement flake8-pyi's `PYI017` by [@qdegraaf](https://togithub.com/qdegraaf) in [astral-sh/ruff#5895 - \[`flake8-pyi`] Implement flake8-pyi's `PYI036` by [@density](https://togithub.com/density) in [astral-sh/ruff#5668 - \[`flake8-pyi`] Implement flake8-pyi's `PYI041` by [@density](https://togithub.com/density) in [astral-sh/ruff#5722 - \[`flake8-use-pathlib`] Implement `os-path-getsize` and `os-path-get(a|m|c)-time` (`PTH202-205`) by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5835 - \[`flake8-use-pathlib`] Implement `path-constructor-default-argument` (`PTH201`) by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5833 - \[`pandas-vet`] Implement constant series rule (`PD101`) by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5802 - \[`pylint`] Implement Pylint's `consider-using-in` (`PLR1714`) by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#5193 ##### Rule changes - \[`flake8-annotations`] Check for `Any` in other types for `ANN401` by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5601 - \[`flake8-bugbear`] Add autofix for B004 by [@density](https://togithub.com/density) in [astral-sh/ruff#5788 - \[`flake8-bugbear`] Remove `B904`'s lowercase exemption by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5751 - \[`flake8-use-pathlib`] extend PTH118 with `os.sep` by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5935 - \[`pyupgrade`] Expand scope of `quoted-annotation` rule (`UP037`) by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5766 - \[`pyupgrade`] Extend PEP 604 rewrites to support some quoted annotations by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5725 - \[`ruff`] Expand `RUF015` to include all expression types by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5767 ##### Bug Fixes - Consider single element subscript expr for implicit optional by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5717 - Ignore `Enum`-and-`str` subclasses for slots enforcement by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5749 - Avoid removing raw strings in comparison fixes by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5755 - Fix nested calls to `sorted` with differing arguments by [@density](https://togithub.com/density) in [astral-sh/ruff#5761 - Use unused variable detection to power `incorrect-dict-iterator` by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5763 - Include alias when formatting import-from structs by [@guillaumeLepape](https://togithub.com/guillaumeLepape) in [astral-sh/ruff#5786 - Make `lint_only` aware of the source kind by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5876 - Restore `redefined-while-unused` violations in classes by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5926 - Flatten nested tuples when fixing UP007 violations by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5724 - Ignore Jupyter Notebooks for `--add-noqa` by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5727 - Avoid checking `EXE001` and `EXE002` on WSL by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#5735 - Properly group assignment targets by [@MichaReiser](https://togithub.com/MichaReiser) in [astral-sh/ruff#5728 - Avoid stack overflow for non-BitOr binary types by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5743 - Move function visit out of `Expr::Call` branches by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5772 - \[B006] Add bytes to immutable types by [@harupy](https://togithub.com/harupy) in [astral-sh/ruff#5776 - Format `SetComp` by [@lkh42t](https://togithub.com/lkh42t) in [astral-sh/ruff#5774 - Gate `runtime-import-in-type-checking-block` (`TCH004`) behind enabled flag by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5789 - perf: only compute start offset for overlong lines by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5811 - Change `pandas-use-of-dot-read-table` rule to emit only when `read_table` is used on CSV data by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#5807 - Do not fix `NamedTuple` calls containing both a list of fields and keywords by [@harupy](https://togithub.com/harupy) in [astral-sh/ruff#5799 - Ignore directories when collecting files to lint by [@harupy](https://togithub.com/harupy) in [astral-sh/ruff#5775 - Add filename to `noqa` warnings by [@sobolevn](https://togithub.com/sobolevn) in [astral-sh/ruff#5856 - Handle io errors gracefully by [@konstin](https://togithub.com/konstin) in [astral-sh/ruff#5611 - Allow `respect_gitignore` when not in a git repo by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5937 #### New Contributors - [@eggplants](https://togithub.com/eggplants) made their first contribution in [astral-sh/ruff#5741 - [@guillaumeLepape](https://togithub.com/guillaumeLepape) made their first contribution in [astral-sh/ruff#5786 - [@odiseo0](https://togithub.com/odiseo0) made their first contribution in [astral-sh/ruff#5888 - [@DavidCain](https://togithub.com/DavidCain) made their first contribution in [astral-sh/ruff#5889 - [@LaBatata101](https://togithub.com/LaBatata101) made their first contribution in [astral-sh/ruff#5844 **Full Changelog**: astral-sh/ruff@v0.0.278...v0.0.279 </details> --- ### 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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/jankatins/pr-workflow-example).

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://beta.ruff.rs/docs) ([source](https://togithub.com/astral-sh/ruff), [changelog](https://togithub.com/astral-sh/ruff/releases)) | `==0.0.278` -> `==0.0.280` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/ruff/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/ruff/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/ruff/0.0.278/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/ruff/0.0.278/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>astral-sh/ruff (ruff)</summary> ### [`v0.0.280`](https://togithub.com/astral-sh/ruff/compare/v0.0.279...v0.0.280) [Compare Source](https://togithub.com/astral-sh/ruff/compare/v0.0.279...v0.0.280) ### [`v0.0.279`](https://togithub.com/astral-sh/ruff/releases/tag/v0.0.279) [Compare Source](https://togithub.com/astral-sh/ruff/compare/v0.0.278...v0.0.279)  #### What's Changed ##### Rules - \[`flake8-pyi`] Implement flake8-pyi's PYI026 by [@LaBatata101](https://togithub.com/LaBatata101) in [astral-sh/ruff#5844 - \[`flake8-pyi`] Implement flake8-pyi's `PYI017` by [@qdegraaf](https://togithub.com/qdegraaf) in [astral-sh/ruff#5895 - \[`flake8-pyi`] Implement flake8-pyi's `PYI036` by [@density](https://togithub.com/density) in [astral-sh/ruff#5668 - \[`flake8-pyi`] Implement flake8-pyi's `PYI041` by [@density](https://togithub.com/density) in [astral-sh/ruff#5722 - \[`flake8-use-pathlib`] Implement `os-path-getsize` and `os-path-get(a|m|c)-time` (`PTH202-205`) by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5835 - \[`flake8-use-pathlib`] Implement `path-constructor-default-argument` (`PTH201`) by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5833 - \[`pandas-vet`] Implement constant series rule (`PD101`) by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5802 - \[`pylint`] Implement Pylint's `consider-using-in` (`PLR1714`) by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#5193 ##### Rule changes - \[`flake8-annotations`] Check for `Any` in other types for `ANN401` by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5601 - \[`flake8-bugbear`] Add autofix for B004 by [@density](https://togithub.com/density) in [astral-sh/ruff#5788 - \[`flake8-bugbear`] Remove `B904`'s lowercase exemption by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5751 - \[`flake8-use-pathlib`] extend PTH118 with `os.sep` by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5935 - \[`pyupgrade`] Expand scope of `quoted-annotation` rule (`UP037`) by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5766 - \[`pyupgrade`] Extend PEP 604 rewrites to support some quoted annotations by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5725 - \[`ruff`] Expand `RUF015` to include all expression types by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5767 ##### Bug Fixes - Consider single element subscript expr for implicit optional by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5717 - Ignore `Enum`-and-`str` subclasses for slots enforcement by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5749 - Avoid removing raw strings in comparison fixes by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5755 - Fix nested calls to `sorted` with differing arguments by [@density](https://togithub.com/density) in [astral-sh/ruff#5761 - Use unused variable detection to power `incorrect-dict-iterator` by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5763 - Include alias when formatting import-from structs by [@guillaumeLepape](https://togithub.com/guillaumeLepape) in [astral-sh/ruff#5786 - Make `lint_only` aware of the source kind by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5876 - Restore `redefined-while-unused` violations in classes by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5926 - Flatten nested tuples when fixing UP007 violations by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5724 - Ignore Jupyter Notebooks for `--add-noqa` by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5727 - Avoid checking `EXE001` and `EXE002` on WSL by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#5735 - Properly group assignment targets by [@MichaReiser](https://togithub.com/MichaReiser) in [astral-sh/ruff#5728 - Avoid stack overflow for non-BitOr binary types by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5743 - Move function visit out of `Expr::Call` branches by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5772 - \[B006] Add bytes to immutable types by [@harupy](https://togithub.com/harupy) in [astral-sh/ruff#5776 - Format `SetComp` by [@lkh42t](https://togithub.com/lkh42t) in [astral-sh/ruff#5774 - Gate `runtime-import-in-type-checking-block` (`TCH004`) behind enabled flag by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5789 - perf: only compute start offset for overlong lines by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5811 - Change `pandas-use-of-dot-read-table` rule to emit only when `read_table` is used on CSV data by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#5807 - Do not fix `NamedTuple` calls containing both a list of fields and keywords by [@harupy](https://togithub.com/harupy) in [astral-sh/ruff#5799 - Ignore directories when collecting files to lint by [@harupy](https://togithub.com/harupy) in [astral-sh/ruff#5775 - Add filename to `noqa` warnings by [@sobolevn](https://togithub.com/sobolevn) in [astral-sh/ruff#5856 - Handle io errors gracefully by [@konstin](https://togithub.com/konstin) in [astral-sh/ruff#5611 - Allow `respect_gitignore` when not in a git repo by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5937 #### New Contributors - [@eggplants](https://togithub.com/eggplants) made their first contribution in [astral-sh/ruff#5741 - [@guillaumeLepape](https://togithub.com/guillaumeLepape) made their first contribution in [astral-sh/ruff#5786 - [@odiseo0](https://togithub.com/odiseo0) made their first contribution in [astral-sh/ruff#5888 - [@DavidCain](https://togithub.com/DavidCain) made their first contribution in [astral-sh/ruff#5889 - [@LaBatata101](https://togithub.com/LaBatata101) made their first contribution in [astral-sh/ruff#5844 **Full Changelog**: astral-sh/ruff@v0.0.278...v0.0.279 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/allenporter/pyrainbird).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://beta.ruff.rs/docs) ([source](https://togithub.com/astral-sh/ruff), [changelog](https://togithub.com/astral-sh/ruff/releases)) | `==0.0.278` -> `==0.0.280` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/ruff/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/ruff/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/ruff/0.0.278/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/ruff/0.0.278/0.0.280?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>astral-sh/ruff (ruff)</summary> ### [`v0.0.280`](https://togithub.com/astral-sh/ruff/releases/tag/v0.0.280) [Compare Source](https://togithub.com/astral-sh/ruff/compare/v0.0.279...v0.0.280)  #### What's Changed ##### Bug Fixes - Avoid collapsing `elif` and `else` branches during import sorting by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5964 **Full Changelog**: astral-sh/ruff@v0.0.279...v0.0.280 ### [`v0.0.279`](https://togithub.com/astral-sh/ruff/releases/tag/v0.0.279) [Compare Source](https://togithub.com/astral-sh/ruff/compare/v0.0.278...v0.0.279)  #### What's Changed ##### Rules - \[`flake8-pyi`] Implement flake8-pyi's PYI026 by [@LaBatata101](https://togithub.com/LaBatata101) in [astral-sh/ruff#5844 - \[`flake8-pyi`] Implement flake8-pyi's `PYI017` by [@qdegraaf](https://togithub.com/qdegraaf) in [astral-sh/ruff#5895 - \[`flake8-pyi`] Implement flake8-pyi's `PYI036` by [@density](https://togithub.com/density) in [astral-sh/ruff#5668 - \[`flake8-pyi`] Implement flake8-pyi's `PYI041` by [@density](https://togithub.com/density) in [astral-sh/ruff#5722 - \[`flake8-use-pathlib`] Implement `os-path-getsize` and `os-path-get(a|m|c)-time` (`PTH202-205`) by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5835 - \[`flake8-use-pathlib`] Implement `path-constructor-default-argument` (`PTH201`) by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5833 - \[`pandas-vet`] Implement constant series rule (`PD101`) by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5802 - \[`pylint`] Implement Pylint's `consider-using-in` (`PLR1714`) by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#5193 ##### Rule changes - \[`flake8-annotations`] Check for `Any` in other types for `ANN401` by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5601 - \[`flake8-bugbear`] Add autofix for B004 by [@density](https://togithub.com/density) in [astral-sh/ruff#5788 - \[`flake8-bugbear`] Remove `B904`'s lowercase exemption by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5751 - \[`flake8-use-pathlib`] extend PTH118 with `os.sep` by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5935 - \[`pyupgrade`] Expand scope of `quoted-annotation` rule (`UP037`) by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5766 - \[`pyupgrade`] Extend PEP 604 rewrites to support some quoted annotations by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5725 - \[`ruff`] Expand `RUF015` to include all expression types by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5767 ##### Bug Fixes - Consider single element subscript expr for implicit optional by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5717 - Ignore `Enum`-and-`str` subclasses for slots enforcement by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5749 - Avoid removing raw strings in comparison fixes by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5755 - Fix nested calls to `sorted` with differing arguments by [@density](https://togithub.com/density) in [astral-sh/ruff#5761 - Use unused variable detection to power `incorrect-dict-iterator` by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5763 - Include alias when formatting import-from structs by [@guillaumeLepape](https://togithub.com/guillaumeLepape) in [astral-sh/ruff#5786 - Make `lint_only` aware of the source kind by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5876 - Restore `redefined-while-unused` violations in classes by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5926 - Flatten nested tuples when fixing UP007 violations by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5724 - Ignore Jupyter Notebooks for `--add-noqa` by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5727 - Avoid checking `EXE001` and `EXE002` on WSL by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#5735 - Properly group assignment targets by [@MichaReiser](https://togithub.com/MichaReiser) in [astral-sh/ruff#5728 - Avoid stack overflow for non-BitOr binary types by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5743 - Move function visit out of `Expr::Call` branches by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5772 - \[B006] Add bytes to immutable types by [@harupy](https://togithub.com/harupy) in [astral-sh/ruff#5776 - Format `SetComp` by [@lkh42t](https://togithub.com/lkh42t) in [astral-sh/ruff#5774 - Gate `runtime-import-in-type-checking-block` (`TCH004`) behind enabled flag by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#5789 - perf: only compute start offset for overlong lines by [@sbrugman](https://togithub.com/sbrugman) in [astral-sh/ruff#5811 - Change `pandas-use-of-dot-read-table` rule to emit only when `read_table` is used on CSV data by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#5807 - Do not fix `NamedTuple` calls containing both a list of fields and keywords by [@harupy](https://togithub.com/harupy) in [astral-sh/ruff#5799 - Ignore directories when collecting files to lint by [@harupy](https://togithub.com/harupy) in [astral-sh/ruff#5775 - Add filename to `noqa` warnings by [@sobolevn](https://togithub.com/sobolevn) in [astral-sh/ruff#5856 - Handle io errors gracefully by [@konstin](https://togithub.com/konstin) in [astral-sh/ruff#5611 - Allow `respect_gitignore` when not in a git repo by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#5937 #### New Contributors - [@eggplants](https://togithub.com/eggplants) made their first contribution in [astral-sh/ruff#5741 - [@guillaumeLepape](https://togithub.com/guillaumeLepape) made their first contribution in [astral-sh/ruff#5786 - [@odiseo0](https://togithub.com/odiseo0) made their first contribution in [astral-sh/ruff#5888 - [@DavidCain](https://togithub.com/DavidCain) made their first contribution in [astral-sh/ruff#5889 - [@LaBatata101](https://togithub.com/LaBatata101) made their first contribution in [astral-sh/ruff#5844 **Full Changelog**: astral-sh/ruff@v0.0.278...v0.0.279 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/allenporter/flux-local).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

LaBatata101 added 2 commits July 17, 2023 19:35

add docs

eb3e654