griffe-runtime-objects
Make runtime objects available through extra.
Installation
pip install griffe-runtime-objects
Usage
Enable the griffe_runtime_objects extension. Now all Griffe objects will have access to the corresponding runtime objects in their extra attribute, under the runtime-objects namespace:
>>> import griffe
>>> griffe_data = griffe.load("griffe", extensions=griffe.load_extensions("griffe_runtime_objects"), resolve_aliases=True)
>>> griffe_data["parse"].extra
defaultdict(<class 'dict'>, {'runtime-objects': {'object': <function parse at 0x78685c951260>}})
>>> griffe_data["Module"].extra
defaultdict(<class 'dict'>, {'runtime-objects': {'object': <class '_griffe.models.Module'>}})
This extension can be useful in custom templates of mkdocstrings-python, to iterate on an object value or attributes.
With MkDocs:
plugins:
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_runtime_objects
Sponsors
Silver sponsors
Bronze sponsors
And 4 more private sponsor(s).
1 maintainer
Metadata
1 maintainer
Release files for griffe-runtime-objects 0.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| griffe_runtime_objects-0.3.2.tar.gz | 30.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| griffe_runtime_objects-0.3.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.6 kB
Release files / griffe_runtime_objects-0.3.2.tar.gz
| Download URL | griffe_runtime_objects-0.3.2.tar.gz |
|---|---|
| Size | 30.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a92224b0d31f39e8fb707ec4a1ac3eed298649f1022b211d9c459a528e1f441
|
|
BLAKE2b-256 checksum How to use checksums |
9a0016f05a3bd24f869e8781cdbeb469066275233a223b53d11180fd1eea622a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / griffe_runtime_objects-0.3.2-py3-none-any.whl
| Download URL | griffe_runtime_objects-0.3.2-py3-none-any.whl |
|---|---|
| Size | 9.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ca115d5ddee47adfdbcd1597d8a877dc235b36a1478c7e1353fb7509a4ddea62
|
|
BLAKE2b-256 checksum How to use checksums |
66fa7c22ef9a427b1663bc4c6628fd49bbc8171dfd85899aa4703d8df01850b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
