# matrixctl
# Copyright (c) 2020-2023 Michael Sasser <Michael@MichaelSasser.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Use this module for structures."""
from __future__ import annotations
import typing as t
[docs]
class Config(t.TypedDict):
"""Cast the YAML config to a typed dict."""
servers: dict[str, ConfigServer]
server: ConfigServer
[docs]
class ConfigServer(t.TypedDict):
"""Add a `server` to the YAML config structure."""
ansible: ConfigServerAnsible
synapse: ConfigServerSynapse
api: ConfigServerAPI
ssh: ConfigServerSSH
maintenance: ConfigServerMaintenance # default = 4
[docs]
class ConfigServerAnsible(t.TypedDict):
"""Add `ansible` to `server` in the YAML config structure."""
playbook: str
[docs]
class ConfigServerSynapse(t.TypedDict):
"""Add `synapse` to `server` in the YAML config structure."""
playbook: str
[docs]
class ConfigServerAPI(t.TypedDict):
"""Add `api` to `server` in the YAML config structure."""
domain: str
username: str
token: str
concurrent_limit: int
[docs]
class ConfigServerMaintenance(t.TypedDict):
"""Add `maintenance` to `server` in the YAML config structure."""
tasks: list[str]
# vim: set ft=python :