TDengine/test/templates/python/material/function.html.jinja

{#- Template for Python functions.

  This template renders a Python function or method.
  
  Context:
    function (griffe.Function): The function to render.
    root (bool): Whether this is the root object, injected with `:::` in a Markdown page.
    heading_level (int): The HTML heading level to use.
    config (dict): The configuration options.
  -#}
  
  {% block logs scoped %}
    {#- Logging block.
  
    This block can be used to log debug messages, deprecation messages, warnings, etc.
    -#}
    {{ log.debug("Rendering " + function.path) }}
  {% endblock logs %}
  
  {% import "language"|get_template as lang with context %}
  {#- Language module providing the `t` translation method. -#}
  
  <div class="doc doc-object doc-function">
    {% with obj = function, html_id = function.path %}
  
      {% if root %}
        {% set show_full_path = config.show_root_full_path %}
        {% set root_members = True %}
      {% elif root_members %}
        {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
        {% set root_members = False %}
      {% else %}
        {% set show_full_path = config.show_object_full_path %}
      {% endif %}
  
      {% set function_name = function.path if show_full_path else function.name %}
      {#- Brief or full function name depending on configuration. -#}
      {% set symbol_type = "method" if function.parent.is_class else "function" %}
      {#- Symbol type: method when parent is a class, function otherwise. -#}
  
      {% if "cases/" in function.relative_filepath|string %}
        {# Only generate docstring for methods starting with "test_" or "Test" in the "cases" directory #}
        {% if function.name.startswith("test_") or function.name.startswith("Test") %}
          {% set should_render = true %}
        {% else %}
          {% set should_render = false %}
        {% endif %}
      {% else %}
        {# For other directories, generate docstring for all methods #}
        {% set should_render = true %}
      {% endif %}
  
      {% if should_render %}
        {% if not root or config.show_root_heading %}
          {% filter heading(
              heading_level,
              role="function",
              id=html_id,
              class="doc doc-heading",
              toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code>&nbsp;')|safe if config.show_symbol_type_toc else '') + 
                        (
                          function.docstring.value.split("\n", 1)[0] if "cases/" in function.relative_filepath|string and function.docstring.value else
                          function.name
                        ),
            ) %}
  
            {% block heading scoped %}
              {#- Heading block.
  
              This block renders the heading for the function.
              -#}
              {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-{{ symbol_type }}"></code>{% endif %}
              {% if config.separate_signature %}
                <span class="doc doc-object-name doc-function-name">{{ config.heading if config.heading and root else function_name }}</span>
              {% else %}
                {%+ filter highlight(language="python", inline=True) %}
                  {{ function_name }}{% include "signature"|get_template with context %}
                {% endfilter %}
              {% endif %}
            {% endblock heading %}
  
            {% block labels scoped %}
              {#- Labels block.
  
              This block renders the labels for the function.
              -#}
              {% with labels = function.labels %}
                {% include "labels"|get_template with context %}
              {% endwith %}
            {% endblock labels %}
  
          {% endfilter %}
    
          {% block signature scoped %}
            {#- Signature block.
    
            This block renders the signature for the function,
            as well as its overloaded signatures if any.
            -#}
            {% if function.overloads %}
              <div class="doc-overloads">
                {% for overload in function.overloads %}
                  {% filter format_signature(overload, config.line_length, annotations=True, crossrefs=config.signature_crossrefs) %}
                    {{ overload.name }}
                  {% endfilter %}
                {% endfor %}
              </div>
            {% endif %}
            {% if config.separate_signature %}
              {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
                {{ function.name }}
              {% endfilter %}
            {% endif %}
          {% endblock signature %}
    
        {% else %}
    
          {% if config.show_root_toc_entry %}
            {% filter heading(
                heading_level,
                role="function",
                id=html_id,
                toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code>&nbsp;')|safe if config.show_symbol_type_toc else '') + 
                          (
                            function.docstring.value.split("\n", 1)[0] if "cases/" in function.relative_filepath|string and function.docstring.value else
                            function.name 
                          ),
                hidden=True,
              ) %}
            {% endfilter %}
          {% endif %}
          {% set heading_level = heading_level - 1 %}
        {% endif %}

        <div class="doc doc-contents {% if root %}first{% endif %}">
          {% block contents scoped %}
            {# 渲染 docstring #}
            {% block docstring scoped %}
              {% with docstring_sections = function.docstring.parsed %}
                {% include "docstring"|get_template with context %}
              {% endwith %}
            {% endblock docstring %}
          {% endblock contents %}
        </div>
      {% endif %}
    {% endwith %}
  </div>