mkdocstrings-python 1.6.2__py3-none-any.whl → 1.6.3__py3-none-any.whl

mkdocstrings_handlers/python/handler.py

@@ -108,7 +108,6 @@ class PythonHandler(BaseHandler):
         "filters": ["!^_[^_]"],
         "annotations_path": "brief",
         "preload_modules": None,
-        "load_external_modules": False,
         "allow_inspection": True,
     }
     """
@@ -189,6 +188,7 @@ class PythonHandler(BaseHandler):
         config_file_path: str | None = None,
         paths: list[str] | None = None,
         locale: str = "en",
+        load_external_modules: bool = False,
         **kwargs: Any,
     ) -> None:
         """Initialize the handler.
@@ -198,10 +198,12 @@ class PythonHandler(BaseHandler):
             config_file_path: The MkDocs configuration file path.
             paths: A list of paths to use as Griffe search paths.
             locale: The locale to use when rendering content.
+            load_external_modules: Load external modules when resolving aliases.
             **kwargs: Same thing, but with keyword arguments.
         """
         super().__init__(*args, **kwargs)
         self._config_file_path = config_file_path
+        self._load_external_modules = load_external_modules
         paths = paths or []
         glob_base_dir = os.path.dirname(os.path.abspath(config_file_path)) if config_file_path else "."
         with chdir(glob_base_dir):
@@ -282,7 +284,7 @@ class PythonHandler(BaseHandler):
                 raise CollectionError(str(error)) from error
             unresolved, iterations = loader.resolve_aliases(
                 implicit=False,
-                external=final_config["load_external_modules"],
+                external=self._load_external_modules,
             )
             if unresolved:
                 logger.debug(f"{len(unresolved)} aliases were still unresolved after {iterations} iterations")
@@ -372,11 +374,13 @@ class PythonHandler(BaseHandler):
 
 
 def get_handler(
+    *,
     theme: str,
     custom_templates: str | None = None,
     config_file_path: str | None = None,
     paths: list[str] | None = None,
     locale: str = "en",
+    load_external_modules: bool = False,
     **config: Any,  # noqa: ARG001
 ) -> PythonHandler:
     """Simply return an instance of `PythonHandler`.
@@ -387,6 +391,7 @@ def get_handler(
         config_file_path: The MkDocs configuration file path.
         paths: A list of paths to use as Griffe search paths.
         locale: The locale to use when rendering content.
+        load_external_modules: Load external modules when resolving aliases.
         **config: Configuration passed to the handler.
 
     Returns:
@@ -399,4 +404,5 @@ def get_handler(
         config_file_path=config_file_path,
         paths=paths,
         locale=locale,
+        load_external_modules=load_external_modules,
     )

mkdocstrings_handlers/python/rendering.py

@@ -351,14 +351,17 @@ def do_filter_objects(
 @lru_cache(maxsize=1)
 def _get_black_formatter() -> Callable[[str, int], str]:
     try:
-        from black import Mode, format_str
+        from black import InvalidInput, Mode, format_str
     except ModuleNotFoundError:
         logger.info("Formatting signatures requires Black to be installed.")
         return lambda text, _: text
 
     def formatter(code: str, line_length: int) -> str:
         mode = Mode(line_length=line_length)
-        return format_str(code, mode=mode)
+        try:
+            return format_str(code, mode=mode)
+        except InvalidInput:
+            return code
 
     return formatter
 

mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html

@@ -40,7 +40,7 @@
   <ul>
     {% for attribute in section.value %}
       <li class="field-body">
-        <b>{{ attribute.name }}</b>
+        <b><code>{{ attribute.name }}</code></b>
         {% if attribute.annotation %}
           {% with expression = attribute.annotation %}
             (<code>{% include "expression.html" with context %}</code>)

mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html

@@ -32,7 +32,7 @@
   <ul>
     {% for class in section.value %}
       <li class="field-body">
-        <b>{{ class.name }}</b>
+        <b><code>{{ class.name }}</code></b>
         –
         <div class="doc-md-description">
           {{ class.description|convert_markdown(heading_level, html_id) }}

mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html

@@ -35,7 +35,7 @@
     {% for function in section.value %}
       {% if not function.name == "__init__" or not config.merge_init_into_class %}
         <li class="field-body">
-          <b>{{ function.name }}</b>
+          <b><code>{{ function.name }}</code></b>
           –
           <div class="doc-md-description">
             {{ function.description|convert_markdown(heading_level, html_id) }}

mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html

@@ -32,7 +32,7 @@
   <ul>
     {% for module in section.value %}
       <li class="field-body">
-        <b>{{ module.name }}</b>
+        <b><code>{{ module.name }}</code></b>
         –
         <div class="doc-md-description">
           {{ module.description|convert_markdown(heading_level, html_id) }}

mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html

@@ -40,7 +40,7 @@
   <ul>
     {% for parameter in section.value %}
       <li class="field-body">
-        <b>{{ parameter.name }}</b>
+        <b><code>{{ parameter.name }}</code></b>
         {% if parameter.annotation %}
           {% with expression = parameter.annotation %}
             (<code>{% include "expression.html" with context %}</code>)

mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html

@@ -50,7 +50,7 @@
   <ul>
     {% for parameter in section.value %}
       <li class="field-body">
-        <b>{{ parameter.name }}</b>
+        <b><code>{{ parameter.name }}</code></b>
         {% if parameter.annotation %}
           {% with expression = parameter.annotation %}
             (<code>{% include "expression.html" with context %}</code>

mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html

@@ -41,7 +41,7 @@
   <ul>
     {% for receives in section.value %}
       <li class="field-body">
-        {% if receives.name %}<b>{{ receives.name }}</b>{% endif %}
+        {% if receives.name %}<b><code>{{ receives.name }}</code></b>{% endif %}
         {% if receives.annotation %}
           {% with expression = receives.annotation %}
             {% if receives.name %} ({% endif %}

mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html

@@ -41,7 +41,7 @@
   <ul>
     {% for returns in section.value %}
       <li class="field-body">
-        {% if returns.name %}<b>{{ returns.name }}</b>{% endif %}
+        {% if returns.name %}<b><code>{{ returns.name }}</code></b>{% endif %}
         {% if returns.annotation %}
           {% with expression = returns.annotation %}
             {% if returns.name %} ({% endif %}

mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html

@@ -41,7 +41,7 @@
   <ul>
     {% for yields in section.value %}
       <li class="field-body">
-        {% if yields.name %}<b>{{ yields.name }}</b>{% endif %}
+        {% if yields.name %}<b><code>{{ yields.name }}</code></b>{% endif %}
         {% if yields.annotation %}
           {% with expression = yields.annotation %}
             {% if yields.name %} ({% endif %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html

@@ -14,7 +14,7 @@
         <ul class="first simple">
           {% for attribute in section.value %}
             <li>
-              <b>{{ attribute.name }}</b>
+              <b><code>{{ attribute.name }}</code></b>
               {% if attribute.annotation %}
                 {% with expression = attribute.annotation %}
                   (<code>{% include "expression.html" with context %}</code>)

mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html

@@ -14,7 +14,7 @@
         <ul class="first simple">
           {% for parameter in section.value %}
             <li>
-              <b>{{ parameter.name }}</b>
+              <b><code>{{ parameter.name }}</code></b>
               {% if parameter.annotation %}
                 {% with expression = parameter.annotation %}
                   (<code>{% include "expression.html" with context %}</code>)

mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html

@@ -14,7 +14,7 @@
         <ul class="first simple">
           {% for parameter in section.value %}
             <li>
-              <b>{{ parameter.name }}</b>
+              <b><code>{{ parameter.name }}</code></b>
               {% if parameter.annotation %}
                 {% with expression = parameter.annotation %}
                   (<code>{% include "expression.html" with context %}</code>

mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html

@@ -14,7 +14,7 @@
         <ul class="first simple">
           {% for receives in section.value %}
             <li>
-              {% if receives.name %}<b>{{ receives.name }}</b>{% endif %}
+              {% if receives.name %}<b><code>{{ receives.name }}</code></b>{% endif %}
               {% if receives.annotation %}
                 {% with expression = receives.annotation %}
                   {% if receives.name %}({% endif %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html

@@ -14,7 +14,7 @@
       <ul class="first simple">
         {% for returns in section.value %}
           <li>
-            {% if returns.name %}<b>{{ returns.name }}</b>{% endif %}
+            {% if returns.name %}<b><code>{{ returns.name }}</code></b>{% endif %}
             {% if returns.annotation %}
               {% with expression = returns.annotation %}
                 {% if returns.name %}({% endif %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html

@@ -14,7 +14,7 @@
         <ul class="first simple">
           {% for yields in section.value %}
             <li>
-              {% if yields.name %}<b>{{ yields.name }}</b>{% endif %}
+              {% if yields.name %}<b></code>{{ yields.name }}</code></b>{% endif %}
               {% if yields.annotation %}
                 {% with expression = yields.annotation %}
                   {% if yields.name %}({% endif %}

{mkdocstrings_python-1.6.2.dist-info → mkdocstrings_python-1.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.6.2
+Version: 1.6.3
 Summary: A Python handler for mkdocstrings.
 Author-Email: Timothée Mazzucotelli <pawamoy@pm.me>
 License: ISC

{mkdocstrings_python-1.6.2.dist-info → mkdocstrings_python-1.6.3.dist-info}/RECORD

@@ -1,24 +1,24 @@
 mkdocstrings_handlers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/__init__.py,sha256=CJT3hmg9HpEMy5dbq2jL3Y8unO6UOHND7yCLojwQrS8,326
-mkdocstrings_handlers/python/handler.py,sha256=jPvs61494rIBvpKWNVzJx5EM_AwCed1zTFdDqvpyEIw,19866
-mkdocstrings_handlers/python/rendering.py,sha256=JrV5NSwegXdMVZaFyLql3400EpKdQlylFv6NYwfvccs,11467
+mkdocstrings_handlers/python/handler.py,sha256=DBYtXwFGSDUkfllF4j07LsBzha-w1fmflXs7bIKMcLA,20180
+mkdocstrings_handlers/python/rendering.py,sha256=pBpsM_zxGGlp-xmCNZRcOOkQppyQFPev5b1exmtJSW0,11551
 mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=1nLfAEyZiD3DF9R7nyEb69cIM5oFp1MA-Zl7SJwuVts,2539
 mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=8z5dQ2HOywV7CQ3KYYgdBX8N-CGbnYZ8Sm7ugN89IIo,5709
 mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=OQATi6Zz0Vg34ONWwh6mimGdeHd2s0VqxulyrLMMzq8,4479
 mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=Sw8TwJy4aTZA2phqqg61QVAZDfLYJAzgE_lQmDcdUsU,2163
 mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=wiD2FtMnGrFMZJDilURnNqzIu8bOR0zcMErUVUqbDPo,274
-mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html,sha256=bP30_K01q1Gv01MQtNZj64xDsWtbx5pe0rbgrU3v0EY,2827
-mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html,sha256=g40XWtu_oamj8P8MZH60CkjgQ4H1d_9-GLecgrSQ7dg,1882
+mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html,sha256=hpGB3CKuD44C4utJxKfA4V-uqQCVnV4fVRkjwGMrcdU,2840
+mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html,sha256=gMGsXcfNAF5k760HZcs5Y9_5klqC4USUfzOjulsyb0A,1895
 mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html,sha256=1VqrMMFMr45RPkBjK0X7VL9PHGl-kDg2IJL2xODSg0o,460
-mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html,sha256=mA0cpZ10HRRSJxzXljT83fEkDbt3vlVTETj7y41PF4Y,2396
-mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html,sha256=0pxH2aobXTPdwXuQSbczXXD87Zlw1cLpS873b2Rip5o,1893
-mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html,sha256=RlhZVV70GGvQdqiqgjK0PiX0zWovH5pR34mpqEAgK0M,2853
-mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html,sha256=GgHlAbkxUexlzs7ZNxot2OK_kLnUpnqau2Bn5Pf4gwg,3810
+mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html,sha256=4uqe8A6yWv8RPk_0tpYJApb-JfniEC0ZwTeSDFe-aPo,2409
+mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html,sha256=u098YP1CJ0aeLFbOZh76BDW-iFVUsMrNJ9yR5GooH_A,1906
+mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html,sha256=sB6CnpjXe6vRWyzjAf-Z0f7pZKlMsBttEBuQfxx8q4c,2866
+mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html,sha256=34Xkxn5K2FXw2U72Irwudi27vK_DnzOVQoBNpi_W6cU,3823
 mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html,sha256=wQKL0aGo8iSjaUJdUT_BWFjjqc9SDC-Qe4yByfHWIa0,2478
-mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html,sha256=dxxt5FYMzIbgNoDT48YUnpBO5WzRO47_fKlDDm2E6uU,3490
-mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html,sha256=6EBMBm4T4Yt2HATBQIGXAd4NKQwSGLJJz988tm7LpWI,3466
+mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html,sha256=OVVXLKy-hSOto720TKGmmVPh-gcLNwR-w34LvDm1Brs,3503
+mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html,sha256=GACKAuJKUjAu3mUts_GJnQ31VZt04wxznMQNdHbDeAI,3479
 mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html,sha256=FROLXo9Xd97TlpokL0YZC1kZ08QRL5bIm8_QnFtrBNQ,2453
-mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html,sha256=XpgWIrC_dU7X-GPL6X7hIldaZiiW2PD-wrZ6V295F48,3431
+mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html,sha256=3aBn3F8wO6ptxWQzMHyykrX8r4_rn2ezfhE7IZUO1Uw,3444
 mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=lfvgET2b8dxvqYZJqiGjS-ooO_nNXqV42zsL8yL05_s,1845
 mkdocstrings_handlers/python/templates/material/_base/function.html,sha256=7f_RhIvsWa9KNDrg5Dgj8XX0_ltAv629EybAX-yQ2p0,2787
 mkdocstrings_handlers/python/templates/material/_base/labels.html,sha256=QMO1lrs1smktTGvkDZabvJZFQpMp_nSoM8JBt-tAcu8,250
@@ -54,20 +54,20 @@ mkdocstrings_handlers/python/templates/material/languages/zh.html,sha256=1yUDcpU
 mkdocstrings_handlers/python/templates/material/module.html,sha256=GKdbkIxQoObcjxZP6PRLpLOYXMVFS4gSN-nxolEeDjw,34
 mkdocstrings_handlers/python/templates/material/signature.html,sha256=u9zdNsM5Lqh0ROOcThzsjHeHPJCMixy3XfzjypwyGLM,37
 mkdocstrings_handlers/python/templates/material/style.css,sha256=_lHEDcsuVAuEGhLjrMSpdH5-lxZTeVOe-K-ZDmYlVOk,999
-mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html,sha256=c5-gLJIUf2HHLhaMD6c1jmCuMhbqxIPOOw2Htno8B8k,988
-mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html,sha256=2_7dEL9xxyjSNN2riNQPIwwruY2lOLLUCxEvQ4ZX3wg,994
-mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html,sha256=FtG6R64dB3F21Ui8uOtxCJYM2Imsll4IgSRvcCNK49Q,1266
+mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html,sha256=Bx3UUWdjKQIZi_LOr6Cry5-77E0mbme_gboJTLUPI6g,1001
+mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html,sha256=gyNlRfgj4Gp06kVxf1iXXHzUQQrbBQpGtWVjUz99038,1007
+mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html,sha256=Xz3USHwc-KoxN9Wig43gMs4icxJp933NyHYEYlISYW4,1279
 mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html,sha256=0G60QbAAhq7Pkv8qK7rXFigHQlSlfsswao3T9BLzofU,928
-mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html,sha256=0O93TnlEG30_iYfi6A4nB_K5nS1lGaCqSw4_O01PAsc,1118
-mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html,sha256=ssC5RR8K2tIc-B-fcGzVpfqePHeZJ25bmLLj6pndlSM,1067
+mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html,sha256=Nr4nppTugLm66MQ7K4xdcuk1ivsDtre3tuDAJsw6QP8,1131
+mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html,sha256=96E9kb1PAuaPXMWj-_OsUoZtsV8uxIIeVO_6EAn9eK8,1080
 mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html,sha256=r5nv78e78OdN5j9DAX-WCeUr6FAPEurt7IKHjwq1zOo,923
-mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html,sha256=BAp8pYytRWu2GVCibjMDtuEN8Rv02lDd2e4-NV7ruBY,1100
+mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html,sha256=Qx7Nj2D9ElQ28fxtBXqmUkjLggZp7zMgniSlJ2guBG4,1114
 mkdocstrings_handlers/python/templates/readthedocs/language.html,sha256=ntV-16zf2S3h9EmKCVsD9Ny9yM5cFKXh5_h47LuA07U,431
 mkdocstrings_handlers/python/templates/readthedocs/languages/en.html,sha256=bhfjbEhYdKeUCq4O3-XwX19jvTAF8u0vr_VU62ahN4g,356
 mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html,sha256=ULdcRwrN9rF8shxFVwEZ1jqSICebVKMi8cYHpNZypd8,372
 mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=ZYm9N33cRC4Z66-ZqmteWDfRNfo8hKe25Bz4ijVk22A,359
 mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
-mkdocstrings_python-1.6.2.dist-info/METADATA,sha256=YfmINB_E2q6u8d072asiwDmaIwEOp3CAjrVFb0IbVeA,5748
-mkdocstrings_python-1.6.2.dist-info/WHEEL,sha256=1D4d-_ODszlK6-qFybc5BLF-ZhZvee-uKVh2hLa3IIc,90
-mkdocstrings_python-1.6.2.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-1.6.2.dist-info/RECORD,,
+mkdocstrings_python-1.6.3.dist-info/METADATA,sha256=z0xXCzKJz7OiEMLn7m7S7wD_p90XMZrn6OUoOoZdXjQ,5748
+mkdocstrings_python-1.6.3.dist-info/WHEEL,sha256=1D4d-_ODszlK6-qFybc5BLF-ZhZvee-uKVh2hLa3IIc,90
+mkdocstrings_python-1.6.3.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-1.6.3.dist-info/RECORD,,