Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanhwanglim/module-level-lint
A Flake8 plugin to enforce code quality by checking module level docstrings, future-imports, and module level dunders as specified in PEP 8
https://github.com/hanhwanglim/module-level-lint
flake8 linter python python3
Last synced: about 2 months ago
JSON representation
A Flake8 plugin to enforce code quality by checking module level docstrings, future-imports, and module level dunders as specified in PEP 8
- Host: GitHub
- URL: https://github.com/hanhwanglim/module-level-lint
- Owner: hanhwanglim
- License: mit
- Created: 2023-10-23T09:32:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-16T11:41:45.000Z (12 months ago)
- Last Synced: 2024-10-29T01:11:25.859Z (2 months ago)
- Topics: flake8, linter, python, python3
- Language: Python
- Homepage:
- Size: 51.8 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Module Level Lint
A Flake8 plugin to enforce code quality by checking module level docstrings, future-imports, and module level dunders as specified in [PEP 8](https://peps.python.org/pep-0008/#module-level-dunder-names)
## Installation
You can install this plugin via pip:
```bash
pip install module-level-lint
```
## Usage
After installation, you can use this plugin with the `flake8` command. Here's how to run it:
```bash
flake8 [path]
```
To show only module level lint errors, run:
```bash
flake8 --select MLL [path]
```
To show only specific errors
```bash
flake8 --select MLL001,MLL002 [path]
```
To apply formatting
```bash
flake8 --select MLL [path] --fix
```
## Features
### Lint
#### Module Docstring Check: Ensure that your docstrings are always at the top of the file
- Linting Error: **MLL001**
Example:
```python
import random
# Bad: Module docstring is not at the top of the file
"""This is a docstring"""
def foo():
pass
```
```python
# Good: Docstring present at the top of the file
""" This is a docstring. """
def foo():
pass
```
#### Future-Imports Check: Ensure that future-imports are always at the top after module docstrings
- Linting Error: **MLL002**
Example:
```python
import random
# Bad: Future-imports is not at the top of the file
from __future__ import print_function
```
```python
# Good: Future-imports is at the top of the file
from __future__ import division
import random
```
- Linting Error: **MLL003**
Example:
```python
from __future__ import print_function
# Bad: Docstring is not at the top of the file
"""This is a docstring."""
```
```python
"""This is a docstring."""
# Good: Future-imports is at the top of the file after docstring
from __future__ import division
```
#### Module-Level Dunders: Ensure that module level dunders are always at the top after future-imports or docstrings
- Linting Error: **MLL004**
Example:
```python
import random
# Bad: Module level dunder after imports
__all__ = ["foo"]
def foo():
pass
```
```python
# Bad: Module level dunder before docstring
__all__ = ["foo"]
"""This is a docstring"""
def foo():
pass
```
```python
def foo():
pass
# Bad: Module level dunder after code
__all__ = ["foo"]
```
```python
# Good: Module level dunder at the top of the file
__all__ = ["foo"]
def foo():
pass
```
### Format
With the `--fix` flag, this plugin will try to format the files that have no rule violations. It will fix the newlines in the following format:
```python
"""Docstring goes here""" # An empty line after docstrings
from __future__ import annotations # An empty line after future imports
__all__ = ["foo"] # An empty line after module dunders
import random # Rest of the code
def foo():
return random.randint(1, 10)
```
## Configuration
This plugin doesn't require any specific configuration, but you can include its error codes in your Flake8 configuration file to disable or enable specific checks:
```ini
[flake8]
extend-ignore = MLL001, MLL002, MLL003, MLL004
```
## Contributing
Contributions, issues, and feature requests are welcome! Please feel free to submit a pull request or open an issue.
## License
This plugin is licensed under the MIT License.