tnfr 4.5.1__py3-none-any.whl → 6.0.0__py3-none-any.whl

tnfr/utils/init.py

@@ -0,0 +1,746 @@
+"""Core logging and import helpers for :mod:`tnfr`.
+
+This module merges the functionality that historically lived in
+``tnfr.logging_utils`` and ``tnfr.import_utils``.  The behaviour is kept
+identical so downstream consumers can keep relying on the same APIs while
+benefiting from a consolidated entry point under :mod:`tnfr.utils`.
+"""
+
+from __future__ import annotations
+
+import importlib
+import logging
+import threading
+import warnings
+import weakref
+from collections import OrderedDict
+from dataclasses import dataclass, field
+from typing import Any, Callable, Hashable, Iterable, Iterator, Literal, Mapping
+
+from ..cache import CacheManager
+
+__all__ = (
+    "_configure_root",
+    "cached_import",
+    "warm_cached_import",
+    "LazyImportProxy",
+    "get_logger",
+    "get_numpy",
+    "get_nodenx",
+    "prune_failed_imports",
+    "WarnOnce",
+    "warn_once",
+    "IMPORT_LOG",
+    "EMIT_MAP",
+    "_warn_failure",
+    "_IMPORT_STATE",
+    "_reset_logging_state",
+    "_reset_import_state",
+    "_FAILED_IMPORT_LIMIT",
+    "_DEFAULT_CACHE_SIZE",
+)
+
+
+_LOGGING_CONFIGURED = False
+
+
+def _reset_logging_state() -> None:
+    """Reset cached logging configuration state."""
+
+    global _LOGGING_CONFIGURED
+    _LOGGING_CONFIGURED = False
+
+
+def _configure_root() -> None:
+    """Ensure the root logger has handlers and a default format."""
+
+    global _LOGGING_CONFIGURED
+    if _LOGGING_CONFIGURED:
+        return
+
+    root = logging.getLogger()
+    if not root.handlers:
+        kwargs = {"format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"}
+        if root.level == logging.NOTSET:
+            kwargs["level"] = logging.INFO
+        logging.basicConfig(**kwargs)
+
+    _LOGGING_CONFIGURED = True
+
+
+def get_logger(name: str) -> logging.Logger:
+    """Return a module-specific logger."""
+
+    _configure_root()
+    return logging.getLogger(name)
+
+
+class WarnOnce:
+    """Log a warning only once for each unique key.
+
+    ``WarnOnce`` tracks seen keys in a bounded :class:`set`. When ``maxsize`` is
+    reached an arbitrary key is evicted to keep memory usage stable; ordered
+    eviction is intentionally avoided to keep the implementation lightweight.
+    Instances are callable and accept either a mapping of keys to values or a
+    single key/value pair. Passing ``maxsize <= 0`` disables caching and logs on
+    every invocation.
+    """
+
+    def __init__(self, logger: logging.Logger, msg: str, *, maxsize: int = 1024) -> None:
+        self._logger = logger
+        self._msg = msg
+        self._maxsize = maxsize
+        self._seen: set[Hashable] = set()
+        self._lock = threading.Lock()
+
+    def _mark_seen(self, key: Hashable) -> bool:
+        """Return ``True`` when ``key`` has not been seen before."""
+
+        if self._maxsize <= 0:
+            # Caching disabled – always log.
+            return True
+        if key in self._seen:
+            return False
+        if len(self._seen) >= self._maxsize:
+            # ``set.pop()`` removes an arbitrary element which is acceptable for
+            # this lightweight cache.
+            self._seen.pop()
+        self._seen.add(key)
+        return True
+
+    def __call__(
+        self,
+        data: Mapping[Hashable, Any] | Hashable,
+        value: Any | None = None,
+    ) -> None:
+        """Log new keys found in ``data``.
+
+        ``data`` may be a mapping of keys to payloads or a single key. When
+        called with a single key ``value`` customises the payload passed to the
+        logging message; the key itself is used when ``value`` is omitted.
+        """
+
+        if isinstance(data, Mapping):
+            new_items: dict[Hashable, Any] = {}
+            with self._lock:
+                for key, item_value in data.items():
+                    if self._mark_seen(key):
+                        new_items[key] = item_value
+            if new_items:
+                self._logger.warning(self._msg, new_items)
+            return
+
+        key = data
+        payload = value if value is not None else data
+        with self._lock:
+            should_log = self._mark_seen(key)
+        if should_log:
+            self._logger.warning(self._msg, payload)
+
+    def clear(self) -> None:
+        """Reset tracked keys."""
+
+        with self._lock:
+            self._seen.clear()
+
+
+def warn_once(
+    logger: logging.Logger,
+    msg: str,
+    *,
+    maxsize: int = 1024,
+) -> WarnOnce:
+    """Return a :class:`WarnOnce` logger."""
+
+    return WarnOnce(logger, msg, maxsize=maxsize)
+
+
+_FAILED_IMPORT_LIMIT = 128
+_DEFAULT_CACHE_SIZE = 128
+
+_SUCCESS_CACHE_NAME = "import.success"
+_FAILURE_CACHE_NAME = "import.failure"
+
+
+def _import_key(module_name: str, attr: str | None) -> str:
+    return module_name if attr is None else f"{module_name}.{attr}"
+
+
+@dataclass(slots=True)
+class ImportRegistry:
+    """Process-wide registry tracking failed imports and emitted warnings."""
+
+    limit: int = 128
+    failed: OrderedDict[str, None] = field(default_factory=OrderedDict)
+    warned: set[str] = field(default_factory=set)
+    lock: threading.Lock = field(default_factory=threading.Lock)
+
+    def _insert(self, key: str) -> None:
+        self.failed[key] = None
+        self.failed.move_to_end(key)
+        while len(self.failed) > self.limit:
+            self.failed.popitem(last=False)
+
+    def record_failure(self, key: str, *, module: str | None = None) -> None:
+        """Record ``key`` and, optionally, ``module`` as failed imports."""
+
+        with self.lock:
+            self._insert(key)
+            if module and module != key:
+                self._insert(module)
+
+    def discard(self, key: str) -> None:
+        """Remove ``key`` from the registry and clear its warning state."""
+
+        with self.lock:
+            self.failed.pop(key, None)
+            self.warned.discard(key)
+
+    def mark_warning(self, module: str) -> bool:
+        """Mark ``module`` as warned and return ``True`` if it was new."""
+
+        with self.lock:
+            if module in self.warned:
+                return False
+            self.warned.add(module)
+            return True
+
+    def clear(self) -> None:
+        """Remove all failure records and warning markers."""
+
+        with self.lock:
+            self.failed.clear()
+            self.warned.clear()
+
+    def __contains__(self, key: str) -> bool:  # pragma: no cover - trivial
+        with self.lock:
+            return key in self.failed
+
+
+# Successful imports are cached so lazy proxies can resolve once and later
+# requests return the concrete object without recreating the proxy. The cache
+# stores weak references whenever possible so unused imports can be collected
+# after external references disappear.
+
+
+class _CacheEntry:
+    """Container storing either a weak or strong reference to a value."""
+
+    __slots__ = ("_kind", "_value")
+
+    def __init__(
+        self,
+        value: Any,
+        *,
+        key: str,
+        remover: Callable[[str, weakref.ReferenceType[Any]], None],
+    ) -> None:
+        try:
+            reference = weakref.ref(value, lambda ref, key=key: remover(key, ref))
+        except TypeError:
+            self._kind = "strong"
+            self._value = value
+        else:
+            self._kind = "weak"
+            self._value = reference
+
+    def get(self) -> Any | None:
+        if self._kind == "weak":
+            return self._value()
+        return self._value
+
+    def matches(self, ref: weakref.ReferenceType[Any]) -> bool:
+        return self._kind == "weak" and self._value is ref
+
+
+_IMPORT_CACHE_MANAGER = CacheManager(default_capacity=_DEFAULT_CACHE_SIZE)
+
+
+def _success_cache_factory() -> OrderedDict[str, _CacheEntry]:
+    return OrderedDict()
+
+
+def _failure_cache_factory() -> OrderedDict[str, Exception]:
+    return OrderedDict()
+
+
+_IMPORT_CACHE_MANAGER.register(_SUCCESS_CACHE_NAME, _success_cache_factory)
+_IMPORT_CACHE_MANAGER.register(_FAILURE_CACHE_NAME, _failure_cache_factory)
+
+
+def _remove_success_entry(key: str, ref: weakref.ReferenceType[Any]) -> None:
+
+    def _cleanup(cache: OrderedDict[str, _CacheEntry]) -> OrderedDict[str, _CacheEntry]:
+        entry = cache.get(key)
+        if entry is not None and entry.matches(ref):
+            cache.pop(key, None)
+            _IMPORT_CACHE_MANAGER.increment_eviction(_SUCCESS_CACHE_NAME)
+        return cache
+
+    _IMPORT_CACHE_MANAGER.update(_SUCCESS_CACHE_NAME, _cleanup)
+
+
+def _trim_cache(name: str, cache: OrderedDict[str, Any]) -> None:
+    capacity = _IMPORT_CACHE_MANAGER.get_capacity(name)
+    if capacity is None:
+        return
+    while len(cache) > capacity:
+        cache.popitem(last=False)
+        _IMPORT_CACHE_MANAGER.increment_eviction(name)
+
+
+def _get_success(key: str) -> Any | None:
+    result: Any | None = None
+    hit = False
+
+    with _IMPORT_CACHE_MANAGER.timer(_SUCCESS_CACHE_NAME):
+
+        def _lookup(cache: OrderedDict[str, _CacheEntry]) -> OrderedDict[str, _CacheEntry]:
+            nonlocal result, hit
+            entry = cache.get(key)
+            if entry is None:
+                return cache
+            value = entry.get()
+            if value is None:
+                cache.pop(key, None)
+                _IMPORT_CACHE_MANAGER.increment_eviction(_SUCCESS_CACHE_NAME)
+                return cache
+            cache.move_to_end(key)
+            result = value
+            hit = True
+            return cache
+
+        _IMPORT_CACHE_MANAGER.update(_SUCCESS_CACHE_NAME, _lookup)
+        if hit:
+            _IMPORT_CACHE_MANAGER.increment_hit(_SUCCESS_CACHE_NAME)
+            return result
+        _IMPORT_CACHE_MANAGER.increment_miss(_SUCCESS_CACHE_NAME)
+        return None
+
+
+def _store_success(key: str, value: Any) -> None:
+    entry = _CacheEntry(value, key=key, remover=_remove_success_entry)
+
+    def _store(cache: OrderedDict[str, _CacheEntry]) -> OrderedDict[str, _CacheEntry]:
+        cache[key] = entry
+        cache.move_to_end(key)
+        _trim_cache(_SUCCESS_CACHE_NAME, cache)
+        return cache
+
+    def _purge_failure(cache: OrderedDict[str, Exception]) -> OrderedDict[str, Exception]:
+        if cache.pop(key, None) is not None:
+            _IMPORT_CACHE_MANAGER.increment_eviction(_FAILURE_CACHE_NAME)
+        return cache
+
+    _IMPORT_CACHE_MANAGER.update(_SUCCESS_CACHE_NAME, _store)
+    _IMPORT_CACHE_MANAGER.update(_FAILURE_CACHE_NAME, _purge_failure)
+
+
+def _get_failure(key: str) -> Exception | None:
+    result: Exception | None = None
+    hit = False
+
+    with _IMPORT_CACHE_MANAGER.timer(_FAILURE_CACHE_NAME):
+
+        def _lookup(cache: OrderedDict[str, Exception]) -> OrderedDict[str, Exception]:
+            nonlocal result, hit
+            exc = cache.get(key)
+            if exc is None:
+                return cache
+            cache.move_to_end(key)
+            result = exc
+            hit = True
+            return cache
+
+        _IMPORT_CACHE_MANAGER.update(_FAILURE_CACHE_NAME, _lookup)
+        if hit:
+            _IMPORT_CACHE_MANAGER.increment_hit(_FAILURE_CACHE_NAME)
+            return result
+        _IMPORT_CACHE_MANAGER.increment_miss(_FAILURE_CACHE_NAME)
+        return None
+
+
+def _store_failure(key: str, exc: Exception) -> None:
+
+    def _store(cache: OrderedDict[str, Exception]) -> OrderedDict[str, Exception]:
+        cache[key] = exc
+        cache.move_to_end(key)
+        _trim_cache(_FAILURE_CACHE_NAME, cache)
+        return cache
+
+    def _purge_success(cache: OrderedDict[str, _CacheEntry]) -> OrderedDict[str, _CacheEntry]:
+        if cache.pop(key, None) is not None:
+            _IMPORT_CACHE_MANAGER.increment_eviction(_SUCCESS_CACHE_NAME)
+        return cache
+
+    _IMPORT_CACHE_MANAGER.update(_FAILURE_CACHE_NAME, _store)
+    _IMPORT_CACHE_MANAGER.update(_SUCCESS_CACHE_NAME, _purge_success)
+
+
+def _clear_import_cache() -> None:
+    _IMPORT_CACHE_MANAGER.clear()
+
+
+_IMPORT_STATE = ImportRegistry()
+# Public alias to ease direct introspection in tests and diagnostics.
+IMPORT_LOG = _IMPORT_STATE
+
+
+def _reset_import_state() -> None:
+    """Reset cached import tracking structures."""
+
+    global _IMPORT_STATE, IMPORT_LOG
+    _IMPORT_STATE = ImportRegistry()
+    IMPORT_LOG = _IMPORT_STATE
+    _clear_import_cache()
+
+
+def _import_cached(module_name: str, attr: str | None) -> tuple[bool, Any]:
+    """Import ``module_name`` (and optional ``attr``) capturing failures."""
+
+    key = _import_key(module_name, attr)
+    cached_value = _get_success(key)
+    if cached_value is not None:
+        return True, cached_value
+
+    cached_failure = _get_failure(key)
+    if cached_failure is not None:
+        return False, cached_failure
+
+    try:
+        module = importlib.import_module(module_name)
+        obj = getattr(module, attr) if attr else module
+    except (ImportError, AttributeError) as exc:
+        _store_failure(key, exc)
+        return False, exc
+
+    _store_success(key, obj)
+    return True, obj
+
+
+logger = get_logger(__name__)
+
+
+def _format_failure_message(module: str, attr: str | None, err: Exception) -> str:
+    """Return a standardised failure message."""
+
+    return (
+        f"Failed to import module '{module}': {err}"
+        if isinstance(err, ImportError)
+        else f"Module '{module}' has no attribute '{attr}': {err}"
+    )
+
+
+EMIT_MAP: dict[str, Callable[[str], None]] = {
+    "warn": lambda msg: _emit(msg, "warn"),
+    "log": lambda msg: _emit(msg, "log"),
+    "both": lambda msg: _emit(msg, "both"),
+}
+
+
+def _emit(message: str, mode: Literal["warn", "log", "both"]) -> None:
+    """Emit ``message`` via :mod:`warnings`, logger or both."""
+
+    if mode in ("warn", "both"):
+        warnings.warn(message, RuntimeWarning, stacklevel=2)
+    if mode in ("log", "both"):
+        logger.warning(message)
+
+
+def _warn_failure(
+    module: str,
+    attr: str | None,
+    err: Exception,
+    *,
+    emit: Literal["warn", "log", "both"] = "warn",
+) -> None:
+    """Emit a warning about a failed import."""
+
+    msg = _format_failure_message(module, attr, err)
+    if _IMPORT_STATE.mark_warning(module):
+        EMIT_MAP[emit](msg)
+    else:
+        logger.debug(msg)
+
+
+class LazyImportProxy:
+    """Descriptor that defers imports until first use."""
+
+    __slots__ = (
+        "_module",
+        "_attr",
+        "_emit",
+        "_fallback",
+        "_target_ref",
+        "_strong_target",
+        "_lock",
+        "_key",
+        "__weakref__",
+    )
+
+    _UNRESOLVED = object()
+
+    def __init__(
+        self,
+        module_name: str,
+        attr: str | None,
+        emit: Literal["warn", "log", "both"],
+        fallback: Any | None,
+    ) -> None:
+        self._module = module_name
+        self._attr = attr
+        self._emit = emit
+        self._fallback = fallback
+        self._target_ref: weakref.ReferenceType[Any] | None = None
+        self._strong_target: Any = self._UNRESOLVED
+        self._lock = threading.Lock()
+        self._key = _import_key(module_name, attr)
+
+    def _store_target(self, target: Any) -> None:
+        try:
+            self_ref = weakref.ref(self)
+
+            def _cleanup(ref: weakref.ReferenceType[Any]) -> None:
+                proxy = self_ref()
+                if proxy is None:
+                    return
+                with proxy._lock:
+                    if proxy._target_ref is ref:
+                        proxy._target_ref = None
+
+            self._target_ref = weakref.ref(target, _cleanup)
+        except TypeError:
+            self._strong_target = target
+            self._target_ref = None
+        else:
+            self._strong_target = self._UNRESOLVED
+
+    def _resolved_target(self) -> Any:
+        if self._strong_target is not self._UNRESOLVED:
+            return self._strong_target
+        if self._target_ref is None:
+            return self._UNRESOLVED
+        target = self._target_ref()
+        if target is None:
+            self._target_ref = None
+            return self._UNRESOLVED
+        return target
+
+    def _resolve(self) -> Any:
+        target = self._resolved_target()
+        if target is not self._UNRESOLVED:
+            return target
+
+        with self._lock:
+            target = self._resolved_target()
+            if target is self._UNRESOLVED:
+                target = _resolve_import(
+                    self._module,
+                    self._attr,
+                    self._emit,
+                    self._fallback,
+                )
+                self._store_target(target)
+        return target
+
+    def resolve(self) -> Any:
+        """Eagerly resolve and return the proxied object."""
+
+        return self._resolve()
+
+    def __getattr__(self, item: str) -> Any:
+        return getattr(self._resolve(), item)
+
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        return self._resolve()(*args, **kwargs)
+
+    def __bool__(self) -> bool:
+        return bool(self._resolve())
+
+    def __repr__(self) -> str:  # pragma: no cover - representation helper
+        target = self._resolved_target()
+        if target is self._UNRESOLVED:
+            return f"<LazyImportProxy pending={self._key!r}>"
+        return repr(target)
+
+    def __str__(self) -> str:  # pragma: no cover - representation helper
+        return str(self._resolve())
+
+    def __iter__(self) -> Iterator[Any]:  # pragma: no cover - passthrough helper
+        return iter(self._resolve())
+
+
+def _resolve_import(
+    module_name: str,
+    attr: str | None,
+    emit: Literal["warn", "log", "both"],
+    fallback: Any | None,
+) -> Any | None:
+    key = _import_key(module_name, attr)
+    success, result = _import_cached(module_name, attr)
+    if success:
+        _IMPORT_STATE.discard(key)
+        if attr is not None:
+            _IMPORT_STATE.discard(module_name)
+        return result
+
+    exc: Exception = result
+    include_module = isinstance(exc, ImportError)
+    _warn_failure(module_name, attr, exc, emit=emit)
+    _IMPORT_STATE.record_failure(key, module=module_name if include_module else None)
+    return fallback
+
+
+def cached_import(
+    module_name: str,
+    attr: str | None = None,
+    *,
+    fallback: Any | None = None,
+    emit: Literal["warn", "log", "both"] = "warn",
+    lazy: bool = False,
+) -> Any | None:
+    """Import ``module_name`` (and optional ``attr``) with caching and fallback.
+
+    When ``lazy`` is ``True`` the import is deferred until the returned proxy is
+    first used. The proxy integrates with the shared cache so subsequent calls
+    return the resolved object directly.
+    """
+
+    key = _import_key(module_name, attr)
+
+    if lazy:
+        cached_obj = _get_success(key)
+        if cached_obj is not None:
+            return cached_obj
+        return LazyImportProxy(module_name, attr, emit, fallback)
+
+    return _resolve_import(module_name, attr, emit, fallback)
+
+
+_ModuleSpec = str | tuple[str, str | None]
+
+
+def _normalise_warm_specs(
+    module: _ModuleSpec | Iterable[_ModuleSpec],
+    extra: tuple[_ModuleSpec, ...],
+    attr: str | None,
+) -> list[tuple[str, str | None]]:
+    if attr is not None:
+        if extra:
+            raise ValueError("'attr' can only be combined with a single module name")
+        if not isinstance(module, str):
+            raise TypeError("'attr' requires the first argument to be a module name string")
+        return [(module, attr)]
+
+    specs: list[_ModuleSpec]
+    if extra:
+        specs = [module, *extra]
+    elif isinstance(module, tuple) and len(module) == 2:
+        specs = [module]
+    elif isinstance(module, str):
+        specs = [module]
+    else:
+        if isinstance(module, Iterable):
+            specs = list(module)
+            if not specs:
+                raise ValueError("At least one module specification is required")
+        else:
+            raise TypeError("Unsupported module specification for warm_cached_import")
+
+    normalised: list[tuple[str, str | None]] = []
+    for spec in specs:
+        if isinstance(spec, str):
+            normalised.append((spec, None))
+            continue
+        if isinstance(spec, tuple) and len(spec) == 2:
+            module_name, module_attr = spec
+            if not isinstance(module_name, str) or (
+                module_attr is not None and not isinstance(module_attr, str)
+            ):
+                raise TypeError("Invalid module specification for warm_cached_import")
+            normalised.append((module_name, module_attr))
+            continue
+        raise TypeError("Module specifications must be strings or (module, attr) tuples")
+
+    return normalised
+
+
+def warm_cached_import(
+    module: _ModuleSpec | Iterable[_ModuleSpec],
+    *extra: _ModuleSpec,
+    attr: str | None = None,
+    fallback: Any | None = None,
+    emit: Literal["warn", "log", "both"] = "warn",
+    lazy: bool = False,
+    resolve: bool = False,
+) -> Any | dict[str, Any | None]:
+    """Pre-populate the import cache for the provided module specifications.
+
+    When ``lazy`` is ``True`` the cached objects are returned as proxies by
+    default. Setting ``resolve`` forces those proxies to resolve immediately
+    during the warm-up phase while still sharing the same cache entries.
+    """
+
+    if resolve and not lazy:
+        raise ValueError("'resolve' can only be used when 'lazy' is True")
+
+    specs = _normalise_warm_specs(module, extra, attr)
+    results: dict[str, Any | None] = {}
+    for module_name, module_attr in specs:
+        key = _import_key(module_name, module_attr)
+        results[key] = cached_import(
+            module_name,
+            module_attr,
+            fallback=fallback,
+            emit=emit,
+            lazy=lazy,
+        )
+        if resolve and isinstance(results[key], LazyImportProxy):
+            results[key] = results[key].resolve()
+
+    if len(results) == 1:
+        return next(iter(results.values()))
+    return results
+
+
+def _clear_default_cache() -> None:
+    global _NP_MISSING_LOGGED
+
+    _clear_import_cache()
+    _NP_MISSING_LOGGED = False
+
+
+cached_import.cache_clear = _clear_default_cache  # type: ignore[attr-defined]
+
+
+_NP_MISSING_LOGGED = False
+
+
+def get_numpy() -> Any | None:
+    """Return the cached :mod:`numpy` module when available."""
+
+    global _NP_MISSING_LOGGED
+
+    np = cached_import("numpy")
+    if np is None:
+        if not _NP_MISSING_LOGGED:
+            logger.debug("Failed to import numpy; continuing in non-vectorised mode")
+            _NP_MISSING_LOGGED = True
+        return None
+
+    if _NP_MISSING_LOGGED:
+        _NP_MISSING_LOGGED = False
+    return np
+
+
+def get_nodenx() -> type | None:
+    """Return :class:`tnfr.node.NodeNX` using import caching."""
+
+    return cached_import("tnfr.node", "NodeNX")
+
+
+def prune_failed_imports() -> None:
+    """Clear the registry of recorded import failures and warnings."""
+
+    _IMPORT_STATE.clear()
+    _IMPORT_CACHE_MANAGER.clear(_FAILURE_CACHE_NAME)