seaborn: mark simple deprecations with typing_extensions.deprecated #11130
Conversation
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
hamdanal
commented
Dec 9, 2023
stubs/seaborn/seaborn/algorithms.pyi
Outdated
| random_seed: _Seed | None = None, # deprecated | ||
| ) -> NDArray[Any]: ... | ||
| @overload | ||
| @deprecated("Parameter `random_seed` is deprecated in favor of `seed`") |
There was a problem hiding this comment.
| @@ -92,6 +92,7 @@ class _BaseGrid: | |||
| **kwargs: Any, | |||
| ) -> Self: ... | |||
| @property | |||
| @deprecated("Attribute `fig` is deprecated in favor of `figure`") | |||
There was a problem hiding this comment.
| @@ -139,7 +139,8 @@ def displot( | |||
| facet_kws: dict[str, Any] | None = None, | |||
| **kwargs: Any, | |||
| ) -> FacetGrid: ... | |||
| def distplot( # deprecated | |||
| @deprecated("Function `distplot` is deprecated and will be removed in seaborn v0.14.0") | |||
There was a problem hiding this comment.
| # def set(*args, **kwargs) -> None: ... # deprecated alias for set_theme | ||
| set = set_theme | ||
|
|
||
| @deprecated("Function `set` is deprecated in favor of `set_theme`") |
There was a problem hiding this comment.
| @@ -75,7 +75,8 @@ def saturate(color: ColorType) -> tuple[float, float, float]: ... | |||
| def set_hls_values( | |||
| color: ColorType, h: float | None = None, l: float | None = None, s: float | None = None | |||
| ) -> tuple[float, float, float]: ... | |||
| def axlabel(xlabel: str, ylabel: str, **kwargs: Any) -> None: ... # deprecated | |||
| @deprecated("Function `axlabel` is deprecated and will be removed in a future version") | |||
There was a problem hiding this comment.
This comment has been minimized.
This comment has been minimized.
|
Is the stubtest crash a known issue? |
Yeah, it's fixed on mypy master, the fix should be included as part of mypy 1.8 :) |
This comment has been minimized.
This comment has been minimized.
Thank you. I just confirmed that the change passes on mypy's |
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
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.
Note that I intentionally left out deprecated parameters of the big API functions as they would require overloads with very long signatures.