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 7 more private sponsor(s).
1 maintainer
Metadata
1 maintainer
Release files for griffe-runtime-objects 0.3.1
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.1.tar.gz | 28.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| griffe_runtime_objects-0.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 35.4 kB
Release files / griffe_runtime_objects-0.3.1.tar.gz
| Download URL | griffe_runtime_objects-0.3.1.tar.gz |
|---|---|
| Size | 28.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eecb887e1fb6b48bddcfc6115a61f59b3a91aeaadd9b932b8056eb8dd7811a57
|
|
BLAKE2b-256 checksum How to use checksums |
2a38e80d9a1a52ce7a815f18739e7ce6f8ac3604ae3007ec0e671e85cecdd340
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Release files / griffe_runtime_objects-0.3.1-py3-none-any.whl
| Download URL | griffe_runtime_objects-0.3.1-py3-none-any.whl |
|---|---|
| Size | 7.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e7b219f2b58f7aefa763329213c11174cda815d7d69aeb2903460a7ddc3fef1c
|
|
BLAKE2b-256 checksum How to use checksums |
366cbc25e97b6aabe224da5106787cd585d2aa8ca3da9b7e73ef06a697037e24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
