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
|
"""Defines directories for the application.
Follows the XDG Base Directory Specification on Linux: <https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>
See <https://pypi.org/project/platformdirs/> for other platforms.
"""
from __future__ import annotations
import logging
from pathlib import Path
from typing import NamedTuple
from platformdirs import PlatformDirs
from zabbix_cli.__about__ import APP_NAME
from zabbix_cli.__about__ import AUTHOR
logger = logging.getLogger(__name__)
_PLATFORM_DIR = PlatformDirs(APP_NAME, AUTHOR)
CONFIG_DIR = _PLATFORM_DIR.user_config_path
"""Directory for user configuration files."""
DATA_DIR = _PLATFORM_DIR.user_data_path
"""Directory for user data files."""
LOGS_DIR = _PLATFORM_DIR.user_log_path
"""Directory to store user log files."""
SITE_CONFIG_DIR = _PLATFORM_DIR.site_config_path
"""Directory for site-wide configuration files, i.e. `/etc/xdg/zabbix-cli`."""
EXPORT_DIR = DATA_DIR / "exports"
"""Directory to store exported data."""
class Directory(NamedTuple):
name: str
path: Path
required: bool = False
create: bool = True
"""Do not log/print on failure to create directory."""
DIRS = [
Directory("Config", CONFIG_DIR),
Directory("Data", DATA_DIR),
Directory("Logs", LOGS_DIR),
# Don't create site config directory by default (root-only)
Directory("Site Config", SITE_CONFIG_DIR, create=False),
# Exports directory is created on demand
Directory("Exports", EXPORT_DIR, create=False),
]
def init_directories() -> None:
"""Create required directories for the application to function."""
from .output.console import error
from .output.console import exit_err
for directory in DIRS:
if directory.path.exists() or not directory.create:
logger.debug(
"Skipping creating directory '%s'. Exists: %s",
directory.path,
directory.path.exists(),
)
continue
try:
directory.path.mkdir(parents=True)
except Exception as e:
message = (
f"Failed to create {directory.name} directory {directory.path}: {e}"
)
if directory.required:
exit_err(message, exc_info=True)
else:
error(message, exc_info=True)
|
