core: migrate code to benefit from 3.9 stuff

for now keeping ruff on 3.8 target version, need to sort out modules as well
This commit is contained in:
Dima Gerasimov 2024-10-19 20:19:07 +01:00
parent d1511929a8
commit 721fd98dca
37 changed files with 413 additions and 302 deletions

View file

@ -2,19 +2,21 @@
Bindings for the 'core' HPI configuration
'''
from __future__ import annotations
import re
from collections.abc import Sequence
from dataclasses import dataclass
from pathlib import Path
from typing import Optional
from . import PathIsh, warnings
from . import warnings
try:
from my.config import core as user_config # type: ignore[attr-defined]
except Exception as e:
try:
from my.config import common as user_config # type: ignore[attr-defined]
warnings.high("'common' config section is deprecated. Please rename it to 'core'.")
except Exception as e2:
# make it defensive, because it's pretty commonly used and would be annoying if it breaks hpi doctor etc.
@ -25,6 +27,7 @@ except Exception as e:
_HPI_CACHE_DIR_DEFAULT = ''
@dataclass
class Config(user_config):
'''
@ -35,7 +38,7 @@ class Config(user_config):
cache_dir = '/your/custom/cache/path'
'''
cache_dir: Optional[PathIsh] = _HPI_CACHE_DIR_DEFAULT
cache_dir: Path | str | None = _HPI_CACHE_DIR_DEFAULT
'''
Base directory for cachew.
- if None , means cache is disabled
@ -45,7 +48,7 @@ class Config(user_config):
NOTE: you shouldn't use this attribute in HPI modules directly, use Config.get_cache_dir()/cachew.cache_dir() instead
'''
tmp_dir: Optional[PathIsh] = None
tmp_dir: Path | str | None = None
'''
Path to a temporary directory.
This can be used temporarily while extracting zipfiles etc...
@ -53,34 +56,36 @@ class Config(user_config):
- otherwise , use the specified directory as the base temporary directory
'''
enabled_modules : Optional[Sequence[str]] = None
enabled_modules: Sequence[str] | None = None
'''
list of regexes/globs
- None means 'rely on disabled_modules'
'''
disabled_modules: Optional[Sequence[str]] = None
disabled_modules: Sequence[str] | None = None
'''
list of regexes/globs
- None means 'rely on enabled_modules'
'''
def get_cache_dir(self) -> Optional[Path]:
def get_cache_dir(self) -> Path | None:
cdir = self.cache_dir
if cdir is None:
return None
if cdir == _HPI_CACHE_DIR_DEFAULT:
from .cachew import _appdirs_cache_dir
return _appdirs_cache_dir()
else:
return Path(cdir).expanduser()
def get_tmp_dir(self) -> Path:
tdir: Optional[PathIsh] = self.tmp_dir
tdir: Path | str | None = self.tmp_dir
tpath: Path
# use tempfile if unset
if tdir is None:
import tempfile
tpath = Path(tempfile.gettempdir()) / 'HPI'
else:
tpath = Path(tdir)
@ -88,10 +93,10 @@ class Config(user_config):
tpath.mkdir(parents=True, exist_ok=True)
return tpath
def _is_module_active(self, module: str) -> Optional[bool]:
def _is_module_active(self, module: str) -> bool | None:
# None means the config doesn't specify anything
# todo might be nice to return the 'reason' too? e.g. which option has matched
def matches(specs: Sequence[str]) -> Optional[str]:
def matches(specs: Sequence[str]) -> str | None:
for spec in specs:
# not sure because . (packages separate) matches anything, but I guess unlikely to clash
if re.match(spec, module):
@ -107,10 +112,10 @@ class Config(user_config):
return None
else:
return False
else: # not None
else: # not None
if off is None:
return True
else: # not None
else: # not None
# fallback onto the 'enable everything', then the user will notice
warnings.medium(f"[module]: conflicting regexes '{on}' and '{off}' are set in the config. Please only use one of them.")
return True
@ -164,4 +169,5 @@ def test_active_modules() -> None:
assert cc._is_module_active("my.body.exercise") is True
assert len(record_warnings) == 1
### tests end