django-model-map 0.3.2

A CLI tool to map Django model relationships for optimizing queries (select_related vs prefetch_related).

Django Model Map

Stop guessing your query optimizations.

django-model-map is a simple management command that inspects your Django models and outputs a JSON map of relationships. It explicitly categorizes relations into select_related and prefetch_related candidates, helping you avoid N+1 problems and write optimized QuerySets faster.

🚀 Features

• Automatic Classification: Distinguishes between select_related (ForeignKey, OneToOne) and prefetch_related (ManyToMany, Reverse FK).
• Deep Inspection: Supports configurable nesting levels for mapping nested relationships (e.g., prefetch_related('lvl1__lvl2__lvl3')).
• Reverse Relation Discovery: Finds standard _set accessors and custom related_name attributes.
• Recursion Detection: Identifies self-referencing models.
• JSON Output: Easy to read, parse, or integrate into other tools.

📦 Installation

Install via pip:

pip install django-model-map

Add it to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    ...
    'django_model_map',
    ...
]

🛠 Usage

# Inspect all installed apps
python manage.py modelmap

# Inspect a specific app
python manage.py modelmap [app_name]

# Save to file for reference using stdout
python manage.py modelmap [app_name] > relations.json
# or export to file with command
python manage.py modelmap [app_name] [--output[-o]] relations.json

# Specify inspection nesting level (default: 1)
python manage.py modelmap [app_name] --depth 2

📖 Example Output

For a blog application with Post, User, Tag and Comment models:

{
    "blog.Post": {
        "queryset_snippet": "Post.objects.select_related('author', 'category').prefetch_related('tags', 'comments')",
        "select_related_fields": [
            "author",
            "category"
        ],
        "prefetch_related_fields": [
            "tags",
            "comments"
        ],
        "details": {
            "select_related": [
                {
                    "field_name": "author",
                    "target_model": "users.User",
                    "is_recursive": false
                },
                 ...
            ],
            "prefetch_related": [...]
        }
    }
}

💡 How it helps

When writing a view, instead of opening models.py and mentally parsing the relationships, just look at the output. With the --depth argument, you can automatically discover deeply nested relationships that need optimization:

• Copy fields from "queryset_snippet" -> paste into project.
• Copy fields from "select_related_fields" -> paste into .select_related(...).
• Copy fields from "prefetch_related_fields" -> paste into .prefetch_related(...).

🤝 Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

📄 License

MIT