fix #88, add import deprecation warning

Author: bckohan

README.md

@@ -31,6 +31,16 @@ Please refer to the [full documentation](https://django-typer.readthedocs.io/) f
 
 ![django-typer example](https://raw.githubusercontent.com/bckohan/django-typer/main/doc/source/_static/img/closepoll_example.gif)
 
+**Imports from ``django_typer`` **have been deprecated and will be removed in 3.0! Imports have moved to ``django_typer.management``:**
+
+```python
+   # old way
+   from django_typer import TyperCommand, command, group, initialize, Typer
+
+   # new way!
+   from django_typer.management import TyperCommand, command, group, initialize, Typer
+```
+
 ## Installation
 
 1. Clone django-typer from GitHub or install a release off [PyPI](https://pypi.org/project/django-typer/):

django_typer/__init__.py

@@ -31,21 +31,21 @@
 
 # WARNING - these imports are going away in version 3!
 # import them from django_typer.management directly
-from .management import (
-    CommandNode,  # noqa: F401
-    Context,  # noqa: F401
-    DjangoTyperMixin,  # noqa: F401
-    DTCommand,  # noqa: F401
-    DTGroup,  # noqa: F401
-    Typer,  # noqa: F401
-    TyperCommand,  # noqa: F401
-    callback,  # noqa: F401
-    command,  # noqa: F401
-    get_command,  # noqa: F401
-    group,  # noqa: F401
-    initialize,  # noqa: F401
-    model_parser_completer,  # noqa: F401
-)
+# from .management import (
+#     CommandNode,  # noqa: F401
+#     Context,  # noqa: F401
+#     DjangoTyperMixin,  # noqa: F401
+#     DTCommand,  # noqa: F401
+#     DTGroup,  # noqa: F401
+#     Typer,  # noqa: F401
+#     TyperCommand,  # noqa: F401
+#     callback,  # noqa: F401
+#     command,  # noqa: F401
+#     get_command,  # noqa: F401
+#     group,  # noqa: F401
+#     initialize,  # noqa: F401
+#     model_parser_completer,  # noqa: F401
+# )
 
 VERSION = (2, 1, 0)
 

django_typer/apps.py

@@ -5,38 +5,33 @@
 
 import inspect
 import os
+import sys
 import typing as t
-from types import ModuleType
 
 from django.apps import AppConfig
 from django.conf import settings
 from django.core.checks import CheckMessage, register
 from django.core.checks import Warning as CheckWarning
 from django.utils.translation import gettext as _
 
-from django_typer import patch
-from django_typer.utils import traceback_config
+from .config import traceback_config
 
-patch.apply()
+tb_config = traceback_config()
+try_install = isinstance(tb_config, dict) and not tb_config.get("no_install", False)
 
-rich: t.Optional[ModuleType]
-traceback: t.Optional[ModuleType]
+if try_install:
+    try:
+        import rich
+        from rich import traceback
 
-try:
-    import sys
+        from django_typer import patch
 
-    import rich
-    from rich import traceback
-    from typer import main as typer_main
+        patch.apply()
+
+        from typer import main as typer_main
 
-    tb_config = traceback_config()
-    if (
-        rich
-        and traceback
-        and isinstance(tb_config, dict)
-        and not tb_config.get("no_install", False)
-    ):
         # install rich tracebacks if we've been configured to do so (default)
+        assert isinstance(tb_config, dict)
         no_color = "NO_COLOR" in os.environ
         force_color = "FORCE_COLOR" in os.environ
         traceback.install(
@@ -64,9 +59,9 @@
         # on when typer was imported it may have the original fallback system hook or our
         # installed rich one - we patch it here to make sure!
         typer_main._original_except_hook = sys.excepthook
-except ImportError:
-    rich = None
-    traceback = None
+
+    except ImportError:
+        pass
 
 
 @register("settings")
@@ -76,15 +71,17 @@ def check_traceback_config(app_configs, **kwargs) -> t.List[CheckMessage]:
     contains only the expected parameters.
     """
     warnings: t.List[CheckMessage] = []
-    tb_cfg = traceback_config()
-    if isinstance(tb_cfg, dict):
-        if rich and traceback:
+    if try_install:
+        assert isinstance(tb_config, dict)
+        try:
+            from rich import traceback
+
             expected = {
                 "no_install",
                 "short",
                 *inspect.signature(traceback.install).parameters.keys(),
             }
-            unexpected = set(tb_cfg.keys()) - expected
+            unexpected = set(tb_config.keys()) - expected
             if unexpected:
                 warnings.append(
                     CheckWarning(
@@ -96,6 +93,8 @@ def check_traceback_config(app_configs, **kwargs) -> t.List[CheckMessage]:
                         id="django_typer.W001",
                     )
                 )
+        except ImportError:
+            pass
     return warnings
 
 

django_typer/config.py

@@ -0,0 +1,18 @@
+import typing as t
+
+from django.conf import settings
+
+
+def traceback_config() -> t.Union[bool, t.Dict[str, t.Any]]:
+    """
+    Fetch the rich traceback installation parameters from our settings. By default
+    rich tracebacks are on with show_locals = True. If the config is set to False
+    or None rich tracebacks will not be installed even if the library is present.
+
+    This allows us to have a common traceback configuration for all commands. If rich
+    tracebacks are managed separately this setting can also be switched off.
+    """
+    cfg = getattr(settings, "DT_RICH_TRACEBACK_CONFIG", {"show_locals": True})
+    if cfg:
+        return {"show_locals": True, **cfg}
+    return bool(cfg)

django_typer/management/__init__.py

@@ -32,6 +32,7 @@
 from typer.models import Default, DefaultPlaceholder  # noqa: E402
 
 from ..completers import ModelObjectCompleter  # noqa: E402
+from ..config import traceback_config  # noqa: E402
 from ..parsers import ModelObjectParser  # noqa: E402
 from ..types import (  # noqa: E402
     ForceColor,
@@ -50,7 +51,6 @@
     called_from_module,
     get_usage_script,
     is_method,
-    traceback_config,
     with_typehint,
 )
 

django_typer/utils.py

@@ -14,7 +14,7 @@
 from threading import local
 from types import MethodType, ModuleType
 
-from django.conf import settings
+from .config import traceback_config
 
 # DO NOT IMPORT ANYTHING FROM TYPER HERE - SEE patch.py
 
@@ -46,21 +46,6 @@ def get_usage_script(script: t.Optional[str] = None) -> t.Union[Path, str]:
         return cmd_pth.absolute()
 
 
-def traceback_config() -> t.Union[bool, t.Dict[str, t.Any]]:
-    """
-    Fetch the rich traceback installation parameters from our settings. By default
-    rich tracebacks are on with show_locals = True. If the config is set to False
-    or None rich tracebacks will not be installed even if the library is present.
-
-    This allows us to have a common traceback configuration for all commands. If rich
-    tracebacks are managed separately this setting can also be switched off.
-    """
-    cfg = getattr(settings, "DT_RICH_TRACEBACK_CONFIG", {"show_locals": True})
-    if cfg:
-        return {"show_locals": True, **cfg}
-    return bool(cfg)
-
-
 _command_context = local()
 
 

doc/source/changelog.rst

@@ -5,6 +5,20 @@ Change Log
 v2.1.0
 ======
 
+.. warning::
+
+    **Imports from** ``django_typer`` **have been deprecated and will be removed in 3.0!** Imports
+    have moved to ``django_typer.management``:
+
+    .. code-block::
+
+        # old way
+        from django_typer import TyperCommand, command, group, initialize, Typer
+
+        # new way!
+        from django_typer.management import TyperCommand, command, group, initialize, Typer
+
+* Implemented `Only attempt to import rich and typer if settings has not disabled tracebacks. <https://github.com/bckohan/django-typer/issues/88>`_
 * Implemented `Move tests into top level dir. <https://github.com/bckohan/django-typer/issues/87>`_
 * Implemented `Move core code out of __init__.py into management/__init__.py <https://github.com/bckohan/django-typer/issues/81>`_
 * Fixed `Typer(help="") doesnt work. <https://github.com/bckohan/django-typer/issues/78>`_

doc/source/index.rst

@@ -28,6 +28,18 @@ familiar with. All of the BaseCommand_ functionality is preserved, so that
       commands.
     * Add plugins to upstream commands.
 
+.. warning::
+
+    **Imports from** ``django_typer`` **have been deprecated and will be removed in 3.0!** Imports
+    have moved to ``django_typer.management``:
+
+    .. code-block::
+
+        # old way
+        from django_typer import TyperCommand, command, group, initialize, Typer
+
+        # new way!
+        from django_typer.management import TyperCommand, command, group, initialize, Typer
 
 :big:`Installation`
 

tests/settings/no_django_typer.py

@@ -1,7 +1,6 @@
 from .base import *
 
 INSTALLED_APPS = [
-    #"django_typer",
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",