psutil: Type ad_value as object#14106
Open
vnmabus wants to merge 1 commit into
Open
Conversation
After python#14063, calls to `psutil.process_iter` and `psutil.Process.as_dict` are being reported by Pyright, as the `ad_value` parameter is untyped. However, given that (from the documentation) this is just a placeholder value to use when an error is raised while fetching some attribute, I think that typing it as `object` is appropriate.
Contributor
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
srittau
requested changes
May 20, 2025
srittau
left a comment
srittau
left a comment
Collaborator
There was a problem hiding this comment.
Considering that the supplied type influenced the result type (but we can't express that relation properly), Any is a bit more appropriate. Also, we need to document uses of Any, see suggestions below.
| def oneshot(self) -> AbstractContextManager[None]: ... | ||
| def as_dict( | ||
| self, attrs: list[str] | tuple[str, ...] | set[str] | frozenset[str] | None = None, ad_value=None | ||
| self, attrs: list[str] | tuple[str, ...] | set[str] | frozenset[str] | None = None, ad_value: object = None |
Collaborator
There was a problem hiding this comment.
Suggested change
| self, attrs: list[str] | tuple[str, ...] | set[str] | frozenset[str] | None = None, ad_value: object = None | |
| self, | |
| attrs: list[str] | tuple[str, ...] | set[str] | frozenset[str] | None = None, | |
| ad_value: Any = None, # arbitrary value used as result in case of error |
| def pid_exists(pid: int) -> bool: ... | ||
| def process_iter( | ||
| attrs: list[str] | tuple[str, ...] | set[str] | frozenset[str] | None = None, ad_value=None | ||
| attrs: list[str] | tuple[str, ...] | set[str] | frozenset[str] | None = None, ad_value: object = None |
Collaborator
There was a problem hiding this comment.
Suggested change
| attrs: list[str] | tuple[str, ...] | set[str] | frozenset[str] | None = None, ad_value: object = None | |
| attrs: list[str] | tuple[str, ...] | set[str] | frozenset[str] | None = None, | |
| ad_value: Any = None, # arbitrary value used as result in case of error |
Author
Can't we? Wouldn't be possible to create a (fake) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
After #14063, calls to
psutil.process_iterandpsutil.Process.as_dictare being reported by Pyright, as thead_valueparameter is untyped.However, given that (from the documentation) this is just a placeholder value to use when an error is raised while fetching some attribute, I think that typing it as
objectis appropriate.