diff options
| author | Josh Morman <jmorman@gnuradio.org> | 2021-11-24 11:58:07 -0500 |
|---|---|---|
| committer | mormj <34754695+mormj@users.noreply.github.com> | 2021-11-24 14:41:53 -0500 |
| commit | c6f291d57d913708a2517de3c6902425c2c575d3 (patch) | |
| tree | ae91bea06ef85bf4456cc4b914514ab21c2bc0ac | |
| parent | 8e55c08ca6a5c22aa657c51b32c74f4d3c268700 (diff) | |
tools: add autoformat and check scripts
Signed-off-by: Josh Morman <jmorman@gnuradio.org>
| -rw-r--r-- | tools/autoformat_python.sh | 37 | ||||
| -rw-r--r-- | tools/check_pep8.sh | 24 |
2 files changed, 61 insertions, 0 deletions
diff --git a/tools/autoformat_python.sh b/tools/autoformat_python.sh new file mode 100644 index 0000000000..385f16567c --- /dev/null +++ b/tools/autoformat_python.sh @@ -0,0 +1,37 @@ +#!/bin/bash + +############################################################################# +# Perform python formatting on the GNU Radio source tree +# Requires: +# - autopep8 +# - pycodestyle +# +# Usage: +# sh autoformat_python.sh /path/to/module/ +# Example +# sh check_pep8.sh ./gr-digital +# sh check_pep8.sh . # to check the entire source tree +# +# WARNING: +# autopep8 can be a bit aggressive - it particularly messes with __init__.py +# files because of some of the import ordering +############################################################################# + +if [ $# -lt 1 ]; then + echo The number of arguments provided is incorrect. Please provide the path \ + to the module to be formatted. + exit 1 +fi + +echo "WARNING: this script calls autopep8 which can cause issues in __init__py especially" + +TARGET=$1 + +autopep8 -r -i ./$TARGET --select E101,E11,E121,E122,E123,E124,E125,E126,E127,\ +E128,E129,E131,E133,E20,E211,E22,E224,E225,E226,E227,E228,E231,E241,E242,E251,\ +E252,E26,E265,E266,E27,E301,E302,E303,E304,E305,E306,E401,E402,E501,E502,E701,\ +E70,E711,E712,E713,E714,E721,E722,E731,W291,W292,W293,W391,W503,W601,W602,W603,\ +W604,W690 + +find ./$TARGET -iname *.py | xargs pycodestyle --max-line-length=120 --ignore \ +E265,E266,E402,E501,E704,E712,E713,E714,E711,E722,E741,W504,W605
\ No newline at end of file diff --git a/tools/check_pep8.sh b/tools/check_pep8.sh new file mode 100644 index 0000000000..8515f34591 --- /dev/null +++ b/tools/check_pep8.sh @@ -0,0 +1,24 @@ +#!/bin/bash + +############################################################################# +# Check python formatting on the GNU Radio source tree +# Requires: +# - pycodestyle +# +# Usage: +# sh autoformat_python.sh /path/to/module/ +# Example +# sh check_pep8.sh ./gr-digital +# sh check_pep8.sh . # to check the entire source tree +############################################################################# + +if [ $# -lt 1 ]; then + echo The number of arguments provided is incorrect. Please provide the path \ + to the module to be formatted. + exit 1 +fi + +TARGET=$1 + +find ./$TARGET -iname *.py | xargs pycodestyle --max-line-length=120 --ignore \ +E265,E266,E402,E501,E704,E712,E713,E714,E711,E722,E741,W504,W605
\ No newline at end of file |