Spaces:
Running
Running
File size: 16,307 Bytes
d631808 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 |
# This module contains helpers. They simplify programmatic use of Griffe,
# for example to load data from strings or to create temporary packages.
# They are particularly useful for our own tests suite.
from __future__ import annotations
import sys
import tempfile
from contextlib import contextmanager
from dataclasses import dataclass
from importlib import invalidate_caches
from pathlib import Path
from textwrap import dedent
from typing import TYPE_CHECKING, Any
from _griffe.agents.inspector import inspect
from _griffe.agents.visitor import visit
from _griffe.collections import LinesCollection
from _griffe.loader import load
from _griffe.models import Module, Object
if TYPE_CHECKING:
from collections.abc import Iterator, Mapping, Sequence
from _griffe.collections import ModulesCollection
from _griffe.docstrings.parsers import DocstringStyle
from _griffe.enumerations import Parser
from _griffe.extensions.base import Extensions
_TMPDIR_PREFIX = "griffe_"
@dataclass
class TmpPackage:
"""A temporary package.
The `tmpdir` and `path` parameters can be passed as relative path.
They will be resolved to absolute paths after initialization.
"""
tmpdir: Path
"""The temporary directory containing the package."""
name: str
"""The package name, as to dynamically import it."""
path: Path
"""The package path."""
def __post_init__(self) -> None:
self.tmpdir = self.tmpdir.resolve()
self.path = self.path.resolve()
@contextmanager
def temporary_pyfile(code: str, *, module_name: str = "module") -> Iterator[tuple[str, Path]]:
"""Create a Python file containing the given code in a temporary directory.
Parameters:
code: The code to write to the temporary file.
module_name: The name of the temporary module.
Yields:
module_name: The module name, as to dynamically import it.
module_path: The module path.
"""
with tempfile.TemporaryDirectory(prefix=_TMPDIR_PREFIX) as tmpdir:
tmpfile = Path(tmpdir) / f"{module_name}.py"
tmpfile.write_text(dedent(code))
yield module_name, tmpfile
@contextmanager
def temporary_pypackage(
package: str,
modules: Sequence[str] | Mapping[str, str] | None = None,
*,
init: bool = True,
inits: bool = True,
) -> Iterator[TmpPackage]:
"""Create a package containing the given modules in a temporary directory.
Parameters:
package: The package name. Example: `"a"` gives
a package named `a`, while `"a/b"` gives a namespace package
named `a` with a package inside named `b`.
If `init` is false, then `b` is also a namespace package.
modules: Additional modules to create in the package.
If a list, simply touch the files: `["b.py", "c/d.py", "e/f"]`.
If a dict, keys are the file names and values their contents:
`{"b.py": "b = 1", "c/d.py": "print('hey from c')"}`.
init: Whether to create an `__init__` module in the top package.
inits: Whether to create `__init__` modules in subpackages.
Yields:
A temporary package.
"""
modules = modules or {}
if isinstance(modules, list):
modules = dict.fromkeys(modules, "")
mkdir_kwargs = {"parents": True, "exist_ok": True}
with tempfile.TemporaryDirectory(prefix=_TMPDIR_PREFIX) as tmpdir:
tmpdirpath = Path(tmpdir)
package_name = ".".join(Path(package).parts)
package_path = tmpdirpath / package
package_path.mkdir(**mkdir_kwargs)
if init:
package_path.joinpath("__init__.py").touch()
for module_name, module_contents in modules.items(): # type: ignore[union-attr]
current_path = package_path
for part in Path(module_name).parts:
if part.endswith((".py", ".pyi")):
current_path.joinpath(part).write_text(dedent(module_contents))
else:
current_path /= part
current_path.mkdir(**mkdir_kwargs)
if inits:
current_path.joinpath("__init__.py").touch()
yield TmpPackage(tmpdirpath, package_name, package_path)
@contextmanager
def temporary_visited_package(
package: str,
modules: Sequence[str] | Mapping[str, str] | None = None,
*,
init: bool = True,
inits: bool = True,
extensions: Extensions | None = None,
docstring_parser: DocstringStyle | Parser | None = None,
docstring_options: dict[str, Any] | None = None,
lines_collection: LinesCollection | None = None,
modules_collection: ModulesCollection | None = None,
allow_inspection: bool = False,
store_source: bool = True,
resolve_aliases: bool = False,
resolve_external: bool | None = None,
resolve_implicit: bool = False,
) -> Iterator[Module]:
"""Create and visit a temporary package.
Parameters:
package: The package name. Example: `"a"` gives
a package named `a`, while `"a/b"` gives a namespace package
named `a` with a package inside named `b`.
If `init` is false, then `b` is also a namespace package.
modules: Additional modules to create in the package.
If a list, simply touch the files: `["b.py", "c/d.py", "e/f"]`.
If a dict, keys are the file names and values their contents:
`{"b.py": "b = 1", "c/d.py": "print('hey from c')"}`.
init: Whether to create an `__init__` module in the top package.
inits: Whether to create `__init__` modules in subpackages.
extensions: The extensions to use.
docstring_parser: The docstring parser to use. By default, no parsing is done.
docstring_options: Additional docstring parsing options.
lines_collection: A collection of source code lines.
modules_collection: A collection of modules.
allow_inspection: Whether to allow inspecting modules when visiting them is not possible.
store_source: Whether to store code source in the lines collection.
resolve_aliases: Whether to resolve aliases.
resolve_external: Whether to try to load unspecified modules to resolve aliases.
Default value (`None`) means to load external modules only if they are the private sibling
or the origin module (for example when `ast` imports from `_ast`).
resolve_implicit: When false, only try to resolve an alias if it is explicitly exported.
Yields:
A module.
"""
with temporary_pypackage(package, modules, init=init, inits=inits) as tmp_package:
yield load( # type: ignore[misc]
tmp_package.name,
search_paths=[tmp_package.tmpdir],
extensions=extensions,
docstring_parser=docstring_parser,
docstring_options=docstring_options,
lines_collection=lines_collection,
modules_collection=modules_collection,
allow_inspection=allow_inspection,
store_source=store_source,
resolve_aliases=resolve_aliases,
resolve_external=resolve_external,
resolve_implicit=resolve_implicit,
force_inspection=False,
)
@contextmanager
def temporary_inspected_package(
package: str,
modules: Sequence[str] | Mapping[str, str] | None = None,
*,
init: bool = True,
inits: bool = True,
extensions: Extensions | None = None,
docstring_parser: DocstringStyle | Parser | None = None,
docstring_options: dict[str, Any] | None = None,
lines_collection: LinesCollection | None = None,
modules_collection: ModulesCollection | None = None,
allow_inspection: bool = True,
store_source: bool = True,
resolve_aliases: bool = False,
resolve_external: bool | None = None,
resolve_implicit: bool = False,
) -> Iterator[Module]:
"""Create and inspect a temporary package.
Parameters:
package: The package name. Example: `"a"` gives
a package named `a`, while `"a/b"` gives a namespace package
named `a` with a package inside named `b`.
If `init` is false, then `b` is also a namespace package.
modules: Additional modules to create in the package.
If a list, simply touch the files: `["b.py", "c/d.py", "e/f"]`.
If a dict, keys are the file names and values their contents:
`{"b.py": "b = 1", "c/d.py": "print('hey from c')"}`.
init: Whether to create an `__init__` module in the top package.
inits: Whether to create `__init__` modules in subpackages.
extensions: The extensions to use.
docstring_parser: The docstring parser to use. By default, no parsing is done.
docstring_options: Additional docstring parsing options.
lines_collection: A collection of source code lines.
modules_collection: A collection of modules.
allow_inspection: Whether to allow inspecting modules.
store_source: Whether to store code source in the lines collection.
resolve_aliases: Whether to resolve aliases.
resolve_external: Whether to try to load unspecified modules to resolve aliases.
Default value (`None`) means to load external modules only if they are the private sibling
or the origin module (for example when `ast` imports from `_ast`).
resolve_implicit: When false, only try to resolve an alias if it is explicitly exported.
Yields:
A module.
"""
with temporary_pypackage(package, modules, init=init, inits=inits) as tmp_package:
try:
yield load( # type: ignore[misc]
tmp_package.name,
search_paths=[tmp_package.tmpdir],
extensions=extensions,
docstring_parser=docstring_parser,
docstring_options=docstring_options,
lines_collection=lines_collection,
modules_collection=modules_collection,
allow_inspection=allow_inspection,
store_source=store_source,
resolve_aliases=resolve_aliases,
resolve_external=resolve_external,
resolve_implicit=resolve_implicit,
force_inspection=True,
)
finally:
for name in tuple(sys.modules.keys()):
if name == package or name.startswith(f"{package}."):
sys.modules.pop(name, None)
invalidate_caches()
@contextmanager
def temporary_visited_module(
code: str,
*,
module_name: str = "module",
extensions: Extensions | None = None,
parent: Module | None = None,
docstring_parser: DocstringStyle | Parser | None = None,
docstring_options: dict[str, Any] | None = None,
lines_collection: LinesCollection | None = None,
modules_collection: ModulesCollection | None = None,
) -> Iterator[Module]:
"""Create and visit a temporary module with the given code.
Parameters:
code: The code of the module.
module_name: The name of the temporary module.
extensions: The extensions to use when visiting the AST.
parent: The optional parent of this module.
docstring_parser: The docstring parser to use. By default, no parsing is done.
docstring_options: Additional docstring parsing options.
lines_collection: A collection of source code lines.
modules_collection: A collection of modules.
Yields:
The visited module.
"""
code = dedent(code)
with temporary_pyfile(code, module_name=module_name) as (_, path):
lines_collection = lines_collection or LinesCollection()
lines_collection[path] = code.splitlines()
module = visit(
module_name,
filepath=path,
code=code,
extensions=extensions,
parent=parent,
docstring_parser=docstring_parser,
docstring_options=docstring_options,
lines_collection=lines_collection,
modules_collection=modules_collection,
)
module.modules_collection[module_name] = module
yield module
@contextmanager
def temporary_inspected_module(
code: str,
*,
module_name: str = "module",
import_paths: list[Path] | None = None,
extensions: Extensions | None = None,
parent: Module | None = None,
docstring_parser: DocstringStyle | Parser | None = None,
docstring_options: dict[str, Any] | None = None,
lines_collection: LinesCollection | None = None,
modules_collection: ModulesCollection | None = None,
) -> Iterator[Module]:
"""Create and inspect a temporary module with the given code.
Parameters:
code: The code of the module.
module_name: The name of the temporary module.
import_paths: Paths to import the module from.
extensions: The extensions to use when visiting the AST.
parent: The optional parent of this module.
docstring_parser: The docstring parser to use. By default, no parsing is done.
docstring_options: Additional docstring parsing options.
lines_collection: A collection of source code lines.
modules_collection: A collection of modules.
Yields:
The inspected module.
"""
with temporary_pyfile(code, module_name=module_name) as (_, path):
lines_collection = lines_collection or LinesCollection()
lines_collection[path] = code.splitlines()
try:
module = inspect(
module_name,
filepath=path,
import_paths=import_paths,
extensions=extensions,
parent=parent,
docstring_parser=docstring_parser,
docstring_options=docstring_options,
lines_collection=lines_collection,
modules_collection=modules_collection,
)
module.modules_collection[module_name] = module
yield module
finally:
if module_name in sys.modules:
del sys.modules[module_name]
invalidate_caches()
def vtree(*objects: Object, return_leaf: bool = False) -> Object:
"""Link objects together, vertically.
Parameters:
*objects: A sequence of objects. The first one is at the top of the tree.
return_leaf: Whether to return the leaf instead of the root.
Raises:
ValueError: When no objects are provided.
Returns:
The top or leaf object.
"""
if not objects:
raise ValueError("At least one object must be provided")
top = objects[0]
leaf = top
for obj in objects[1:]:
leaf.set_member(obj.name, obj)
leaf = obj
return leaf if return_leaf else top
def htree(*objects: Object) -> Object:
"""Link objects together, horizontally.
Parameters:
*objects: A sequence of objects. All objects starting at the second become members of the first.
Raises:
ValueError: When no objects are provided.
Returns:
The first given object, with all the other objects as members of it.
"""
if not objects:
raise ValueError("At least one object must be provided")
top = objects[0]
for obj in objects[1:]:
top.set_member(obj.name, obj)
return top
def module_vtree(path: str, *, leaf_package: bool = True, return_leaf: bool = False) -> Module:
"""Link objects together, vertically.
Parameters:
path: The complete module path, like `"a.b.c.d"`.
leaf_package: Whether the deepest module should also be a package.
return_leaf: Whether to return the leaf instead of the root.
Raises:
ValueError: When no objects are provided.
Returns:
The top or leaf module.
"""
parts = path.split(".")
modules = [Module(name, filepath=Path(*parts[:index], "__init__.py")) for index, name in enumerate(parts)]
if not leaf_package:
filepath = modules[-1].filepath.with_stem(parts[-1]) # type: ignore[union-attr]
modules[-1]._filepath = filepath
return vtree(*modules, return_leaf=return_leaf) # type: ignore[return-value]
|