Skip to content

Fix mypy typing for utilities.warnings #8786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Fix mypy typing for utilities.warnings #8786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
404e244
Fix mypy typing for .
stancld Aug 7, 2021
b064501
Clean import
stancld Aug 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ module = [
"pytorch_lightning.utilities.distributed",
"pytorch_lightning.utilities.memory",
"pytorch_lightning.utilities.parsing",
"pytorch_lightning.utilities.warnings",
"pytorch_lightning.utilities.xla_device",
]
ignore_errors = "False"
15 changes: 9 additions & 6 deletions pytorch_lightning/utilities/warnings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,20 @@
"""Warning-related utilities"""
import warnings
from functools import partial
from typing import Any, Type, Union

from pytorch_lightning.utilities.distributed import rank_zero_only


def _warn(*args, stacklevel: int = 2, **kwargs):
warnings.warn(*args, stacklevel=stacklevel, **kwargs)
def _warn(m: Union[str, Warning], category: Union[Type[Warning], Any], stacklevel: int = 2, **kwargs: Any) -> None:
warnings.warn(m, category, stacklevel=stacklevel, **kwargs)


@rank_zero_only
def rank_zero_warn(*args, stacklevel: int = 4, **kwargs):
_warn(*args, stacklevel=stacklevel, **kwargs)
def rank_zero_warn(
m: Union[str, Warning], category: Union[Type[Warning], Any], stacklevel: int = 4, **kwargs: Any
) -> None:
_warn(m, category, stacklevel=stacklevel, **kwargs)


class LightningDeprecationWarning(DeprecationWarning):
Expand All @@ -38,12 +41,12 @@ class LightningDeprecationWarning(DeprecationWarning):


class WarningCache(set):
def warn(self, m, *args, stacklevel: int = 5, **kwargs):
def warn(self, m: str, *args: Any, stacklevel: int = 5, **kwargs: Any) -> None:
if m not in self:
self.add(m)
rank_zero_warn(m, *args, stacklevel=stacklevel, **kwargs)

def deprecation(self, m, *args, stacklevel: int = 5, **kwargs):
def deprecation(self, m: str, *args: Any, stacklevel: int = 5, **kwargs: Any) -> None:
if m not in self:
self.add(m)
rank_zero_deprecation(m, *args, stacklevel=stacklevel, **kwargs)