Inspired by this blog post. I described the building process of this tool here.
“For those who like dinosaurs 🦖 and clean try/except ✨ blocks.”
Summary
- Installation and usage
- Violations
- Pre-commit
- Show your style
- Extra Resources
- Contributing
- Change log
- License
- Credits
pip install tryceratops
OR
poetry add -D tryceratops
tryceratops [filename or dir...]
You can enable experimental analyzers by running:
tryceratops --experimental [filename or dir...]
You can ignore specific violations by using: --ignore TRYXXX repeatedly:
tryceratops --ignore TRY201 --ignore TRY202 [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 TRY src/tests/samples/violations/call_raise_vanilla.py
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY002 Create your own exception
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY003 Avoid specifying long messages outside the exception class
src/tests/samples/violations/call_raise_vanilla.py:21:9: TRY201 Simply use 'raise' without specifying exception object again
All violations and its descriptions can be found in docs.
So far, autofix only supports violations: TRY200, TRY201, and TRY400.
If you want to ignore a violation in a specific file, you can either:
- Add a comment with
noqato the top of the file you want to ignore - Add a comment with
noqato the line you want to ignore - Add a comment with
noqa: CODEto the line you want to ignore a specific violation
Example:
def verbose_reraise_1():
try:
a = 1
except Exception as ex:
raise ex # noqa: TRY202You 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 = ["TRY002", "TRY200", "TRY300"]
experimental = false
check_pickable = false
allowed_base_exceptions = ["MyAppBase"]CLI flags always overwrite the config file.
If you wish to use pre-commit, add this:
- repo: https://github.com/guilatrova/tryceratops
rev: v2.4.1
hooks:
- id: tryceratopsAdd this fancy badge to your project's README.md:
[](https://github.com/guilatrova/tryceratops)If you want to read more about:
Thank you for considering making Tryceratops better for everyone!
Refer to Contributing docs.
See CHANGELOG.
MIT
Thanks to God for the inspiration 🙌 ☁️ ☀️
The black project for insights.
