Skip to content

Checks

Checks for the telegram app.

check_get_commands(app_configs, **kwargs)

Check that get_commands() can load all command classes without errors.

Since get_commands() is cached, this check also serves to warm the cache.

Source code in django_telegram_app/checks.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
@register()
def check_get_commands(app_configs, **kwargs):  # noqa: ARG001  # pylint: disable=unused-argument
    """Check that get_commands() can load all command classes without errors.

    Since get_commands() is cached, this check also serves to warm the cache.
    """
    errors = []
    try:
        get_commands()
    except Exception as exc:
        errors.append(
            Error(
                f"Error loading commands: {exc!r}",
                hint="Ensure the command modules are defined correctly.",
                id="telegram.E005",
            )
        )
    return errors

check_swappable_telegram_settings(app_configs, **kwargs)

Check that TELEGRAM_SETTINGS_MODEL resolves correctly and is a subclass of AbstractTelegramSettings.

Source code in django_telegram_app/checks.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
@register()
def check_swappable_telegram_settings(app_configs, **kwargs):  # noqa: ARG001  # pylint: disable=unused-argument
    """Check that TELEGRAM_SETTINGS_MODEL resolves correctly and is a subclass of AbstractTelegramSettings."""
    errors = []

    try:
        model = get_telegram_settings_model()
    except ImproperlyConfigured as exc:
        errors.append(
            Error(
                str(exc),
                hint="Ensure TELEGRAM_SETTINGS_MODEL is defined correctly or omit it to use the default.",
                id="telegram.E002",
            )
        )
        return errors
    except Exception as exc:  # just in case of unexpected errors
        errors.append(
            Error(
                f"Unexpected error while resolving TELEGRAM_SETTINGS_MODEL: {exc!r}",
                id="telegram.E003",
            )
        )
        return errors

    # If resolution succeeded, ensure it subclasses AbstractTelegramSettings
    if not issubclass(model, AbstractTelegramSettings):
        errors.append(
            Error(
                f"{model._meta.label} must subclass telegram.models.base.AbstractTelegramSettings.",
                hint="Update your custom model to inherit from the abstract base.",
                id="telegram.E004",
            )
        )

    return errors

check_telegram_required_settings(app_configs, **kwargs)

Check that all required TELEGRAM settings are present.

Source code in django_telegram_app/checks.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@register()
def check_telegram_required_settings(app_configs, **kwargs):  # noqa: ARG001  # pylint: disable=unused-argument
    """Check that all required TELEGRAM settings are present."""
    errors = []
    missing = settings.missing_settings()
    if missing:
        errors.append(
            Error(
                f"Missing required TELEGRAM settings: {', '.join(missing)}",
                hint="Add the missing settings in settings.py under the TELEGRAM key.",
                id="telegram.E001",
            )
        )
    return errors