Change Log

v3.1.0 (2024-04-02)

• Fixed Fish shell completion fails for any script named something other than “manage”

• Fixed shellcompletion install fails on fish when the command resolves to a script path

• Implemented Add completer for settings names.

• Implemented Separate ModelObjectCompleter default queries out into standalone functions.

• Fixed Shell completion tests let failures through in CI

• Fixed fish completion installs should respect XDG_CONFIG_HOME

• Fixed zsh completion installs should respect ZDOTDIR

• Implemented Prompt before writing to dotfiles when installing completions

• Implemented Support Django 5.2

• Implemented Use intersphinx for external document references.

• Implemented Add completer for language codes.

• Implemented Switch poetry -> uv

• Implemented Model object completers should handle fields with choices appropriately

• Implemented Require tests to pass before release action runs.

v3.0.0 (2024-02-16)

• Implemented Completer for media files.

• Implemented Completer for static files.

• Fixed Completions before the end of the typed command string do not work.

• Implemented Add print_return class field to enable/disable result printing

• BREAKING Default rich traceback should not show locals - its too much information.

• Implemented path completers should be configurable with a root directory other than cwd

• Implemented Migrate pyproject.toml to poetry 2 and portable project specifiers.

• BREAKING Split parsers.py and completers.py into submodules.

• Implemented Model completer/parser should support returning the field value

• Fixed Model objects with null lookup fields should not be included in model field completion output

• Implemented Add a performance regression.

• Implemented Use in-house shell completer classes.

• Implemented Add precommit hook to fix safe lint and format issues

• Fixed Fish shell complete is broken when rich is installed.

• BREAKING Remove name parameter from initialize()/callback().

• Implemented Run full test suite on mac osx

• Implemented Convert check.sh to justfile

• Implemented Run full test suite on windows in CI

• Implemented ANSI color control sequences should optionally be scrubbed from shell completions

• Fixed supressed_base_arguments are still present in the Context

• Implemented Add showcase of commands using django-typer to docs

• Implemented Add a @finalize decorator for functions to collect/operate on subroutine results.

• Fixed Remove management imports in django_typer/__init__.py

• Fixed ParamSpec includes self for group methods

• Fixed Installed shellcompletion scripts do not pass values of –settings or –pythonpath

• Implemented Add support for QuerySet parameter types.

• Fixed shellcompletion complete should print to the command’s stdout.

• Implemented Add translations for helps..

• Implemented Add completer/parser for FileField and FilePathField

• Implemented Add completer/parser for DurationField

• Implemented Add completer/parser for DateTimeField

• Implemented Add completer/parser for DateField

• Implemented Add completer/parser for TimeField

• Implemented Improve shell completion continuous integration tests

Migrating from 2.x to 3.x

• Imports from the django_typer namespace have been removed. You should now import from django_typer.management.

• The name parameter has been removed from django_typer.management.initialize() and django_typer.management.Typer.callback(). This change was forced by upstream changes in Typer that will allow django_typer.management.Typer.add_typer() to define commands across multiple files.

• Rich tracebacks will not include local variables by default. To replicate the old behavior you will need to add this to your settings:

  RICH_TRACEBACK_CONFIG={"show_locals": True}
  

  –show-locals and –hide-locals common parameters are added to toggle local variables on and off in the stack trace output.

Shell Completions

Some imports have changed in the django_typer namespace!

old	new
management.model_parser_completer	utils.model_parser_completer
parsers.ModelObjectParser	parsers.model.ModelObjectParser
parsers.parse_app_label	parsers.apps.app_config
completers.complete_app_label	completers.apps.app_labels
completers.commands	completers.cmd.commands
completers.databases	completers.db.databases
completers.ModelObjectCompleter	completers.model.ModelObjectCompleter
completers.complete_path	completers.path.paths
completers.complete_directory	completers.path.directories
completers.complete_import_path	completers.path.import_paths

• If you are using shell tab completions you will need to reinstall the completion scripts. Using the shellcompletion install command. To be extra safe you may want to uninstall the old scripts before updating, using the v2.x shellcompletion remove command.

• The interface to shellcompletion has changed. --shell is now an initialization option and remove was renamed to uninstall.:

  # old interface
  manage shellcompletion complete --shell zsh "command string"
  manage shellcompletion remove
  
  # new interface
  manage shellcompletion --shell zsh complete "command string"
  manage shellcompletion uninstall
  

• The function signature for shellcompletion fallbacks has changed. The fallback signature is now:

  import typing as t
  from click.shell_complete import CompletionItem
  
  def fallback(args: t.List[str], incomplete: str) -> t.List[CompletionItem]:
      ...
  

v2.6.0 (2024-12-03)

• Fixed On Python 3.13, sometimes flush is called on the stream wrapped by OutputWrapper after it is closed.

• Implemented Support Typer 0.15.x

v2.5.0 (2024-11-29)

• Implemented Support Typer >=0.14

• Fixed Typer-style interface throws an assertion when no callback is present on a subgroup.

v2.4.0 (2024-11-07)

• Implemented Support Typer 0.13

v2.3.0 (2024-10-13)

• Fixed Inheritance more than one level deep of TyperCommands does not work.

• Implemented Drop python 3.8 support.

• Implemented Command help order should respect definition order for class based commands.

• Fixed Overriding the command group class does not work.

• Completed Add project to test PyPI

• Completed Open up vulnerability reporting and add security policy.

• Completed Add example of custom plugin logic to plugins tutorial.

• Completed Move architecture in docs to ARCHITECTURE.md

• Completed Transfer to django-commons

• Completed Add howto for how to change the display order of commands in help.

v2.2.2 (2024-08-25)

• Implemented Support python 3.13

• Fixed typer > 0.12.5 toggles rich help renderings off by default

v2.2.1 (2024-08-17)

• Fixed Remove shell_complete monkey patch when upstream PR is merged.

v2.2.0 (2024-07-26)

• Implemented ModelObjectCompleter should optionally accept a QuerySet in place of a Model class.

v2.1.3 (2024-07-15)

• Fixed Move from django_typer to django_typer.management broke doc reference links.

• Implemented Support Django 5.1

v2.1.2 (2024-06-07)

• Fixed Type hint kwargs to silence pylance warnings about partially unknown types

v2.1.1 (2024-06-06)

• Fixed handle = None does not work for mypy to silence type checkers

v2.1.0 (2024-06-05)

Warning

Imports from django_typer have been deprecated and will be removed in 3.0! Imports have moved to django_typer.management:

# 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.

• Implemented Move tests into top level dir.

• Implemented Move core code out of __init__.py into management/__init__.py

• Fixed Typer(help=””) doesnt work.

v2.0.2 (2024-06-03)

• Fixed class help attribute should be type hinted to allow a lazy translation string.

v2.0.1 (2024-05-31)

• Fixed Readme images are broken.

v2.0.0 (2024-05-31)

This major version release, includes an extensive internal refactor, numerous bug fixes and the addition of a plugin-based extension pattern.

• Fixed Stack trace produced when attempted to tab-complete a non-existent management command.

• Fixed Overriding handle() in inherited commands results in multiple commands.

• Implemented Support subgroup name overloads.

• Fixed Helps from class docstrings and TyperCommand class parameters are not inherited.

• Implemented Allow callback and initialize to be aliases of each other.

• Implemented Shell completion for –pythonpath

• Implemented Shell completion for –settings

• Fixed An intelligible exception should be thrown when a command is invoked that has no implementation.

• Implemented TyperCommand class docstring should be used as the help as a last resort.

• Implemented Adapter pattern that allows commands and groups to be added without extension by apps further up the app stack.

• Fixed ModelObjectParser should use a metavar appropriate to the field type.

• Implemented Switch to ruff for linting and formatting.

• Implemented Add a wrapper for typer’s echo/secho

• Implemented Support a native typer-like interface.

• Fixed @group type hint does not carry over the parameter spec of the wrapped function

• Implemented Better test organization.

• Implemented Add completer/parser for GenericIPAddressField.

v1.1.2 (2024-04-22)

• Fixed Overridden common Django arguments fail to pass through when passed through call_command

v1.1.1 (2024-04-11)

• Implemented Fix pyright type checking and add to CI

• Implemented Convert CONTRIBUTING.rst to markdown

v1.1.0 (2024-04-03)

• Implemented Convert readme to markdown.

• Fixed typer 0.12.0 breaks django_typer 1.0.9

v1.0.9 (yanked)

• Fixed Support typer 0.12.0

v1.0.8 (2024-03-26)

• Fixed Support typer 0.10 and 0.11

v1.0.7 (2024-03-17)

• Fixed Helps throw an exception when invoked from an absolute path that is not relative to the getcwd()

v1.0.6 (2024-03-14)

• Fixed prompt options on groups still prompt when given as named parameters on call_command

v1.0.5 (2024-03-14)

• Fixed Options with prompt=True are prompted twice

v1.0.4 (2024-03-13)

• Fixed Help sometimes shows full script path in Usage: when it shouldnt.

• Fixed METAVAR when ModelObjectParser supplied should default to model name

v1.0.3 (2024-03-08)

• Fixed Incomplete typing info for @command decorator

v1.0.2 (2024-03-05)

• Fixed name property on TyperCommand is too generic and should be private.

• Fixed When usage errors are thrown the help output should be that of the subcommand invoked not the parent group.

• Fixed typer installs its own system exception hook when commands are run and this may step on the installed rich hook

• Fixed Add py.typed stub

• Fixed Run type checking with django-stubs installed.

• Fixed Add pyright to linting and resolve any pyright errors.

• Fixed Missing subcommand produces stack trace without –traceback.

• Fixed Allow handle() to be an initializer.

v1.0.1 (2024-02-29)

• Fixed shell_completion broken for click < 8.1

v1.0.0 (2024-02-26)

• Initial production/stable release.

v0.6.1b (2024-02-24)

• Incremental beta release - this is also the second release candidate for version 1.

• Peg typer version to 0.9.x

v0.6.0b (2024-02-23)

• Incremental beta release - this is also the first release candidate for version 1.

v0.5.0b (2024-01-31)

• Incremental Beta Release

v0.4.0b (2024-01-08)

• Incremental Beta Release

v0.3.0b (2024-01-06)

• Incremental Beta Release

v0.2.0b (2024-01-04)

• Incremental Beta Release

v0.1.0b (2023-12-05)

• Initial Release (Beta)