A linter to manage your exception like a PRO!
Project description
Manage your exceptions in Python like a PRO
Inspired by this blog post.
I shared the building process of this tool here.
“For those who like dinosaurs 🦖 and clean try/except ✨ blocks.”
- Installation and usage
- Violations
- Pre-commit
- Show your style
- Extra Resources
- Contributing
- Change log
- License
- Credits
Installation and usage
Installation
pip install tryceratops
Usage
tryceratops [filename or dir...]
You can enable experimental analyzers by running:
tryceratops --experimental [filename or dir...]
You can ignore specific violations by using: --ignore TCXXX
repeatedly:
tryceratops --ignore TC201 --ignore TC202 [filename or dir...]
You can exclude dirs by using: --exclude dir/path
repeatedly:
tryceratops --exclude tests --exclude .venv [filename or dir...]
You can also autofix some violations:
tryceratops --autofix [filename or dir...]
flake8
Plugin
🦖 Tryceratops is also a plugin for flake8
, so you can:
❯ flake8 --select TC src/tests/samples/violations/call_raise_vanilla.py
src/tests/samples/violations/call_raise_vanilla.py:13:9: TC002 Create your own exception
src/tests/samples/violations/call_raise_vanilla.py:13:9: TC003 Avoid specifying long messages outside the exception class
src/tests/samples/violations/call_raise_vanilla.py:21:9: TC201 Simply use 'raise' without specifying exception object again
Violations
All violations and its descriptions can be found in docs.
Autofix support
So far, autofix only supports violations: TC200, TC201, and TC400.
Ignoring violations
If you want to ignore a violation in a specific file, you can either:
- Add a comment with
noqa
to the top of the file you want to ignore - Add a comment with
noqa
to the line you want to ignore - Add a comment with
noqa: CODE
to the line you want to ignore a specific violation
Example:
def verbose_reraise_1():
try:
a = 1
except Exception as ex:
raise ex # noqa: TC202
Configuration
You can set up a pyproject.toml
file to set rules.
This is useful to avoid reusing the same CLI flags over and over again and helps to define the structure of your project.
Example:
[tool.tryceratops]
exclude = ["samples"]
ignore = ["TC002", "TC200", "TC300"]
experimental = true
CLI flags always overwrite the config file.
Pre-commit
If you wish to use pre-commit, add this:
- repo: https://github.com/guilatrova/tryceratops
rev: v0.6.1
hooks:
- id: tryceratops
Show your style
Add this fancy badge to your project's README.md
:
[![try/except style: tryceratops](https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black)](https://github.com/guilatrova/tryceratops)
Extra Resources
If you want to read more about:
Contributing
Thank you for considering making Tryceratops better for everyone!
Refer to Contributing docs.
Change log
See CHANGELOG.
License
MIT
Credits
Thanks to God for the inspiration 🙌 ☁️ ☀️
Logo icon was made by https://www.freepik.com
The black project for insights.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tryceratops-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d140d7c1c3240e5dea59dc321c08283d0feac5af717b20b439cd5ad63272ed93 |
|
MD5 | e0f55ef0dd11345a2f7003c93f3260b3 |
|
BLAKE2b-256 | 85f9f1ff323611183d4a63262544c8b986a30207e4f281bb037a3077dbd6e98c |