|
1 | 1 | from __future__ import annotations |
2 | 2 |
|
3 | | -from typing import Any, TypeAlias |
4 | | - |
5 | 3 | from awepatch._function import FunctionPatcher |
6 | 4 | from awepatch._module import ModulePatcher |
7 | | -from awepatch._utils import AbstractPatcher, Ident, Patch |
| 5 | +from awepatch._utils import AbstractPatcher, Ident |
8 | 6 | from awepatch._version import __commit_id__, __version__, __version_tuple__ |
9 | 7 |
|
10 | | -TYPE_CHECKING = False |
11 | | - |
12 | | -if TYPE_CHECKING: |
13 | | - from collections.abc import Callable |
14 | | - |
15 | | - |
16 | | -def _check_patches(patch: Any) -> list[Patch]: # noqa: ANN401 |
17 | | - """Check and normalize the patches input. |
18 | | -
|
19 | | - Args: |
20 | | - patch: A single Patch or a list of Patch objects. |
21 | | -
|
22 | | - Returns: |
23 | | - A list of Patch objects. |
24 | | -
|
25 | | - """ |
26 | | - if isinstance(patch, Patch): |
27 | | - return [patch] |
28 | | - elif isinstance(patch, list) and all(isinstance(p, Patch) for p in patch): # pyright: ignore[reportUnknownVariableType] |
29 | | - return patch # pyright: ignore[reportUnknownVariableType] |
30 | | - else: |
31 | | - raise TypeError("patch must be a Patch or a list of Patch objects") |
32 | | - |
33 | | - |
34 | | -def patch_callable( |
35 | | - func: Callable[..., Any], |
36 | | - /, |
37 | | - patch: Patch | list[Patch], |
38 | | -) -> AbstractPatcher: |
39 | | - """Patch a callable using AST manipulation. |
40 | | -
|
41 | | - Args: |
42 | | - func (Callable[..., Any]): The function to patch. |
43 | | - patch (Patch | list[Patch]): Patch or list of Patch objects for applying |
44 | | - multiple patches. |
45 | | -
|
46 | | - Examples: |
47 | | - >>> from awepatch import Patch, patch_callable |
48 | | - >>> def my_function(x): |
49 | | - ... return x + 1 |
50 | | - >>> with patch_callable(my_function, Patch("x + 1", "x + 2", "replace")): |
51 | | - ... assert my_function(3) == 5 |
52 | | -
|
53 | | - """ |
54 | | - |
55 | | - collector = FunctionPatcher() |
56 | | - patches = _check_patches(patch) |
57 | | - for p in patches: |
58 | | - collector.add_patch(func, p.target, p.content, p.mode) |
59 | | - return collector |
60 | | - |
61 | | - |
62 | | -# compatibility alias |
63 | | -CallablePatcher: TypeAlias = AbstractPatcher |
64 | | - |
65 | | - |
66 | 8 | __all__ = ( |
67 | 9 | "__commit_id__", |
68 | 10 | "__version__", |
69 | 11 | "__version_tuple__", |
70 | | - "CallablePatcher", |
71 | | - "Patch", |
72 | 12 | "Ident", |
73 | | - "patch_callable", |
74 | 13 | "AbstractPatcher", |
75 | 14 | "ModulePatcher", |
76 | 15 | "FunctionPatcher", |
|
0 commit comments