https://github.com/periareon/rules_mypy
Bazel rules for the Mypy, the Python static typing tool
https://github.com/periareon/rules_mypy
bazel bazel-rules linting mypy python python3 starlark static-typing
Last synced: 6 months ago
JSON representation
Bazel rules for the Mypy, the Python static typing tool
- Host: GitHub
- URL: https://github.com/periareon/rules_mypy
- Owner: periareon
- Created: 2024-09-28T17:20:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-13T22:15:19.000Z (11 months ago)
- Last Synced: 2024-12-12T09:06:44.097Z (10 months ago)
- Topics: bazel, bazel-rules, linting, mypy, python, python3, starlark, static-typing
- Language: Starlark
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rules_mypy
## Overview
Rules for the Python static type checker [mypy][mp]
### Setup
To setup the rules for `mypy`, define a [py_mypy_toolchain](#py_mypy_toolchain) within your
project and register it within your workspace. For example say you have the following `BUILD.bazel`
file in the root of your workspace:
```python
load("@rules_mypy//python/mypy:defs.bzl", "py_mypy_toolchain")
py_mypy_toolchain(
name = "py_mypy_toolchain",
mypy = "@pip_deps//:mypy",
)
toolchain(
name = "toolchain",
toolchain = ":py_mypy_toolchain",
toolchain_type = "@rules_mypy//python/mypy:toolchain_type",
visibility = ["//visibility:public"],
)
```
You would then add the following to your `WORKSPACE.bazel` file.
```python
register_toolchains("//tools/mypy:toolchain")
```
In addition to this formatter, a check can be added to your build phase using the [py_mypy_aspect](#py_mypy_aspect)
aspect. Simply add the following to a `.bazelrc` file to enable this check.
```text
build --aspects=@rules_mypy//python/mypy:defs.bzl%py_mypy_aspect
build --output_groups=+py_mypy_checks
```
These rules use a global flag to determine the location of the configuration file to use with mypy. To wire up a custom
config file, simply add the following to your `.bazelrc` file
```text
build --@rules_mypy//python/mypy:config=//:mypy.ini
```
Note the flag above assumes you have a `mpyp.ini` in the root of your repository.
It's recommended to only enable this aspect in your CI environment so formatting issues do not
impact user's ability to rapidly iterate on changes.
[mp]: https://mypy.readthedocs.io/
## Rules
- [current_py_mypy_toolchain](#current_py_mypy_toolchain)
- [py_mypy_aspect](#py_mypy_aspect)
- [py_mypy_test](#py_mypy_aspect)
- [py_mypy_toolchain](#py_mypy_toolchain)
---
---
## py_mypy_test
py_mypy_test(name, config, target)
A rule for running mypy on a Python target.
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| name | A unique name for this target. | Name | required | |
| config | The config file (`mypy.ini`) containing mypy settings. | Label | optional | `"@rules_mypy//python/mypy:config"` |
| target | The target to run `mypy` on. | Label | required | |
## py_mypy_toolchain
py_mypy_toolchain(name, mypy)
A toolchain for the [mypy](https://mypy.readthedocs.io/) formatter rules.
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| name | A unique name for this target. | Name | required | |
| mypy | The mypy `py_library` to use with the rules. | Label | required | |
## py_mypy_aspect
py_mypy_aspect(name)
An aspect for running mypy on targets with Python sources.
**ASPECT ATTRIBUTES**
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| name | A unique name for this target. | Name | required | |