https://github.com/mariusvniekerk/pytest-monkeytype

https://github.com/mariusvniekerk/pytest-monkeytype

pep484 pytest-plugin python3 typing

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mariusvniekerk/pytest-monkeytype
• Owner: mariusvniekerk
• License: mit
• Created: 2018-02-24T16:15:18.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-07-29T20:47:50.000Z (almost 5 years ago)
• Last Synced: 2024-12-28T10:12:21.674Z (4 months ago)
• Topics: pep484, pytest-plugin, python3, typing
• Language: Python
• Size: 28.3 KB
• Stars: 43
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-python-typing - pytest-monkeytype - MonkeyType plugin for pytest. (Tools / Helper tools to add annotations to existing code)

README

        
# pytest-monkeytype

[![Build Status](https://travis-ci.org/mariusvniekerk/pytest-monkeytype.svg?branch=master)](https://travis-ci.org/mariusvniekerk/pytest-monkeytype)

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![PyPI Python](https://img.shields.io/pypi/pyversions/pytest-monkeytype.svg)](https://pypi.python.org/pypi/pytest-monkeytype)

[![PyPI Version](https://img.shields.io/pypi/v/pytest-monkeytype.svg)](https://pypi.python.org/pypi/pytest-monkeytype)

[![PyPI Status](https://img.shields.io/pypi/status/pytest-monkeytype.svg)](https://pypi.python.org/pypi/pytest-monkeytype)

[![PyPI Wheel](https://img.shields.io/pypi/wheel/pytest-monkeytype.svg)](https://pypi.python.org/pypi/pytest-monkeytype)

[MonkeyType](https://github.com/Instagram/MonkeyType) as a

[pytest](https://docs.pytest.org/en/latest/) plugin.

```

pip install pytest-monkeytype

# Generate annotations by running your pytest tests as usual:

py.test --monkeytype-output=./monkeytype.sqlite3

# Get a listing of modules annotated by monkeytype

monkeytype list-modules

# Generate a stub file for those annotations using monkeytype:

monkeytype stub some.module

# Apply these annotations directly

monkeytype apply some.module

```

This project is inspired by [pytest-annotate](https://github.com/kensho-technologies/pytest-annotate)