pico-ioc 1.4.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
pico_ioc/config.py DELETED
@@ -1,332 +0,0 @@
1
- # src/pico_ioc/config.py
2
- from __future__ import annotations
3
-
4
- import os, json, configparser, pathlib
5
- from dataclasses import is_dataclass, fields, MISSING
6
- from typing import Any, Callable, Dict, Iterable, Optional, Sequence, Tuple, Protocol
7
-
8
- # ---- Flags & metadata on classes / fields ----
9
- _CONFIG_FLAG = "_pico_is_config_component"
10
- _CONFIG_PREFIX = "_pico_config_prefix"
11
- _FIELD_META = "_pico_config_field_meta" # dict: name -> FieldSpec
12
-
13
- # ---- Source protocol & implementations ----
14
-
15
- class ConfigSource(Protocol):
16
- def get(self, key: str) -> Optional[str]: ...
17
- def keys(self) -> Iterable[str]: ...
18
-
19
- class EnvSource:
20
- def __init__(self, prefix: str = ""):
21
- self.prefix = prefix or ""
22
- def get(self, key: str) -> Optional[str]:
23
- # try PREFIX+KEY first, then KEY
24
- v = os.getenv(self.prefix + key)
25
- if v is not None:
26
- return v
27
- return os.getenv(key)
28
- def keys(self) -> Iterable[str]:
29
- # best-effort; env keys only (without prefix expansion)
30
- return os.environ.keys()
31
-
32
- class FileSource:
33
- def __init__(self, path: os.PathLike[str] | str, optional: bool = False):
34
- self.path = str(path)
35
- self.optional = bool(optional)
36
- self._cache: Dict[str, Any] = {}
37
- self._load_once()
38
-
39
- def _load_once(self):
40
- p = pathlib.Path(self.path)
41
- if not p.exists():
42
- if self.optional:
43
- self._cache = {}
44
- return
45
- raise FileNotFoundError(self.path)
46
- text = p.read_text(encoding="utf-8")
47
-
48
- # Try in order: JSON, INI, dotenv, YAML (if available)
49
- # JSON
50
- try:
51
- data = json.loads(text)
52
- self._cache = _flatten_obj(data)
53
- return
54
- except Exception:
55
- pass
56
- # INI
57
- try:
58
- cp = configparser.ConfigParser()
59
- cp.read_string(text)
60
- data = {s: dict(cp.items(s)) for s in cp.sections()}
61
- # also root-level keys under DEFAULT
62
- data.update(dict(cp.defaults()))
63
- self._cache = _flatten_obj(data)
64
- return
65
- except Exception:
66
- pass
67
- # dotenv (simple KEY=VALUE per line)
68
- try:
69
- kv = {}
70
- for line in text.splitlines():
71
- line = line.strip()
72
- if not line or line.startswith("#"):
73
- continue
74
- if "=" in line:
75
- k, v = line.split("=", 1)
76
- kv[k.strip()] = _strip_quotes(v.strip())
77
- self._cache = _flatten_obj(kv)
78
- if self._cache:
79
- return
80
- except Exception:
81
- pass
82
- # YAML if available
83
- try:
84
- import yaml # type: ignore
85
- data = yaml.safe_load(text) or {}
86
- self._cache = _flatten_obj(data)
87
- return
88
- except Exception:
89
- # if everything fails, fallback to empty (optional) or raise
90
- if self.optional:
91
- self._cache = {}
92
- return
93
- raise ValueError(f"Unrecognized file format: {self.path}")
94
-
95
- def get(self, key: str) -> Optional[str]:
96
- v = self._cache.get(key)
97
- return None if v is None else str(v)
98
-
99
- def keys(self) -> Iterable[str]:
100
- return self._cache.keys()
101
-
102
- # ---- Field specs (overrides) ----
103
-
104
- class FieldSpec:
105
- __slots__ = ("sources", "keys", "default", "path_is_dot")
106
- def __init__(self, *, sources: Tuple[str, ...], keys: Tuple[str, ...], default: Any, path_is_dot: bool):
107
- self.sources = sources
108
- self.keys = keys
109
- self.default = default
110
- self.path_is_dot = path_is_dot # true when keys are dotted-paths for structured files
111
-
112
- class _ValueSentinel:
113
- def __getitem__(self, key_default: str | Tuple[str, Any], /):
114
- if isinstance(key_default, tuple):
115
- key, default = key_default
116
- else:
117
- key, default = key_default, MISSING
118
- # default sources order env>file unless overridden in Value(...)
119
- return _ValueFactory(key, default)
120
- Value = _ValueSentinel()
121
-
122
- class _ValueFactory:
123
- def __init__(self, key: str, default: Any):
124
- self.key = key
125
- self.default = default
126
- def __call__(self, *, sources: Tuple[str, ...] = ("env","file")):
127
- return FieldSpec(sources=tuple(sources), keys=(self.key,), default=self.default, path_is_dot=False)
128
-
129
- class _EnvSentinel:
130
- def __getitem__(self, key_default: str | Tuple[str, Any], /):
131
- key, default = (key_default if isinstance(key_default, tuple) else (key_default, MISSING))
132
- return FieldSpec(sources=("env",), keys=(key,), default=default, path_is_dot=False)
133
- Env = _EnvSentinel()
134
-
135
- class _FileSentinel:
136
- def __getitem__(self, key_default: str | Tuple[str, Any], /):
137
- key, default = (key_default if isinstance(key_default, tuple) else (key_default, MISSING))
138
- return FieldSpec(sources=("file",), keys=(key,), default=default, path_is_dot=False)
139
- File = _FileSentinel()
140
-
141
- class _PathSentinel:
142
- class _FilePath:
143
- def __getitem__(self, key_default: str | Tuple[str, Any], /):
144
- key, default = (key_default if isinstance(key_default, tuple) else (key_default, MISSING))
145
- return FieldSpec(sources=("file",), keys=(key,), default=default, path_is_dot=True)
146
- file = _FilePath()
147
- Path = _PathSentinel()
148
-
149
- # ---- Class decorator ----
150
-
151
- def config_component(*, prefix: str = ""):
152
- def dec(cls):
153
- setattr(cls, _CONFIG_FLAG, True)
154
- setattr(cls, _CONFIG_PREFIX, prefix or "")
155
- if not hasattr(cls, _FIELD_META):
156
- setattr(cls, _FIELD_META, {})
157
- return cls
158
- return dec
159
-
160
- def is_config_component(cls: type) -> bool:
161
- return bool(getattr(cls, _CONFIG_FLAG, False))
162
-
163
- # ---- Registry / resolution ----
164
-
165
- class ConfigRegistry:
166
- """Holds ordered sources and provides typed resolution for @config_component classes."""
167
- def __init__(self, sources: Sequence[ConfigSource]):
168
- self.sources = tuple(sources or ())
169
-
170
- def resolve(self, keys: Iterable[str]) -> Optional[str]:
171
- # try each key across sources in order
172
- for key in keys:
173
- for src in self.sources:
174
- v = src.get(key)
175
- if v is not None:
176
- return v
177
- return None
178
-
179
- def register_field_spec(cls: type, name: str, spec: FieldSpec) -> None:
180
- meta: Dict[str, FieldSpec] = getattr(cls, _FIELD_META, None) or {}
181
- meta[name] = spec
182
- setattr(cls, _FIELD_META, meta)
183
-
184
- def build_component_instance(cls: type, registry: ConfigRegistry) -> Any:
185
- prefix = getattr(cls, _CONFIG_PREFIX, "")
186
- overrides: Dict[str, FieldSpec] = getattr(cls, _FIELD_META, {}) or {}
187
-
188
- if is_dataclass(cls):
189
- kwargs = {}
190
- for f in fields(cls):
191
- name = f.name
192
- spec = overrides.get(name)
193
- if spec:
194
- val = _resolve_with_spec(spec, registry)
195
- else:
196
- # auto: PREFIX+NAME or NAME (env), NAME (file)
197
- val = registry.resolve((prefix + name.upper(), name.upper()))
198
- if val is None and f.default is not MISSING:
199
- val = f.default
200
- elif val is None and f.default_factory is not MISSING: # type: ignore
201
- val = f.default_factory() # type: ignore
202
- if val is None and f.default is MISSING and getattr(f, "default_factory", MISSING) is MISSING: # type: ignore
203
- raise NameError(f"Missing config for field {cls.__name__}.{name}")
204
- kwargs[name] = _coerce_type(val, f.type)
205
- return cls(**kwargs)
206
-
207
- # Non-dataclass: inspect __init__ signature
208
- import inspect
209
- sig = inspect.signature(cls.__init__)
210
- hints = _get_type_hints_safe(cls.__init__, owner=cls)
211
- kwargs = {}
212
- for pname, par in sig.parameters.items():
213
- if pname == "self" or par.kind in (inspect.Parameter.VAR_POSITIONAL, inspect.Parameter.VAR_KEYWORD):
214
- continue
215
- ann = hints.get(pname, par.annotation)
216
- spec = overrides.get(pname)
217
- if spec:
218
- val = _resolve_with_spec(spec, registry)
219
- else:
220
- val = registry.resolve((prefix + pname.upper(), pname.upper()))
221
- if val is None and par.default is not inspect._empty:
222
- val = par.default
223
- if val is None and par.default is inspect._empty:
224
- raise NameError(f"Missing config for field {cls.__name__}.{pname}")
225
- kwargs[pname] = _coerce_type(val, ann)
226
- return cls(**kwargs)
227
-
228
- # ---- helpers ----
229
-
230
- def _resolve_with_spec(spec: FieldSpec, registry: ConfigRegistry) -> Any:
231
- # respect spec.sources ordering, but try all keys for each source
232
- for src_kind in spec.sources:
233
- if src_kind == "env":
234
- v = _resolve_from_sources(registry, spec.keys, predicate=lambda s: isinstance(s, EnvSource))
235
- elif src_kind == "file":
236
- if spec.path_is_dot:
237
- v = _resolve_path_from_files(registry, spec.keys)
238
- else:
239
- v = _resolve_from_sources(registry, spec.keys, predicate=lambda s: isinstance(s, FileSource))
240
- else:
241
- v = None
242
- if v is not None:
243
- return v
244
- return None if spec.default is MISSING else spec.default
245
-
246
- def _resolve_from_sources(registry: ConfigRegistry, keys: Tuple[str, ...], predicate: Callable[[ConfigSource], bool]) -> Optional[str]:
247
- for key in keys:
248
- for src in registry.sources:
249
- if predicate(src):
250
- v = src.get(key)
251
- if v is not None:
252
- return v
253
- return None
254
-
255
- def _resolve_path_from_files(registry: ConfigRegistry, dotted_keys: Tuple[str, ...]) -> Optional[str]:
256
- for key in dotted_keys:
257
- path = key.split(".")
258
- for src in registry.sources:
259
- if isinstance(src, FileSource):
260
- # FileSource caches flattened dict already
261
- v = src.get(key)
262
- if v is not None:
263
- return v
264
- return None
265
-
266
- def _flatten_obj(obj: Any, prefix: str = "") -> Dict[str, Any]:
267
- out: Dict[str, Any] = {}
268
- if isinstance(obj, dict):
269
- for k, v in obj.items():
270
- k2 = (prefix + "." + str(k)) if prefix else str(k)
271
- out.update(_flatten_obj(v, k2))
272
- elif isinstance(obj, (list, tuple)):
273
- for i, v in enumerate(obj):
274
- k2 = (prefix + "." + str(i)) if prefix else str(i)
275
- out.update(_flatten_obj(v, k2))
276
- else:
277
- out[prefix] = obj
278
- if "." in prefix:
279
- # also expose leaf as KEY without dots if single-segment? no; keep dotted only
280
- pass
281
- # also expose top-level KEY without dots when no prefix used:
282
- if prefix and "." not in prefix:
283
- out[prefix] = obj
284
- # Additionally mirror top-level simple keys as UPPERCASE for convenience
285
- if prefix and "." not in prefix:
286
- out[prefix.upper()] = obj
287
- return out
288
-
289
- def _strip_quotes(s: str) -> str:
290
- if (s.startswith('"') and s.endswith('"')) or (s.startswith("'") and s.endswith("'")):
291
- return s[1:-1]
292
- return s
293
-
294
- def _coerce_type(val: Any, ann: Any) -> Any:
295
- if val is None:
296
- return None
297
- # strings from sources come as str; coerce to basic types
298
- try:
299
- from typing import get_origin, get_args
300
- origin = get_origin(ann) or ann
301
- if origin in (int,):
302
- return int(val)
303
- if origin in (float,):
304
- return float(val)
305
- if origin in (bool,):
306
- s = str(val).strip().lower()
307
- if s in ("1","true","yes","y","on"): return True
308
- if s in ("0","false","no","n","off"): return False
309
- return bool(val)
310
- except Exception:
311
- pass
312
- return val
313
-
314
- def _get_type_hints_safe(fn, owner=None):
315
- try:
316
- import inspect
317
- mod = inspect.getmodule(fn)
318
- g = getattr(mod, "__dict__", {})
319
- l = vars(owner) if owner is not None else None
320
- from typing import get_type_hints
321
- return get_type_hints(fn, globalns=g, localns=l, include_extras=True)
322
- except Exception:
323
- return {}
324
-
325
- # ---- Public API helpers to be imported by users ----
326
-
327
- __all__ = [
328
- "config_component", "EnvSource", "FileSource",
329
- "Env", "File", "Path", "Value",
330
- "ConfigRegistry", "register_field_spec", "is_config_component",
331
- ]
332
-
pico_ioc/decorators.py DELETED
@@ -1,158 +0,0 @@
1
- # src/pico_ioc/decorators.py
2
- from __future__ import annotations
3
-
4
- import functools
5
- from typing import Any, Iterable, Optional, Callable, Tuple, Literal
6
-
7
-
8
- # ---- marker attributes (read by scanner/policy) ----
9
-
10
- COMPONENT_FLAG = "_is_component"
11
- COMPONENT_KEY = "_component_key"
12
- COMPONENT_LAZY = "_component_lazy"
13
-
14
- FACTORY_FLAG = "_is_factory_component"
15
- PROVIDES_KEY = "_provides_name"
16
- PROVIDES_LAZY = "_pico_lazy"
17
-
18
- PLUGIN_FLAG = "_is_pico_plugin"
19
- QUALIFIERS_KEY = "_pico_qualifiers"
20
-
21
- COMPONENT_TAGS = "_pico_tags"
22
- PROVIDES_TAGS = "_pico_tags"
23
-
24
- ON_MISSING_META = "_pico_on_missing"
25
- PRIMARY_FLAG = "_pico_primary"
26
- CONDITIONAL_META = "_pico_conditional"
27
-
28
- INTERCEPTOR_META = "__pico_interceptor__"
29
-
30
-
31
- # ---- core decorators ----
32
-
33
- def factory_component(cls):
34
- """Mark a class as a factory component (its methods can @provides)."""
35
- setattr(cls, FACTORY_FLAG, True)
36
- return cls
37
-
38
-
39
- def component(cls=None, *, name: Any = None, lazy: bool = False, tags: Iterable[str] = ()):
40
- """Mark a class as a component. Optional: custom key, lazy instantiation, tags."""
41
- def dec(c):
42
- setattr(c, COMPONENT_FLAG, True)
43
- setattr(c, COMPONENT_KEY, name if name is not None else c)
44
- setattr(c, COMPONENT_LAZY, bool(lazy))
45
- setattr(c, COMPONENT_TAGS, tuple(tags) if tags else ())
46
- return c
47
- return dec(cls) if cls else dec
48
-
49
-
50
- def provides(key: Any, *, lazy: bool = False, tags: Iterable[str] = ()):
51
- """Declare a factory method that provides a binding for `key`."""
52
- def dec(fn):
53
- @functools.wraps(fn)
54
- def w(*a, **k):
55
- return fn(*a, **k)
56
- setattr(w, PROVIDES_KEY, key)
57
- setattr(w, PROVIDES_LAZY, bool(lazy))
58
- setattr(w, PROVIDES_TAGS, tuple(tags) if tags else ())
59
- return w
60
- return dec
61
-
62
-
63
- def plugin(cls):
64
- """Mark a class as a Pico plugin (scanner lifecycle)."""
65
- setattr(cls, PLUGIN_FLAG, True)
66
- return cls
67
-
68
-
69
- # ---- qualifiers ----
70
-
71
- class Qualifier(str):
72
- """String qualifier type used with Annotated[T, 'q1', ...]."""
73
- __slots__ = ()
74
-
75
-
76
- def qualifier(*qs: Qualifier):
77
- """Attach one or more qualifiers to a component class key."""
78
- def dec(cls):
79
- current: Iterable[Qualifier] = getattr(cls, QUALIFIERS_KEY, ())
80
- seen = set(current)
81
- merged = list(current)
82
- for q in qs:
83
- if q not in seen:
84
- merged.append(q)
85
- seen.add(q)
86
- setattr(cls, QUALIFIERS_KEY, tuple(merged))
87
- return cls
88
- return dec
89
-
90
-
91
- # ---- defaults / selection ----
92
-
93
- def on_missing(selector: object, *, priority: int = 0):
94
- """Declare this target as a default for `selector` when no binding exists."""
95
- def dec(obj):
96
- setattr(obj, ON_MISSING_META, {"selector": selector, "priority": int(priority)})
97
- return obj
98
- return dec
99
-
100
-
101
- def primary(obj):
102
- """Hint this candidate should be preferred among equals."""
103
- setattr(obj, PRIMARY_FLAG, True)
104
- return obj
105
-
106
-
107
- def conditional(
108
- *,
109
- profiles: Tuple[str, ...] = (),
110
- require_env: Tuple[str, ...] = (),
111
- predicate: Optional[Callable[[], bool]] = None,
112
- ):
113
- """Activate only when profiles/env/predicate conditions pass."""
114
- def dec(obj):
115
- setattr(obj, CONDITIONAL_META, {
116
- "profiles": tuple(profiles),
117
- "require_env": tuple(require_env),
118
- "predicate": predicate,
119
- })
120
- return obj
121
- return dec
122
-
123
-
124
- # ---- interceptors ----
125
-
126
- def interceptor(
127
- _obj=None,
128
- *,
129
- kind: Literal["method", "container"] = "method",
130
- order: int = 0,
131
- profiles: Tuple[str, ...] = (),
132
- require_env: Tuple[str, ...] = (),
133
- predicate: Callable[[], bool] | None = None,
134
- ):
135
- """Declare an interceptor (method or container) with optional activation metadata."""
136
- def dec(obj):
137
- setattr(obj, INTERCEPTOR_META, {
138
- "kind": kind,
139
- "order": int(order),
140
- "profiles": tuple(profiles),
141
- "require_env": tuple(require_env),
142
- "predicate": predicate,
143
- })
144
- return obj
145
- return dec if _obj is None else dec(_obj)
146
-
147
-
148
- __all__ = [
149
- "component", "factory_component", "provides", "plugin",
150
- "Qualifier", "qualifier",
151
- "on_missing", "primary", "conditional", "interceptor",
152
- "COMPONENT_FLAG", "COMPONENT_KEY", "COMPONENT_LAZY",
153
- "FACTORY_FLAG", "PROVIDES_KEY", "PROVIDES_LAZY",
154
- "PLUGIN_FLAG", "QUALIFIERS_KEY", "COMPONENT_TAGS", "PROVIDES_TAGS",
155
- "ON_MISSING_META", "PRIMARY_FLAG", "CONDITIONAL_META",
156
- "INTERCEPTOR_META",
157
- ]
158
-
pico_ioc/interceptors.py DELETED
@@ -1,56 +0,0 @@
1
- # src/pico_ioc/interceptors.py
2
- from __future__ import annotations
3
-
4
- import inspect
5
- from typing import Any, Callable, Protocol, Sequence
6
-
7
-
8
- class Invocation:
9
- __slots__ = ("target", "method_name", "call", "args", "kwargs", "is_async")
10
-
11
- def __init__(self, target: object, method_name: str, call: Callable[..., Any],
12
- args: tuple, kwargs: dict):
13
- self.target = target
14
- self.method_name = method_name
15
- self.call = call
16
- self.args = args
17
- self.kwargs = kwargs
18
- self.is_async = inspect.iscoroutinefunction(call)
19
-
20
-
21
- class MethodInterceptor(Protocol):
22
- def __call__(self, inv: Invocation, proceed: Callable[[], Any]) -> Any: ...
23
-
24
-
25
- async def _chain_async(interceptors: Sequence[MethodInterceptor], inv: Invocation, i: int = 0):
26
- if i >= len(interceptors):
27
- return await inv.call(*inv.args, **inv.kwargs)
28
- cur = interceptors[i]
29
-
30
- async def next_step():
31
- return await _chain_async(interceptors, inv, i + 1)
32
-
33
- res = cur(inv, next_step)
34
- return await res if inspect.isawaitable(res) else res
35
-
36
-
37
- def _chain_sync(interceptors: Sequence[MethodInterceptor], inv: Invocation, i: int = 0):
38
- if i >= len(interceptors):
39
- return inv.call(*inv.args, **inv.kwargs)
40
- cur = interceptors[i]
41
- return cur(inv, lambda: _chain_sync(interceptors, inv, i + 1))
42
-
43
-
44
- def dispatch(interceptors: Sequence[MethodInterceptor], inv: Invocation):
45
- """Dispatch invocation through a chain of interceptors."""
46
- if inv.is_async:
47
- return _chain_async(interceptors, inv, 0) # coroutine
48
- return _chain_sync(interceptors, inv, 0) # value
49
-
50
-
51
- class ContainerInterceptor(Protocol):
52
- def on_resolve(self, key: Any, annotation: Any, qualifiers: tuple[str, ...] | tuple()) -> None: ...
53
- def on_before_create(self, key: Any) -> None: ...
54
- def on_after_create(self, key: Any, instance: Any) -> Any: ...
55
- def on_exception(self, key: Any, exc: BaseException) -> None: ...
56
-
pico_ioc/plugins.py DELETED
@@ -1,28 +0,0 @@
1
- # pico_ioc/plugins.py
2
- from typing import Protocol, Any, Tuple
3
- from .container import Binder, PicoContainer
4
- import logging
5
-
6
- class PicoPlugin(Protocol):
7
- def before_scan(self, package: Any, binder: Binder) -> None: ...
8
- def visit_class(self, module: Any, cls: type, binder: Binder) -> None: ...
9
- def after_scan(self, package: Any, binder: Binder) -> None: ...
10
- def after_bind(self, container: PicoContainer, binder: Binder) -> None: ...
11
- def before_eager(self, container: PicoContainer, binder: Binder) -> None: ...
12
- def after_ready(self, container: PicoContainer, binder: Binder) -> None: ...
13
-
14
- def run_plugin_hook(
15
- plugins: Tuple[PicoPlugin, ...],
16
- hook_name: str,
17
- *args,
18
- **kwargs,
19
- ) -> None:
20
- """Run a lifecycle hook across all plugins, logging (but not raising) exceptions."""
21
- for pl in plugins:
22
- try:
23
- fn = getattr(pl, hook_name, None)
24
- if fn:
25
- fn(*args, **kwargs)
26
- except Exception:
27
- logging.exception("Plugin %s failed", hook_name)
28
-