mkdocstrings-python 1.6.1__tar.gz → 1.6.3__tar.gz

{mkdocstrings_python-1.6.1 → mkdocstrings_python-1.6.3}/PKG-INFO

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

{mkdocstrings_python-1.6.1 → mkdocstrings_python-1.6.3}/pyproject.toml

@@ -35,7 +35,7 @@ dependencies = [
     "mkdocstrings>=0.20",
     "griffe>=0.35",
 ]
-version = "1.6.1"
+version = "1.6.3"
 
 [project.license]
 text = "ISC"

{mkdocstrings_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/mkdocstrings_handlers/python/rendering.py

@@ -88,13 +88,17 @@ def do_format_signature(
     function: Function,
     line_length: int,
     *,
+    annotations: bool | None = None,  # noqa: ARG001
     crossrefs: bool = False,  # noqa: ARG001
 ) -> str:
     """Format a signature using Black.
 
     Parameters:
+        context: Jinja context, passed automatically.
         callable_path: The path of the callable we render the signature of.
+        function: The function we render the signature of.
         line_length: The line length to give to Black.
+        annotations: Whether to show type annotations.
         crossrefs: Whether to cross-reference types in the signature.
 
     Returns:
@@ -126,6 +130,7 @@ def do_format_attribute(
     """Format an attribute using Black.
 
     Parameters:
+        context: Jinja context, passed automatically.
         attribute_path: The path of the callable we render the signature of.
         attribute: The attribute we render the signature of.
         line_length: The line length to give to Black.
@@ -346,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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html

@@ -8,9 +8,13 @@
       {%- set annotation = full -%}
     {%- endif -%}
     {%- for title, path in annotation|split_path(full) -%}
-      {%- filter stash_crossref(length=title|length) -%}
-        <span data-autorefs-optional{% if title != path %}-hover{% endif %}="{{ path }}">{{ title }}</span>
-      {%- endfilter -%}
+      {%- if not signature or config.signature_crossrefs -%}
+        {%- filter stash_crossref(length=title|length) -%}
+          <span data-autorefs-optional{% if title != path %}-hover{% endif %}="{{ path }}">{{ title }}</span>
+        {%- endfilter -%}
+      {%- else -%}
+        {{ title }}
+      {%- endif -%}
       {%- if not loop.last -%}.{%- endif -%}
     {%- endfor -%}
   {%- endwith -%}

{mkdocstrings_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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_python-1.6.1 → mkdocstrings_python-1.6.3}/src/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 %}