firefighter ¤

ASGI config for firefighter project.

It exposes the ASGI callable as a module-level variable named application.

For more information on this file, see https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/

Classes:

• CustomCheckboxSelectMultiple –

  Custom template.

• FFDateRangeSingleFilter –

  TODO Fix typings, implement tests, move in proper location.

• GroupedCheckboxSelectMultiple –

  Widget to group checkboxes in a select multiple.

• TextDateRangeField –

optgroups(name: str, value: list[Any], attrs: dict[str, Any] | None = None) -> list[tuple[str | None, list[dict[str, Any]], int | None]]

84
85
86
87
88
89
90
91
92

def optgroups(
    self, name: str, value: list[Any], attrs: dict[str, Any] | None = None
) -> list[tuple[str | None, list[dict[str, Any]], int | None]]:
    """Return a list of optgroups for this widget."""
    self.choices = [
        (key, list(group))
        for key, group in groupby(self.choices, key=lambda x: x[0].instance.group)  # type: ignore[union-attr]
    ]
    return super().optgroups(name, value, attrs)

to_python(value: str | None) -> tuple[date | None, date | None, str | None, str | None] | None

25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

def to_python(
    self, value: str | None
) -> tuple[date | None, date | None, str | None, str | None] | None:
    """Validate date range. Field is optional."""
    if not value or value.strip() == "":
        return None
    date_range = get_date_range_from_special_date(value)
    if date_range[0] is None and date_range[1] is None:
        err_msg = f"Invalid date range: {value}"
        raise ValidationError(err_msg)
    if (date_range[0] is not None and date_range[1] is not None) and date_range[
        0
    ] > date_range[1]:
        err_msg = f"Start date must be before end date ({date_range[0].strftime('%Y-%m-%d %H:%M:%S')} > {date_range[1].strftime('%Y-%m-%d %H:%M:%S')})."
        raise ValidationError(err_msg)

    return date_range

Collection of custom Django template filters. They are added as built-in filters and thus can be used in templates of any app.

Functions:

• apply_filter –

  Applies a filter function to a given value.

• get_item –

  Get the value of a key from a dictionary or object.

• markdown –

  Converts markdown-formatted text to HTML.

• readable_time_delta –

  Format a time delta as a string. Ignore seconds and microseconds

• timedelta_chop_microseconds –

  Removes microseconds from a timedelta object.

apply_filter(value: Any, fn_holder: dict[Literal['filter_args', 'filter'], Callable[..., V]]) -> V | Any

60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

@register_global.filter
def apply_filter(
    value: Any,
    fn_holder: dict[Literal["filter_args", "filter"], Callable[..., V]],
) -> V | Any:
    """Applies a filter function to a given value.

    Args:
        value: The value to be filtered.
        fn_holder: A dictionary containing the filter function and its arguments.

    Returns:
        The filtered value.
    """
    fn = fn_holder.get("filter")

    if not fn:
        return value

    args = fn_holder.get("filter_args")
    if args:
        return fn(value, args)
    return fn(value)

get_item(dictionary: dict[str, Any], key: Any) -> Any

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

@register_global.filter
def get_item(dictionary: dict[str, Any], key: Any) -> Any:
    """Get the value of a key from a dictionary or object.

    Args:
        dictionary (dict[str, Any]): The dictionary or object to get the value from.
        key (Any): The key to get the value for.

    Returns:
        Any: The value of the key in the dictionary or object.
    """
    if hasattr(dictionary, key):
        return getattr(dictionary, key)
    if hasattr(dictionary, "__getitem__"):
        try:
            return dictionary[key]
        except KeyError:
            pass
    if hasattr(dictionary, "get"):
        return dictionary.get(key)
    if not isinstance(dictionary, dict):
        dictionary = dictionary.__dict__  # type: ignore

    return dictionary.get(key)

markdown(text: str) -> str

133
134
135
136
137
138
139
140
141
142
143
144
145

@register_global.filter
def markdown(text: str) -> str:
    """Converts markdown-formatted text to HTML.

    Sanitize the HTML to only allow a subset of tags.

    Args:
        text (str): The markdown-formatted text to convert.

    Returns:
        str: The HTML-formatted text.
    """
    return nh3.clean(md.markdown(text, output_format="html"), tags=nh3.ALLOWED_TAGS)

readable_time_delta(delta: timedelta) -> str

 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

@register_global.filter
def readable_time_delta(delta: timedelta) -> str:
    """Format a time delta as a string. Ignore seconds and microseconds
    From https://github.com/wimglenn/readabledelta/blob/master/readabledelta.py (The Unlicense).
    """
    negative = delta < timedelta(0)
    delta = abs(delta)

    # Other allowed values are  "seconds", "milliseconds", "microseconds".
    keys = [
        "weeks",
        "days",
        "hours",
        "minutes",
    ]

    # datetime.timedelta are normalized internally in Python to the units days, seconds, microseconds allowing a unique
    # representation.  This is not the only possible basis; the calculations below rebase onto more human friendly keys
    # noinspection PyDictCreation
    data = {}
    # rebase days onto weeks, days
    data["weeks"], data["days"] = divmod(delta.days, 7)
    # rebase seconds onto hours, minutes, seconds
    data["hours"], data["seconds"] = divmod(delta.seconds, 60 * 60)
    data["minutes"], data["seconds"] = divmod(data["seconds"], 60)
    # rebase microseconds onto milliseconds, microseconds

    if data["weeks"] != 0 or data["days"] != 0:
        keys.remove("minutes")
        keys.remove("hours")

    output = [
        f"{data[k]} {k[:-1] if data[k] == 1 else k}" for k in keys if data[k] != 0
    ]

    if not output:
        result = "an instant"
    elif len(output) == 1:
        [result] = output
    else:
        left, right = output[:-1], output[-1:]
        result = ", ".join(left) + " and " + right[0]

    if negative:
        return "-" + result
    return result

timedelta_chop_microseconds(delta: timedelta) -> timedelta

21
22
23
24
25
26
27
28
29
30
31

@register_global.filter
def timedelta_chop_microseconds(delta: timedelta) -> timedelta:
    """Removes microseconds from a timedelta object.

    Args:
        delta (timedelta): The timedelta object to remove microseconds from.

    Returns:
        timedelta: A new timedelta object with microseconds removed.
    """
    return delta - timedelta(microseconds=delta.microseconds)

See Django docs: https://docs.djangoproject.com/en/4.2/topics/i18n/formatting/ .

Classes:

• HttpClient –

  Base class for HTTP clients. Uses httpx under the hood.

HttpClient(client_kwargs: dict[str, Any] | None = None)

27
28
29
30
31
32
33
34

def __init__(self, client_kwargs: dict[str, Any] | None = None) -> None:
    self._client = httpx.Client(**(client_kwargs or {}))
    self._client.timeout = httpx.Timeout(15, read=20)
    if FF_HTTP_CLIENT_ADDITIONAL_HEADERS:
        self._client.headers = httpx.Headers({
            **self._client.headers,
            **FF_HTTP_CLIENT_ADDITIONAL_HEADERS,
        })

Classes:

• HeaderUser –

  Adds the user ID to the response headers configured with "FF-User-Id", to log in access logs.

HeaderUser(get_response: Callable[[HttpRequest], HttpResponse])

18
19

def __init__(self, get_response: Callable[[HttpRequest], HttpResponse]) -> None:
    self.get_response = get_response

This module define all the settings for the FireFighter project.

from django.conf import settings

Modules:

• components –
• environments –

  Overriding settings based on the environment.

• settings_builder –
• settings_utils –

Classes:

• AccessLogFilter –

  Filter Gunicorn.access logs to avoid logging static files and healthcheck requests logging.

• CustomJsonFormatter –

  Custom JSON formatter for Python loggin, with Datadog specific attributes.

• PrettyFormatter –

  A custom logging formatter that formats log records with colors and a pretty output, for local development.

Attributes:

• APP_DISPLAY_NAME (str) –

  The name of the app. Used in the title of the app, and in the navigation bar.

• BASE_URL (str) –

  The base URL of the app. Used for links in externals surfaces, like Slack or documents.

• CONFLUENCE_API_KEY (str) –

  The Confluence API key to use.

• CONFLUENCE_ON_CALL_PAGE_ID (int | None) –

  The Confluence page ID where to export the current on-call schedule. If not set, export tasks will be skipped.

• CONFLUENCE_POSTMORTEM_FOLDER_ID (int) –

  The Confluence page ID where to create and nest postmortems.

• CONFLUENCE_POSTMORTEM_SPACE (str) –

  XXX To rename CONFLUENCE_DEFAULT_SPACE. The Confluence space where to create pages by default, mainly for postmortems.

• CONFLUENCE_POSTMORTEM_TEMPLATE_PAGE_ID (int) –

  The Confluence page ID of the template to use for postmortems.

• CONFLUENCE_RUNBOOKS_FOLDER_ID (int) –

  The Confluence page ID where runbooks are stored.

• CONFLUENCE_URL (str) –

  The Confluence URL to use. If no protocol is defined, https will be used.

• CONFLUENCE_USERNAME (str) –

  The Confluence username to use.

• DRF_STANDARDIZED_ERRORS –

  Additional servers to add to the OpenAPI schema

• ENABLE_CONFLUENCE –

  Enable the Confluence app.

• ENABLE_JIRA (bool) –

  Enable the Jira app.

• ENABLE_PAGERDUTY (bool) –

  Enable PagerDuty integration.

• ENABLE_RAID (bool) –

  Enable the Raid app. Jira app must be enabled and configured as well.

• FF_HTTP_CLIENT_ADDITIONAL_HEADERS (dict[str, Any] | None) –

  Additional headers to send with every HTTP request made using our HttpClient. Useful for global auth, or adding a specific User-Agent.

• FF_OVERRIDE_MENUS_CREATION (Callable[[], None] | None) –

  Override the default menus creation. Useful for custom menus.

• FF_ROLE_REMINDER_MIN_DAYS_INTERVAL –

  Number of days between role explanation/reminders, for each role. -1 disable the messages, and 0 will send the message everytime.

• FF_SKIP_SECRET_KEY_CHECK (bool) –

  Skip the SECRET_KEY check. Make sure to set a strong SECRET_KEY in production.

• FF_SLACK_SKIP_CHECKS (bool) –

  Skip Slack checks. Only use for testing or demo.

• FF_USER_ID_HEADER (str) –

  Header name to add to every HTTP request made using our HttpClient. Useful for logging.

• PAGERDUTY_ACCOUNT_EMAIL (str) –

  PagerDuty account email, linked to the API key.

• PAGERDUTY_API_KEY (str) –

  PagerDuty API key.

• PAGERDUTY_URL (str) –

  PagerDuty API URL.

• RAID_DEFAULT_JIRA_QRAFT_USER_ID (str) –

  The default Jira user ID to use for creating issues

• RAID_JIRA_API_PASSWORD (str) –

  The Jira API password to use.

• RAID_JIRA_API_URL (str) –

  The Jira API URL to use. If no protocol is defined, https will be used.

• RAID_JIRA_API_USER (str) –

  The Jira API user to use.

• RAID_JIRA_PROJECT_KEY (str) –

  The Jira project key to use for creating issues, e.g. 'INC'

• RAID_JIRA_USER_IDS (dict[str, str]) –

  Mapping of domain to default Jira user ID

• RAID_TOOLBOX_URL (str) –

  Toolbox URL

• SLACK_APP_EMOJI (str) –

  Emoji to represent the app in Slack surfaces. Can be an actual emoji, or a string for a custom emoji present in your Workspace, like ":incident_logo:".

• SLACK_BOT_TOKEN (str) –

  The Slack bot token to use.

• SLACK_EMERGENCY_COMMUNICATION_GUIDE_URL (str | None) –

  URL to add in the Slack emergency message. Useful to point to your own documentation.

• SLACK_EMERGENCY_USERGROUP_ID (str | None) –

  The Slack usergroup ID to use for emergency notifications. If not set, no group will be mentionned in the message.

• SLACK_INCIDENT_COMMAND (str) –

  The Slack slash command to use to create and manage incidents.

• SLACK_INCIDENT_COMMAND_ALIASES (list[str]) –

  Comma-separated list of aliases for the incident command.

• SLACK_INCIDENT_HELP_GUIDE_URL (str | None) –

  URL to add in the Slack help message (/incident help). Useful to point to your own documentation.

• SLACK_POSTMORTEM_HELP_URL (str | None) –

  URL to a guide on how to write a postmortem. Useful to point to your own documentation.

• SLACK_SEVERITY_HELP_GUIDE_URL (str | None) –

  URL to add in the form to choose the priority. Useful to point to your own documentation.

• SLACK_SIGNING_SECRET (str) –

  The Slack signing secret to use.

APP_DISPLAY_NAME: str = config('APP_DISPLAY_NAME', default='FireFighter')

BASE_URL: str = config('BASE_URL')

CONFLUENCE_API_KEY: str = config('CONFLUENCE_API_KEY')

CONFLUENCE_ON_CALL_PAGE_ID: int | None = config('CONFLUENCE_ON_CALL_PAGE_ID', cast=int, default=None)

CONFLUENCE_POSTMORTEM_FOLDER_ID: int = config('CONFLUENCE_POSTMORTEM_FOLDER_ID', cast=int)

CONFLUENCE_POSTMORTEM_SPACE: str = config('CONFLUENCE_POSTMORTEM_SPACE')

CONFLUENCE_POSTMORTEM_TEMPLATE_PAGE_ID: int = config('CONFLUENCE_POSTMORTEM_TEMPLATE_PAGE_ID', cast=int)

CONFLUENCE_RUNBOOKS_FOLDER_ID: int = config('CONFLUENCE_RUNBOOKS_FOLDER_ID', cast=int)

CONFLUENCE_URL: str = config('CONFLUENCE_URL')

CONFLUENCE_USERNAME: str = config('CONFLUENCE_USERNAME')

DRF_STANDARDIZED_ERRORS = {'ALLOWED_ERROR_STATUS_CODES': ['400', '401', '403', '404', '429', '500']}

ENABLE_CONFLUENCE = config('ENABLE_CONFLUENCE', cast=bool, default=False)

ENABLE_JIRA: bool = config('ENABLE_JIRA', cast=bool, default=False)

ENABLE_PAGERDUTY: bool = config('ENABLE_PAGERDUTY', cast=bool, default=False)

ENABLE_RAID: bool = config('ENABLE_RAID', cast=bool, default=False)

FF_HTTP_CLIENT_ADDITIONAL_HEADERS: dict[str, Any] | None = None

FF_OVERRIDE_MENUS_CREATION: Callable[[], None] | None = None

FF_ROLE_REMINDER_MIN_DAYS_INTERVAL = config('FF_ROLE_REMINDER_MIN_DAYS_INTERVAL', default=90, cast=int)

FF_SKIP_SECRET_KEY_CHECK: bool = config('FF_SKIP_SECRET_KEY_CHECK', default=False, cast=bool)

FF_SLACK_SKIP_CHECKS: bool = config('FF_SLACK_SKIP_CHECKS', cast=bool, default=_is_default_skip_check_cmd)

FF_USER_ID_HEADER: str = 'FF-User-Id'

PAGERDUTY_ACCOUNT_EMAIL: str = config('PAGERDUTY_ACCOUNT_EMAIL')

PAGERDUTY_API_KEY: str = config('PAGERDUTY_API_KEY')

PAGERDUTY_URL: str = config('PAGERDUTY_URL', default='https://api.pagerduty.com')

RAID_DEFAULT_JIRA_QRAFT_USER_ID: str = config('RAID_DEFAULT_JIRA_QRAFT_USER_ID')

RAID_JIRA_API_PASSWORD: str = config('RAID_JIRA_API_PASSWORD')

RAID_JIRA_API_URL: str = config('RAID_JIRA_API_URL')

RAID_JIRA_API_USER: str = config('RAID_JIRA_API_USER')

RAID_JIRA_PROJECT_KEY: str = config('RAID_JIRA_PROJECT_KEY')

RAID_JIRA_USER_IDS: dict[str, str] = {}

RAID_TOOLBOX_URL: str = config('RAID_TOOLBOX_URL')

SLACK_APP_EMOJI: str = config('SLACK_APP_EMOJI', default=':fire_extinguisher:')

SLACK_BOT_TOKEN: str = config('SLACK_BOT_TOKEN')

SLACK_EMERGENCY_COMMUNICATION_GUIDE_URL: str | None = config('SLACK_EMERGENCY_COMMUNICATION_GUIDE_URL', default=None)

SLACK_EMERGENCY_USERGROUP_ID: str | None = config('SLACK_EMERGENCY_USERGROUP_ID', default=None)

SLACK_INCIDENT_COMMAND: str = config('SLACK_INCIDENT_COMMAND', default='/incident')

SLACK_INCIDENT_COMMAND_ALIASES: list[str] = config('SLACK_INCIDENT_COMMAND_ALIASES', cast=Csv(), default='')

SLACK_INCIDENT_HELP_GUIDE_URL: str | None = config('SLACK_INCIDENT_HELP_GUIDE_URL', default=None)

SLACK_POSTMORTEM_HELP_URL: str | None = config('SLACK_POSTMORTEM_HELP_URL', default=None)

SLACK_SEVERITY_HELP_GUIDE_URL: str | None = config('SLACK_SEVERITY_HELP_GUIDE_URL', default=None)

SLACK_SIGNING_SECRET: str = config('SLACK_SIGNING_SECRET')

CustomJsonFormatter(*args: Any, **kwargs: Any)

49
50
51

def __init__(self, *args: Any, **kwargs: Any) -> None:
    self.FF_USER_ID_HEADER: str = settings.FF_USER_ID_HEADER
    super().__init__(*args, **kwargs)

DRF_STANDARDIZED_ERRORS = {'ALLOWED_ERROR_STATUS_CODES': ['400', '401', '403', '404', '429', '500']}

FF_DEBUG_ERROR_PAGES: bool = config('FF_DEBUG_ERROR_PAGES', default=False, cast=bool)

FF_EXPOSE_API_DOCS: bool = config('FF_EXPOSE_API_DOCS', default=False, cast=bool)

FF_HTTP_CLIENT_ADDITIONAL_HEADERS: dict[str, Any] | None = None

FF_OVERRIDE_MENUS_CREATION: Callable[[], None] | None = None

FF_ROLE_REMINDER_MIN_DAYS_INTERVAL = config('FF_ROLE_REMINDER_MIN_DAYS_INTERVAL', default=90, cast=int)

FF_SKIP_SECRET_KEY_CHECK: bool = config('FF_SKIP_SECRET_KEY_CHECK', default=False, cast=bool)

FF_USER_ID_HEADER: str = 'FF-User-Id'

CONFLUENCE_API_KEY: str = config('CONFLUENCE_API_KEY')

CONFLUENCE_ON_CALL_PAGE_ID: int | None = config('CONFLUENCE_ON_CALL_PAGE_ID', cast=int, default=None)

CONFLUENCE_POSTMORTEM_FOLDER_ID: int = config('CONFLUENCE_POSTMORTEM_FOLDER_ID', cast=int)

CONFLUENCE_POSTMORTEM_SPACE: str = config('CONFLUENCE_POSTMORTEM_SPACE')

CONFLUENCE_POSTMORTEM_TEMPLATE_PAGE_ID: int = config('CONFLUENCE_POSTMORTEM_TEMPLATE_PAGE_ID', cast=int)

CONFLUENCE_RUNBOOKS_FOLDER_ID: int = config('CONFLUENCE_RUNBOOKS_FOLDER_ID', cast=int)

CONFLUENCE_URL: str = config('CONFLUENCE_URL')

CONFLUENCE_USERNAME: str = config('CONFLUENCE_USERNAME')

ENABLE_CONFLUENCE = config('ENABLE_CONFLUENCE', cast=bool, default=False)

ENABLE_JIRA: bool = config('ENABLE_JIRA', cast=bool, default=False)

RAID_JIRA_API_PASSWORD: str = config('RAID_JIRA_API_PASSWORD')

RAID_JIRA_API_URL: str = config('RAID_JIRA_API_URL')

RAID_JIRA_API_USER: str = config('RAID_JIRA_API_USER')

ENABLE_PAGERDUTY: bool = config('ENABLE_PAGERDUTY', cast=bool, default=False)

PAGERDUTY_ACCOUNT_EMAIL: str = config('PAGERDUTY_ACCOUNT_EMAIL')

PAGERDUTY_API_KEY: str = config('PAGERDUTY_API_KEY')

PAGERDUTY_URL: str = config('PAGERDUTY_URL', default='https://api.pagerduty.com')

ENABLE_RAID: bool = config('ENABLE_RAID', cast=bool, default=False)

RAID_DEFAULT_JIRA_QRAFT_USER_ID: str = config('RAID_DEFAULT_JIRA_QRAFT_USER_ID')

RAID_JIRA_PROJECT_KEY: str = config('RAID_JIRA_PROJECT_KEY')

RAID_JIRA_USER_IDS: dict[str, str] = {}

RAID_TOOLBOX_URL: str = config('RAID_TOOLBOX_URL')

FF_SLACK_SKIP_CHECKS: bool = config('FF_SLACK_SKIP_CHECKS', cast=bool, default=_is_default_skip_check_cmd)

SLACK_APP_EMOJI: str = config('SLACK_APP_EMOJI', default=':fire_extinguisher:')

SLACK_BOT_TOKEN: str = config('SLACK_BOT_TOKEN')

SLACK_EMERGENCY_COMMUNICATION_GUIDE_URL: str | None = config('SLACK_EMERGENCY_COMMUNICATION_GUIDE_URL', default=None)

SLACK_EMERGENCY_USERGROUP_ID: str | None = config('SLACK_EMERGENCY_USERGROUP_ID', default=None)

SLACK_INCIDENT_COMMAND: str = config('SLACK_INCIDENT_COMMAND', default='/incident')

SLACK_INCIDENT_COMMAND_ALIASES: list[str] = config('SLACK_INCIDENT_COMMAND_ALIASES', cast=Csv(), default='')

SLACK_INCIDENT_HELP_GUIDE_URL: str | None = config('SLACK_INCIDENT_HELP_GUIDE_URL', default=None)

SLACK_POSTMORTEM_HELP_URL: str | None = config('SLACK_POSTMORTEM_HELP_URL', default=None)

SLACK_SEVERITY_HELP_GUIDE_URL: str | None = config('SLACK_SEVERITY_HELP_GUIDE_URL', default=None)

SLACK_SIGNING_SECRET: str = config('SLACK_SIGNING_SECRET')

APP_DISPLAY_NAME: str = config('APP_DISPLAY_NAME', default='FireFighter')

BASE_URL: str = config('BASE_URL')

CONFLUENCE_API_KEY: str = config('CONFLUENCE_API_KEY')

CONFLUENCE_ON_CALL_PAGE_ID: int | None = config('CONFLUENCE_ON_CALL_PAGE_ID', cast=int, default=None)

CONFLUENCE_POSTMORTEM_FOLDER_ID: int = config('CONFLUENCE_POSTMORTEM_FOLDER_ID', cast=int)

CONFLUENCE_POSTMORTEM_SPACE: str = config('CONFLUENCE_POSTMORTEM_SPACE')

CONFLUENCE_POSTMORTEM_TEMPLATE_PAGE_ID: int = config('CONFLUENCE_POSTMORTEM_TEMPLATE_PAGE_ID', cast=int)

CONFLUENCE_RUNBOOKS_FOLDER_ID: int = config('CONFLUENCE_RUNBOOKS_FOLDER_ID', cast=int)

CONFLUENCE_URL: str = config('CONFLUENCE_URL')

CONFLUENCE_USERNAME: str = config('CONFLUENCE_USERNAME')

DRF_STANDARDIZED_ERRORS = {'ALLOWED_ERROR_STATUS_CODES': ['400', '401', '403', '404', '429', '500']}

ENABLE_CONFLUENCE = config('ENABLE_CONFLUENCE', cast=bool, default=False)

ENABLE_JIRA: bool = config('ENABLE_JIRA', cast=bool, default=False)

ENABLE_PAGERDUTY: bool = config('ENABLE_PAGERDUTY', cast=bool, default=False)

ENABLE_RAID: bool = config('ENABLE_RAID', cast=bool, default=False)

FF_HTTP_CLIENT_ADDITIONAL_HEADERS: dict[str, Any] | None = None

FF_OVERRIDE_MENUS_CREATION: Callable[[], None] | None = None

FF_ROLE_REMINDER_MIN_DAYS_INTERVAL = config('FF_ROLE_REMINDER_MIN_DAYS_INTERVAL', default=90, cast=int)

FF_SKIP_SECRET_KEY_CHECK: bool = config('FF_SKIP_SECRET_KEY_CHECK', default=False, cast=bool)

FF_SLACK_SKIP_CHECKS: bool = config('FF_SLACK_SKIP_CHECKS', cast=bool, default=_is_default_skip_check_cmd)

FF_USER_ID_HEADER: str = 'FF-User-Id'

PAGERDUTY_ACCOUNT_EMAIL: str = config('PAGERDUTY_ACCOUNT_EMAIL')

PAGERDUTY_API_KEY: str = config('PAGERDUTY_API_KEY')

PAGERDUTY_URL: str = config('PAGERDUTY_URL', default='https://api.pagerduty.com')

RAID_DEFAULT_JIRA_QRAFT_USER_ID: str = config('RAID_DEFAULT_JIRA_QRAFT_USER_ID')

RAID_JIRA_API_PASSWORD: str = config('RAID_JIRA_API_PASSWORD')

RAID_JIRA_API_URL: str = config('RAID_JIRA_API_URL')

RAID_JIRA_API_USER: str = config('RAID_JIRA_API_USER')

RAID_JIRA_PROJECT_KEY: str = config('RAID_JIRA_PROJECT_KEY')

RAID_JIRA_USER_IDS: dict[str, str] = {}

RAID_TOOLBOX_URL: str = config('RAID_TOOLBOX_URL')

SLACK_APP_EMOJI: str = config('SLACK_APP_EMOJI', default=':fire_extinguisher:')

SLACK_BOT_TOKEN: str = config('SLACK_BOT_TOKEN')

SLACK_EMERGENCY_COMMUNICATION_GUIDE_URL: str | None = config('SLACK_EMERGENCY_COMMUNICATION_GUIDE_URL', default=None)

SLACK_EMERGENCY_USERGROUP_ID: str | None = config('SLACK_EMERGENCY_USERGROUP_ID', default=None)

SLACK_INCIDENT_COMMAND: str = config('SLACK_INCIDENT_COMMAND', default='/incident')

SLACK_INCIDENT_COMMAND_ALIASES: list[str] = config('SLACK_INCIDENT_COMMAND_ALIASES', cast=Csv(), default='')

SLACK_INCIDENT_HELP_GUIDE_URL: str | None = config('SLACK_INCIDENT_HELP_GUIDE_URL', default=None)

SLACK_POSTMORTEM_HELP_URL: str | None = config('SLACK_POSTMORTEM_HELP_URL', default=None)

SLACK_SEVERITY_HELP_GUIDE_URL: str | None = config('SLACK_SEVERITY_HELP_GUIDE_URL', default=None)

SLACK_SIGNING_SECRET: str = config('SLACK_SIGNING_SECRET')

CustomJsonFormatter(*args: Any, **kwargs: Any)

49
50
51

def __init__(self, *args: Any, **kwargs: Any) -> None:
    self.FF_USER_ID_HEADER: str = settings.FF_USER_ID_HEADER
    super().__init__(*args, **kwargs)

APP_DISPLAY_NAME: str = config('APP_DISPLAY_NAME', default='FireFighter')

BASE_URL: str = config('BASE_URL')

firefighter URL Configuration.

The urlpatterns list routes URLs to views. For more information please see: https://docs.djangoproject.com/en/4.2/topics/http/urls/

Examples:¤

Function views¤

1. Add an import: from my_app import views
2. Add a URL to urlpatterns: path('', views.home, name='home')

Class-based views¤

1. Add an import: from other_app.views import Home
2. Add a URL to urlpatterns: path('', Home.as_view(), name='home')

Including another URLconf¤

1. Import the include() function: from django.urls import include, path
2. Add a URL to urlpatterns: path('blog/', include('blog.urls'))

Functions:

• get_first_in –

  Returns the first element of a list of dicts, where the value of a key matches one in the provided iterable.

• get_in –

  Get a value from arbitrarily nested dicts.

• is_during_office_hours –

  Check whether a datetime is during office hours. 9am-5pm, Mon-Fri.

get_first_in(ulist: list[T], key: str | Sequence[str], matches: Iterable[str], default: V | None = None) -> T | V | None

48
49
50
51
52
53
54
55
56
57
58
59
60

def get_first_in(
    ulist: list[T],
    key: str | Sequence[str],
    matches: Iterable[str],
    default: V | None = None,
) -> T | V | None:
    """Returns the first element of a list of dicts, where the value of a key matches one in the provided iterable."""
    if not isinstance(ulist, list) or ulist is None:
        return default  # type: ignore[unreachable]
    return next(
        (e for e in ulist if get_in(e, key) in matches),
        default,
    )

get_in(dictionary: dict[str, Any] | Any | None, keys: str | Sequence[str], default: Any | None = None) -> Any

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

def get_in(
    dictionary: dict[str, Any] | Any | None,
    keys: str | Sequence[str],
    default: Any | None = None,
) -> Any:
    """Get a value from arbitrarily nested dicts."""
    if dictionary is None:
        return None

    if isinstance(keys, str):
        keys = keys.split(".")
    if not keys:
        return dictionary
    if len(keys) == 1:
        return dictionary.get(keys[0], default)
    return get_in(dictionary.get(keys[0], {}), keys[1:], default=default)

is_during_office_hours(dt: datetime) -> bool

73
74
75
76
77
78
79