mirror of
https://github.com/dashpay/dash.git
synced 2024-12-24 11:32:46 +01:00
Merge bitcoin/bitcoin#24800: lint: convert lint-python-mutable-default-parameters.sh to Python
e8e48fa82bdce3f0c1da0693148867befa221de7 Converted lint-python-mutable-default-parameters.sh to python (TakeshiMusgrave) Pull request description: This converts one of the linter scripts to Python. Reference issue: https://github.com/bitcoin/bitcoin/issues/24783 The approach is to just call git grep using subprocess.run. Alternative approaches could be to use Python instead of git grep (I'm not sure how) or use ```pylint --disable=all --enable=W0102```, though that requires installation of pylint. ACKs for top commit: MarcoFalke: review ACK e8e48fa82bdce3f0c1da0693148867befa221de7 Tree-SHA512: 7f6f4887dee02c9751b225a6a131fb705868859c4a9af25bb3485cda2358650486b110f17adf89d96a20f212d7d94899922a07aab12c8dc11984cfd5feb7a076
This commit is contained in:
parent
8aebca8e19
commit
5a18a539db
72
test/lint/lint-python-mutable-default-parameters.py
Executable file
72
test/lint/lint-python-mutable-default-parameters.py
Executable file
@ -0,0 +1,72 @@
|
||||
#!/usr/bin/env python3
|
||||
#
|
||||
# Copyright (c) 2019 The Bitcoin Core developers
|
||||
# Distributed under the MIT software license, see the accompanying
|
||||
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
"""
|
||||
Detect when a mutable list or dict is used as a default parameter value in a Python function.
|
||||
"""
|
||||
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
|
||||
def main():
|
||||
command = [
|
||||
"git",
|
||||
"grep",
|
||||
"-E",
|
||||
r"^\s*def [a-zA-Z0-9_]+\(.*=\s*(\[|\{)",
|
||||
"--",
|
||||
"*.py",
|
||||
]
|
||||
output = subprocess.run(command, stdout=subprocess.PIPE, universal_newlines=True)
|
||||
if len(output.stdout) > 0:
|
||||
error_msg = (
|
||||
"A mutable list or dict seems to be used as default parameter value:\n\n"
|
||||
f"{output.stdout}\n"
|
||||
f"{example()}"
|
||||
)
|
||||
print(error_msg)
|
||||
sys.exit(1)
|
||||
else:
|
||||
sys.exit(0)
|
||||
|
||||
|
||||
def example():
|
||||
return """This is how mutable list and dict default parameter values behave:
|
||||
|
||||
>>> def f(i, j=[], k={}):
|
||||
... j.append(i)
|
||||
... k[i] = True
|
||||
... return j, k
|
||||
...
|
||||
>>> f(1)
|
||||
([1], {1: True})
|
||||
>>> f(1)
|
||||
([1, 1], {1: True})
|
||||
>>> f(2)
|
||||
([1, 1, 2], {1: True, 2: True})
|
||||
|
||||
The intended behaviour was likely:
|
||||
|
||||
>>> def f(i, j=None, k=None):
|
||||
... if j is None:
|
||||
... j = []
|
||||
... if k is None:
|
||||
... k = {}
|
||||
... j.append(i)
|
||||
... k[i] = True
|
||||
... return j, k
|
||||
...
|
||||
>>> f(1)
|
||||
([1], {1: True})
|
||||
>>> f(1)
|
||||
([1], {1: True})
|
||||
>>> f(2)
|
||||
([2], {2: True})"""
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
@ -1,52 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Copyright (c) 2019 The Bitcoin Core developers
|
||||
# Distributed under the MIT software license, see the accompanying
|
||||
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
#
|
||||
# Detect when a mutable list or dict is used as a default parameter value in a Python function.
|
||||
|
||||
export LC_ALL=C
|
||||
EXIT_CODE=0
|
||||
OUTPUT=$(git grep -E '^\s*def [a-zA-Z0-9_]+\(.*=\s*(\[|\{)' -- "*.py")
|
||||
if [[ ${OUTPUT} != "" ]]; then
|
||||
echo "A mutable list or dict seems to be used as default parameter value:"
|
||||
echo
|
||||
echo "${OUTPUT}"
|
||||
echo
|
||||
cat << EXAMPLE
|
||||
This is how mutable list and dict default parameter values behave:
|
||||
|
||||
>>> def f(i, j=[], k={}):
|
||||
... j.append(i)
|
||||
... k[i] = True
|
||||
... return j, k
|
||||
...
|
||||
>>> f(1)
|
||||
([1], {1: True})
|
||||
>>> f(1)
|
||||
([1, 1], {1: True})
|
||||
>>> f(2)
|
||||
([1, 1, 2], {1: True, 2: True})
|
||||
|
||||
The intended behaviour was likely:
|
||||
|
||||
>>> def f(i, j=None, k=None):
|
||||
... if j is None:
|
||||
... j = []
|
||||
... if k is None:
|
||||
... k = {}
|
||||
... j.append(i)
|
||||
... k[i] = True
|
||||
... return j, k
|
||||
...
|
||||
>>> f(1)
|
||||
([1], {1: True})
|
||||
>>> f(1)
|
||||
([1], {1: True})
|
||||
>>> f(2)
|
||||
([2], {2: True})
|
||||
EXAMPLE
|
||||
EXIT_CODE=1
|
||||
fi
|
||||
exit ${EXIT_CODE}
|
Loading…
Reference in New Issue
Block a user