✨ Feature: disable lazy loading with env flag (#262)

Author: yanyongyu

codegen/templates/latest/models.py.jinja

@@ -4,7 +4,9 @@
 
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+from githubkit.lazy_module import is_lazy_disabled
+
+if TYPE_CHECKING or is_lazy_disabled():
     {% for name in model_names %}
     from {{ output_module }}.{{ latest_version_module }}.models import {{ name }} as {{ name }}
     {% endfor %}

codegen/templates/latest/types.py.jinja

@@ -4,7 +4,9 @@
 
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+from githubkit.lazy_module import is_lazy_disabled
+
+if TYPE_CHECKING or is_lazy_disabled():
     {% for name in model_names %}
     from {{ output_module }}.{{ latest_version_module }}.types import {{ name }}Type as {{ name }}Type
     {% endfor %}

codegen/templates/latest/webhooks.py.jinja

@@ -4,7 +4,9 @@
 
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+from githubkit.lazy_module import is_lazy_disabled
+
+if TYPE_CHECKING or is_lazy_disabled():
     {% for name in event_names %}
     from {{ output_module }}.{{ latest_version_module }}.webhooks import {{ pascal_case(name) }}Event as {{ pascal_case(name) }}Event
     from {{ output_module }}.{{ latest_version_module }}.webhooks import {{ name }}_action_types as {{ name }}_action_types

codegen/templates/models/models.py.jinja

@@ -4,7 +4,9 @@
 
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+from githubkit.lazy_module import is_lazy_disabled
+
+if TYPE_CHECKING or is_lazy_disabled():
     {% for group in groups %}
     {% for model in group.models %}
     from .{{ group_name(group, groups) }} import {{ model.class_name }} as {{ model.class_name }}

codegen/templates/models/types.py.jinja

@@ -4,7 +4,9 @@
 
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+from githubkit.lazy_module import is_lazy_disabled
+
+if TYPE_CHECKING or is_lazy_disabled():
     {% for group in groups %}
     {% for model in group.models %}
     from .{{ group_name(group, groups) }} import {{ model.get_param_type_string() }} as {{ model.get_param_type_string() }}

codegen/templates/webhooks/__init__.py.jinja

@@ -4,7 +4,9 @@
 
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+from githubkit.lazy_module import is_lazy_disabled
+
+if TYPE_CHECKING or is_lazy_disabled():
     {% for name in event_names %}
     from .{{ name }} import {{ pascal_case(name) }}Event as {{ pascal_case(name) }}Event
     from .{{ name }} import {{ name }}_action_types as {{ name }}_action_types

githubkit/__init__.py

@@ -1,6 +1,7 @@
 from . import lazy_module
 
-lazy_module.apply()
+if not lazy_module.is_lazy_disabled():
+    lazy_module.apply()
 
 from .auth import ActionAuthStrategy as ActionAuthStrategy
 from .auth import AppAuthStrategy as AppAuthStrategy

githubkit/lazy_module.py

@@ -3,11 +3,14 @@
 from importlib.abc import Loader
 from importlib.machinery import ModuleSpec, PathFinder, SourceFileLoader
 from itertools import chain
+import os
 import re
 import sys
 from types import ModuleType
 from typing import Any, Optional
 
+GITHUBKIT_LAZY_DISABLE_FLAG = "GITHUBKIT_LAZY_DISABLE_FLAG"
+
 LAZY_MODULES = (
     r"^githubkit\.rest$",
     r"^githubkit\.versions\.[^.]+\.models$",
@@ -142,5 +145,9 @@ def find_spec(
             return module_spec
 
 
+def is_lazy_disabled() -> bool:
+    return bool(os.getenv(GITHUBKIT_LAZY_DISABLE_FLAG))
+
+
 def apply():
     sys.meta_path.insert(0, LazyModuleFinder())

githubkit/rest/__init__.py

@@ -9,7 +9,9 @@
 
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+from githubkit.lazy_module import is_lazy_disabled
+
+if TYPE_CHECKING or is_lazy_disabled():
     from githubkit.versions.v2022_11_28.models import (
         ActionsArtifactAndLogRetention as ActionsArtifactAndLogRetention,
     )

githubkit/versions/ghec_v2022_11_28/models/__init__.py

@@ -9,7 +9,9 @@
 
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+from githubkit.lazy_module import is_lazy_disabled
+
+if TYPE_CHECKING or is_lazy_disabled():
     from .group_0000 import Root as Root
     from .group_0001 import CvssSeverities as CvssSeverities
     from .group_0001 import CvssSeveritiesPropCvssV3 as CvssSeveritiesPropCvssV3