Skip to content

[WIP] Automatically (re)format code using "black" library #4604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Kami wants to merge 5 commits into from
Closed

[WIP] Automatically (re)format code using "black" library #4604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
71d85f7
Add new tox target for reformatting all the code using black library.
Kami Mar 19, 2019
bcda5df
Squashed 'lint-configs/' changes from e43b03a98..e0a12db78
Kami Mar 19, 2019
cc95c3b
Merge commit 'bcda5df0f7d2e38289bd7f7518e35feb4b9cb66c' into black_au…
Kami Mar 19, 2019
a3df5f9
Squashed 'lint-configs/' changes from e0a12db78..41e64995b
Kami Mar 19, 2019
6897ede
Merge commit 'a3df5f9a4d1fc3f78f9d325529225499afb94a53' into black_au…
Kami Mar 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions lint-configs/python/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[tool.black]
line-length = 100
skip_string_normalization = true
target_version = ['py27', 'py36', 'py37', 'py38']
include = '\.pyi?$'
exclude = '''
/(
\.eggs
| \.git
| \.hg
| \.mypy_cache
| \.tox
| \.venv
| _build
| buck-out
| build
| dist
| virtualenv
| virtualenv-py3
| virtualenv-st2client
| test_content_version
)/

25 changes: 25 additions & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,31 @@ deps = -r{toxinidir}/requirements.txt
-e{toxinidir}/st2reactor

# Python 3 tasks
[testenv:py36-black]
Copy link
Member Author

@Kami Kami Mar 19, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE: I needed to add a special tox target because black only works under Python 3.

basepython = python3.6
setenv = PYTHONPATH = {toxinidir}/external:{toxinidir}/st2common:{toxinidir}/st2api:{toxinidir}/st2actions:{toxinidir}/st2exporter:{toxinidir}/st2reactor:{toxinidir}/st2tests:{toxinidir}/contrib/runners/action_chain_runner:{toxinidir}/contrib/runners/local_runner:{toxinidir}/contrib/runners/python_runner:{toxinidir}/contrib/runners/http_runner:{toxinidir}/contrib/runners/noop_runner:{toxinidir}/contrib/runners/announcement_runner:{toxinidir}/contrib/runners/remote_runner:{toxinidir}/contrib/runners/remote_runner:{toxinidir}/contrib/runners/mistral_v2:{toxinidir}/contrib/runners/orquesta_runner:{toxinidir}/contrib/runners/inquirer_runner:{toxinidir}/contrib/runners/http_runner:{toxinidir}/contrib/runners/winrm_runner
VIRTUALENV_DIR = {envdir}
passenv = NOSE_WITH_TIMER TRAVIS
install_command = pip install -U --force-reinstall {opts} {packages}
deps = virtualenv
-r{toxinidir}/requirements.txt
-e{toxinidir}/st2client
-e{toxinidir}/st2common
black
commands =
black --config lint-configs/python/pyproject.toml st2api/
black --config lint-configs/python/pyproject.toml st2auth/
black --config lint-configs/python/pyproject.toml st2client/
black --config lint-configs/python/pyproject.toml st2common/
black --config lint-configs/python/pyproject.toml st2debug/
black --config lint-configs/python/pyproject.toml st2exporter/
black --config lint-configs/python/pyproject.toml st2reactor/
black --config lint-configs/python/pyproject.toml st2stream/
black --config lint-configs/python/pyproject.toml st2tests/
black --config lint-configs/python/pyproject.toml contrib/
black --config lint-configs/python/pyproject.toml tools/
black --config lint-configs/python/pyproject.toml scripts

[testenv:py36-unit]
basepython = python3.6
setenv = PYTHONPATH = {toxinidir}/external:{toxinidir}/st2common:{toxinidir}/st2api:{toxinidir}/st2actions:{toxinidir}/st2exporter:{toxinidir}/st2reactor:{toxinidir}/st2tests:{toxinidir}/contrib/runners/action_chain_runner:{toxinidir}/contrib/runners/local_runner:{toxinidir}/contrib/runners/python_runner:{toxinidir}/contrib/runners/http_runner:{toxinidir}/contrib/runners/noop_runner:{toxinidir}/contrib/runners/announcement_runner:{toxinidir}/contrib/runners/remote_runner:{toxinidir}/contrib/runners/remote_runner:{toxinidir}/contrib/runners/mistral_v2:{toxinidir}/contrib/runners/orquesta_runner:{toxinidir}/contrib/runners/inquirer_runner:{toxinidir}/contrib/runners/http_runner:{toxinidir}/contrib/runners/winrm_runner
Expand Down