mkdocstrings-python 1.10.3__py3-none-any.whl → 1.10.4__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.
- mkdocstrings_handlers/python/debug.py +4 -1
- mkdocstrings_handlers/python/handler.py +4 -4
- mkdocstrings_handlers/python/templates/material/_base/children.html.jinja +5 -5
- {mkdocstrings_python-1.10.3.dist-info → mkdocstrings_python-1.10.4.dist-info}/METADATA +5 -4
- {mkdocstrings_python-1.10.3.dist-info → mkdocstrings_python-1.10.4.dist-info}/RECORD +7 -7
- {mkdocstrings_python-1.10.3.dist-info → mkdocstrings_python-1.10.4.dist-info}/WHEEL +0 -0
- {mkdocstrings_python-1.10.3.dist-info → mkdocstrings_python-1.10.4.dist-info}/licenses/LICENSE +0 -0
|
@@ -37,6 +37,8 @@ class Environment:
|
|
|
37
37
|
"""Python interpreter name."""
|
|
38
38
|
interpreter_version: str
|
|
39
39
|
"""Python interpreter version."""
|
|
40
|
+
interpreter_path: str
|
|
41
|
+
"""Path to Python executable."""
|
|
40
42
|
platform: str
|
|
41
43
|
"""Operating System."""
|
|
42
44
|
packages: list[Package]
|
|
@@ -83,6 +85,7 @@ def get_debug_info() -> Environment:
|
|
|
83
85
|
return Environment(
|
|
84
86
|
interpreter_name=py_name,
|
|
85
87
|
interpreter_version=py_version,
|
|
88
|
+
interpreter_path=sys.executable,
|
|
86
89
|
platform=platform.platform(),
|
|
87
90
|
variables=[Variable(var, val) for var in variables if (val := os.getenv(var))],
|
|
88
91
|
packages=[Package(pkg, get_version(pkg)) for pkg in packages],
|
|
@@ -93,7 +96,7 @@ def print_debug_info() -> None:
|
|
|
93
96
|
"""Print debug/environment information."""
|
|
94
97
|
info = get_debug_info()
|
|
95
98
|
print(f"- __System__: {info.platform}")
|
|
96
|
-
print(f"- __Python__: {info.interpreter_name} {info.interpreter_version}")
|
|
99
|
+
print(f"- __Python__: {info.interpreter_name} {info.interpreter_version} ({info.interpreter_path})")
|
|
97
100
|
print("- __Environment variables__:")
|
|
98
101
|
for var in info.variables:
|
|
99
102
|
print(f" - `{var.name}`: `{var.value}`")
|
|
@@ -53,7 +53,7 @@ patch_loggers(get_logger)
|
|
|
53
53
|
class PythonHandler(BaseHandler):
|
|
54
54
|
"""The Python handler class."""
|
|
55
55
|
|
|
56
|
-
name = "python"
|
|
56
|
+
name: str = "python"
|
|
57
57
|
"""The handler's name."""
|
|
58
58
|
domain: str = "py" # to match Sphinx's default domain
|
|
59
59
|
"""The cross-documentation domain/language for this handler."""
|
|
@@ -197,7 +197,7 @@ class PythonHandler(BaseHandler):
|
|
|
197
197
|
config_file_path: str | None = None,
|
|
198
198
|
paths: list[str] | None = None,
|
|
199
199
|
locale: str = "en",
|
|
200
|
-
load_external_modules: bool =
|
|
200
|
+
load_external_modules: bool | None = None,
|
|
201
201
|
**kwargs: Any,
|
|
202
202
|
) -> None:
|
|
203
203
|
"""Initialize the handler.
|
|
@@ -296,7 +296,7 @@ class PythonHandler(BaseHandler):
|
|
|
296
296
|
if unknown_module:
|
|
297
297
|
extensions = self.normalize_extension_paths(final_config.get("extensions", []))
|
|
298
298
|
loader = GriffeLoader(
|
|
299
|
-
extensions=load_extensions(extensions),
|
|
299
|
+
extensions=load_extensions(*extensions),
|
|
300
300
|
search_paths=self._paths,
|
|
301
301
|
docstring_parser=parser,
|
|
302
302
|
docstring_options=parser_options,
|
|
@@ -474,7 +474,7 @@ def get_handler(
|
|
|
474
474
|
config_file_path: str | None = None,
|
|
475
475
|
paths: list[str] | None = None,
|
|
476
476
|
locale: str = "en",
|
|
477
|
-
load_external_modules: bool =
|
|
477
|
+
load_external_modules: bool | None = None,
|
|
478
478
|
**config: Any, # noqa: ARG001
|
|
479
479
|
) -> PythonHandler:
|
|
480
480
|
"""Simply return an instance of `PythonHandler`.
|
|
@@ -49,7 +49,7 @@ Context:
|
|
|
49
49
|
{% endif %}
|
|
50
50
|
{% with heading_level = heading_level + extra_level %}
|
|
51
51
|
{% for attribute in attributes|order_members(config.members_order, members_list) %}
|
|
52
|
-
{% if members_list is not none or attribute.
|
|
52
|
+
{% if members_list is not none or not attribute.is_imported %}
|
|
53
53
|
{% include attribute|get_template with context %}
|
|
54
54
|
{% endif %}
|
|
55
55
|
{% endfor %}
|
|
@@ -69,7 +69,7 @@ Context:
|
|
|
69
69
|
{% endif %}
|
|
70
70
|
{% with heading_level = heading_level + extra_level %}
|
|
71
71
|
{% for class in classes|order_members(config.members_order, members_list) %}
|
|
72
|
-
{% if members_list is not none or class.
|
|
72
|
+
{% if members_list is not none or not class.is_imported %}
|
|
73
73
|
{% include class|get_template with context %}
|
|
74
74
|
{% endif %}
|
|
75
75
|
{% endfor %}
|
|
@@ -90,7 +90,7 @@ Context:
|
|
|
90
90
|
{% with heading_level = heading_level + extra_level %}
|
|
91
91
|
{% for function in functions|order_members(config.members_order, members_list) %}
|
|
92
92
|
{% if not (obj.kind.value == "class" and function.name == "__init__" and config.merge_init_into_class) %}
|
|
93
|
-
{% if members_list is not none or function.
|
|
93
|
+
{% if members_list is not none or not function.is_imported %}
|
|
94
94
|
{% include function|get_template with context %}
|
|
95
95
|
{% endif %}
|
|
96
96
|
{% endif %}
|
|
@@ -112,7 +112,7 @@ Context:
|
|
|
112
112
|
{% endif %}
|
|
113
113
|
{% with heading_level = heading_level + extra_level %}
|
|
114
114
|
{% for module in modules|order_members(config.members_order.alphabetical, members_list) %}
|
|
115
|
-
{% if members_list is not none or module.
|
|
115
|
+
{% if members_list is not none or not module.is_alias %}
|
|
116
116
|
{% include module|get_template with context %}
|
|
117
117
|
{% endif %}
|
|
118
118
|
{% endfor %}
|
|
@@ -137,7 +137,7 @@ Context:
|
|
|
137
137
|
|
|
138
138
|
{% if not (obj.is_class and child.name == "__init__" and config.merge_init_into_class) %}
|
|
139
139
|
|
|
140
|
-
{% if members_list is not none or child.is_public
|
|
140
|
+
{% if members_list is not none or child.is_public %}
|
|
141
141
|
{% if child.is_attribute %}
|
|
142
142
|
{% with attribute = child %}
|
|
143
143
|
{% include attribute|get_template with context %}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: mkdocstrings-python
|
|
3
|
-
Version: 1.10.
|
|
3
|
+
Version: 1.10.4
|
|
4
4
|
Summary: A Python handler for mkdocstrings.
|
|
5
5
|
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
|
|
6
6
|
License: ISC
|
|
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.9
|
|
|
14
14
|
Classifier: Programming Language :: Python :: 3.10
|
|
15
15
|
Classifier: Programming Language :: Python :: 3.11
|
|
16
16
|
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
18
|
Classifier: Topic :: Documentation
|
|
18
19
|
Classifier: Topic :: Software Development
|
|
19
20
|
Classifier: Topic :: Utilities
|
|
@@ -28,7 +29,7 @@ Project-URL: Gitter, https://gitter.im/mkdocstrings/python
|
|
|
28
29
|
Project-URL: Funding, https://github.com/sponsors/pawamoy
|
|
29
30
|
Requires-Python: >=3.8
|
|
30
31
|
Requires-Dist: mkdocstrings>=0.25
|
|
31
|
-
Requires-Dist: griffe>=0.
|
|
32
|
+
Requires-Dist: griffe>=0.47
|
|
32
33
|
Description-Content-Type: text/markdown
|
|
33
34
|
|
|
34
35
|
<h1 align="center">mkdocstrings-python</h1>
|
|
@@ -36,9 +37,9 @@ Description-Content-Type: text/markdown
|
|
|
36
37
|
<p align="center">A Python handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
|
|
37
38
|
|
|
38
39
|
[](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)
|
|
39
|
-
[](https://mkdocstrings.github.io/python/)
|
|
40
41
|
[](https://pypi.org/project/mkdocstrings-python/)
|
|
41
|
-
[](https://gitpod.io/#https://github.com/mkdocstrings/python)
|
|
42
43
|
[](https://app.gitter.im/#/room/#python:gitter.im)
|
|
43
44
|
|
|
44
45
|
---
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
mkdocstrings_handlers/python/__init__.py,sha256=k-0NWvXysr5RqWjtGyCozookveBB-ADZHIhgxvI1px8,128
|
|
2
|
-
mkdocstrings_handlers/python/debug.py,sha256=
|
|
3
|
-
mkdocstrings_handlers/python/handler.py,sha256=
|
|
2
|
+
mkdocstrings_handlers/python/debug.py,sha256=4vqIbCbbz_vcjcFk6jPoF8E1kLig8AQEsQ93ybcjIVc,2894
|
|
3
|
+
mkdocstrings_handlers/python/handler.py,sha256=aRrjQpaW-zR_3S9K-oElyxsNUecs3yATi6BoGfz6p9w,24337
|
|
4
4
|
mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
5
5
|
mkdocstrings_handlers/python/rendering.py,sha256=kxy4MKpEUb_WzxXVXLnZ16HCFzqvWbuaDQQXGiIIV1U,18039
|
|
6
6
|
mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=nn0671f4bE7VqnTs-VQL3SGPACWAxb2uJBRcP2nwYng,427
|
|
7
7
|
mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=T29m8kLAh7ZWnik7wgdT0MvZLfmyUl2BXDMriZynuDA,4373
|
|
8
8
|
mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=mOafkSlphFQJLWfrYrIMFVRGi2yjdtN6iJh8bPt7uRI,424
|
|
9
|
-
mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=
|
|
9
|
+
mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=KYfL1IKgUy22iTE70VUmXqDXEiGyxeEUhUKLZDEKDU0,6330
|
|
10
10
|
mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=x0M8Wjk7TC9cgnstMoukLVQvxZUEMFjQA0VJQPEAC9Y,415
|
|
11
11
|
mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=lkEExDnNqFbyjG0EsJoygU9ZrrSGAk3KT8uVcqo6_Ok,7241
|
|
12
12
|
mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=9gDeMzbEUGfOBklwvriH5HMfcotOcaXUvlgLC9klTi8,427
|
|
@@ -177,7 +177,7 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha25
|
|
|
177
177
|
mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
|
|
178
178
|
mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
|
|
179
179
|
mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
|
|
180
|
-
mkdocstrings_python-1.10.
|
|
181
|
-
mkdocstrings_python-1.10.
|
|
182
|
-
mkdocstrings_python-1.10.
|
|
183
|
-
mkdocstrings_python-1.10.
|
|
180
|
+
mkdocstrings_python-1.10.4.dist-info/METADATA,sha256=O10YEPGLqyNu3iBUDW7th6cahw5OE0aES_eWw9sAxrs,5551
|
|
181
|
+
mkdocstrings_python-1.10.4.dist-info/WHEEL,sha256=vnE8JVcI2Wz7GRKorsPArnBdnW2SWKWGow5gu5tHlRU,90
|
|
182
|
+
mkdocstrings_python-1.10.4.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
|
|
183
|
+
mkdocstrings_python-1.10.4.dist-info/RECORD,,
|
|
File without changes
|
{mkdocstrings_python-1.10.3.dist-info → mkdocstrings_python-1.10.4.dist-info}/licenses/LICENSE
RENAMED
|
File without changes
|