griffe-runtime-objects 0.3.0__py3-none-any.whl → 0.3.2__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.
- griffe_runtime_objects/__init__.py +18 -0
- griffe_runtime_objects/_internal/__init__.py +17 -0
- griffe_runtime_objects/_internal/debug.py +19 -1
- griffe_runtime_objects/_internal/extension.py +18 -0
- griffe_runtime_objects-0.3.2.dist-info/METADATA +129 -0
- griffe_runtime_objects-0.3.2.dist-info/RECORD +10 -0
- {griffe_runtime_objects-0.3.0.dist-info → griffe_runtime_objects-0.3.2.dist-info}/WHEEL +1 -1
- {griffe_runtime_objects-0.3.0.dist-info → griffe_runtime_objects-0.3.2.dist-info}/licenses/LICENSE +1 -1
- griffe_runtime_objects-0.3.0.dist-info/METADATA +0 -78
- griffe_runtime_objects-0.3.0.dist-info/RECORD +0 -10
- {griffe_runtime_objects-0.3.0.dist-info → griffe_runtime_objects-0.3.2.dist-info}/entry_points.txt +0 -0
|
@@ -1,3 +1,21 @@
|
|
|
1
|
+
# SPDX-License-Identifier: ISC
|
|
2
|
+
#
|
|
3
|
+
# ISC License
|
|
4
|
+
#
|
|
5
|
+
# Copyright (c) 2024, Timothée Mazzucotelli and contributors
|
|
6
|
+
#
|
|
7
|
+
# Permission to use, copy, modify, and/or distribute this software for any
|
|
8
|
+
# purpose with or without fee is hereby granted, provided that the above
|
|
9
|
+
# copyright notice and this permission notice appear in all copies.
|
|
10
|
+
#
|
|
11
|
+
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
12
|
+
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
13
|
+
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
14
|
+
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
15
|
+
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
16
|
+
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
17
|
+
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
18
|
+
|
|
1
19
|
"""griffe-runtime-objects package.
|
|
2
20
|
|
|
3
21
|
Make runtime objects available through `extra`.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# SPDX-License-Identifier: ISC
|
|
2
|
+
#
|
|
3
|
+
# ISC License
|
|
4
|
+
#
|
|
5
|
+
# Copyright (c) 2024, Timothée Mazzucotelli and contributors
|
|
6
|
+
#
|
|
7
|
+
# Permission to use, copy, modify, and/or distribute this software for any
|
|
8
|
+
# purpose with or without fee is hereby granted, provided that the above
|
|
9
|
+
# copyright notice and this permission notice appear in all copies.
|
|
10
|
+
#
|
|
11
|
+
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
12
|
+
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
13
|
+
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
14
|
+
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
15
|
+
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
16
|
+
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
17
|
+
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
@@ -1,3 +1,21 @@
|
|
|
1
|
+
# SPDX-License-Identifier: ISC
|
|
2
|
+
#
|
|
3
|
+
# ISC License
|
|
4
|
+
#
|
|
5
|
+
# Copyright (c) 2024, Timothée Mazzucotelli and contributors
|
|
6
|
+
#
|
|
7
|
+
# Permission to use, copy, modify, and/or distribute this software for any
|
|
8
|
+
# purpose with or without fee is hereby granted, provided that the above
|
|
9
|
+
# copyright notice and this permission notice appear in all copies.
|
|
10
|
+
#
|
|
11
|
+
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
12
|
+
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
13
|
+
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
14
|
+
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
15
|
+
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
16
|
+
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
17
|
+
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
18
|
+
|
|
1
19
|
from __future__ import annotations
|
|
2
20
|
|
|
3
21
|
import os
|
|
@@ -85,7 +103,7 @@ def _get_debug_info() -> _Environment:
|
|
|
85
103
|
interpreter_version=py_version,
|
|
86
104
|
interpreter_path=sys.executable,
|
|
87
105
|
platform=platform.platform(),
|
|
88
|
-
variables=[_Variable(var, val) for var in variables if (val := os.getenv(var))],
|
|
106
|
+
variables=[_Variable(var, val) for var in variables if (val := os.getenv(var))],
|
|
89
107
|
packages=[_Package(pkg, _get_version(pkg)) for pkg in packages],
|
|
90
108
|
)
|
|
91
109
|
|
|
@@ -1,3 +1,21 @@
|
|
|
1
|
+
# SPDX-License-Identifier: ISC
|
|
2
|
+
#
|
|
3
|
+
# ISC License
|
|
4
|
+
#
|
|
5
|
+
# Copyright (c) 2024, Timothée Mazzucotelli and contributors
|
|
6
|
+
#
|
|
7
|
+
# Permission to use, copy, modify, and/or distribute this software for any
|
|
8
|
+
# purpose with or without fee is hereby granted, provided that the above
|
|
9
|
+
# copyright notice and this permission notice appear in all copies.
|
|
10
|
+
#
|
|
11
|
+
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
12
|
+
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
13
|
+
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
14
|
+
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
15
|
+
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
16
|
+
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
17
|
+
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
18
|
+
|
|
1
19
|
from __future__ import annotations
|
|
2
20
|
|
|
3
21
|
from typing import TYPE_CHECKING, Any
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: griffe-runtime-objects
|
|
3
|
+
Version: 0.3.2
|
|
4
|
+
Summary: Make runtime objects available through `extra`.
|
|
5
|
+
Author-Email: Timothée Mazzucotelli <dev@pawamoy.fr>
|
|
6
|
+
License-Expression: ISC
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Classifier: Development Status :: 4 - Beta
|
|
9
|
+
Classifier: Intended Audience :: Developers
|
|
10
|
+
Classifier: Programming Language :: Python
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.15
|
|
18
|
+
Classifier: Topic :: Documentation
|
|
19
|
+
Classifier: Topic :: Software Development
|
|
20
|
+
Classifier: Topic :: Utilities
|
|
21
|
+
Classifier: Typing :: Typed
|
|
22
|
+
Project-URL: Homepage, https://mkdocstrings.github.io/griffe-runtime-objects
|
|
23
|
+
Project-URL: Documentation, https://mkdocstrings.github.io/griffe-runtime-objects
|
|
24
|
+
Project-URL: Changelog, https://mkdocstrings.github.io/griffe-runtime-objects/changelog
|
|
25
|
+
Project-URL: Repository, https://github.com/mkdocstrings/griffe-runtime-objects
|
|
26
|
+
Project-URL: Issues, https://github.com/mkdocstrings/griffe-runtime-objects/issues
|
|
27
|
+
Project-URL: Discussions, https://github.com/mkdocstrings/griffe-runtime-objects/discussions
|
|
28
|
+
Project-URL: Gitter, https://gitter.im/mkdocstrings/griffe-runtime-objects
|
|
29
|
+
Project-URL: Funding, https://github.com/sponsors/pawamoy
|
|
30
|
+
Requires-Python: >=3.11
|
|
31
|
+
Requires-Dist: griffelib>=2.0
|
|
32
|
+
Description-Content-Type: text/markdown
|
|
33
|
+
|
|
34
|
+
# griffe-runtime-objects
|
|
35
|
+
|
|
36
|
+
[](https://github.com/mkdocstrings/griffe-runtime-objects/actions?query=workflow%3Aci)
|
|
37
|
+
[](https://mkdocstrings.github.io/griffe-runtime-objects/)
|
|
38
|
+
[](https://pypi.org/project/griffe-runtime-objects/)
|
|
39
|
+
[](https://app.gitter.im/#/room/#griffe-runtime-objects:gitter.im)
|
|
40
|
+
|
|
41
|
+
Make runtime objects available through `extra`.
|
|
42
|
+
|
|
43
|
+
## Installation
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
pip install griffe-runtime-objects
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Usage
|
|
50
|
+
|
|
51
|
+
[Enable](https://mkdocstrings.github.io/griffe/guide/users/extending/#using-extensions) 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:
|
|
52
|
+
|
|
53
|
+
```pycon
|
|
54
|
+
>>> import griffe
|
|
55
|
+
>>> griffe_data = griffe.load("griffe", extensions=griffe.load_extensions("griffe_runtime_objects"), resolve_aliases=True)
|
|
56
|
+
>>> griffe_data["parse"].extra
|
|
57
|
+
defaultdict(<class 'dict'>, {'runtime-objects': {'object': <function parse at 0x78685c951260>}})
|
|
58
|
+
>>> griffe_data["Module"].extra
|
|
59
|
+
defaultdict(<class 'dict'>, {'runtime-objects': {'object': <class '_griffe.models.Module'>}})
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
This extension can be useful in custom templates of mkdocstrings-python, to iterate on an object value or attributes.
|
|
63
|
+
|
|
64
|
+
With MkDocs:
|
|
65
|
+
|
|
66
|
+
```yaml
|
|
67
|
+
plugins:
|
|
68
|
+
- mkdocstrings:
|
|
69
|
+
handlers:
|
|
70
|
+
python:
|
|
71
|
+
options:
|
|
72
|
+
extensions:
|
|
73
|
+
- griffe_runtime_objects
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Sponsors
|
|
77
|
+
|
|
78
|
+
<!-- sponsors-start -->
|
|
79
|
+
|
|
80
|
+
<div id="premium-sponsors" style="text-align: center;">
|
|
81
|
+
|
|
82
|
+
<div id="silver-sponsors"><b>Silver sponsors</b><p>
|
|
83
|
+
<a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a><br>
|
|
84
|
+
</p></div>
|
|
85
|
+
|
|
86
|
+
<div id="bronze-sponsors"><b>Bronze sponsors</b><p>
|
|
87
|
+
<a href="https://www.nixtla.io/"><picture><source media="(prefers-color-scheme: light)" srcset="https://www.nixtla.io/img/logo/full-black.svg"><source media="(prefers-color-scheme: dark)" srcset="https://www.nixtla.io/img/logo/full-white.svg"><img alt="Nixtla" src="https://www.nixtla.io/img/logo/full-black.svg" style="height: 60px; "></picture></a><br>
|
|
88
|
+
</p></div>
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
<div id="sponsors"><p>
|
|
94
|
+
<a href="https://github.com/ofek"><img alt="ofek" src="https://avatars.githubusercontent.com/u/9677399?u=386c330f212ce467ce7119d9615c75d0e9b9f1ce&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
95
|
+
<a href="https://github.com/samuelcolvin"><img alt="samuelcolvin" src="https://avatars.githubusercontent.com/u/4039449?u=42eb3b833047c8c4b4f647a031eaef148c16d93f&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
96
|
+
<a href="https://github.com/tlambert03"><img alt="tlambert03" src="https://avatars.githubusercontent.com/u/1609449?u=922abf0524b47739b37095e553c99488814b05db&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
97
|
+
<a href="https://github.com/ssbarnea"><img alt="ssbarnea" src="https://avatars.githubusercontent.com/u/102495?u=c7bd9ddf127785286fc939dd18cb02db0a453bce&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
98
|
+
<a href="https://github.com/femtomc"><img alt="femtomc" src="https://avatars.githubusercontent.com/u/34410036?u=f13a71daf2a9f0d2da189beaa94250daa629e2d8&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
99
|
+
<a href="https://github.com/cmarqu"><img alt="cmarqu" src="https://avatars.githubusercontent.com/u/360986?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
100
|
+
<a href="https://github.com/kolenaIO"><img alt="kolenaIO" src="https://avatars.githubusercontent.com/u/77010818?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
101
|
+
<a href="https://github.com/ramnes"><img alt="ramnes" src="https://avatars.githubusercontent.com/u/835072?u=3fca03c3ba0051e2eb652b1def2188a94d1e1dc2&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
102
|
+
<a href="https://github.com/machow"><img alt="machow" src="https://avatars.githubusercontent.com/u/2574498?u=c41e3d2f758a05102d8075e38d67b9c17d4189d7&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
103
|
+
<a href="https://github.com/BenHammersley"><img alt="BenHammersley" src="https://avatars.githubusercontent.com/u/99436?u=4499a7b507541045222ee28ae122dbe3c8d08ab5&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
104
|
+
<a href="https://github.com/trevorWieland"><img alt="trevorWieland" src="https://avatars.githubusercontent.com/u/28811461?u=74cc0e3756c1d4e3d66b5c396e1d131ea8a10472&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
105
|
+
<a href="https://github.com/MarcoGorelli"><img alt="MarcoGorelli" src="https://avatars.githubusercontent.com/u/33491632?u=7de3a749cac76a60baca9777baf71d043a4f884d&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
106
|
+
<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=fe0e7bf2882d1c9c901a341c2502e1518466527a&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
107
|
+
<a href="https://github.com/OdinManiac"><img alt="OdinManiac" src="https://avatars.githubusercontent.com/u/22727172?u=36ab20970f7f52ae8e7eb67b7fcf491fee01ac22&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
108
|
+
<a href="https://github.com/rstudio-sponsorship"><img alt="rstudio-sponsorship" src="https://avatars.githubusercontent.com/u/58949051?u=0c471515dd18111be30dfb7669ed5e778970959b&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
109
|
+
<a href="https://github.com/schlich"><img alt="schlich" src="https://avatars.githubusercontent.com/u/21191435?u=6f1240adb68f21614d809ae52d66509f46b1e877&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
110
|
+
<a href="https://github.com/butterlyn"><img alt="butterlyn" src="https://avatars.githubusercontent.com/u/53323535?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
111
|
+
<a href="https://github.com/livingbio"><img alt="livingbio" src="https://avatars.githubusercontent.com/u/10329983?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
112
|
+
<a href="https://github.com/NemetschekAllplan"><img alt="NemetschekAllplan" src="https://avatars.githubusercontent.com/u/912034?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
113
|
+
<a href="https://github.com/EricJayHartman"><img alt="EricJayHartman" src="https://avatars.githubusercontent.com/u/9259499?u=7e58cc7ec0cd3e85b27aec33656aa0f6612706dd&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
114
|
+
<a href="https://github.com/15r10nk"><img alt="15r10nk" src="https://avatars.githubusercontent.com/u/44680962?u=f04826446ff165742efa81e314bd03bf1724d50e&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
115
|
+
<a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
116
|
+
<a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
117
|
+
<a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
118
|
+
<a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
119
|
+
<a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
120
|
+
<a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
121
|
+
<a href="https://github.com/blakeNaccarato"><img alt="blakeNaccarato" src="https://avatars.githubusercontent.com/u/20692450?u=bb919218be30cfa994514f4cf39bb2f7cf952df4&v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
122
|
+
<a href="https://github.com/ChargeStorm"><img alt="ChargeStorm" src="https://avatars.githubusercontent.com/u/26000165?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
123
|
+
<a href="https://github.com/Cusp-AI"><img alt="Cusp-AI" src="https://avatars.githubusercontent.com/u/178170649?v=4" style="height: 32px; border-radius: 100%;"></a>
|
|
124
|
+
</p></div>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
*And 4 more private sponsor(s).*
|
|
128
|
+
|
|
129
|
+
<!-- sponsors-end -->
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
griffe_runtime_objects-0.3.2.dist-info/METADATA,sha256=uAgfC1B-hMHMFSAB_92L6GFYXA1VHuy75pZ0Zsqrf4w,10056
|
|
2
|
+
griffe_runtime_objects-0.3.2.dist-info/WHEEL,sha256=IuIk3wbaEnFH1cx75iM2R1CmliRI3dFLXTbRakgvgFQ,90
|
|
3
|
+
griffe_runtime_objects-0.3.2.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
|
|
4
|
+
griffe_runtime_objects-0.3.2.dist-info/licenses/LICENSE,sha256=V2vVqJE2MAvjfrbPQJpHvhqFsd6Uk4zSkn-bNrt-LAI,771
|
|
5
|
+
griffe_runtime_objects/__init__.py,sha256=Pu8pIdpUA-lUt2fKcjuMgF3QLjmOWaZ5RFC7OzrYNFU,1086
|
|
6
|
+
griffe_runtime_objects/_internal/__init__.py,sha256=GCHH6x0pUOm-lySutKOrjhfyf5HAHy-gxB472daeKhQ,831
|
|
7
|
+
griffe_runtime_objects/_internal/debug.py,sha256=OahFU_nyBgGEIqyGiMCfSA5psVqtIgMmcFVmokIRM_E,3686
|
|
8
|
+
griffe_runtime_objects/_internal/extension.py,sha256=9G76KeBzBNJJF2fiSAbwHiVTwtdCf22QMU9Lr9jIXsg,1903
|
|
9
|
+
griffe_runtime_objects/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
10
|
+
griffe_runtime_objects-0.3.2.dist-info/RECORD,,
|
{griffe_runtime_objects-0.3.0.dist-info → griffe_runtime_objects-0.3.2.dist-info}/licenses/LICENSE
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
ISC License
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2024, Timothée Mazzucotelli
|
|
3
|
+
Copyright (c) 2024, Timothée Mazzucotelli and contributors
|
|
4
4
|
|
|
5
5
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
6
6
|
purpose with or without fee is hereby granted, provided that the above
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: griffe-runtime-objects
|
|
3
|
-
Version: 0.3.0
|
|
4
|
-
Summary: Make runtime objects available through `extra`.
|
|
5
|
-
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
|
|
6
|
-
License-Expression: ISC
|
|
7
|
-
License-File: LICENSE
|
|
8
|
-
Classifier: Development Status :: 4 - Beta
|
|
9
|
-
Classifier: Intended Audience :: Developers
|
|
10
|
-
Classifier: Programming Language :: Python
|
|
11
|
-
Classifier: Programming Language :: Python :: 3
|
|
12
|
-
Classifier: Programming Language :: Python :: 3 :: Only
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.14
|
|
18
|
-
Classifier: Topic :: Documentation
|
|
19
|
-
Classifier: Topic :: Software Development
|
|
20
|
-
Classifier: Topic :: Utilities
|
|
21
|
-
Classifier: Typing :: Typed
|
|
22
|
-
Project-URL: Homepage, https://mkdocstrings.github.io/griffe-runtime-objects
|
|
23
|
-
Project-URL: Documentation, https://mkdocstrings.github.io/griffe-runtime-objects
|
|
24
|
-
Project-URL: Changelog, https://mkdocstrings.github.io/griffe-runtime-objects/changelog
|
|
25
|
-
Project-URL: Repository, https://github.com/mkdocstrings/griffe-runtime-objects
|
|
26
|
-
Project-URL: Issues, https://github.com/mkdocstrings/griffe-runtime-objects/issues
|
|
27
|
-
Project-URL: Discussions, https://github.com/mkdocstrings/griffe-runtime-objects/discussions
|
|
28
|
-
Project-URL: Gitter, https://gitter.im/mkdocstrings/griffe-runtime-objects
|
|
29
|
-
Project-URL: Funding, https://github.com/sponsors/pawamoy
|
|
30
|
-
Requires-Python: >=3.10
|
|
31
|
-
Description-Content-Type: text/markdown
|
|
32
|
-
|
|
33
|
-
# griffe-runtime-objects
|
|
34
|
-
|
|
35
|
-
[](https://github.com/mkdocstrings/griffe-runtime-objects/actions?query=workflow%3Aci)
|
|
36
|
-
[](https://mkdocstrings.github.io/griffe-runtime-objects/)
|
|
37
|
-
[](https://pypi.org/project/griffe-runtime-objects/)
|
|
38
|
-
[](https://app.gitter.im/#/room/#griffe-runtime-objects:gitter.im)
|
|
39
|
-
|
|
40
|
-
Make runtime objects available through `extra`.
|
|
41
|
-
|
|
42
|
-
## Installation
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
pip install griffe-runtime-objects
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## Usage
|
|
49
|
-
|
|
50
|
-
[Enable](https://mkdocstrings.github.io/griffe/guide/users/extending/#using-extensions) 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:
|
|
51
|
-
|
|
52
|
-
```pycon
|
|
53
|
-
>>> import griffe
|
|
54
|
-
>>> griffe_data = griffe.load("griffe", extensions=griffe.load_extensions("griffe_runtime_objects"), resolve_aliases=True)
|
|
55
|
-
>>> griffe_data["parse"].extra
|
|
56
|
-
defaultdict(<class 'dict'>, {'runtime-objects': {'object': <function parse at 0x78685c951260>}})
|
|
57
|
-
>>> griffe_data["Module"].extra
|
|
58
|
-
defaultdict(<class 'dict'>, {'runtime-objects': {'object': <class '_griffe.models.Module'>}})
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
This extension can be useful in custom templates of mkdocstrings-python, to iterate on an object value or attributes.
|
|
62
|
-
|
|
63
|
-
With MkDocs:
|
|
64
|
-
|
|
65
|
-
```yaml
|
|
66
|
-
plugins:
|
|
67
|
-
- mkdocstrings:
|
|
68
|
-
handlers:
|
|
69
|
-
python:
|
|
70
|
-
options:
|
|
71
|
-
extensions:
|
|
72
|
-
- griffe_runtime_objects
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
## Sponsors
|
|
76
|
-
|
|
77
|
-
<!-- sponsors-start -->
|
|
78
|
-
<!-- sponsors-end -->
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
griffe_runtime_objects-0.3.0.dist-info/METADATA,sha256=8bC3zkvZGYSMb2LoN05n9Xh82vmKoyJfi0EFaB-oW_4,3306
|
|
2
|
-
griffe_runtime_objects-0.3.0.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
|
|
3
|
-
griffe_runtime_objects-0.3.0.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
|
|
4
|
-
griffe_runtime_objects-0.3.0.dist-info/licenses/LICENSE,sha256=nke00CVElTmhjAOYXkupvTNauLNPzBTuASi3u9moZ1U,754
|
|
5
|
-
griffe_runtime_objects/__init__.py,sha256=SktsUZTE9uE8wNId6f6RRC62_0JYb0NZsmFuy-WmDMM,254
|
|
6
|
-
griffe_runtime_objects/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
7
|
-
griffe_runtime_objects/_internal/debug.py,sha256=Tl6ZhNPrt18DwlWlvBNLIxNfyM77RerhJrRsba1oPI8,2891
|
|
8
|
-
griffe_runtime_objects/_internal/extension.py,sha256=J1Tjvzas8zu0e8y8wrYMP6g2-JhYH1acg4ztfhIU6hs,1071
|
|
9
|
-
griffe_runtime_objects/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
10
|
-
griffe_runtime_objects-0.3.0.dist-info/RECORD,,
|
{griffe_runtime_objects-0.3.0.dist-info → griffe_runtime_objects-0.3.2.dist-info}/entry_points.txt
RENAMED
|
File without changes
|