https://github.com/orsinium-labs/typeforce

Make mypy more effective
https://github.com/orsinium-labs/typeforce

cli code-quality mypy mypy-stubs python python-types python3 qa typing

Last synced: 3 months ago
JSON representation

Make mypy more effective

• Host: GitHub
• URL: https://github.com/orsinium-labs/typeforce
• Owner: orsinium-labs
• License: mit
• Created: 2021-04-15T12:26:03.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-09-30T09:37:05.000Z (about 2 years ago)
• Last Synced: 2024-07-05T13:31:24.449Z (4 months ago)
• Topics: cli, code-quality, mypy, mypy-stubs, python, python-types, python3, qa, typing
• Language: Python
• Homepage:
• Size: 12.7 KB
• Stars: 19
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-python-typing - typeforce - CLI tool that enriches your Python environment with type annotations, empowering mypy. (Tools / Working with types)

README

        
# typeforce

**Typeforce** is a CLI tool that enriches your Python environment with type annotations, empowering [mypy](https://mypy.readthedocs.io/en/stable/).

In particular:

+ Generates `py.typed` for annotated packages.

+ Installs missed stub files and plugins.

## py.typed

[PEP-561](https://www.python.org/dev/peps/pep-0561/) says the following:

> Package maintainers who wish to support type checking of their code MUST add a marker file named py.typed to their package supporting typing.

In practice, many maintainers don't know about this marker. So there are tons of packages that do have type annotations but don't have `py.typed`.

Typeforce checks all installed third-party packages and adds `py.typed` into packages that have type annotations.

## stubs and plugins

One of the breaking changes [mypy 0.900 introduced](http://mypy-lang.blogspot.com/2021/06/mypy-0900-released.html?m=1) is moving out all [stubs](https://mypy.readthedocs.io/en/stable/stubs.html) and plugins for third-party packages out of mypy itself. Now, stub files for every such package should be installed manually.

Typeforce scans all installed third-party packages and installs all needed stub files and plugins if available.

## Installation

```bash

python3 -m pip install --user typeforce

```

## Usage

```bash

python3 -m typeforce --exe python3.9

```