[pydoclint] Teach rules to understand reraised exceptions as being explicitly raised
#12639
Conversation
This file contains 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
…explicitly raised
AlexWaygood
added
rule
AlexWaygood
commented
Aug 2, 2024
Comment on lines
-574
to
-584
| fn extract_raised_exception<'a>( | ||
| semantic: &SemanticModel<'a>, | ||
| exc: &'a Expr, | ||
| ) -> Option<QualifiedName<'a>> { | ||
| if let Some(qualified_name) = semantic.resolve_qualified_name(exc) { | ||
| return Some(qualified_name); | ||
| } | ||
| if let Expr::Call(ast::ExprCall { func, .. }) = exc { | ||
| return extract_raised_exception(semantic, func.as_ref()); | ||
| } | ||
| None |
There was a problem hiding this comment.
I got rid of this helper by using map_callable() before passing the node to resolve_qualified_name in visit_stmt
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| DOC501 | 109 | 109 | 0 | 0 | 0 |
charliermarsh
approved these changes
Aug 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes #12630.
DOC501 and DOC502 now understand functions with constructs like this to be explicitly raising
TypeError(which should be documented in a function's docstring):I made an exception for
ExceptionandBaseException, however. Constructs like this are reasonably common, and I don't think anybody would say that it's worth putting in the docstring that it raises "some kind of generic exception":Test Plan
cargo test -p ruff_linter --lib