Skip to content

config

This module contains both Flask configuration and application constants for Downtime Panda.

exports
  • Config: Configuration class for the Downtime Panda application.
  • TestingConfig: Configuration class for testing environment.

Config

Configuration class for the Downtime Panda application. This class holds configuration settings such as debug mode, database URL, and secret key.

Source code in src\downtime_panda\config.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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class Config:
    """
    Configuration class for the Downtime Panda application.
    This class holds configuration settings such as debug mode, database URL, and secret key.
    """

    DEBUG = os.getenv("DTPANDA_DEBUG", "false").lower() in ("true", "1", "yes")
    """
    Indicates whether the application is running in debug mode.
    Set to True if the environment variable 'DTPANDA_DEBUG' is set to 'true', '1', or 'yes' (case-insensitive).
    """

    SQLALCHEMY_DATABASE_URI = (
        f"postgresql+psycopg://{os.getenv('DTPANDA_DB_URL')}"
        if os.getenv("DTPANDA_DB_URL")
        else "sqlite:///dtpanda.db"
    )
    """
    The database connection URL for the database, constructed from the environment variable 'DTPANDA_DB_URL'.

    Defaults to a SQLite database file named `dtpanda.db` if the environment variable is not set, which is saved inside the `src/instance` directory.
    """

    SECRET_KEY = os.getenv("DTPANDA_SECRET_KEY") or "a_very_secret_key"
    """
    The secret key used by Flask for cryptographic operations (e.g., session signing).
    Loaded from the environment variable 'DTPANDA_SECRET'.
    """

    # -------------------------------- APSCHEDULER ------------------------------- #
    SCHEDULER_JOBSTORES = {
        "default": SQLAlchemyJobStore(
            url=SQLALCHEMY_DATABASE_URI
            if os.getenv("DTPANDA_DB_URL")
            else "sqlite:///src/instance/dtpanda.db",
            tablename="apscheduler_jobs",
        ),
    }
    """
    Configuration for the APScheduler job store.
    """

    SCHEDULER_TIMEZONE = pytz.utc
    """
    The timezone used by the APScheduler.
    Set to UTC by default.
    """

DEBUG = os.getenv('DTPANDA_DEBUG', 'false').lower() in ('true', '1', 'yes') class-attribute instance-attribute

Indicates whether the application is running in debug mode. Set to True if the environment variable 'DTPANDA_DEBUG' is set to 'true', '1', or 'yes' (case-insensitive).

SCHEDULER_JOBSTORES = {'default': SQLAlchemyJobStore(url=SQLALCHEMY_DATABASE_URI if os.getenv('DTPANDA_DB_URL') else 'sqlite:///src/instance/dtpanda.db', tablename='apscheduler_jobs')} class-attribute instance-attribute

Configuration for the APScheduler job store.

SCHEDULER_TIMEZONE = pytz.utc class-attribute instance-attribute

The timezone used by the APScheduler. Set to UTC by default.

SECRET_KEY = os.getenv('DTPANDA_SECRET_KEY') or 'a_very_secret_key' class-attribute instance-attribute

The secret key used by Flask for cryptographic operations (e.g., session signing). Loaded from the environment variable 'DTPANDA_SECRET'.

SQLALCHEMY_DATABASE_URI = f'postgresql+psycopg://{os.getenv('DTPANDA_DB_URL')}' if os.getenv('DTPANDA_DB_URL') else 'sqlite:///dtpanda.db' class-attribute instance-attribute

The database connection URL for the database, constructed from the environment variable 'DTPANDA_DB_URL'.

Defaults to a SQLite database file named dtpanda.db if the environment variable is not set, which is saved inside the src/instance directory.

TestingConfig

Bases: Config

Configuration class for testing environment. Inherits from Config and overrides specific settings for testing.

Source code in src\downtime_panda\config.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
class TestingConfig(Config):
    """
    Configuration class for testing environment.
    Inherits from Config and overrides specific settings for testing.
    """

    DEBUG = True
    """
    Enables debug mode for testing.
    """

    SQLALCHEMY_DATABASE_URI = "sqlite:///:memory:"
    """
    Uses an in-memory SQLite database for testing purposes.
    This allows for fast tests without needing a persistent database.
    """

    TESTING = True
    """
    Indicates that the application is in testing mode.
    This can enable additional testing features or behaviors.
    """

    WTF_CSRF_ENABLED = False
    """
    Disables CSRF protection for testing.
    This is often done in tests to simplify form submissions.
    """

DEBUG = True class-attribute instance-attribute

Enables debug mode for testing.

SQLALCHEMY_DATABASE_URI = 'sqlite:///:memory:' class-attribute instance-attribute

Uses an in-memory SQLite database for testing purposes. This allows for fast tests without needing a persistent database.

TESTING = True class-attribute instance-attribute

Indicates that the application is in testing mode. This can enable additional testing features or behaviors.

WTF_CSRF_ENABLED = False class-attribute instance-attribute

Disables CSRF protection for testing. This is often done in tests to simplify form submissions.