flake8-annotations: add ignore-fully-untyped by akx · Pull Request #2128 · astral-sh/ruff

akx · 2023-01-24T13:59:57Z

This PR adds a configuration option to inhibit ANN* violations for functions that have no other annotations either, for easier gradual typing of a large codebase (looking at you, Home Assistant 😁).

src/flake8_to_ruff/converter.rs

charliermarsh · 2023-01-24T14:25:20Z

Would functions to which this applies not trigger ANN100 et al for each untyped argument? What's the configuration that would make this useful? Suppressing ANN100 plus enabling this to allow fully untyped functions + require return types for any partially typed functions?

akx · 2023-01-24T14:45:06Z

Replying to both comments here 😄

Generally, we only need to add these if the source plugin defines them. But I don't think this option exists in flake8-annotations, does it?

I don't think it does, that's right, but I feel this is an useful check to make ANN2* less blanket-y. See below...

What's the configuration that would make this useful?

I should have probably mentioned this in the PR proper, but this is meant as a replacement for this pylint plugin in Home Assistant: ('__init__ should have explicit return type "None"' – Used when __init__ has all arguments typed but doesn't have return type declared).

In particular, enabling ANN204 on Home Assistant's repo right now yields oodles (1108 in particular) of these warnings for files that haven't been fully strictly typed yet; this option makes that number, well, 1. 😂

(The other (bad, cumbersome) option I see would be to allow setting per-file-select or similar, and configure it to align with https://github.com/home-assistant/core/blob/dev/.strict-typing.)

charliermarsh · 2023-01-24T14:58:19Z

Ah, okay, yeah, I see. That makes sense.

(In practice, this would be coupled with disabling the ANN00-level rules, right? Again, just confirming my understanding.)

akx · 2023-01-24T15:01:08Z

(In practice, this would be coupled with disabling the ANN00-level rules, right? Again, just confirming my understanding.)

Yep, my idea is to enable just ANN204 with this configuration for now to emulate what the pylint plugin does.

charliermarsh · 2023-01-26T23:46:28Z

I wonder if this should be made into a more general setting: if a definition doesn't have any types, suppress all ANN rules. That way, you wouldn't need to turn off the ANN00* rules. But they would get flagged if you had a return type, but not argument types.

akx · 2023-01-27T15:53:09Z

@charliermarsh Yeah, that sounds good too. tool.ruff.flake8-annotations.all-or-nothing = true? 😁

charliermarsh · 2023-01-27T16:16:28Z

ignore-fully-untyped?

charliermarsh

(Just requesting changes to help me manage my queue, no rush.)

src/rules/flake8_annotations/rules.rs

charliermarsh · 2023-02-04T21:27:57Z

Is this ready for review?

akx · 2023-02-07T15:36:29Z

@charliermarsh Yeah, sorry, it's ready for review now! 😄 I'm not sure why the mypy_init_return snapshot changed though...

…hars]] Implements astral-sh#2128: `Literal["abba"]` is now recognized as a subtype of `Sequence[Literal["a", "b"]]`. Changes: - Add `KnownClass::Sequence` as a known protocol class from `typing` - Extend `has_relation_to_impl` to check if a string literal's unique characters are all subtypes of the Sequence's element type - Add mdtests covering positive cases, negative cases, and edge cases (empty strings, unicode, multi-char literals) The implementation first tries the standard `str` fallback. If that fails and the target is `Sequence[X]`, it verifies each unique character in the string literal is a subtype of `X`, accumulating constraints properly via `when_all`. Closes astral-sh#2128

…hars]] Implements astral-sh#2128: `Literal["abba"]` is now recognized as a subtype of `Sequence[Literal["a", "b"]]`. Changes: - Add `KnownClass::Sequence` as a known protocol class from `typing` - Extend `has_relation_to_impl` to check if a string literal's unique characters are all subtypes of the Sequence's element type - Add mdtests covering positive cases, negative cases, and edge cases Closes astral-sh#2128

charliermarsh reviewed Jan 24, 2023

View reviewed changes

src/flake8_to_ruff/converter.rs Outdated Show resolved Hide resolved

akx force-pushed the ann-allow-untyped-return-if-untyped branch from a665839 to 5727594 Compare January 24, 2023 14:50

not-my-profile mentioned this pull request Jan 24, 2023

Feature request: support for flake8-annotations #579

Closed

charliermarsh requested changes Jan 29, 2023

View reviewed changes

akx force-pushed the ann-allow-untyped-return-if-untyped branch 2 times, most recently from 12b445e to 1fef299 Compare February 2, 2023 11:53

akx changed the title ~~flake8-annotations: add allow_untyped_return_if_untyped~~ flake8-annotations: add allow-untyped-return-if-untyped & ignore-fully-untyped Feb 2, 2023

akx requested a review from charliermarsh February 2, 2023 12:06

charliermarsh reviewed Feb 2, 2023

View reviewed changes

src/rules/flake8_annotations/rules.rs Outdated Show resolved Hide resolved

akx force-pushed the ann-allow-untyped-return-if-untyped branch from 1fef299 to b7e8121 Compare February 2, 2023 20:21

akx changed the title ~~flake8-annotations: add allow-untyped-return-if-untyped & ignore-fully-untyped~~ flake8-annotations: add ignore-fully-untyped Feb 2, 2023

akx force-pushed the ann-allow-untyped-return-if-untyped branch from b7e8121 to 72e753c Compare February 2, 2023 20:25

akx marked this pull request as draft February 2, 2023 20:25

akx force-pushed the ann-allow-untyped-return-if-untyped branch 2 times, most recently from f51861a to 679983a Compare February 3, 2023 10:17

akx mentioned this pull request Feb 4, 2023

Update Ruff to 0.0.241 home-assistant/core#87386

Merged

15 tasks

akx force-pushed the ann-allow-untyped-return-if-untyped branch from 679983a to 73d9ac0 Compare February 4, 2023 11:27

akx force-pushed the ann-allow-untyped-return-if-untyped branch from 73d9ac0 to 12fc824 Compare February 6, 2023 07:25

flake8-annotations: use Default in tests

ba8cf57

akx force-pushed the ann-allow-untyped-return-if-untyped branch from 12fc824 to a40ef50 Compare February 7, 2023 14:54

flake8-annotations: add ignore_fully_untyped

9a52b4a

akx force-pushed the ann-allow-untyped-return-if-untyped branch from a40ef50 to 9a52b4a Compare February 7, 2023 15:27

Update mypy_init_return snapshot... for some reason

01fdc18

akx marked this pull request as ready for review February 7, 2023 15:35

charliermarsh added 2 commits February 7, 2023 11:25

Merge branch 'main' into ann-allow-untyped-return-if-untyped

9eb18cc

Dedent; fix false positive on typed function arguments

f359c6b

charliermarsh approved these changes Feb 7, 2023

View reviewed changes

charliermarsh merged commit 2bc16eb into astral-sh:main Feb 7, 2023

charliermarsh added configuration Related to settings and configuration typing Related to type annotations labels Feb 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

flake8-annotations: add ignore-fully-untyped#2128

flake8-annotations: add ignore-fully-untyped#2128
charliermarsh merged 5 commits intoastral-sh:mainfrom
akx:ann-allow-untyped-return-if-untyped

akx commented Jan 24, 2023 •

edited

Loading

Uh oh!

Uh oh!

charliermarsh commented Jan 24, 2023

Uh oh!

akx commented Jan 24, 2023

Uh oh!

charliermarsh commented Jan 24, 2023

Uh oh!

akx commented Jan 24, 2023

Uh oh!

charliermarsh commented Jan 26, 2023

Uh oh!

akx commented Jan 27, 2023

Uh oh!

charliermarsh commented Jan 27, 2023

Uh oh!

charliermarsh left a comment

Uh oh!

Uh oh!

charliermarsh commented Feb 4, 2023

Uh oh!

akx commented Feb 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

akx commented Jan 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

charliermarsh commented Jan 24, 2023

Uh oh!

akx commented Jan 24, 2023

Uh oh!

charliermarsh commented Jan 24, 2023

Uh oh!

akx commented Jan 24, 2023

Uh oh!

charliermarsh commented Jan 26, 2023

Uh oh!

akx commented Jan 27, 2023

Uh oh!

charliermarsh commented Jan 27, 2023

Uh oh!

charliermarsh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

charliermarsh commented Feb 4, 2023

Uh oh!

akx commented Feb 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

akx commented Jan 24, 2023 •

edited

Loading