API Coverage Report

{% macro render_coverage_indicator(coverage) -%}

{{ coverage.hits }}/{{ coverage.total }}

{%- endmacro %} {% macro render_type_hint(type_obj) -%} {{ type_obj.name }} {%- if type_obj.args -%} {#- Render arguments of a parametrized type -#} [{% for arg in type_obj.args %}{% if not loop.first %}, {% endif %}{{ render_type_hint_list(arg) }}{% endfor %}] {%- endif -%} {%- endmacro %} {%- macro render_type_hint_list(type_list) -%} {%- for type_obj in type_list -%} {%- if not loop.first -%} | {%- endif -%}{{ render_type_hint(type_obj) }} {%- endfor -%} {%- endmacro -%} {% macro render_signature(signature) -%} ( {%- for param_name in signature.params -%} {%- if not loop.first -%} , {% endif %} {#- This comment removes space before span -#} {{ param_name }} {%- if signature.params[param_name] -%} : {{ render_type_hint_list(signature.params[param_name]) }} {%- endif -%} {%- endfor -%} ) {% if signature.ret %} -> {{ render_type_hint_list(signature.ret) }} {% endif %} {%- endmacro %} {% macro render_call_signature(signature) -%} ( {%- if signature.parameters -%} {%- for arg in signature.parameters -%} {%- if not loop.first -%} , {% endif %} {#- This comment removes space before span -#} {{ arg }} {%- endfor -%} {%- elif signature.args -%} {{ signature.args }} {%- endif -%} ) {% if signature.return_type %} -> {{ signature.return_type }} {% endif %} {% if signature.result %}

{{ signature.result }}

{% endif %} {%- endmacro %}

{% if files %}

{% for file in files %}

                    {{ file.name }}
                
{{ "%.1f"|format(file.coverage.ratio * 100) }}%
Coverage
{{ file.coverage.hits }}/{{ file.coverage.total }}

                {% for item in file.members recursive %}
                ▼
                                {% if item.kind == 'class' %}class{% else %}def{% endif %}
                                {{ item.name }}
                                {% if item.kind == 'function' %}
                                    {% if item.signature %}
                                        {{ render_signature(item.signature) }}
                                    {% else %}
                                        (...)
                                    {% endif %}
                                {% endif %}
                            

                            {% if item.lineno %}
                                L{{ item.lineno }}
                            {% endif %}
                            {% if item.coverage %}
                                {{ render_coverage_indicator(item.coverage) }}
                            {% endif %}
                        

                        {% if item.kind == 'class' %}
                            {% if item.members %}
                                {{ loop(item.members) }}
                            {% else %}
                                This class has no members.

                            {% endif %}
                        {% else %}
                            {% if item.call_details %}
                                {% for title, class, calls in [
                                    ("⚡️ Matched runtime calls", "matched", item.call_details.matched),
                                    ("⚠️ Unmatched return value", "unmatched_ret", item.call_details.unmatched_ret),
                                    ("💥 Exceptions", "unmatched_ret", item.call_details.exceptions),
                                    ("❗️ Signature mismatch", "unmatched_sig", item.call_details.unmatched_calls),
                                ] %}
                                {% if calls %}
                                    {{ title }} ({{ calls | length }})

                                        {% for call in calls %}
                                            
                                                {{ render_call_signature(call) }}
                                            

                                        {% endfor %}
                                    

                                {% endif %}
                                {% endfor %}
                            {% else %}
                                No calls were traced for this function.

                            {% endif %}
                        {% endif %}
                    

                {% endfor %}
            

{% endfor %} {% else %}

No coverage data available

Run your tests with tracing enabled to generate coverage data.

{% endif %}