Coverage for downtify/db/config.py: 100%

67 statements  

« prev     ^ index     » next       coverage.py v7.17.4, created at 2026-11-21 22:18 +0000

1from __future__ import annotations 

2 

3import enum 

4import os 

5import re 

6from collections.abc import Mapping 

7from dataclasses import dataclass 

8from pathlib import Path 

9 

10_POSTGRES_PREFIXES = ('postgres://', 'postgresql://') 

11_IDENTIFIER = re.compile(r'^[A-Za-z_][A-Za-z0-9_]{0,62}$') 

12 

13 

14class Dialect(enum.Enum): 

15 SQLITE = 'sqlite' 

16 POSTGRES = 'postgres' 

17 

18 

19# DB group -> SQLite file, relative to the data directory. 

20GROUP_FILES: dict[str, str] = { 

21 'library': 'downtify_library.db', 

22 'monitor': 'downtify_monitor.db', 

23 'auth': 'downtify_auth.db', 

24 'activity': 'downtify_activity.db', 

25 'doctor_hashes': 'doctor/audio_hashes.db', 

26 'doctor_dupes': 'doctor/duplicates.db', 

27} 

28 

29 

30def _parse_int(env: Mapping[str, str], name: str, default: int) -> int: 

31 raw = env.get(name) 

32 if raw is None or not raw.strip(): 

33 return default 

34 try: 

35 return int(raw.strip()) 

36 except ValueError: 

37 raise ValueError(f'{name} must be an integer, got {raw.strip()!r}') 

38 

39 

40def _parse_float(env: Mapping[str, str], name: str, default: float) -> float: 

41 raw = env.get(name) 

42 if raw is None or not raw.strip(): 

43 return default 

44 try: 

45 return float(raw.strip()) 

46 except ValueError: 

47 raise ValueError(f'{name} must be a number, got {raw.strip()!r}') 

48 

49 

50@dataclass(frozen=True) 

51class DbConfig: 

52 url: str | None = None 

53 data_dir: Path = Path('/data') 

54 pool_min: int = 2 

55 pool_max: int = 20 

56 pool_timeout: float = 10.0 

57 #: PostgreSQL schema to use (``DB_SEARCH_PATH``); None keeps the 

58 #: server default (``public``). 

59 search_path: str | None = None 

60 

61 @property 

62 def dialect(self) -> Dialect: 

63 return Dialect.POSTGRES if self.url else Dialect.SQLITE 

64 

65 def sqlite_path(self, group: str) -> Path: 

66 try: 

67 filename = GROUP_FILES[group] 

68 except KeyError: 

69 raise ValueError(f'unknown DB group: {group!r}') from None 

70 return self.data_dir / filename 

71 

72 @classmethod 

73 def from_env(cls, env: Mapping[str, str] | None = None) -> DbConfig: 

74 if env is None: 

75 env = os.environ 

76 

77 # Never echo the URL in an error message: it may contain a password. 

78 url = (env.get('DATABASE_URL') or '').strip() or None 

79 if url is not None and not url.startswith(_POSTGRES_PREFIXES): 

80 raise ValueError( 

81 'DATABASE_URL must start with postgres:// or postgresql://' 

82 ) 

83 

84 data_dir = Path(env.get('DATABASE_DIR') or '/data') 

85 pool_min = _parse_int(env, 'DB_POOL_MIN', 2) 

86 pool_max = _parse_int(env, 'DB_POOL_MAX', 20) 

87 pool_timeout = _parse_float(env, 'DB_POOL_TIMEOUT', 10.0) 

88 

89 if pool_min < 0: 

90 raise ValueError('DB_POOL_MIN must be >= 0') 

91 if pool_max < 1: 

92 raise ValueError('DB_POOL_MAX must be >= 1') 

93 if pool_max < pool_min: 

94 raise ValueError('DB_POOL_MAX must be >= DB_POOL_MIN') 

95 

96 search_path = (env.get('DB_SEARCH_PATH') or '').strip() or None 

97 if search_path is not None and not _IDENTIFIER.match(search_path): 

98 raise ValueError( 

99 'DB_SEARCH_PATH must be a plain identifier (letters, digits ' 

100 'and underscores, not starting with a digit)' 

101 ) 

102 

103 return cls( 

104 url=url, 

105 data_dir=data_dir, 

106 pool_min=pool_min, 

107 pool_max=pool_max, 

108 pool_timeout=pool_timeout, 

109 search_path=search_path, 

110 )