Pyupgrade wrapper to supply configuration via pyproject.toml
Project description
pyproject pyupgrade
pyproject.toml configuration wrapper for pyupgrade
Installation
Via pip
pip install pyproject-pyupgrade
Via poetry
poetry add --group dev pyproject-pyupgrade
Via pipx
pipx install -f pyproject-pyupgrade
Usage
Make sure you have a desired version of pyupgrade
installed in your python environment.
Add the following section in your pyproject.toml
:
[tool.pyupgrade]
# for example, if you're using python 3.10
py310-plus = true
And then just execute it via CLI
pyproject-pyupgrade [filename [filenames...]]
or shorter version
ppyupgrade [filename [filenames...]]
So, basically you specify flags that you want to add to pyupgrade
CLI arguments specifying them without leading two dashes (--
).
This is the way how you can supply any option that your version of pyupgrade
receives
There is also one additional parameter provided exclusively by pyproject-pyupgrade
wrapper:
[tool.pyupgrade]
pyproject-pyupgrade-debug = true
Or directly via CLI
ppyupgrade --pyproject-pyupgrade-debug ...
This option is going to output debug information about pyproject-pyupgrade
.
Info about parsed configuration from pyproject.toml (if there is one) and all the flags
As a pre-commit hook
See pre-commit for instructions.
Sample .pre-commit-config.yaml
:
repos:
- repo: https://github.com/venomlab/pyproject-pyupgrade
rev: v0.1.0
hooks:
- id: ppyupgrade
ToDo
- Add tests and
tox
config to run them for all supported python versions - Add option to specify custom
pyupgrade
command. It allows in case if you want to chain pyupgrade wrappers (for instance, with pyupgrade-directories) - Add better parser for TOML. Right now the parser is ultra primitive and might lead to errors if used improperly
- If
python
version >=3.11
use tomllib forpyproject.toml
parsing - Support adding custom options or key-value arguments to
pyupgrade
CLI - Support storing configuration in
pyupgrade.ini
- Support storing configuration in
tox.ini
- Support storing configuration in
setup.cfg
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 pyproject_pyupgrade-0.1.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 876e0bd1fb0d6243573dc8a08c1a62fc6089ac9f42eea04ac71a5bab712fe00a |
|
MD5 | a529839452675c74aceaecde42581fff |
|
BLAKE2b-256 | c99c4c8bd22f69f767e9e112ffad631b5707b78a7786de959a58c411b9889b38 |
Hashes for pyproject_pyupgrade-0.1.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c81a26192ba8c5a91f13e66b9a7de92bfb83bd058a3b33f46746050ee336da9d |
|
MD5 | c0a3a207d525fef7b3c94c77df3558f2 |
|
BLAKE2b-256 | ebc9df93055337ac87d97cf84c442439f80d7c7753f108ee7c1f69d6109a1b1d |