mirror of https://github.com/astral-sh/ruff
45fb3732a4
<!-- Thank you for contributing to Ruff/ty! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? (Please prefix with `[ty]` for ty pull requests.) - Does this pull request include references to any relevant issues? --> ## Summary Fixes https://github.com/astral-sh/ruff/issues/8774 This PR fixes `pydocstyle` incorrectly flagging missing argument for arguments with `Unpack` type annotation by extracting the `kwarg` `D417` suppression logic into a helper function for future rules as needed. ## Problem Statement The below example was incorrectly triggering `D417` error for missing `**kwargs` doc. ```python class User(TypedDict): id: int name: str def do_something(some_arg: str, **kwargs: Unpack[User]): """Some doc Args: some_arg: Some argument """ ``` <img width="1135" height="276" alt="image" src="https://github.com/user-attachments/assets/42fa4bb9-61a5-4a70-a79c-0c8922a3ee66" /> `**kwargs: Unpack[User]` indicates the function expects keyword arguments that will be unpacked. Ideally, the individual fields of the User `TypedDict` should be documented, not in the `**kwargs` itself. The `**kwargs` parameter acts as a semantic grouping rather than a parameter requiring documentation. ## Solution As discussed in the linked issue, it makes sense to suppress the `D417` for parameters with `Unpack` annotation. I extract a helper function to solely check `D417` should be suppressed with `**kwarg: Unpack[T]` parameter, this function can also be unit tested independently and reduce complexity of current `missing_args` check function. This also makes it easier to add additional rules in the future. _✏️ Note:_ This is my first PR in this repo, as I've learned a ton from it, please call out anything that could be improved. Thanks for making this excellent tool 👏 ## Test Plan Add 2 test cases in `D417.py` and update snapshots. --------- Co-authored-by: Brent Westbrook <36778786+ntBre@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| D104 | ||
| _unrelated | ||
| D.py | ||
| D100.ipynb | ||
| D200.py | ||
| D202.py | ||
| D208.py | ||
| D209_D400.py | ||
| D214_module.py | ||
| D215.py | ||
| D300.py | ||
| D301.py | ||
| D400.py | ||
| D400_415.py | ||
| D401.py | ||
| D402.py | ||
| D403.py | ||
| D410.py | ||
| D413.py | ||
| D417.py | ||
| all.py | ||
| bom.py | ||
| canonical_google_examples.py | ||
| canonical_numpy_examples.py | ||
| sections.py | ||
| setter.py | ||
| sphinx.py | ||