sphinx-autodoc-typehints

This extension allows you to use Python 3 annotations for documenting acceptable argument types and return value types of functions. 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 '{} {}'.format(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 '{} {}'.format(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:

set_type_checking_flag (default: False): if True, set typing.TYPE_CHECKING to True to enable “expensive” typing imports
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.
typehints_document_rtype (default: True): If False, never add an :rtype: directive. If True, add the :rtype: directive if no existing :rtype: is found.

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:

Import only the module, not the classes/functions from it
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.

Using type hint comments

If you’re documenting code that needs to stay compatible with Python 2.7, you cannot use regular type annotations. Instead, you must either be using Python 3.8 or later or have typed_ast installed. The package extras type_comments will pull in the appropiate dependencies automatically. Then you can add type hint comments in the following manner:

def myfunction(arg1, arg2):
    # type: (int, str) -> int
    return 42

or alternatively:

def myfunction(
    arg1,  # type: int
    arg2  # type: str
):
    # type: (...) -> int
    return 42

Metadata

Release files for sphinx-autodoc-typehints 1.11.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-autodoc-typehints 1.11.0
File	Size	Uploaded
sphinx-autodoc-typehints-1.11.0.tar.gz	16.7 kB	Jun 21, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-autodoc-typehints 1.11.0
File	Interpreter	ABI	Platform	Reset
sphinx_autodoc_typehints-1.11.0-py3-none-any.whl 8.5 kB Jun 21, 2020	Python 3	none	any	Details

Total release size: 25.2 kB

Release files / sphinx-autodoc-typehints-1.11.0.tar.gz

Download URL	sphinx-autodoc-typehints-1.11.0.tar.gz
Size	16.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`bbf0b203f1019b0f9843ee8eef0cff856dc04b341f6dbe1113e37f2ebf243e11`
BLAKE2b-256 checksum How to use checksums	`a4c93ac759ba6baf9da138fb4a661fe92526a001bd5371d6d6e8675472076a36`
Upload date	Jun 21, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.7`

Release files / sphinx_autodoc_typehints-1.11.0-py3-none-any.whl

Download URL	sphinx_autodoc_typehints-1.11.0-py3-none-any.whl
Size	8.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`89e19370a55db4aef1be2094d8fb1fb500ca455c55b3fcc8d2600ff805227e04`
BLAKE2b-256 checksum How to use checksums	`82247b0a565c99df8b2b7da14b553d601e446f7fe57bc2d8cd42851c4da9c1ae`
Upload date	Jun 21, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.7`