Module bsstatus.config

Configuration interface for bsstatus.

bsstatus stores its configurations in the config.json file inside the bsstatus directory in the user's config directory.

We use the platformdirs library to determine the user's config directory.

Functions

def get_config() ‑> Config

Expand source code

def get_config() -> Config:
    """
    Fetch a Config object based off the config file.

    If the config file does not exist, it will be created with default values.
    """
    config_dir_path = user_config_path("bsstatus", ensure_exists=True)
    config_file_path = config_dir_path / "config.json"

    if not config_file_path.exists():
        log.debug(f"Writing new config file (with defaults) to {config_file_path}")
        config_file_path.write_text(Config().model_dump_json(indent=4))

    c = Config.model_validate_json(config_file_path.read_text())
    log.debug(f"Config: {c.model_dump_json(indent=4)}")
    return c

Fetch a Config object based off the config file.

If the config file does not exist, it will be created with default values.

Classes

class BlinkstickConfig (**data: Any)

Expand source code

class BlinkstickConfig(BaseModel):
    """
    Holds configurations for working with the Blinkstick.
    """

    # The color to use when the user is away.
    away_color: int = 0x323200

    # The color to use when the user is busy.
    busy_color: int = 0x332100

    # The color to use when the user is do not disturb.
    dnd_color: int = 0x320000

    # The color to use when the user is available.
    available_color: int = 0x003200

    # The color to use when the user state is unknown.
    unknown_color: int = 0x000032

Holds configurations for working with the Blinkstick.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• pydantic.main.BaseModel

Class variables

var available_color : int

var away_color : int

var busy_color : int

var dnd_color : int

var model_config

var unknown_color : int

class Config (**data: Any)

Expand source code

class Config(BaseModel):
    """
    Holds all configurations for bsstatus.
    """

    # We can monitor multiple slacks at once.
    slacks: list[SlackConfig] = [SlackConfig()]

    # We can monitor multiple icals at once.
    icals: list[ICalConfig] = [ICalConfig()]

    # There is only one blinkstick configuration
    blinkstick: BlinkstickConfig = BlinkstickConfig()

    # The time (in seconds) to wait between checking the status of the user.
    pause_time: int = 5

    model_config = ConfigDict(extra="forbid")

Holds all configurations for bsstatus.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• pydantic.main.BaseModel

Class variables

var blinkstick : BlinkstickConfig

var icals : list[ICalConfig]

var model_config

var pause_time : int

var slacks : list[SlackConfig]

class FinderConfig

Expand source code

class FinderConfig:
    """
    Base class for all finder configurations.
    """

    pass

Base class for all finder configurations.

Subclasses

• ICalConfig
• SlackConfig

class ICalConfig (**data: Any)

Expand source code

class ICalConfig(BaseModel, FinderConfig):
    """
    Holds configurations for working with an iCal.
    """

    # The URL of the iCal to monitor.
    url: str | None = None

    """
    This is a list of dict from key to value.
    Each item in the list is a listing of key-value pairs that
    if all in the dict match an event, it will be ignored even if
    it matches up for the current time.
    For example, if i want to ignore events that have a iCal key of
    X-MICROSOFT-CDO-BUSYSTATUS with value of TENTATIVE
    ignore_events_matching_any_of_all = [
        {
            "X-MICROSOFT-CDO-BUSYSTATUS": "TENTATIVE"
        }
    ]

    If I want to ignore events that have an iCal key of
    X-MICROSOFT-CDO-BUSYSTATUS with value of TENTATIVE
    AND another key of X-MICROSOFT-CDO-ALLDAYEVENT with value of TRUE
    ignore_events_matching_any_of_all = [
        {
            "X-MICROSOFT-CDO-BUSYSTATUS": "TENTATIVE",
            "X-MICROSOFT-CDO-ALLDAYEVENT": "TRUE"
        }
    ]

    In other words each dict is OR'd while the items in the dict are AND'd.
    """
    ignore_events_matching_any_of_all: list[dict[str, str]] = [
        # By default ignore events that according to Outlook we respond to as 'tentative'
        # or just didn't respond at all.
        {
            "X-MICROSOFT-CDO-BUSYSTATUS": "TENTATIVE",
        },
        # Also ignore events that lead to a busy status of 'free'
        {
            "X-MICROSOFT-CDO-BUSYSTATUS": "FREE",
        },
        # Also ignore events that are marked by Outlook as all-day events.
        {"X-MICROSOFT-CDO-ALLDAYEVENT": "TRUE"},
    ]

Holds configurations for working with an iCal.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• pydantic.main.BaseModel
• FinderConfig

Class variables

var ignore_events_matching_any_of_all : list[dict[str, str]]

var model_config

var url : str | None

This is a list of dict from key to value. Each item in the list is a listing of key-value pairs that if all in the dict match an event, it will be ignored even if it matches up for the current time. For example, if i want to ignore events that have a iCal key of X-MICROSOFT-CDO-BUSYSTATUS with value of TENTATIVE ignore_events_matching_any_of_all = [ { "X-MICROSOFT-CDO-BUSYSTATUS": "TENTATIVE" } ]

If I want to ignore events that have an iCal key of X-MICROSOFT-CDO-BUSYSTATUS with value of TENTATIVE AND another key of X-MICROSOFT-CDO-ALLDAYEVENT with value of TRUE ignore_events_matching_any_of_all = [ { "X-MICROSOFT-CDO-BUSYSTATUS": "TENTATIVE", "X-MICROSOFT-CDO-ALLDAYEVENT": "TRUE" } ]

In other words each dict is OR'd while the items in the dict are AND'd.

class SlackConfig (**data: Any)

Expand source code

class SlackConfig(BaseModel, FinderConfig):
    """
    Holds configurations for working with Slack.
    """

    # The user id of the user to monitor. NOT the slack user name.
    user_id: str | None = None

    # Usually starts with xoxp-
    # Need at leastt dnd:read and users:read
    token: str | None = None

    # When parsing the status text, if this regex matches, the user is considered busy.
    busy_regex: str = ".*busy.*"

    # When parsing the status text, if this regex matches, the user is considered away.
    away_regex: str = ".*(afk|brb|be right back|lunch|walking).*"

Holds configurations for working with Slack.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• pydantic.main.BaseModel
• FinderConfig

Class variables

var away_regex : str

var busy_regex : str

var model_config

var token : str | None

var user_id : str | None