1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
# -*- coding: ascii -*-
#
# Copyright 2018 - 2025
# Andr\xe9 Malo or his licensors, as applicable
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Run code formatters
~~~~~~~~~~~~~~~~~~~
"""
import os as _os
import invoke as _invoke
from . import _features
from ._inv import tasks as _tasks
_FORMATTERS = []
@_tasks.optional(_FORMATTERS, _features.isort)
@_invoke.task()
def isort(ctx, diff=False):
"""
Format python code using isort formatter
Parameters:
diff (bool):
Just emit a diff instead of changing files inline? Default: false
"""
cmd = [ctx.which("isort")]
if diff:
cmd += ctx.s("--diff --color")
cmd += ctx.s("--settings-path pyproject.toml")
cmd += ["tasks"]
if ctx.get("package"):
cmd += [ctx.package]
if _os.path.exists(ctx.shell.native("tests")):
cmd += ["tests"]
with ctx.shell.root_dir():
ctx.run(ctx.c(cmd), echo=True)
@_tasks.optional(_FORMATTERS, _features.black)
@_invoke.task()
def black(ctx, diff=False):
"""
Format python code using Black formatter
Parameters:
diff (bool):
Just emit a diff instead of changing files inline? Default: false
"""
cmd = [ctx.which("black")]
if diff:
cmd += ctx.s("--diff --color")
cmd += ctx.s("--config pyproject.toml .")
with ctx.shell.root_dir():
ctx.run(ctx.c(cmd), echo=True)
@_tasks.optional(_FORMATTERS, _features.terraform)
@_invoke.task(name="tf")
def terraform(ctx):
"""Format terraform code"""
base_cmd = [ctx.which("terraform"), "-chdir=" + ctx.paths.terraform]
with ctx.shell.root_dir():
ctx.run(ctx.c(base_cmd + ctx.s("fmt -recursive")), echo=True)
@_tasks.optional(_FORMATTERS)
@_invoke.task(name="all", default=True)
def all_(ctx):
"""Run all formatters"""
_tasks.execute(ctx, *["format." + formatter for formatter in _FORMATTERS])
|
