{{ package.name }} :: {% if module.qualname %}{{ module.qualname }}{% else %}{{ display_module_name }}{% endif %}
← Back to Overview

{% if module.name == "__init__" %}Package{% else %}Module{% endif %} {{ display_module_name }}

{% if module.docstring %}
{{ module.docstring | safe }}
{% endif %} {% if module.classes %}

Classes

{% for class in module.classes %}
class {{ class.name }}{% if class.bases %}({{ class.bases | join(sep=", ") }}){% endif %}: {% if source_url %}source{% else %}{{ module.source_path }}:{{ class.line }}{% endif %}
{% if class.docstring %}
{{ class.docstring | safe }}
{% endif %} {% if class.functions %}

Methods

{% for func in class.functions %}
{% if func.is_async %}async {% endif %}def {{ func.name }}({{ func.args | join(sep=", ") }}){% if func.return_type %} -> {{ func.return_type }}{% endif %}: {% for badge in func.badges %}{{ badge }}{% endfor %}{% if source_url %}source{% else %}line {{ func.line }}{% endif %}
{% if func.docstring %}
{{ func.docstring | safe }}
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}
{% endif %} {% if module.functions %}

Functions

{% for func in module.functions %}
{% if func.is_async %}async {% endif %}def {{ func.name }}({{ func.args | join(sep=", ") }}){% if func.return_type %} -> {{ func.return_type }}{% endif %}: {% for badge in func.badges %}{{ badge }}{% endfor %}{% if source_url %}source{% else %}{{ module.source_path }}:{{ func.line }}{% endif %}
{% if func.docstring %}
{{ func.docstring | safe }}
{% endif %}
{% endfor %}
{% endif %}