Merge pull request #484 from HackSoftware/blog/print-qs-in-shell

Blog example: Quick and Sweet Django - Print queryset in a table format, for shell purposes

Author: RadoRado

config/django/base.py

@@ -187,3 +187,8 @@
 from config.settings.debug_toolbar.setup import DebugToolbarSetup  # noqa
 
 INSTALLED_APPS, MIDDLEWARE = DebugToolbarSetup.do_settings(INSTALLED_APPS, MIDDLEWARE)
+
+
+SHELL_PLUS_IMPORTS = [
+    "from styleguide_example.blog_examples.print_qs_in_shell.utils import print_qs"
+]

mypy.ini

@@ -44,4 +44,8 @@ ignore_missing_imports = True
 
 [mypy-qrcode.*]
 # Remove this when qrcode stubs are present
-ignore_missing_imports = True
+ignore_missing_imports = True
+
+[mypy-tabulate.*]
+# Remove this when qrcode stubs are present
+ignore_missing_imports = True

requirements/base.txt

@@ -31,3 +31,4 @@ google-auth-oauthlib==1.2.1
 
 pyotp==2.9.0
 qrcode==8.0
+tabulate==0.9.0

styleguide_example/blog_examples/print_qs_in_shell/utils.py

@@ -0,0 +1,22 @@
+from tabulate import tabulate
+
+
+def tabulate_qs(queryset, *, fields: list[str] | None = None, exclude: list[str] | None = None) -> str:
+    # Make sure the table won't be empty
+    if not fields:
+        fields = [field.name for field in queryset.model._meta.fields]
+
+    if not exclude:
+        exclude = []
+
+    fields = [field for field in fields if field not in exclude]
+
+    return tabulate(
+        tabular_data=queryset.values_list(*fields),
+        headers=fields,
+        tablefmt="github",
+    )
+
+
+def print_qs(queryset, *, fields: list[str] | None = None, exclude: list[str] | None = None) -> None:
+    print(tabulate_qs(queryset, fields=fields, exclude=exclude))