Skip to content

Django

backup_local_db(context, file='')

Back up local db.

Source code in saritasa_invocations/django.py
348
349
350
351
352
353
354
355
356
357
358
@invoke.task
def backup_local_db(
    context: invoke.Context,
    file: str = "",
) -> None:
    """Back up local db."""
    db.backup_local_db(
        context,
        file=file,
        **load_django_db_settings(context),
    )

backup_remote_db(context, file='')

Make dump of remote db and download it.

Source code in saritasa_invocations/django.py
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
@invoke.task
def backup_remote_db(
    context: invoke.Context,
    file: str = "",
) -> str:
    """Make dump of remote db and download it."""
    settings = load_django_remote_env_db_settings(context)
    db_k8s.create_dump(
        context,
        file=file,
        **settings,
    )
    return db_k8s.get_dump(
        context,
        file=file,
    )

check_new_migrations(context)

Check if there is new migrations or not.

Source code in saritasa_invocations/django.py
84
85
86
87
88
89
90
91
@invoke.task
def check_new_migrations(context: invoke.Context) -> None:
    """Check if there is new migrations or not."""
    printing.print_success("Django: Checking migrations")
    manage(
        context,
        command="makemigrations --check --dry-run",
    )

createsuperuser(context, email='', username='', password='')

Create superuser.

Source code in saritasa_invocations/django.py
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
@invoke.task
def createsuperuser(
    context: invoke.Context,
    email: str = "",
    username: str = "",
    password: str = "",
) -> None:
    """Create superuser."""
    config = _config.Config.from_context(context)
    email_source = "cmd"
    username_source = "cmd"
    if not email:
        with contextlib.suppress(invoke.Failure):
            output = context.run(
                "git config user.email",
                echo=False,
                hide="out",
            )
            if output and (email := output.stdout.replace(" ", "").strip()):
                email_source = "git"
        if not email:
            email = config.django.default_superuser_email
            email_source = "config"
    if not username:
        with contextlib.suppress(invoke.Failure):
            output = context.run(
                "git config user.name",
                echo=False,
                hide="out",
            )
            if output and (username := output.stdout.replace(" ", "").strip()):
                username_source = "git"
        if not username:
            username = config.django.default_superuser_username
            username_source = "config"
    if not password:
        password = config.django.default_superuser_password

    printing.print_success(
        "Django: Creating superuser with the following ->\n"
        f"{email=} from {email_source}\n"
        f"{username=} from {username_source}",
    )

    responder_email = invoke.FailingResponder(
        pattern=rf"{config.django.verbose_email_name}.*: ",
        response=f"{email}\n",
        sentinel="That Email address is already taken.",
    )
    responder_user_name = invoke.Responder(
        pattern=rf"{config.django.verbose_username_name}.*: ",
        response=f"{username}\n",
    )
    password_pattern = config.django.verbose_password_name
    responder_password = invoke.Responder(
        pattern=rf"({password_pattern}: )|({password_pattern} \(again\): )",
        response=f"{password}\n",
    )
    try:
        manage(
            context,
            command="createsuperuser",
            watchers=(
                responder_email,
                responder_user_name,
                responder_password,
            ),
        )
    except invoke.Failure:
        printing.print_warn(
            "Superuser with that email already exists. Skipped.",
        )

dbshell(context)

Open database shell with credentials from either local or dev env.

Source code in saritasa_invocations/django.py
259
260
261
262
263
@invoke.task
def dbshell(context: invoke.Context) -> None:
    """Open database shell with credentials from either local or dev env."""
    printing.print_success("Entering DB shell")
    manage(context, command="dbshell")

load_db_dump(context, file='')

Reset db and load db dump.

Source code in saritasa_invocations/django.py
337
338
339
340
341
342
343
344
345
@invoke.task
def load_db_dump(context: invoke.Context, file: str = "") -> None:
    """Reset db and load db dump."""
    resetdb(context, apply_migrations=False)
    db.load_db_dump(
        context,
        file=file,
        **load_django_db_settings(context),
    )

load_django_db_settings(context)

Get database-related config from django settings.

Source code in saritasa_invocations/django.py
399
400
401
402
403
404
405
406
407
408
409
def load_django_db_settings(context: invoke.Context) -> dict[str, str]:
    """Get database-related config from django settings."""
    settings = load_django_settings(context)
    db_settings = settings.DATABASES["default"]
    return {
        "dbname": db_settings["NAME"],
        "host": db_settings["HOST"],
        "port": db_settings["PORT"],
        "username": str(db_settings["USER"]),
        "password": db_settings["PASSWORD"],
    }

load_django_remote_env_db_settings(context)

Load remote django settings from .env file.

Support two sources:

  • single env variable from config.django.remote_db_url_config_name
  • multiple env vars from config.django.remote_db_config_mapping
Requires python-decouple

https://github.com/HBNetwork/python-decouple

Source code in saritasa_invocations/django.py
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
def load_django_remote_env_db_settings(
    context: invoke.Context,
) -> dict[str, str]:
    """Load remote django settings from .env file.

    Support two sources:

    - single env variable from config.django.remote_db_url_config_name
    - multiple env vars from config.django.remote_db_config_mapping

    Requires python-decouple:
        https://github.com/HBNetwork/python-decouple

    """
    system.create_tmp_folder(context)
    env_path = ".tmp/.env.tmp"
    config = _config.Config.from_context(context)
    k8s.download_file(
        context,
        path_to_file_in_pod=config.django.path_to_remote_config_file,
        path_to_where_save_file=env_path,
    )

    # decouple could not be installed during project init
    # so we import decouple this way to avoid import errors
    # during project initialization

    import decouple

    env_config = decouple.Config(decouple.RepositoryEnv(env_path))
    pathlib.Path(env_path).unlink()
    if database_url := str(
        env_config(
            config.django.remote_db_url_config_name,
            env_config(
                config.django.remote_db_url_config_name.lower(),
                default="",
            ),
        ),
    ):
        parsed_url = urllib.parse.urlsplit(database_url)
        return {
            "dbname": parsed_url.path.lstrip("/"),
            "host": parsed_url.hostname or "",
            "port": str(parsed_url.port or ""),
            "username": str(parsed_url.username or ""),
            "password": str(parsed_url.password or ""),
        }
    return {
        arg: str(env_config(env_var, env_config(env_var.lower(), default="")))
        for arg, env_var in config.django.remote_db_config_mapping.items()
    }

load_django_settings(context)

Load django settings from settings file (DJANGO_SETTINGS_MODULE).

Source code in saritasa_invocations/django.py
389
390
391
392
393
394
395
396
def load_django_settings(context: invoke.Context):  # noqa: ANN201
    """Load django settings from settings file (DJANGO_SETTINGS_MODULE)."""
    config = _config.Config.from_context(context)
    os.environ["DJANGO_SETTINGS_MODULE"] = config.django.settings_path

    from django.conf import settings  # type: ignore

    return settings

load_remote_db(context, file='')

Make dump of remote db, download it and apply it.

Source code in saritasa_invocations/django.py
379
380
381
382
383
384
385
386
@invoke.task
def load_remote_db(
    context: invoke.Context,
    file: str = "",
) -> None:
    """Make dump of remote db, download it and apply it."""
    file = backup_remote_db(context, file=file)
    load_db_dump(context, file=file)

makemigrations(context)

Run makemigrations command and chown created migrations.

Source code in saritasa_invocations/django.py
75
76
77
78
79
80
81
@invoke.task
def makemigrations(context: invoke.Context) -> None:
    """Run makemigrations command and chown created migrations."""
    printing.print_success("Django: Make migrations")
    manage(context, command="makemigrations")
    if python.get_python_env() == python.PythonEnv.DOCKER:
        system.chown(context)

manage(context, command, docker_params='', watchers=())

Run manage.py command.

This command also handle starting of required services and waiting DB to be ready.


context: Invoke context
command: Manage command
docker_params: Params for docker run
watchers: Automated responders to command
Source code in saritasa_invocations/django.py
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
@invoke.task
def manage(
    context: invoke.Context,
    command: str,
    docker_params: str = "",
    watchers: collections.abc.Sequence[invoke.StreamWatcher] = (),
) -> invoke.runners.Result | None:
    """Run `manage.py` command.

    This command also handle starting of required services and waiting DB to
    be ready.

    Args:
    ----
        context: Invoke context
        command: Manage command
        docker_params: Params for docker run
        watchers: Automated responders to command

    """
    config = _config.Config.from_context(context)
    wait_for_database(context)
    return python.run(
        context,
        docker_params=docker_params,
        command=f"{config.django.manage_file_path} {command}",
        watchers=watchers,
        env={
            "DJANGO_SETTINGS_MODULE": config.django.settings_path,
        },
    )

migrate(context)

Run migrate command.

Source code in saritasa_invocations/django.py
116
117
118
119
120
121
@invoke.task
def migrate(context: invoke.Context) -> None:
    """Run `migrate` command."""
    printing.print_success("Django: Apply migrations")
    config = _config.Config.from_context(context)
    manage(context, command=config.django.migrate_command)

recompile_messages(context)

Generate and recompile translation messages.

https://docs.djangoproject.com/en/4.2/ref/django-admin/#makemessages

Source code in saritasa_invocations/django.py
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
@invoke.task
def recompile_messages(context: invoke.Context) -> None:
    """Generate and recompile translation messages.

    https://docs.djangoproject.com/en/4.2/ref/django-admin/#makemessages

    """
    printing.print_success("Recompiling translation messages")
    config = _config.Config.from_context(context)
    manage(
        context,
        command=f"makemessages {config.django.makemessages_params}",
    )
    manage(
        context,
        command=f"compilemessages {config.django.compilemessages_params}",
    )

resetdb(context, apply_migrations=True)

Reset database to initial state (including test DB).

Requires django-extensions

https://django-extensions.readthedocs.io/en/latest/installation_instructions.html

Source code in saritasa_invocations/django.py
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
@invoke.task
def resetdb(
    context: invoke.Context,
    apply_migrations: bool = True,
) -> None:
    """Reset database to initial state (including test DB).

    Requires django-extensions:
        https://django-extensions.readthedocs.io/en/latest/installation_instructions.html

    """
    printing.print_success("Reset database to its initial state")
    manage(context, command="drop_test_database --noinput")
    manage(context, command="reset_db -c --noinput")
    if not apply_migrations:
        return
    makemigrations(context)
    migrate(context)
    createsuperuser(context)
    set_default_site(context)

run(context)

Run development web-server.

Source code in saritasa_invocations/django.py
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
@invoke.task
def run(context: invoke.Context) -> None:
    """Run development web-server."""
    printing.print_success("Running app")
    config = _config.Config.from_context(context)
    manage(
        context,
        docker_params=config.django.runserver_docker_params,
        command="{command} {host}:{port} {params}".format(  # noqa: UP032
            command=config.django.runserver_command,
            host=config.django.runserver_host,
            port=config.django.runserver_port,
            params=config.django.runserver_params,
        ),
    )

set_default_site(context)

Set default site to localhost.

Set default site domain to localhost:8000 so get_absolute_url works correctly in local environment

Source code in saritasa_invocations/django.py
322
323
324
325
326
327
328
329
330
331
332
333
334
def set_default_site(context: invoke.Context) -> None:
    """Set default site to localhost.

    Set default site domain to `localhost:8000` so `get_absolute_url` works
    correctly in local environment

    """
    manage(
        context,
        command=(
            "set_default_site --name localhost:8000 --domain localhost:8000"
        ),
    )

shell(context, params='')

Shortcut for manage.py shell command.

Requires django-extensions

https://django-extensions.readthedocs.io/en/latest/installation_instructions.html

Additional params available here

https://django-extensions.readthedocs.io/en/latest/shell_plus.html

Source code in saritasa_invocations/django.py
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
@invoke.task
def shell(
    context: invoke.Context,
    params: str = "",
) -> None:
    """Shortcut for manage.py shell command.

    Requires django-extensions:
        https://django-extensions.readthedocs.io/en/latest/installation_instructions.html

    Additional params available here:
        https://django-extensions.readthedocs.io/en/latest/shell_plus.html

    """
    printing.print_success("Entering Django Shell")
    config = _config.Config.from_context(context)
    manage(
        context,
        command=f"{config.django.shell_command} {params}",
    )

show_urls(context, search='')

Show urls of project.

Use search param to filter urls by regex.

Not using grep to make cross-platform and also keep color output.

Source code in saritasa_invocations/django.py
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
@invoke.task
def show_urls(
    context: invoke.Context,
    search: str = "",
) -> None:
    """Show urls of project.

    Use search param to filter urls by regex.

    Not using grep to make cross-platform and also keep color output.

    """
    console = rich.console.Console()
    with _config.context_override(
        context,
        run={
            "hide": True,
        },
    ) as context_override:
        for url_info in manage(
            context_override,
            command="show_urls",
        ).stdout.splitlines():
            if search and not re.search(search, url_info):
                continue
            url_parts = url_info.split()
            console.print(
                rich.text.Text.assemble(
                    url_parts[0],
                    " ",
                    url_parts[1],
                    " ",
                    url_parts[2],
                ),
            )

startapp(context)

Create new django app using copier.

Requires uv

https://docs.astral.sh/uv/getting-started/installation/

Source code in saritasa_invocations/django.py
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
@invoke.task
def startapp(context: invoke.Context) -> None:
    """Create new django app using copier.

    Requires uv:
        https://docs.astral.sh/uv/getting-started/installation/

    """
    config = _config.Config.from_context(context)
    if not config.django.app_boilerplate_link:
        raise invoke.Exit(
            code=1,
            message="Please, provide link to your django app boilerplate!",
        )
    context.run(
        "uvx copier copy "
        f"'{config.django.app_boilerplate_link}' "
        f"'{config.django.apps_path}' "
        f"--trust --vcs-ref=HEAD",
    )

wait_for_database(context)

Ensure that database is up and ready to accept connections.

Function called just once during subsequent calls of management commands.

Requires django_probes

https://github.com/painless-software/django-probes#basic-usage

Source code in saritasa_invocations/django.py
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
@invoke.task
def wait_for_database(context: invoke.Context) -> None:
    """Ensure that database is up and ready to accept connections.

    Function called just once during subsequent calls of management commands.

    Requires django_probes:
        https://github.com/painless-software/django-probes#basic-usage

    """
    config = _config.Config.from_context(context)
    if hasattr(wait_for_database, "_called"):
        return
    docker.up(context)
    # Not using manage to avoid infinite loop
    python.run(
        context,
        command=(
            f"{config.django.manage_file_path} wait_for_database --stable 0"
        ),
        env={
            "DJANGO_SETTINGS_MODULE": config.django.settings_path,
        },
    )
    wait_for_database._called = True  # type: ignore