Type hints (PEP 484) support for the Sphinx autodoc extension

Navigation

Verified details

These details have been verified by PyPI
Project links
Owner
organization icon tox
GitHub Statistics
Maintainers
Avatar for agronholm from gravatar.com agronholm

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License
  • Author: Bernát Gábor
  • Maintainer: Bernát Gábor
  • Tags environments, isolated, testing, virtual
  • Requires: Python >=3.10
  • Provides-Extra: docs, numpy, testing
Classifiers

Project description

sphinx-autodoc-typehints

PyPI Supported Python versions Downloads check

This extension allows you to use Python 3 annotations for documenting acceptable argument types and return value types of functions. See an example of the Sphinx render at the pyproject-api docs.

This allows you to use type hints in a very natural fashion, allowing you to migrate from this:

def format_unit(value, unit):
    """
    Formats the given value as a human readable string using the given units.

    :param float|int value: a numeric value
    :param str unit: the unit for the value (kg, m, etc.)
    :rtype: str
    """
    return f"{value} {unit}"

to this:

from typing import Union


def format_unit(value: Union[float, int], unit: str) -> str:
    """
    Formats the given value as a human readable string using the given units.

    :param value: a numeric value
    :param unit: the unit for the value (kg, m, etc.)
    """
    return f"{value} {unit}"

Installation and setup

First, use pip to download and install the extension:

pip install sphinx-autodoc-typehints

Then, add the extension to your conf.py:

extensions = ["sphinx.ext.autodoc", "sphinx_autodoc_typehints"]

Options

The following configuration options are accepted:

  • typehints_fully_qualified (default: False): if True, class names are always fully qualified (e.g. module.for.Class). If False, just the class name displays (e.g. Class)

  • always_document_param_types (default: False): If False, do not add type info for undocumented parameters. If True, add stub documentation for undocumented parameters to be able to add type info.

  • always_use_bars_union (default: False): If True, display Union's using the | operator described in PEP 604. (e.g X | Y or int | None). If False, Unions will display with the typing in brackets. (e.g. Union[X, Y] or Optional[int])

  • typehints_document_rtype (default: True): If False, never add an :rtype: directive. If True, add the :rtype: directive if no existing :rtype: is found.

  • typehints_use_rtype (default: True): Controls behavior when typehints_document_rtype is set to True. If True, document return type in the :rtype: directive. If False, document return type as part of the :return: directive, if present, otherwise fall back to using :rtype:. Use in conjunction with napoleon_use_rtype to avoid generation of duplicate or redundant return type information.

  • typehints_defaults (default: None): If None, defaults are not added. Otherwise, adds a default annotation:

    • 'comma' adds it after the type, changing Sphinx’ default look to “param (int, default: 1) -- text”.
    • 'braces' adds (default: ...) after the type (useful for numpydoc like styles).
    • 'braces-after' adds (default: ...) at the end of the parameter documentation text instead.

  • simplify_optional_unions (default: True): If True, optional parameters of type "Union[...]" are simplified as being of type Union[..., None] in the resulting documentation (e.g. Optional[Union[A, B]] -> Union[A, B, None]). If False, the "Optional"-type is kept. Note: If False, any Union containing None will be displayed as Optional! Note: If an optional parameter has only a single type (e.g Optional[A] or Union[A, None]), it will always be displayed as Optional!

  • typehints_formatter (default: None): If set to a function, this function will be called with annotation as first argument and sphinx.config.Config argument second. The function is expected to return a string with reStructuredText code or None to fall back to the default formatter.

  • typehints_use_signature (default: False): If True, typehints for parameters in the signature are shown.

  • typehints_use_signature_return (default: False): If True, return annotations in the signature are shown.

How it works

The extension listens to the autodoc-process-signature and autodoc-process-docstring Sphinx events. In the former, it strips the annotations from the function signature. In the latter, it injects the appropriate :type argname: and :rtype: directives into the docstring.

Only arguments that have an existing :param: directive in the docstring get their respective :type: directives added. The :rtype: directive is added if and only if no existing :rtype: is found.

Compatibility with sphinx.ext.napoleon

To use sphinx.ext.napoleon with sphinx-autodoc-typehints, make sure you load sphinx.ext.napoleon first, before sphinx-autodoc-typehints. See Issue 15 on the issue tracker for more information.

Dealing with circular imports

Sometimes functions or classes from two different modules need to reference each other in their type annotations. This creates a circular import problem. The solution to this is the following:

  1. Import only the module, not the classes/functions from it
  2. Use forward references in the type annotations (e.g. def methodname(self, param1: 'othermodule.OtherClass'):)

On Python 3.7, you can even use from __future__ import annotations and remove the quotes.

Project details

Verified details

These details have been verified by PyPI
Project links
Owner
organization icon tox
GitHub Statistics
Maintainers
Avatar for agronholm from gravatar.com agronholm

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License
  • Author: Bernát Gábor
  • Maintainer: Bernát Gábor
  • Tags environments, isolated, testing, virtual
  • Requires: Python >=3.10
  • Provides-Extra: docs, numpy, testing
Classifiers

Release history Release notifications | RSS feed

This version

2.5.0

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.0

2.2.3

2.2.2

2.2.1

2.2.0

2.1.1

2.1.0

2.0.1

2.0.0

1.25.3

1.25.2

1.25.1

1.25.0

1.24.1

1.24.0

1.23.4 yanked

Reason this release was yanked:

invalid version

1.23.3

1.23.2

1.23.1

1.23.0

1.22

1.21.8

1.21.7

1.21.6

1.21.5

1.21.4

1.21.3

1.21.2

1.21.1

1.21.0

1.20.2

1.20.1

1.20.0

1.19.5

1.19.4

1.19.3

1.19.2

1.19.1

1.19.0

1.18.3

1.18.2

1.18.1

1.18.0

1.17.1

1.17.0

1.16.0

1.15.3

1.15.2

1.15.1

1.15.0

1.14.1

1.14.0

1.13.1

1.13.0

1.12.0

1.11.1

1.11.0

1.10.3

1.10.2

1.10.1

1.10.0

1.9.0

1.8.0

1.7.0

1.6.0

1.5.2

1.5.1

1.5.0

1.4.0

1.3.0

1.2.5

1.2.4

1.2.3

1.2.1

1.2.0

1.1.0

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_autodoc_typehints-2.5.0.tar.gz (40.8 kB view details)

Uploaded Source

Built Distribution

sphinx_autodoc_typehints-2.5.0-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_autodoc_typehints-2.5.0.tar.gz.

File metadata

File hashes

Hashes for sphinx_autodoc_typehints-2.5.0.tar.gz
Algorithm Hash digest
SHA256 259e1026b218d563d72743f417fcc25906a9614897fe37f91bd8d7d58f748c3b
MD5 e11698413b4269989f708b643fc6991a
BLAKE2b-256 2ea04f17d564c86aa269749d99dd498a5c94abe0915d2ff349187f8ff8c75994

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_typehints-2.5.0.tar.gz:

Publisher: release.yaml on tox-dev/sphinx-autodoc-typehints

Attestations:

File details

Details for the file sphinx_autodoc_typehints-2.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autodoc_typehints-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53def4753239683835b19bfa8b68c021388bd48a096efcb02cdab508ece27363
MD5 e7c093b4f0a31fc8a8ee81d8b104ec4a
BLAKE2b-256 faae322d05bec884977b89eced3af811c228652a9e25f9646ee6236890987214

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_typehints-2.5.0-py3-none-any.whl:

Publisher: release.yaml on tox-dev/sphinx-autodoc-typehints

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page