fix #167

Author: bckohan

django_typer/management/__init__.py

@@ -2480,11 +2480,15 @@ class OutputWrapper(BaseOutputWrapper):
     returned from command functions.
     """
 
+    disable: bool = False
+
     def write(self, msg="", style_func=None, ending=None):
         """
         If the message is not a string, first cast it before invoking the base
         class write method.
         """
+        if self.disable:
+            return
         if not isinstance(msg, str):
             msg = str(msg)
         return super().write(msg=msg, style_func=style_func, ending=ending)
@@ -2495,6 +2499,26 @@ def flush(self):
             super().flush()
 
 
+class _CommandResult:
+    """
+    A container for result objects - we use this to make TyperCommand.print_result with
+    minimal impact to BaseCommand.
+    """
+
+    result: t.Any
+    print_result: bool
+
+    def __init__(self, result, print_result):
+        self.result = result
+        self.print_result = print_result
+
+    def __str__(self):
+        return str(self.result)
+
+    def __bool__(self):
+        return self.print_result and bool(self.result)
+
+
 class TyperCommand(BaseCommand, metaclass=TyperCommandMeta):
     """
     An extension of BaseCommand_ that uses the Typer_ library to parse
@@ -2636,6 +2660,10 @@ def command2(self, option: t.Optional[str] = None):
     no_color: bool = False
     force_color: bool = False
     skip_checks: bool = False
+
+    print_result: bool = True
+    """Turn on/off automatic write to stdout of results returned by command"""
+
     _handle: t.Callable[..., t.Any]
     _traceback: bool = False
     _help_kwarg: t.Optional[str] = Default(None)
@@ -3248,9 +3276,10 @@ def _run(self, *args, **options):
             ):
                 # result callbacks are not called on singular commands by click/typer
                 #  we do that here to keep our interface consistent
-                return self.typer_app.info.result_callback(
+                result = self.typer_app.info.result_callback(
                     result, **options, _command=self
                 )
+            self.stdout.disable = not self.print_result
             return result
 
     def run_from_argv(self, argv):

doc/source/changelog.rst

@@ -10,6 +10,7 @@ v3.0.0 (202X-XX-XX)
 * Implemented `Completer for media files. <https://github.com/django-commons/django-typer/issues/175>`_
 * Implemented `Completer for static files. <https://github.com/django-commons/django-typer/issues/174>`_
 * Fixed `Completions before the end of the typed command string do not work. <https://github.com/django-commons/django-typer/issues/168>`_
+* Implemented `Add print_return class field to enable/disable result printing <https://github.com/django-commons/django-typer/issues/167>`_
 * BREAKING `Default rich traceback should not show locals - its too much information. <https://github.com/django-commons/django-typer/issues/166>`_
 * Implemented `path completers should be configurable with a root directory other than cwd <https://github.com/django-commons/django-typer/issues/165>`_
 * Implemented `Migrate pyproject.toml to poetry 2 and portable project specifiers. <https://github.com/django-commons/django-typer/issues/164>_`

doc/source/howto.rst

@@ -849,3 +849,31 @@ streams:
         .. literalinclude:: ../../tests/apps/howto/management/commands/printing_typer.py
             :language: python
             :linenos:
+
+
+Toggle on/off result printing
+-----------------------------
+
+Django's BaseCommand_ will print any truthy values returned from the handle() method. This may not
+always be desired behavior. By default :class:`~django_typer.management.TyperCommand` will do the
+same, but you may toggle this behavior off by setting the class field ``print_result`` to False.
+
+
+.. tabs::
+
+    .. tab:: Django-style
+
+        .. literalinclude:: ../../tests/apps/howto/management/commands/print_result.py
+            :language: python
+            :linenos:
+
+    .. tab:: Typer-style
+
+        .. literalinclude:: ../../tests/apps/howto/management/commands/print_result_typer.py
+            :language: python
+            :linenos:
+
+.. warning::
+
+    We may switch the default behavior to not print in the future, so if you want guaranteed forward
+    compatible behavior you should set this field.

tests/apps/howto/management/commands/print_result.py

@@ -0,0 +1,8 @@
+from django_typer.management import TyperCommand
+
+
+class Command(TyperCommand):
+    print_result = False
+
+    def handle(self):
+        return "This will not be printed"

tests/apps/howto/management/commands/print_result_typer.py

@@ -0,0 +1,10 @@
+from django_typer.management import Typer
+
+app = Typer()
+
+app.django_command.print_result = False
+
+
+@app.command()
+def handle():
+    return "This will not be printed"

tests/test_examples.py

@@ -401,15 +401,20 @@ def test_hierarchy(self):
             "multiply",
             "--help",
         )[0].strip()
-        self.assertGreater(
-            similarity(
-                observed_help,
-                hierarchy_math_multiply_help
-                if rich_installed
-                else hierarchy_math_multiply_help_no_rich,
-            ),
-            0.99,
-        )
+        try:
+            self.assertGreater(
+                similarity(
+                    observed_help,
+                    hierarchy_math_multiply_help
+                    if rich_installed
+                    else hierarchy_math_multiply_help_no_rich,
+                ),
+                0.99,
+            )
+        except AssertionError:
+            import ipdb
+
+            ipdb.set_trace()
 
         self.assertEqual(
             run_command(

tests/test_howto.py

@@ -3,6 +3,7 @@
 import pytest
 from django.core.management import call_command
 from django.test import TestCase, override_settings
+from contextlib import redirect_stdout
 
 from django_typer.management import TyperCommand, get_command
 from tests.utils import rich_installed, run_command, similarity
@@ -498,3 +499,31 @@ def test_howto_finalizer_obj(self):
 
 class TestFinalizerGroupTyperExtHowto(TestFinalizerGroupHowto):
     command = "finalize_group_typer_ext"
+
+
+@override_settings(INSTALLED_APPS=["tests.apps.howto"])
+class TestPrintResultHowTo(TestCase):
+    command = "print_result"
+
+    def test_howto_print_result_run(self):
+        self.assertEqual(
+            run_command(self.command, "--settings", "tests.settings.howto")[0].strip(),
+            "",
+        )
+
+    def test_howto_print_result_call(self):
+        output = StringIO()
+        with redirect_stdout(output):
+            self.assertEqual(call_command(self.command), "This will not be printed")
+        self.assertEqual(output.getvalue().strip(), "")
+
+    def test_howto_print_result_obj(self):
+        command = get_command(self.command)
+        self.assertEqual(
+            command.handle(),
+            "This will not be printed",
+        )
+
+
+class TestPrintResultTyperHowTo(TestPrintResultHowTo):
+    command = "print_result_typer"