platypush/platypush
platypush
/
platypush
2
2
Fork 4
Code Issues 41 Pull Requests Packages Projects 4 Releases Wiki Activity

A better logic to process relative references in docstrings.

This commit is contained in:
Fabio Manganiello 2023-10-10 01:35:37 +02:00
parent 5726c6985f
commit 434855ffdd
Signed by: blacklight
GPG Key ID: D90FBA7F76362774
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
platypush/common/reflection/_parser/rst.py
View File

@ -3,6 +3,8 @@ import logging
import re import re
import textwrap as tw import textwrap as tw
from platypush.utils import get_defining_class
from .._model.constants import doc_base_url from .._model.constants import doc_base_url
from .context import ParseContext from .context import ParseContext
@ -130,9 +132,13 @@ class RstExtensionsMixin:
cls, docstr: str, ex_name: str, match: re.Match, ctx: ParseContext cls, docstr: str, ex_name: str, match: re.Match, ctx: ParseContext
) -> str: ) -> str:
value = match.group("name") value = match.group("name")
modname = obj_name = url_path = None
if value.startswith("."): if value.startswith("."):
modname = ctx.obj.__module__ # noqa base_cls = get_defining_class(ctx.obj)
obj_name = ctx.obj.__qualname__ if base_cls:
modname = base_cls.__module__
obj_name = f'{base_cls.__qualname__}.{value[1:]}'
elif ex_name == "method": elif ex_name == "method":
modname = ".".join(value.split(".")[:-2]) modname = ".".join(value.split(".")[:-2])
obj_name = ".".join(value.split(".")[-2:]) obj_name = ".".join(value.split(".")[-2:])
@ -140,16 +146,15 @@ class RstExtensionsMixin:
modname = ".".join(value.split(".")[:-1]) modname = ".".join(value.split(".")[:-1])
obj_name = value.split(".")[-1] obj_name = value.split(".")[-1]
url_path = None if modname and obj_name:
if modname.startswith("platypush.plugins"):
if modname.startswith("platypush.plugins"): url_path = "plugins/" + ".".join(modname.split(".")[2:])
url_path = "plugins/" + ".".join(modname.split(".")[2:]) elif modname.startswith("platypush.backend"):
elif modname.startswith("platypush.backend"): url_path = "backends/" + ".".join(modname.split(".")[2:])
url_path = "backends/" + ".".join(modname.split(".")[2:]) elif modname.startswith("platypush.message.event"):
elif modname.startswith("platypush.message.event"): url_path = "events/" + ".".join(modname.split(".")[3:])
url_path = "events/" + ".".join(modname.split(".")[3:]) elif modname.startswith("platypush.message.response"):
elif modname.startswith("platypush.message.response"): url_path = "responses/" + ".".join(modname.split(".")[3:])
url_path = "responses/" + ".".join(modname.split(".")[3:])
if url_path: if url_path:
docstr = docstr.replace( docstr = docstr.replace(