django-qs-lsp 1.4.5

Language Server Protocol implementation for Django ORM operations

Django ORM Language Server Protocol (LSP)

A Language Server Protocol implementation for Django ORM that provides intelligent autocompletion for model queries, field lookups, and related field navigation.

Features

• Smart Completions: Field lookups (__exact, __contains, __startswith) and related field navigation (user__profile__bio)
• Multi-App Support: Works with Django projects that have multiple apps
• Django Integration: Uses Django's built-in field lookup APIs

Installation

pip install django-qs-lsp

Usage

Running the Server

django-qs-lsp-server

Neovim Setup

1. Install via Mason:

   :MasonInstall django-qs-lsp
   

2. Configure LSPConfig:

   require("lspconfig").django_qs_lsp.setup({
     filetypes = { "python" },
     root_dir = require("lspconfig.util").root_pattern("manage.py"),
   })
   

Supported Contexts

The LSP provides completions for:

• Model.objects.filter(...)
• Model.objects.exclude(...)
• Model.objects.get(...)
• Model.objects.annotate(...)
• Model.objects.order_by(...)

Example

from django.contrib.auth.models import User

# Field completions
User.objects.filter(username  # Suggests: username=
User.objects.filter(email__   # Suggests: email__exact, email__contains, etc.

# Related field completions
User.objects.filter(profile__  # Suggests: profile__bio, profile__user, etc.

Configuration

# Debug logging
export DJANGO_QS_LSP_DEBUG=true

Development

# Install dependencies
pip install -e ".[dev]"

# Run tests
python -m pytest tests/ -v

# Code quality
ruff check .
mypy src/django_lsp/

License

MIT License