Skip to content

Add unconditional import when type checking #6500

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 3 commits into from
Closed

Add unconditional import when type checking #6500

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89d3fa2
unconditional import during type checking
kandluis Mar 17, 2021
b0d57b5
fix pep8
kandluis Mar 17, 2021
a862e32
Single vs double quotes to reduce noise
kandluis Mar 17, 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
22 changes: 18 additions & 4 deletions pytorch_lightning/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import os
import sys
import time
import typing

_this_year = time.strftime("%Y")
__version__ = '1.3.0dev'
Expand Down Expand Up @@ -50,6 +51,7 @@
_PACKAGE_ROOT = os.path.dirname(__file__)
_PROJECT_ROOT = os.path.dirname(_PACKAGE_ROOT)


try:
# This variable is injected in the __builtins__ by the build
# process. It used to enable importing subpackages of skimage when
Expand All @@ -58,10 +60,16 @@
except NameError:
__LIGHTNING_SETUP__: bool = False

if __LIGHTNING_SETUP__: # pragma: no-cover
sys.stdout.write(f'Partial import of `{__name__}` during the build process.\n') # pragma: no-cover
# We are not importing the rest of the lightning during the build process, as it may not be compiled yet
else:

if typing.TYPE_CHECKING:
# Simplify the imports for the static type checker.
from pytorch_lightning import metrics
from pytorch_lightning.callbacks import Callback
from pytorch_lightning.core import LightningDataModule, LightningModule
from pytorch_lightning.trainer import Trainer
from pytorch_lightning.utilities.seed import seed_everything

elif not __LIGHTNING_SETUP__: # pragma: no-cover
from pytorch_lightning import metrics
from pytorch_lightning.callbacks import Callback
from pytorch_lightning.core import LightningDataModule, LightningModule
Expand All @@ -76,6 +84,12 @@
'seed_everything',
'metrics',
]
else:
sys.stdout.write(
f'Partial import of `{__name__}` during the build process.\n'
) # pragma: no-cover
# We are not importing the rest of the lightning during the build process, as it may not be compiled yet


# for compatibility with namespace packages
__import__('pkg_resources').declare_namespace(__name__)