griffe-runtime-objects 0.3.0__tar.gz → 0.3.2__tar.gz

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.
Files changed (56) hide show
  1. griffe_runtime_objects-0.3.2/AI_POLICY.md +15 -0
  2. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/CHANGELOG.md +16 -0
  3. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/CONTRIBUTING.md +6 -16
  4. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/LICENSE +1 -1
  5. griffe_runtime_objects-0.3.2/PKG-INFO +129 -0
  6. griffe_runtime_objects-0.3.2/README.md +96 -0
  7. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/config/git-changelog.toml +1 -1
  8. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/config/ruff.toml +8 -23
  9. griffe_runtime_objects-0.3.2/config/ty.toml +6 -0
  10. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/config/vscode/launch.json +1 -2
  11. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/config/vscode/settings.json +1 -3
  12. griffe_runtime_objects-0.3.2/config/zed/debug.json +44 -0
  13. griffe_runtime_objects-0.3.2/config/zed/settings.json +43 -0
  14. griffe_runtime_objects-0.3.2/config/zed/tasks.json +72 -0
  15. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/.overrides/partials/comments.html +1 -1
  16. griffe_runtime_objects-0.3.2/docs/css/apidocs.css +21 -0
  17. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/duties.py +85 -46
  18. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/pyproject.toml +13 -17
  19. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/scripts/gen_credits.py +34 -23
  20. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/scripts/get_version.py +18 -0
  21. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/scripts/make.py +36 -10
  22. griffe_runtime_objects-0.3.2/src/griffe_runtime_objects/__init__.py +28 -0
  23. griffe_runtime_objects-0.3.2/src/griffe_runtime_objects/_internal/__init__.py +17 -0
  24. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/src/griffe_runtime_objects/_internal/debug.py +19 -1
  25. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/src/griffe_runtime_objects/_internal/extension.py +18 -0
  26. griffe_runtime_objects-0.3.2/tests/__init__.py +25 -0
  27. griffe_runtime_objects-0.3.2/tests/conftest.py +19 -0
  28. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/tests/test_api.py +23 -5
  29. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/tests/test_extension.py +18 -0
  30. griffe_runtime_objects-0.3.2/zensical.toml +186 -0
  31. griffe_runtime_objects-0.3.0/PKG-INFO +0 -78
  32. griffe_runtime_objects-0.3.0/README.md +0 -46
  33. griffe_runtime_objects-0.3.0/config/mypy.ini +0 -5
  34. griffe_runtime_objects-0.3.0/docs/.overrides/partials/path-item.html +0 -22
  35. griffe_runtime_objects-0.3.0/docs/css/material.css +0 -4
  36. griffe_runtime_objects-0.3.0/docs/css/mkdocstrings.css +0 -72
  37. griffe_runtime_objects-0.3.0/mkdocs.yml +0 -173
  38. griffe_runtime_objects-0.3.0/src/griffe_runtime_objects/__init__.py +0 -10
  39. griffe_runtime_objects-0.3.0/src/griffe_runtime_objects/_internal/__init__.py +0 -0
  40. griffe_runtime_objects-0.3.0/tests/__init__.py +0 -7
  41. griffe_runtime_objects-0.3.0/tests/conftest.py +0 -1
  42. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/CODE_OF_CONDUCT.md +0 -0
  43. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/config/coverage.ini +0 -0
  44. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/config/pytest.ini +0 -0
  45. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/config/vscode/tasks.json +0 -0
  46. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/.overrides/main.html +0 -0
  47. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/changelog.md +0 -0
  48. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/code_of_conduct.md +0 -0
  49. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/contributing.md +0 -0
  50. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/credits.md +0 -0
  51. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/index.md +0 -0
  52. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/js/feedback.js +0 -0
  53. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/license.md +0 -0
  54. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/docs/reference/api.md +0 -0
  55. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/scripts/make +0 -0
  56. {griffe_runtime_objects-0.3.0 → griffe_runtime_objects-0.3.2}/src/griffe_runtime_objects/py.typed +0 -0
@@ -0,0 +1,15 @@
1
+ # AI Contribution Policy
2
+
3
+ We accept AI-*assisted* contributions, both for code and documentation, with the following expectations:
4
+
5
+ - AI-assisted contributions must disclaim their use of AI.
6
+ - Contributors must fully understand the proposed changes and be able to explain why they are the correct approach.
7
+ - Issues must be created before creating pull requests (unless there is already a relevant issue).
8
+ - Issue and pull request templates must be followed.
9
+ - Comments (including bodies) in issues and pull requests must be written by humans. If you use LLMs to translate from one language to another, please include your original comment and the translated one.
10
+ - Git commits must be authored by humans, not AI/bot accounts or identities.
11
+ - Git commit messages must be written by humans, in English. If you cannot write English, please state so in the pull request body and we will write the commit messages ourselves.
12
+
13
+ Failure to comply with any of these requirements will result in issues or pull requests being closed immediately without comment. Repeated violations of this policy will result in a ban of the offending accounts/identities from contributing to this project and any related project from the same author/organization.
14
+
15
+ We do not accept AI-generated content in community spaces we maintain or moderate, such as GitHub discussions or Matrix rooms.
@@ -6,6 +6,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6
6
  and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7
7
 
8
8
  <!-- insertion marker -->
9
+ ## [0.3.2](https://github.com/mkdocstrings/griffe-runtime-objects/releases/tag/0.3.2) - 2026-10-06
10
+
11
+ <small>[Compare with 0.3.1](https://github.com/mkdocstrings/griffe-runtime-objects/compare/0.3.1...0.3.2)</small>
12
+
13
+ ### Build
14
+
15
+ - Drop support for Python 3.10 ([f467fa6](https://github.com/mkdocstrings/griffe-runtime-objects/commit/f467fa69a1ce956d1720c49614856cc35e35c969) by Timothée Mazzucotelli).
16
+
17
+ ## [0.3.1](https://github.com/mkdocstrings/griffe-runtime-objects/releases/tag/0.3.1) - 2026-02-20
18
+
19
+ <small>[Compare with 0.3.0](https://github.com/mkdocstrings/griffe-runtime-objects/compare/0.3.0...0.3.1)</small>
20
+
21
+ ### Build
22
+
23
+ - Depend on griffelib 2.0 ([d2f015b](https://github.com/mkdocstrings/griffe-runtime-objects/commit/d2f015b341d1a275ebf57176c5edab7814bb479b) by Timothée Mazzucotelli).
24
+
9
25
  ## [0.3.0](https://github.com/mkdocstrings/griffe-runtime-objects/releases/tag/0.3.0) - 2025-11-09
10
26
 
11
27
  <small>[Compare with 0.2.0](https://github.com/mkdocstrings/griffe-runtime-objects/compare/0.2.0...0.3.0)</small>
@@ -1,36 +1,26 @@
1
1
  # Contributing
2
2
 
3
- Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
3
+ Contributions are welcome, and they are greatly appreciated. Every little bit helps, and credit will always be given.
4
4
 
5
- ## Environment setup
5
+ **Please always create an issue before working on a new feature or a bug fix, so that we can discuss the implementation and make sure that your work will be merged.**
6
6
 
7
- Nothing easier!
7
+ ## Environment setup
8
8
 
9
- Fork and clone the repository, then:
9
+ Install [uv](https://github.com/astral-sh/uv) and [direnv](https://direnv.net/), fork and clone the repository, then:
10
10
 
11
11
  ```bash
12
12
  cd griffe-runtime-objects
13
+ direnv allow
13
14
  make setup
14
15
  ```
15
16
 
16
- > NOTE: If it fails for some reason, you'll need to install [uv](https://github.com/astral-sh/uv) manually.
17
- >
18
- > You can install it with:
19
- >
20
- > ```bash
21
- > curl -LsSf https://astral.sh/uv/install.sh | sh
22
- > ```
23
- >
24
- > Now you can try running `make setup` again, or simply `uv sync`.
25
-
26
17
  You now have the dependencies installed.
27
18
 
28
19
  Run `make help` to see all the available actions!
29
20
 
30
21
  ## Tasks
31
22
 
32
- The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed,
33
- while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
23
+ The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed, while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
34
24
 
35
25
  If you work in VSCode, we provide [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup) for the project.
36
26
 
@@ -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
@@ -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
+ [![ci](https://github.com/mkdocstrings/griffe-runtime-objects/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-runtime-objects/actions?query=workflow%3Aci)
37
+ [![documentation](https://img.shields.io/badge/docs-zensical-FF9100.svg?style=flat)](https://mkdocstrings.github.io/griffe-runtime-objects/)
38
+ [![pypi version](https://img.shields.io/pypi/v/griffe-runtime-objects.svg)](https://pypi.org/project/griffe-runtime-objects/)
39
+ [![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](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,96 @@
1
+ # griffe-runtime-objects
2
+
3
+ [![ci](https://github.com/mkdocstrings/griffe-runtime-objects/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-runtime-objects/actions?query=workflow%3Aci)
4
+ [![documentation](https://img.shields.io/badge/docs-zensical-FF9100.svg?style=flat)](https://mkdocstrings.github.io/griffe-runtime-objects/)
5
+ [![pypi version](https://img.shields.io/pypi/v/griffe-runtime-objects.svg)](https://pypi.org/project/griffe-runtime-objects/)
6
+ [![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#griffe-runtime-objects:gitter.im)
7
+
8
+ Make runtime objects available through `extra`.
9
+
10
+ ## Installation
11
+
12
+ ```bash
13
+ pip install griffe-runtime-objects
14
+ ```
15
+
16
+ ## Usage
17
+
18
+ [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:
19
+
20
+ ```pycon
21
+ >>> import griffe
22
+ >>> griffe_data = griffe.load("griffe", extensions=griffe.load_extensions("griffe_runtime_objects"), resolve_aliases=True)
23
+ >>> griffe_data["parse"].extra
24
+ defaultdict(<class 'dict'>, {'runtime-objects': {'object': <function parse at 0x78685c951260>}})
25
+ >>> griffe_data["Module"].extra
26
+ defaultdict(<class 'dict'>, {'runtime-objects': {'object': <class '_griffe.models.Module'>}})
27
+ ```
28
+
29
+ This extension can be useful in custom templates of mkdocstrings-python, to iterate on an object value or attributes.
30
+
31
+ With MkDocs:
32
+
33
+ ```yaml
34
+ plugins:
35
+ - mkdocstrings:
36
+ handlers:
37
+ python:
38
+ options:
39
+ extensions:
40
+ - griffe_runtime_objects
41
+ ```
42
+
43
+ ## Sponsors
44
+
45
+ <!-- sponsors-start -->
46
+
47
+ <div id="premium-sponsors" style="text-align: center;">
48
+
49
+ <div id="silver-sponsors"><b>Silver sponsors</b><p>
50
+ <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>
51
+ </p></div>
52
+
53
+ <div id="bronze-sponsors"><b>Bronze sponsors</b><p>
54
+ <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>
55
+ </p></div>
56
+ </div>
57
+
58
+ ---
59
+
60
+ <div id="sponsors"><p>
61
+ <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>
62
+ <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>
63
+ <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>
64
+ <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>
65
+ <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>
66
+ <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>
67
+ <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>
68
+ <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>
69
+ <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>
70
+ <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>
71
+ <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>
72
+ <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>
73
+ <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>
74
+ <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>
75
+ <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>
76
+ <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>
77
+ <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>
78
+ <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>
79
+ <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>
80
+ <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>
81
+ <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>
82
+ <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>
83
+ <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>
84
+ <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>
85
+ <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>
86
+ <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>
87
+ <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>
88
+ <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>
89
+ <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>
90
+ <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>
91
+ </p></div>
92
+
93
+
94
+ *And 4 more private sponsor(s).*
95
+
96
+ <!-- sponsors-end -->
@@ -4,6 +4,6 @@ in-place = true
4
4
  output = "CHANGELOG.md"
5
5
  parse-refs = false
6
6
  parse-trailers = true
7
- sections = ["build", "deps", "feat", "fix", "refactor"]
7
+ sections = ["build", "deps", "feat", "fix", "perf", "refactor"]
8
8
  template = "keepachangelog"
9
9
  versioning = "pep440"
@@ -1,34 +1,14 @@
1
- target-version = "py39"
1
+ target-version = "py311"
2
2
  line-length = 120
3
+ output-format = "concise"
3
4
 
4
5
  [lint]
5
6
  exclude = [
6
7
  "tests/fixtures/*.py",
7
8
  ]
8
- select = [
9
- "A", "ANN", "ARG",
10
- "B", "BLE",
11
- "C", "C4",
12
- "COM",
13
- "D", "DTZ",
14
- "E", "ERA", "EXE",
15
- "F", "FBT",
16
- "G",
17
- "I", "ICN", "INP", "ISC",
18
- "N",
19
- "PGH", "PIE", "PL", "PLC", "PLE", "PLR", "PLW", "PT", "PYI",
20
- "Q",
21
- "RUF", "RSE", "RET",
22
- "S", "SIM", "SLF",
23
- "T", "T10", "T20", "TCH", "TID", "TRY",
24
- "UP",
25
- "W",
26
- "YTT",
27
- ]
9
+ select = ["ALL"]
28
10
  ignore = [
29
11
  "A001", # Variable is shadowing a Python builtin
30
- "ANN101", # Missing type annotation for self
31
- "ANN102", # Missing type annotation for cls
32
12
  "ANN204", # Missing return type annotation for special method __str__
33
13
  "ANN401", # Dynamically typed expressions (typing.Any) are disallowed
34
14
  "ARG005", # Unused lambda argument
@@ -36,13 +16,18 @@ ignore = [
36
16
  "D105", # Missing docstring in magic method
37
17
  "D417", # Missing argument description in the docstring
38
18
  "E501", # Line too long
19
+ "EM101", # String literal when raising exception
20
+ "EM102", # f-string when raising exception
39
21
  "ERA001", # Commented out code
22
+ "FIX", # TODO, FIXME, etc.
40
23
  "G004", # Logging statement uses f-string
41
24
  "PLR0911", # Too many return statements
42
25
  "PLR0912", # Too many branches
43
26
  "PLR0913", # Too many arguments to function call
44
27
  "PLR0915", # Too many statements
45
28
  "SLF001", # Private member accessed
29
+ "TD002", # Missing author in TODO
30
+ "TD003", # Missing issue link for TODO
46
31
  "TRY003", # Avoid specifying long messages outside the exception class
47
32
  ]
48
33
 
@@ -0,0 +1,6 @@
1
+ [src]
2
+ exclude = ["tests/fixtures"]
3
+
4
+ [terminal]
5
+ error-on-warning = true
6
+ output-format = "concise"
@@ -23,11 +23,10 @@
23
23
  "name": "docs",
24
24
  "type": "debugpy",
25
25
  "request": "launch",
26
- "module": "mkdocs",
26
+ "module": "zensical",
27
27
  "justMyCode": false,
28
28
  "args": [
29
29
  "serve",
30
- "-v"
31
30
  ]
32
31
  },
33
32
  {
@@ -4,9 +4,6 @@
4
4
  "**/.venvs*/**": true,
5
5
  "**/venv*/**": true
6
6
  },
7
- "mypy-type-checker.args": [
8
- "--config-file=config/mypy.ini"
9
- ],
10
7
  "python.testing.unittestEnabled": false,
11
8
  "python.testing.pytestEnabled": true,
12
9
  "python.testing.pytestArgs": [
@@ -19,6 +16,7 @@
19
16
  "ruff.lint.args": [
20
17
  "--config=config/ruff.toml"
21
18
  ],
19
+ "ty.configurationFile": "config/ty.toml",
22
20
  "yaml.schemas": {
23
21
  "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
24
22
  },
@@ -0,0 +1,44 @@
1
+ // Project-local debug tasks
2
+ //
3
+ // For more documentation on how to configure debug tasks,
4
+ // see: https://zed.dev/docs/debugger
5
+ [
6
+ {
7
+ "label": "python (current file)",
8
+ "adapter": "Debugpy",
9
+ "request": "launch",
10
+ "program": "$ZED_FILE",
11
+ "justMyCode": false
12
+ },
13
+ {
14
+ "label": "run",
15
+ "adapter": "Debugpy",
16
+ "request": "launch",
17
+ "module": "griffe_runtime_objects",
18
+ "justMyCode": false
19
+ },
20
+ {
21
+ "label": "docs",
22
+ "adapter": "Debugpy",
23
+ "request": "launch",
24
+ "module": "zensical",
25
+ "args": [
26
+ "serve"
27
+ ],
28
+ "justMyCode": false
29
+ },
30
+ {
31
+ "label": "test",
32
+ "adapter": "Debugpy",
33
+ "request": "launch",
34
+ "module": "pytest",
35
+ "args": [
36
+ "-c=config/pytest.ini",
37
+ "-vvv",
38
+ "--no-cov",
39
+ "--dist=no",
40
+ "tests"
41
+ ],
42
+ "justMyCode": false
43
+ }
44
+ ]
@@ -0,0 +1,43 @@
1
+ // Zed settings
2
+ //
3
+ // For information on how to configure Zed, see the Zed
4
+ // documentation: https://zed.dev/docs/configuring-zed
5
+ //
6
+ // To see all of Zed's default settings without changing your
7
+ // custom settings, run `zed: open default settings` from the
8
+ // command palette (cmd-shift-p / ctrl-shift-p)
9
+ {
10
+ "languages": {
11
+ "YAML": {
12
+ "auto_indent_on_paste": false,
13
+ "auto_indent": "preserve_indent",
14
+ "format_on_save": "off"
15
+ },
16
+ "Python": {
17
+ "language_servers": ["ty", "ruff"],
18
+ "code_actions_on_format": {
19
+ "source.organizeImports.ruff": true
20
+ },
21
+ "formatter": {
22
+ "language_server": {
23
+ "name": "ruff"
24
+ }
25
+ }
26
+ }
27
+ },
28
+ "lsp": {
29
+ "ty": {
30
+ "settings": {
31
+ "configurationFile": "config/ty.toml"
32
+ }
33
+ },
34
+ "ruff": {
35
+ "initialization_options": {
36
+ "settings": {
37
+ "configurationPreference": "filesystemFirst",
38
+ "configuration": "config/ruff.toml"
39
+ }
40
+ }
41
+ }
42
+ }
43
+ }
@@ -0,0 +1,72 @@
1
+ [
2
+ {
3
+ "label": "changelog",
4
+ "command": "scripts/make",
5
+ "args": ["changelog"]
6
+ },
7
+ {
8
+ "label": "check",
9
+ "command": "scripts/make",
10
+ "args": ["check"]
11
+ },
12
+ {
13
+ "label": "check-quality",
14
+ "command": "scripts/make",
15
+ "args": ["check-quality"]
16
+ },
17
+ {
18
+ "label": "check-types",
19
+ "command": "scripts/make",
20
+ "args": ["check-types"]
21
+ },
22
+ {
23
+ "label": "check-docs",
24
+ "command": "scripts/make",
25
+ "args": ["check-docs"]
26
+ },
27
+ {
28
+ "label": "check-api",
29
+ "command": "scripts/make",
30
+ "args": ["check-api"]
31
+ },
32
+ {
33
+ "label": "clean",
34
+ "command": "scripts/make",
35
+ "args": ["clean"]
36
+ },
37
+ {
38
+ "label": "docs",
39
+ "command": "scripts/make",
40
+ "args": ["docs"]
41
+ },
42
+ {
43
+ "label": "docs-deploy",
44
+ "command": "scripts/make",
45
+ "args": ["docs-deploy"]
46
+ },
47
+ {
48
+ "label": "format",
49
+ "command": "scripts/make",
50
+ "args": ["format"]
51
+ },
52
+ {
53
+ "label": "release",
54
+ "command": "scripts/make",
55
+ "args": ["release"]
56
+ },
57
+ {
58
+ "label": "setup",
59
+ "command": "scripts/make",
60
+ "args": ["setup"]
61
+ },
62
+ {
63
+ "label": "test",
64
+ "command": "scripts/make",
65
+ "args": ["test", "coverage"]
66
+ },
67
+ {
68
+ "label": "vscode",
69
+ "command": "scripts/make",
70
+ "args": ["vscode"]
71
+ }
72
+ ]
@@ -1,5 +1,5 @@
1
1
  <!-- Giscus -->
2
- <!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration -->
2
+ <!-- https://zensical.org/docs/setup/comment-system/#giscus-integration -->
3
3
  <div id="feedback" style="display: none;">
4
4
  <h2 id="__comments">Feedback</h2>
5
5
  <script src="https://giscus.app/client.js"
@@ -0,0 +1,21 @@
1
+ /* Mark external links as such. */
2
+ a.external::after,
3
+ a.autorefs-external::after {
4
+ /* https://primer.style/octicons/arrow-up-right-24 */
5
+ mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
6
+ -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
7
+ content: ' ';
8
+
9
+ display: inline-block;
10
+ vertical-align: middle;
11
+ position: relative;
12
+
13
+ height: 1em;
14
+ width: 1em;
15
+ background-color: currentColor;
16
+ }
17
+
18
+ a.external:hover::after,
19
+ a.autorefs-external:hover::after {
20
+ background-color: var(--md-accent-fg-color);
21
+ }