meta,api: lazy load fact and operation modules (#1609)

Author: Dexmachi

src/pyinfra/api/__init__.py

@@ -1,5 +1,5 @@
-from .command import FileDownloadCommand  # noqa: F401 # pragma: no cover
 from .command import (  # noqa: F401
+    FileDownloadCommand,  # noqa: F401 # pragma: no cover
     FileUploadCommand,
     FunctionCommand,
     MaskString,
@@ -9,12 +9,12 @@
 )
 from .config import Config  # noqa: F401 # pragma: no cover
 from .deploy import deploy  # noqa: F401 # pragma: no cover
-from .exceptions import DeployError  # noqa: F401 # pragma: no cover
 from .exceptions import (  # noqa: F401
+    DeployError,  # noqa: F401 # pragma: no cover
     FactError,
+    FactProcessError,
     FactTypeError,
     FactValueError,
-    FactProcessError,
     InventoryError,
     OperationError,
     OperationTypeError,

src/pyinfra/api/operations.py

@@ -200,8 +200,8 @@ def _run_host_op(state: "State", host: "Host", op_hash: str) -> bool:
         if retry_attempt > 0:
             _status_text = f"{_status_text} on retry {retry_attempt}"
 
-        _click_log_status = click.style(_status_text, "green" if executed_commands > 0 else "cyan")
-        logger.info("{0}{1}".format(host.print_prefix, _click_log_status))
+        _log_status = click.style(_status_text, "green" if executed_commands > 0 else "cyan")
+        logger.info("{0}{1}".format(host.print_prefix, _log_status))
 
         state.trigger_callbacks("operation_host_success", host, op_hash, retry_attempt)
     else:

src/pyinfra/facts/__init__.py

@@ -1,12 +1,21 @@
-# This file only exists to support:
-# from pyinfra import facts
-# facts.X.Y
-
+import importlib
 from glob import glob
 from os import path
 
-module_filenames = glob(path.join(path.dirname(__file__), "*.py"))
-module_names = [path.basename(name)[:-3] for name in module_filenames]
-__all__ = [name for name in module_names if name != "__init__"]
+_module_filenames = glob(path.join(path.dirname(__file__), "*.py"))
+__all__ = sorted(
+    set(path.basename(name)[:-3] for name in _module_filenames if not name.endswith("__init__.py"))
+)
+
+
+def __getattr__(name):
+    # On-demand import of facts modules, so we don't have to import them all at once
+    # this forces py3.7>=, but that's fine as py2 is EOL and py3.6 is also EOL
+    # Also, Pyinfra is py3.11>=, so this is not a breaking change.
+    if name in __all__:
+        return importlib.import_module(f".{name}", __package__)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
 
-from . import *  # noqa
+def __dir__():
+    return __all__

src/pyinfra/operations/__init__.py

@@ -1,12 +1,21 @@
-# This file only exists to support:
-# from pyinfra import operations
-# operations.X.Y
-
+import importlib
 from glob import glob
 from os import path
 
-module_filenames = glob(path.join(path.dirname(__file__), "*.py"))
-module_names = [path.basename(name)[:-3] for name in module_filenames]
-__all__ = [name for name in module_names if name != "__init__"]
+_module_filenames = glob(path.join(path.dirname(__file__), "*.py"))
+__all__ = sorted(
+    set(path.basename(name)[:-3] for name in _module_filenames if not name.endswith("__init__.py"))
+)
+
+
+def __getattr__(name):
+    # On-demand import of operations modules, so we don't have to import them all at once
+    # this forces py3.7>=, but that's fine as py2 is EOL and py3.6 is also EOL
+    # Also, Pyinfra is py3.11>=, so this is not a breaking change.
+    if name in __all__:
+        return importlib.import_module(f".{name}", __package__)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
 
-from . import *  # noqa
+def __dir__():
+    return __all__

src/pyinfra/operations/freebsd/__init__.py

@@ -1,12 +1,17 @@
-# This file only exists to support:
-# from pyinfra.operations import freebsd
-# freebsd.X.Y
-
+import importlib
 from glob import glob
 from os import path
 
-module_filenames = glob(path.join(path.dirname(__file__), "*.py"))
-module_names = [path.basename(name)[:-3] for name in module_filenames]
-__all__ = [name for name in module_names if name != "__init__"]
+_module_filenames = glob(path.join(path.dirname(__file__), "*.py"))
+__all__ = sorted(
+    set(path.basename(name)[:-3] for name in _module_filenames if not name.endswith("__init__.py"))
+)
+
 
-from . import *  # noqa
+def __getattr__(name):
+    # On-demand import of operations modules, so we don't have to import them all at once
+    # this forces py3.7>=, but that's fine as py2 is EOL and py3.6 is also EOL
+    # Also, Pyinfra is py3.11>=, so this is not a breaking change.
+    if name in __all__:
+        return importlib.import_module(f".{name}", __package__)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

tests/test_operations.py

@@ -88,6 +88,7 @@ def assert_commands(commands, wanted_commands):
 def make_operation_tests(arg):
     # Get the operation we're testing against
     module_name, op_name = arg.rsplit(".", 1)
+
     module = import_module("pyinfra.operations.{0}".format(module_name))
     op = getattr(module, op_name)