pre-commit hooks #
pre-commit is a framework for building and running git hooks. See the official documentation for more information: pre-commit.com
This document provides a list of available pre-commit hooks provided by Poetry.
args:for a hook in your
.pre-commit-config.yaml, the defaults are overwritten. You must fully specify all arguments for your hook if you make use of
poetry-check hook calls the
poetry check command
to make sure the poetry configuration does not get committed in a broken state.
The hook takes the same arguments as the poetry command. For more information see the check command.
pyproject.tomlfile is not in the root directory, you can specify
args: ["-C", "./subdirectory"].
poetry-lock hook calls the
poetry lock command
to make sure the lock file is up-to-date when committing changes.
The hook takes the same arguments as the poetry command. For more information see the lock command.
poetry-export hook calls the
poetry export command
to sync your
requirements.txt file with your current dependencies.
poetry-lockhook prior to this one.
The hook takes the same arguments as the poetry command. For more information see the export command.
The default arguments are
args: ["-f", "requirements.txt", "-o", "requirements.txt"],
which will create/update the requirements.txt file in the current working directory.
You may add
verbose: true in your
.pre-commit-config.yaml in order to output to the
hooks: - id: poetry-export args: ["-f", "requirements.txt"] verbose: true
--dev can be added to
args to write dev-dependencies to
hooks: - id: poetry-export args: ["--dev", "-f", "requirements.txt", "-o", "requirements.txt"]
For more information on how to use pre-commit please see the official documentation.
repos: - repo: https://github.com/python-poetry/poetry rev: '' # add version here hooks: - id: poetry-check - id: poetry-lock - id: poetry-export args: ["-f", "requirements.txt", "-o", "requirements.txt"]
pre-commit autoupdate not update to the latest version? #
pre-commit autoupdate updates the
rev for each repository defined in your
to the latest available tag in the default branch.
Poetry follows a branching strategy, where the default branch is the active development branch and fixes gets back ported to stable branches. New tags are assigned in these stable branches.
pre-commit does not support such a branching strategy and has decided to not implement
an option, either on the user side
or hook author side, to define a branch for lookup the latest
pre-commit autoupdate is not usable for the hooks described here.
You can avoid changing the
rev to an unexpected value, by using the
--repo parameter (may be specified multiple
times), to explicit list repositories that should be updated. An option to explicit exclude
repositories will not be implemented into