1 2 3 4 5 6 7 8 9 10 11 12 13 14 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 62 63 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 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 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
|
"""Models for Supervisor addons."""
from abc import ABC
from dataclasses import dataclass, field
from enum import StrEnum
from ipaddress import IPv4Address
from typing import Any
from mashumaro import field_options
from mashumaro.config import TO_DICT_ADD_BY_ALIAS_FLAG, BaseConfig
from .base import DEFAULT, ContainerStats, Options, Request, RequestConfig, ResponseData
# --- ENUMS ----
class AddonStage(StrEnum):
"""AddonStage type."""
STABLE = "stable"
EXPERIMENTAL = "experimental"
DEPRECATED = "deprecated"
class AddonBootConfig(StrEnum):
"""AddonBootConfig type."""
AUTO = "auto"
MANUAL = "manual"
MANUAL_ONLY = "manual_only"
class AddonBoot(StrEnum):
"""AddonBoot type."""
AUTO = "auto"
MANUAL = "manual"
class CpuArch(StrEnum):
"""CpuArch type."""
ARMV7 = "armv7"
ARMHF = "armhf"
AARCH64 = "aarch64"
I386 = "i386"
AMD64 = "amd64"
class Capability(StrEnum):
"""Capability type.
This is an incomplete list. Supervisor regularly adds support for new
privileged capabilities as addon developers request them. Therefore
when returning a list of capabilities, there may be some which are not in
this list parsed as strings on older versions of the client.
"""
BPF = "BPF"
CHECKPOINT_RESTORE = "CHECKPOINT_RESTORE"
DAC_READ_SEARCH = "DAC_READ_SEARCH"
IPC_LOCK = "IPC_LOCK"
NET_ADMIN = "NET_ADMIN"
NET_RAW = "NET_RAW"
PERFMON = "PERFMON"
SYS_ADMIN = "SYS_ADMIN"
SYS_MODULE = "SYS_MODULE"
SYS_NICE = "SYS_NICE"
SYS_PTRACE = "SYS_PTRACE"
SYS_RAWIO = "SYS_RAWIO"
SYS_RESOURCE = "SYS_RESOURCE"
SYS_TIME = "SYS_TIME"
class AppArmor(StrEnum):
"""AppArmor type."""
DEFAULT = "default"
DISABLE = "disable"
PROFILE = "profile"
class SupervisorRole(StrEnum):
"""SupervisorRole type."""
ADMIN = "admin"
BACKUP = "backup"
DEFAULT = "default"
HOMEASSISTANT = "homeassistant"
MANAGER = "manager"
class AddonState(StrEnum):
"""AddonState type."""
STARTUP = "startup"
STARTED = "started"
STOPPED = "stopped"
UNKNOWN = "unknown"
ERROR = "error"
class AddonStartup(StrEnum):
"""AddonStartup type."""
APPLICATION = "application"
INITIALIZE = "initialize"
ONCE = "once"
SERVICES = "services"
SYSTEM = "system"
# --- OBJECTS ----
@dataclass(frozen=True)
class AddonInfoBaseFields(ABC):
"""AddonInfoBaseFields ABC type."""
advanced: bool
available: bool
build: bool
description: str
homeassistant: str | None
icon: bool
logo: bool
name: str
repository: str
slug: str
stage: AddonStage
update_available: bool
url: str | None
version_latest: str
version: str | None
@dataclass(frozen=True)
class AddonInfoStoreBaseFields(ABC):
"""AddonInfoAllStoreFields ABC type."""
arch: list[CpuArch]
documentation: bool
@dataclass(frozen=True)
class AddonInfoStoreExtFields(ABC):
"""AddonInfoStoreExtFields ABC type."""
apparmor: AppArmor
auth_api: bool
docker_api: bool
full_access: bool
homeassistant_api: bool
host_network: bool
host_pid: bool
ingress: bool
long_description: str | None
rating: int
signed: bool
# Hassio is deprecated name for supervisor
supervisor_api: bool = field(metadata=field_options(alias="hassio_api"))
supervisor_role: SupervisorRole = field(
metadata=field_options(alias="hassio_role"),
)
class Config(BaseConfig):
"""Mashumaro config options."""
code_generation_options = [TO_DICT_ADD_BY_ALIAS_FLAG] # noqa: RUF012
@dataclass(frozen=True)
class AddonInfoStoreExtInstalledBaseFields(ABC):
"""AddonInfoStoreExtInstalledBaseFields ABC type."""
detached: bool
@dataclass(frozen=True, slots=True)
class StoreAddon(AddonInfoBaseFields, AddonInfoStoreBaseFields, ResponseData):
"""StoreAddon type."""
installed: bool
@dataclass(frozen=True, slots=True)
class StoreAddonComplete(
AddonInfoBaseFields,
AddonInfoStoreBaseFields,
AddonInfoStoreExtFields,
AddonInfoStoreExtInstalledBaseFields,
ResponseData,
):
"""StoreAddonComplete type."""
installed: bool
@dataclass(frozen=True, slots=True)
class InstalledAddon(
AddonInfoBaseFields,
AddonInfoStoreExtInstalledBaseFields,
ResponseData,
):
"""InstalledAddon type."""
state: AddonState
@dataclass(frozen=True, slots=True)
class InstalledAddonComplete(
AddonInfoBaseFields,
AddonInfoStoreExtInstalledBaseFields,
AddonInfoStoreBaseFields,
AddonInfoStoreExtFields,
ResponseData,
):
"""InstalledAddonComplete model."""
state: AddonState
hostname: str
dns: list[str]
protected: bool
boot: AddonBoot
boot_config: AddonBootConfig
options: dict[str, Any]
schema: list[dict[str, Any]] | None
machine: list[str]
network: dict[str, int | None] | None
network_description: dict[str, str] | None
host_ipc: bool
host_uts: bool
host_dbus: bool
privileged: list[Capability | str]
changelog: bool
stdin: bool
gpio: bool
usb: bool
uart: bool
kernel_modules: bool
devicetree: bool
udev: bool
video: bool
audio: bool
startup: AddonStartup
services: list[str]
discovery: list[str]
translations: dict[str, Any]
webui: str | None
ingress_entry: str | None
ingress_url: str | None
ingress_port: int | None
ingress_panel: bool | None
audio_input: str | None
audio_output: str | None
auto_update: bool
ip_address: IPv4Address
watchdog: bool
devices: list[str]
system_managed: bool
system_managed_config_entry: str | None
@dataclass(frozen=True, slots=True)
class AddonsList(ResponseData):
"""AddonsList model."""
addons: list[InstalledAddon]
@dataclass(frozen=True, slots=True)
class AddonsOptions(Options):
"""AddonsOptions model."""
# Options term is used to reference both general options and addon-specific config
# Therefore this field is config to match UI rather then Supervisor's API
config: dict[str, Any] | None = field( # type: ignore[assignment]
default=DEFAULT,
metadata=field_options(alias="options"),
)
boot: AddonBoot | None = None
auto_update: bool | None = None
network: dict[str, int | None] | None = DEFAULT # type: ignore[assignment]
audio_input: str | None = DEFAULT # type: ignore[assignment]
audio_output: str | None = DEFAULT # type: ignore[assignment]
ingress_panel: bool | None = None
watchdog: bool | None = None
class Config(RequestConfig):
"""Mashumaro config options."""
serialize_by_alias = True
@dataclass(frozen=True, slots=True)
class AddonsConfigValidate(ResponseData):
"""AddonsConfigValidate model."""
message: str
valid: bool
pwned: bool | None
@dataclass(frozen=True, slots=True)
class AddonsSecurityOptions(Options):
"""AddonsSecurityOptions model."""
protected: bool | None = None
@dataclass(frozen=True, slots=True)
class AddonsStats(ContainerStats):
"""AddonsStats model."""
@dataclass(frozen=True, slots=True)
class AddonsUninstall(Request):
"""AddonsUninstall model."""
remove_config: bool | None = None
@dataclass(frozen=True, slots=True)
class AddonsRebuild(Request):
"""AddonsRebuild model."""
force: bool | None = None
@dataclass(frozen=True, slots=True)
class Repository(ResponseData):
"""Repository model."""
slug: str
name: str
source: str
url: str
maintainer: str
@dataclass(frozen=True, slots=True)
class StoreAddonsList(ResponseData):
"""StoreAddonsList model."""
addons: list[StoreAddon]
@dataclass(frozen=True, slots=True)
class StoreInfo(StoreAddonsList, ResponseData):
"""StoreInfo model."""
repositories: list[Repository]
@dataclass(frozen=True, slots=True)
class StoreAddonUpdate(Request):
"""StoreAddonUpdate model."""
backup: bool | None = None
background: bool | None = None
@dataclass(frozen=True, slots=True)
class StoreAddonInstall(Request):
"""StoreAddonInstall model."""
background: bool | None = None
@dataclass(frozen=True, slots=True)
class StoreAddRepository(Request):
"""StoreAddRepository model."""
repository: str
|