Reference

django_model_info

Commands

modelinfo

class django_model_info.management.commands.modelinfo.Command(*args, **kwargs)

A Django management command to list out the fields and methods for each model.

__init__(*args, **kwargs)

add_arguments(parser)

Add custom arguments to the command.

Parameters:

parser (CommandParser)

append_abstract_models()

Retrieve abstract models.

For each model in the model list, we get MRO, and add any class in the MRO that is in the same app as the model.

create_parser(prog_name, subcommand, **kwargs)

Create and return the ArgumentParser which will be used to parse the arguments to this command.

Reimplemented to allow new default verbosity of 2.

Parameters:

• prog_name (str)

• subcommand (str)

export_markdown(models)

Generate markdown documentation for Django models.

Parameters:

models (list[Any])

Return type:

str

export_results()

Handle export functionality.

filter_models()

Get the list of filtered models based on user input.

get_clean_method_list(model)

Clean method list by removing uppercase and non-callable methods.

get_model_list()

Retrieve models based on filter option or return all models.

get_options(options)

Get verbosity, filter, and export options.

Return type:

tuple

handle(*_, **options)

Handle the command.

render_field_other_table(title, data_list)

Render table for other fields.

render_field_relations_table(title, data_list)

Render table for field relations.

render_field_reverse_relations_table(title, data_list)

Render table for field reverse relations.

render_manager_table(model)

Render manager information.

render_method_table(title, data_list)

Render table for methods.

render_methods(method_info)

Render tables for methods.

render_modelinfo(modelinfo)

Render model information.

render_other_fields(fields_other)

Render tables for fields.

render_relation_fields(fields_relation)

Render tables for fields.

render_reverse_relation_fields(fields_reverse_relation)

Render tables for fields.

modelfilters

class django_model_info.management.commands.modelfilters.Command(*args, **kwargs)

Display model field relationships in tabular format.

__init__(*args, **kwargs)

add_arguments(parser)

Add command arguments.

Parameters:

parser (CommandParser)

Return type:

None

export_markdown(models, options)

Export markdown content.

Parameters:

• models (list)

• options (dict[str, Any])

Return type:

str

export_results(models=None, options=None)

Handle export functionality.

get_filtered_models(filters, prefix=None)

Get models based on filter arguments.

Parameters:

• filters (list[str] | None)

• prefix (str | None)

Return type:

list[Any]

get_options(options)

Get verbosity, filter, and export options.

Return type:

tuple

get_table_data(model, options)

Get field data for a model.

Parameters:

• model (Any)

• options (dict[str, Any])

Return type:

list[list[str]]

handle(*args, **options)

Execute command.

Parameters:

• args (Any)

• options (Any)

Return type:

None

print_markdown(model, data)

Print table in markdown format.

Parameters:

• model (Any)

• data (list[list[str]])

Return type:

None

print_table(model, data)

Print table using rich.

Parameters:

• model (Any)

• data (list[list[str]])

Return type:

None

process_exclude_patterns(excludes)

Process exclude patterns to handle both app and model exclusions.

Examples

• ‘Permission’ -> [‘Permission’]

• ‘auth.Permission’ -> [‘auth.Permission’]

• ‘auth’ -> [‘User’, ‘Group’, ‘Permission’, …] (all auth models)

Parameters:

excludes (list[str])

Return type:

list[str]

modelgraph

class django_model_info.management.commands.modelgraph.Command(*args, **kwargs)

Django management command to generate model relationship graphs.

Parameters:

• args (Any)

• kwargs (Any)

__init__(*args, **kwargs)

Parameters:

• args (Any)

• kwargs (Any)

Return type:

None

add_arguments(parser)

Add command arguments.

Parameters:

parser (CommandParser)

Return type:

None

handle(*args, **options)

Handle the command execution.

Parameters:

• args (Any)

• options (Any)

Return type:

None

migrationgraph

class django_model_info.management.commands.migrationgraph.Command(*args, **kwargs)

A management command to Visualize migrations and dependencies for applications in the project.

__init__(*args, **kwargs)

add_arguments(parser)

Add optional argument to specify apps to show migrations for.

handle(*args, **options)

Handle the command.