Skip to main content

Python stub file generator.

Project description

pygenstub is a utility for generating stub files from docstrings in source files.

If the docstring of a function includes a sig field, the value of that field will be used to generate a stub by matching the types to the parameters in the same order.

For example, for the function given below:

def foo(a, b):
    """Do foo.

    :sig: (int, str) -> None

pygenstub will generate the following stub:

def foo(a: int, b: str) -> None: ...

pygenstub consists of a single source file which contains such signatures. You can check the stub file generated by running pygenstub on itself as an example.

Getting started

pygenstub runs on Python 3.6 and later versions. You can install the latest version from PyPI:

pip install pygenstub

Installation creates a script named pygenstub which can be used as follows:


This command will generate the file foo.pyi in the same directory as the input file. If the output file already exists, it will be overwritten.

If you download the source file, you can also run it directly without installing:


If pygenstub is activated as a Sphinx extension (after sphinx.ext.autodoc), it will insert type comments into the docstring:

extensions = [

As an example of the output, you can check the API documentation for pygenstub itself.

Getting help

The documentation is available on:

The source code can be obtained from:


Copyright (C) 2016-2021 H. Turgut Uyar <>

pygenstub is released under the GPL license, version 3 or later. Read the included LICENSE.txt for details.

Project details

Download files

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

Files for pygenstub, version 2.0.1
Filename, size File type Python version Upload date Hashes
Filename, size pygenstub-2.0.1.tar.gz (24.8 kB) File type Source Python version None Upload date Hashes View
Filename, size pygenstub-2.0.1-py3-none-any.whl (24.4 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page