Skip to main content

MonkeyType

MonkeyType collects runtime types of function arguments and return values, and can automatically generate stub files or even add draft type annotations directly to your Python code based on the types collected at runtime.

Example

Say some/module.py originally contains:

def add(a, b):
    return a + b

And myscript.py contains:

from some.module import add

add(1, 2)

Now we want to infer the type annotation of add in some/module.py by running myscript.py with MonkeyType. One way is to run:

$ monkeytype run myscript.py

By default this will dump call traces into a sqlite database in the file monkeytype.sqlite3 in the current working directory. You can then use the monkeytype command to generate a stub file for a module, or apply the type annotations directly to your code.

Running monkeytype stub some.module will output a stub:

def add(a: int, b: int) -> int: ...

Running monkeytype apply some.module will modify some/module.py to:

def add(a: int, b: int) -> int:
    return a + b

This example demonstrates both the value and the limitations of MonkeyType. With MonkeyType, it’s very easy to add annotations that reflect the concrete types you use at runtime, but those annotations may not always match the full intended capability of the functions. For instance, add is capable of handling many more types than just integers. Similarly, MonkeyType may generate a concrete List annotation where an abstract Sequence or Iterable would be more appropriate. MonkeyType’s annotations are an informative first draft, to be checked and corrected by a developer.

Motivation

Readability and static analysis are the primary motivations for adding type annotations to code. It’s already common in many Python style guides to document the argument and return types for a function in its docstring; annotations are a standardized way to provide this documentation, which also permits static analysis by a typechecker such as mypy.

For more on the motivation and design of Python type annotations, see PEP 483 and PEP 484.

Requirements

MonkeyType requires Python 3.6+ and the retype library (for applying type stubs to code files). It generates only Python 3 type annotations (no type comments).

Installing

Install MonkeyType with pip:

pip install MonkeyType

How MonkeyType works

MonkeyType uses the sys.setprofile hook provided by Python to interpose on function calls, function returns, and generator yields, and record the types of arguments / return values / yield values.

It generates stub files based on that data, and can use retype to apply those stub files directly to your code.

See the full documentation for details.

Troubleshooting

Check if your issue is mentioned in the frequently asked questions list.

LICENSE

MonkeyType is BSD licensed.

Changelog

19.1.1

  • Pass --incremental to retype when applying stubs, so it doesn’t choke on partial stubs (which can result from e.g. failures to decode some traces).

19.1.0

  • Add --omit-existing-annotations option, implied by apply. Merge of #129. Fixes #11 and #81.

  • Render ... for all parameter defaults in stubs. Remove the --include-unparsable-defaults and --exclude-unparsable-defaults CLI options, as well as the include_unparsable_defaults() config method. Merge of #128, fixes #123.

  • Render forward references (from existing annotations) correctly. Merge of #127.

  • Rewrite Generator[…, None, None] to Iterator[None] by default. Merge of #110, fixes #4. Thanks iyanuashiri.

18.8.0

  • Support Python 3.7. Merge of #107, fixes #78.

  • Print useful error message when filename is passed to stub/apply. Merge of #88, fixes #65. Thanks rajathagasthya.

  • Fix crash in list_modules when there are no traces. Merge of #106, fixes #90. Thanks tyrinwu.

  • Enable python -m monkeytype {run,stub,apply} .... Merge of #100, fixes #99. Thanks retornam.

18.5.1

  • Add MONKEYTYPE_TRACE_MODULES env var for easier tracing of code in site-packages. Merge of #83, fixes #82. Thanks Bo Peng.

  • Fix passing additional arguments to scripts run via monkeytype run. Merge of #85. Thanks Danny Qiu.

  • Fix handling of spaces in filenames passed to retype. Merge of #79, fixes #77.

  • Never render NoneType in stubs, substitute None. Merge of #75, fixes #5. Thanks John Arnold.

18.2.0

  • Move filtering of __main__ module into CallTraceStoreLogger instead of core tracing code, so it can be overridden by special use cases like IPython tracing. Merge of #72, fixes #68. Thanks Tony Fast.

  • Generate stubs for modules where the module file is like module/__init__.py. Print retype stdout/stderr. Merge of #69, Fixes #66. Thanks John Arnold.

18.1.13

  • Improve error messages in case of “no traces found” and/or file path given instead of module name. Merge of #37, partial fix for #65. Thanks Aarni Koskela.

  • Add monkeytype list_modules sub-command to list all modules present in trace db. Merge of #61, fixes #60. Thanks Alex Miasoiedov.

  • Add --diff option to monkeytype stub. Merge of #59, fixes #58. Thanks Tai-Lin!

  • Add --ignore-existing-annotations option to monkeytype stub. Merge of #55, fixes #15. Thanks Tai-Lin!

18.1.11

  • Fix crash in RewriteEmptyContainers rewriter if a parameter has only empty container types in traces (and more than one). Fixes #53.

18.1.10

  • Display retype errors when stub application fails. Merge of #52, fixes #49.

  • Add --sample-count option to show the number of traces a given stub is based on. Merge of #50, fixes #7. Thanks Tai-Lin.

  • Add monkeytype run -m for running a module as a script. Merge of #41. Thanks Simon Gomizelj.

  • Add support for Django’s cached_property decorator. Merge of #46, fixes #9. Thanks Christopher J Wang.

  • Catch and log serialization exceptions instead of crashing. Fixes #38, merge of #39.

  • Fix bug in default code filter when Python lib paths are symlinked. Merge of #40. Thanks Simon Gomizelj.

17.12.3

  • Rewrite imports from _io module to io. (#1, merge of #32). Thanks Radhans Jadhao.

  • Add Config.cli_context() as a hook for custom CLI initialization and cleanup logic (#28; merge of #29). Thanks Rodney Folz.

17.12.2

  • Exclude “frozen importlib” functions in default code filter.

  • Fix passing args to script run with monkeytype run (#18; merge of #21). Thanks Rodney Folz.

  • Fix generated annotations for NewType types (#22; merge of #23). Thanks Rodney Folz.

17.12.1

  • Fix using MonkeyType outside a virtualenv (#16). Thanks Guido van Rossum for the report.

17.12.0

  • Initial public version.

Metadata

Release files for MonkeyType 19.1.1

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

Source distribution (sdist)

Source distribution for MonkeyType 19.1.1
File Size Uploaded Provenance Actions
MonkeyType-19.1.1.tar.gz 27.7 kB Without provenance Details for MonkeyType-19.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for MonkeyType 19.1.1
File Interpreter ABI Platform Actions
MonkeyType-19.1.1-py3-none-any.whl Python 3 none any Details for MonkeyType-19.1.1-py3-none-any.whl

Total release size: 62.5 kB

Release files / MonkeyType-19.1.1.tar.gz

Download URL MonkeyType-19.1.1.tar.gz
Size 27.7 kB
Tags Source
SHA-256 checksum
How to use checksums
ecee4162a153c8a0d2151dfc66f06ebb82e4582b0d46281798d908888bb0c9b9
BLAKE2b-256 checksum
How to use checksums
b7bc35cb145db63319f99fc8a8de7f6b5af02e0d03630ac837b2a84e4ecfa2ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.4

Release files / MonkeyType-19.1.1-py3-none-any.whl

Download URL MonkeyType-19.1.1-py3-none-any.whl
Size 34.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
baeeee422c17202038ccf17ca73eb97eddb65a4178a215c1ff212cfb7373eb65
BLAKE2b-256 checksum
How to use checksums
c3b4c1c5accd5e84fd71bbac67c74dc85c9df120ffda4770707488b4b0223fa3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.4

Security for MonkeyType 19.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page