mkdocstrings-python 1.14.4__py3-none-any.whl → 1.14.6__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.
@@ -307,7 +307,7 @@ class PythonHandler(BaseHandler):
307
307
  def get_aliases(self, identifier: str) -> tuple[str, ...]: # noqa: D102 (ignore missing docstring)
308
308
  try:
309
309
  data = self._modules_collection[identifier]
310
- except KeyError:
310
+ except (KeyError, AliasResolutionError):
311
311
  return ()
312
312
  aliases = [data.path]
313
313
  try:
@@ -539,11 +539,20 @@ def do_as_attributes_section(
539
539
  Returns:
540
540
  An attributes docstring section.
541
541
  """
542
+
543
+ def _parse_docstring_summary(attribute: Attribute) -> str:
544
+ if attribute.docstring is None:
545
+ return ""
546
+ line = attribute.docstring.value.split("\n", 1)[0]
547
+ if ":" in line and attribute.docstring.parser_options.get("returns_type_in_property_summary", False):
548
+ _, line = line.split(":", 1)
549
+ return line
550
+
542
551
  return DocstringSectionAttributes(
543
552
  [
544
553
  DocstringAttribute(
545
554
  name=attribute.name,
546
- description=attribute.docstring.value.split("\n", 1)[0] if attribute.docstring else "",
555
+ description=_parse_docstring_summary(attribute),
547
556
  annotation=attribute.annotation,
548
557
  value=attribute.value, # type: ignore[arg-type]
549
558
  )
@@ -10,20 +10,20 @@
10
10
  {% macro t(key) %}{{ {
11
11
  "ATTRIBUTE": "属性",
12
12
  "Attributes:": "属性:",
13
- "Classes:": "",
14
- "CLASS": "",
13
+ "Classes:": "クラス:",
14
+ "CLASS": "クラス",
15
15
  "DEFAULT:": "デフォルト:",
16
16
  "Default": "デフォルト",
17
17
  "default:": "デフォルト:",
18
18
  "DESCRIPTION": "デスクリプション",
19
19
  "Description": "デスクリプション",
20
20
  "Examples:": "例:",
21
- "Functions:": "",
22
- "FUNCTION": "",
23
- "Methods:": "",
24
- "METHOD": "",
25
- "Modules:": "",
26
- "MODULE": "",
21
+ "Functions:": "関数:",
22
+ "FUNCTION": "関数",
23
+ "Methods:": "メソッド:",
24
+ "METHOD": "メソッド",
25
+ "Modules:": "モジュール:",
26
+ "MODULE": "モジュール",
27
27
  "Name": "名前",
28
28
  "Other Parameters:": "他の引数:",
29
29
  "PARAMETER": "引数",
@@ -10,20 +10,20 @@
10
10
  {% macro t(key) %}{{ {
11
11
  "ATTRIBUTE": "属性",
12
12
  "Attributes:": "属性:",
13
- "Classes:": "",
14
- "CLASS": "",
13
+ "Classes:": "类:",
14
+ "CLASS": "",
15
15
  "DEFAULT:": "默认:",
16
16
  "Default": "默认",
17
17
  "default:": "默认:",
18
18
  "DESCRIPTION": "描述",
19
19
  "Description": "描述",
20
20
  "Examples:": "示例:",
21
- "Functions:": "",
22
- "FUNCTION": "",
23
- "Methods:": "",
24
- "METHOD": "",
25
- "Modules:": "",
26
- "MODULE": "",
21
+ "Functions:": "函数:",
22
+ "FUNCTION": "函数",
23
+ "Methods:": "方法:",
24
+ "METHOD": "方法",
25
+ "Modules:": "模块:",
26
+ "MODULE": "模块",
27
27
  "Name": "名称",
28
28
  "Other Parameters:": "其他参数:",
29
29
  "PARAMETER": "参数",
@@ -4,20 +4,20 @@
4
4
  {% macro t(key) %}{{ {
5
5
  "ATTRIBUTE": "属性",
6
6
  "Attributes:": "属性:",
7
- "Classes:": "",
8
- "CLASS": "",
7
+ "Classes:": "クラス:",
8
+ "CLASS": "クラス",
9
9
  "DEFAULT:": "デフォルト:",
10
10
  "Default": "デフォルト",
11
11
  "default:": "デフォルト:",
12
12
  "DESCRIPTION": "デスクリプション",
13
13
  "Description": "デスクリプション",
14
14
  "Examples:": "例:",
15
- "Functions:": "",
16
- "FUNCTION": "",
17
- "Methods:": "",
18
- "METHOD": "",
19
- "Modules:": "",
20
- "MODULE": "",
15
+ "Functions:": "関数:",
16
+ "FUNCTION": "関数",
17
+ "Methods:": "メソッド:",
18
+ "METHOD": "メソッド",
19
+ "Modules:": "モジュール:",
20
+ "MODULE": "モジュール",
21
21
  "Name": "名前",
22
22
  "Other Parameters:": "他の引数:",
23
23
  "PARAMETER": "引数",
@@ -4,20 +4,20 @@
4
4
  {% macro t(key) %}{{ {
5
5
  "ATTRIBUTE": "属性",
6
6
  "Attributes:": "属性:",
7
- "Classes:": "",
8
- "CLASS": "",
7
+ "Classes:": "类:",
8
+ "CLASS": "",
9
9
  "DEFAULT:": "默认:",
10
10
  "Default": "默认",
11
11
  "default:": "默认:",
12
12
  "DESCRIPTION": "描述",
13
13
  "Description": "描述",
14
14
  "Examples:": "示例:",
15
- "Functions:": "",
16
- "FUNCTION": "",
17
- "Methods:": "",
18
- "METHOD": "",
19
- "Modules:": "",
20
- "MODULE": "",
15
+ "Functions:": "函数:",
16
+ "FUNCTION": "函数",
17
+ "Methods:": "方法:",
18
+ "METHOD": "方法",
19
+ "Modules:": "模块:",
20
+ "MODULE": "模块",
21
21
  "Name": "名称",
22
22
  "Other Parameters:": "其他参数:",
23
23
  "PARAMETER": "参数",
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocstrings-python
3
- Version: 1.14.4
3
+ Version: 1.14.6
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
@@ -150,9 +150,9 @@ mkdocstrings_handlers/python/.mypy_cache/CACHEDIR.TAG,sha256=8cE6_FVTWMkDOw8fMKq
150
150
  mkdocstrings_handlers/python/__init__.py,sha256=k-0NWvXysr5RqWjtGyCozookveBB-ADZHIhgxvI1px8,128
151
151
  mkdocstrings_handlers/python/config.py,sha256=dZTBl2BbEyVc_o8PW0rReWHDzdqYstOP7fnlWioRVk0,31459
152
152
  mkdocstrings_handlers/python/debug.py,sha256=4vqIbCbbz_vcjcFk6jPoF8E1kLig8AQEsQ93ybcjIVc,2894
153
- mkdocstrings_handlers/python/handler.py,sha256=ucz0l8mbt-Ez3RAnPOCx3_e5L8PvRsMRJ--ODTOpbZI,14577
153
+ mkdocstrings_handlers/python/handler.py,sha256=05cu68blsknnR_KCgiHVnyUeDQMcuP57zgiZSHZeReI,14601
154
154
  mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
155
- mkdocstrings_handlers/python/rendering.py,sha256=0j1LmGkwJg8zsnNYTnn_a62iqUJv0McIJMSrmh_ap_8,21628
155
+ mkdocstrings_handlers/python/rendering.py,sha256=rxK3GMaw_kyx8xA2b_LM9H54j746eAz6gbGf7RnGW-A,21946
156
156
  mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=nn0671f4bE7VqnTs-VQL3SGPACWAxb2uJBRcP2nwYng,427
157
157
  mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=sbbkQtl5bPm5mmmZ-VCyLtfsOuhSr-FrD2FUSlbK-Zs,4451
158
158
  mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=mOafkSlphFQJLWfrYrIMFVRGi2yjdtN6iJh8bPt7uRI,424
@@ -198,9 +198,9 @@ mkdocstrings_handlers/python/templates/material/_base/language.html.jinja,sha256
198
198
  mkdocstrings_handlers/python/templates/material/_base/languages/en.html,sha256=E8a7EBeQ1E7HVYzhilVbouqbNJkePhz7amCEJdbRxmQ,436
199
199
  mkdocstrings_handlers/python/templates/material/_base/languages/en.html.jinja,sha256=a14THpy6iJAcKYhIGPpXxke5-sjqQm_sWorpEjN_gHY,1135
200
200
  mkdocstrings_handlers/python/templates/material/_base/languages/ja.html,sha256=OscqH81KN7hkkijGazKv5IdoEuLCxVlgyC6eZj2n0ns,436
201
- mkdocstrings_handlers/python/templates/material/_base/languages/ja.html.jinja,sha256=VVhelj_4yh-2lKl4EivmJfP5MVkWRdv5Ya2Evva4X2Y,1153
201
+ mkdocstrings_handlers/python/templates/material/_base/languages/ja.html.jinja,sha256=ZNwheaB_njz7mP_X83qt3MyZBhPIvTBumuyIylDq_k4,1249
202
202
  mkdocstrings_handlers/python/templates/material/_base/languages/zh.html,sha256=qpCtwgIj9xjbsPDApJE3W34s-V7Syg_iFeN8zX5kZqY,436
203
- mkdocstrings_handlers/python/templates/material/_base/languages/zh.html.jinja,sha256=bQy9x31LAQbHL8fpUlP5wS4PsvhJlaa0BNlSQeoaJ4E,1071
203
+ mkdocstrings_handlers/python/templates/material/_base/languages/zh.html.jinja,sha256=Zr0o9OJv_NWZ2IHZrQYUpM7U-GCnRNr9y5FVQzIHLxY,1125
204
204
  mkdocstrings_handlers/python/templates/material/_base/module.html,sha256=cEq3DXlXfZ57NAK6CXA7OxtyeffgfUpWVvLW1O1aNzw,418
205
205
  mkdocstrings_handlers/python/templates/material/_base/module.html.jinja,sha256=-4xwDnFLnmP5pBRAVJiSTXYbnF79sfKRHpKd9TI1sHo,4169
206
206
  mkdocstrings_handlers/python/templates/material/_base/signature.html,sha256=7TcpvSL7n5pbg0Eokbx49vlLbY6YHM6S8o7aFpaxgXU,427
@@ -299,9 +299,9 @@ mkdocstrings_handlers/python/templates/readthedocs/_base/language.html.jinja,sha
299
299
  mkdocstrings_handlers/python/templates/readthedocs/_base/languages/en.html,sha256=E8a7EBeQ1E7HVYzhilVbouqbNJkePhz7amCEJdbRxmQ,436
300
300
  mkdocstrings_handlers/python/templates/readthedocs/_base/languages/en.html.jinja,sha256=UXTwUvL_GdJscqwAwI16YexazJy26KNOVTz7lWpWqj8,1010
301
301
  mkdocstrings_handlers/python/templates/readthedocs/_base/languages/ja.html,sha256=OscqH81KN7hkkijGazKv5IdoEuLCxVlgyC6eZj2n0ns,436
302
- mkdocstrings_handlers/python/templates/readthedocs/_base/languages/ja.html.jinja,sha256=kvDufODr51l6_mu529Rsb8EwR6k8j2WQykf2m4Hywvk,1028
302
+ mkdocstrings_handlers/python/templates/readthedocs/_base/languages/ja.html.jinja,sha256=iapL0ptac_zIy_hYbhRy6OS4W0noMc8ewQBosp3v2D8,1124
303
303
  mkdocstrings_handlers/python/templates/readthedocs/_base/languages/zh.html,sha256=qpCtwgIj9xjbsPDApJE3W34s-V7Syg_iFeN8zX5kZqY,436
304
- mkdocstrings_handlers/python/templates/readthedocs/_base/languages/zh.html.jinja,sha256=DDtqG4C_NUAGTge7pWgmteSG01s-42fwSYcH0reY9VA,946
304
+ mkdocstrings_handlers/python/templates/readthedocs/_base/languages/zh.html.jinja,sha256=f-6VNxu4K5e2YLJ_4C5n31wy8IiaucTyfi8b992f4Bk,1000
305
305
  mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html,sha256=4NEX89La70-yKKzhrPXkKJpX46cYxT1Dzf_LWTXPxbw,54
306
306
  mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html.jinja,sha256=4NEX89La70-yKKzhrPXkKJpX46cYxT1Dzf_LWTXPxbw,54
307
307
  mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html,sha256=xv3yw03Ta0ugKnsfcuuyf5xhGw0dHtaerMLvulQDXUA,60
@@ -327,8 +327,8 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha25
327
327
  mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
328
328
  mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
329
329
  mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
330
- mkdocstrings_python-1.14.4.dist-info/METADATA,sha256=6PHKMXHWmm30GibflICH_8ZHh1IZ-JJOo1zvZUvpDpE,5570
331
- mkdocstrings_python-1.14.4.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
332
- mkdocstrings_python-1.14.4.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
333
- mkdocstrings_python-1.14.4.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
334
- mkdocstrings_python-1.14.4.dist-info/RECORD,,
330
+ mkdocstrings_python-1.14.6.dist-info/METADATA,sha256=g2HXnCzLjLHuwqo76VSQIGJXNSBmTYVzJ-2XUhU7Vew,5570
331
+ mkdocstrings_python-1.14.6.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
332
+ mkdocstrings_python-1.14.6.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
333
+ mkdocstrings_python-1.14.6.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
334
+ mkdocstrings_python-1.14.6.dist-info/RECORD,,