File: python-formatter.sh

package info (click to toggle)
yade 2025.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,308 kB
  • sloc: cpp: 93,298; python: 50,409; sh: 577; makefile: 162
file content (73 lines) | stat: -rwxr-xr-x 2,723 bytes parent folder | download | duplicates (3)
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
#!/bin/bash
##########################################################################
#  2021        Anton Gladky                                              #
#  2021        Janek Kozicki                                             #
#                                                                        #
#  This program is free software; it is licensed under the terms of the  #
#  GNU General Public License v2 or later. See file LICENSE for details. #
##########################################################################
#
# Let us use this script on python scripts added or changed in new Merge
# Requests. Eventually all the scripts will be nicely formatted.
#
# Warning: we are still looking for optimal flags (or a better formatter).
#
# invoke:
#       scripts/python-formatter.sh ./Directory   optionally-yapf3-executable
#       scripts/python-formatter.sh ./SingleFile  optionally-yapf3-executable

FORMATTER=yapf3
SKIP="NO"

if [ "$#" -ne 1 ]; then
	if [ "$#" -eq 2 ]; then
		if [ ${2} = "--allow-dirty" ]; then
			SKIP="YES"
		else
			echo "Assuming that the yapf3 executable is ${2}"
			FORMATTER=${2}
		fi
	else
		echo "Please invoke this script with either one file or one directory as argument."
		echo "Optionally as second argument pass the yapf3 executable to use."
		echo "Or use second argument --allow-dirty to allow uncommitted changes while formatting."
		exit 1
	fi
fi

git diff-index --quiet HEAD --
CLEAN=$?
if [ ${CLEAN} -ne 0 ] && [ ${SKIP} = "NO" ]; then
	echo "There are uncommitted changes in git directory. Do 'git stash' or 'git commit'."
	echo "Reformatting on top of uncommited files will only cause trouble."
	exit 1
fi

function finish-print-stats {
	echo "Formatting finished. If the changes are a mistake you can call: 'git reset --hard'."
	git diff --shortstat
	exit 0
}

if [ ! -d "${1}" ]; then
	if [ -f "${1}" ]; then
		FILE=${1}
		extension=${FILE##*.}
		echo "File extension: "${extension}
		if [ "${extension}" = "py"  ]; then
			echo "Formatting Python with yapf3"
			${FORMATTER} --style='{based_on_style: google; column_limit: 160; use_tabs: True; dedent_closing_brackets: True; indent_width = 8; continuation_indent_width = 8 }' -i ${1}
		else
			echo "Please use scripts/clang-formatter.sh for formatting C++ code"
		fi
		finish-print-stats
	else
		echo "${1} is neither a file nor a directory"
		exit 1
	fi
else
	echo "Running yapf3 (from packages python3-yapf yapf3). It is slow, so use 8 cores with: -P 8"
	find ${1} -iname *.py -print0 | xargs -0 -P 8 -I'{}' ${FORMATTER} --style='{based_on_style: google; column_limit: 160; use_tabs: True; dedent_closing_brackets: True; indent_width = 8; continuation_indent_width = 8 }' -i {}
	finish-print-stats
fi