mirror of
https://github.com/dashpay/dash.git
synced 2024-12-25 12:02:48 +01:00
a84ec5cc19
e4f4ea47ebf7774fb6f445adde7bf7ea71fa05a1 lint: Catch use of [] or {} as default parameter values in Python functions (practicalswift)
25dd86715039586d92176eee16e9c6644d2547f0 Avoid using mutable default parameter values (practicalswift)
Pull request description:
Avoid common Python default parameter gotcha when mutable `dict`/`list`:s are used as default parameter values.
Examples of this gotcha caught during review:
* https://github.com/bitcoin/bitcoin/pull/16673#discussion_r317415261
* https://github.com/bitcoin/bitcoin/pull/14565#discussion_r241942304
Perhaps surprisingly this is how mutable list and dictionary default parameter values behave in Python:
```
>>> 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})
```
In contrast to:
```
>>> 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})
```
The latter is typically the intended behaviour.
This PR fixes two instances of this and adds a check guarding against this gotcha going forward :-)
ACKs for top commit:
Sjors:
Oh Python... ACK e4f4ea47ebf7774fb6f445adde7bf7ea71fa05a1. Testing tip: swap the two commits.
Tree-SHA512: 56e14d24fc866211a20185c9fdb274ed046c3aed2dc0e07699e58b6f9fa3b79f6d0c880fb02d72b7fe5cc5eb7c0ff6da0ead33123344e1a872209370c2e49e3f
|
||
|---|---|---|
| .. | ||
| check-doc.py | ||
| check-rpc-mappings.py | ||
| commit-script-check.sh | ||
| extended-lint-all.sh | ||
| extended-lint-cppcheck.sh | ||
| git-subtree-check.sh | ||
| lint-all.sh | ||
| lint-assertions.sh | ||
| lint-circular-dependencies.sh | ||
| lint-cppcheck-dash.sh | ||
| lint-filenames.sh | ||
| lint-format-strings.py | ||
| lint-format-strings.sh | ||
| lint-git-commit-check.sh | ||
| lint-include-guards.sh | ||
| lint-includes.sh | ||
| lint-locale-dependence.sh | ||
| lint-logs.sh | ||
| lint-python-dead-code.sh | ||
| lint-python-mutable-default-parameters.sh | ||
| lint-python-utf8-encoding.sh | ||
| lint-python.sh | ||
| lint-qt.sh | ||
| lint-rpc-help.sh | ||
| lint-shebang.sh | ||
| lint-shell-locale.sh | ||
| lint-shell.sh | ||
| lint-spelling.ignore-words.txt | ||
| lint-spelling.sh | ||
| lint-submodule.sh | ||
| lint-tests.sh | ||
| lint-whitespace.sh | ||
| README.md | ||
This folder contains lint scripts.
check-doc.py
Check for missing documentation of command line options.
commit-script-check.sh
Verification of scripted diffs. Scripted diffs are only assumed to run on the latest LTS release of Ubuntu. Running them on other operating systems might require installing GNU tools, such as GNU sed.
git-subtree-check.sh
Run this script from the root of the repository to verify that a subtree matches the contents of the commit it claims to have been updated to.
To use, make sure that you have fetched the upstream repository branch in which the subtree is maintained:
- for
src/secp256k1: https://github.com/bitcoin-core/secp256k1.git (branch master) - for
src/leveldb: https://github.com/bitcoin-core/leveldb.git (branch bitcoin-fork) - for
src/univalue: https://github.com/bitcoin-core/univalue.git (branch master) - for
src/crypto/ctaes: https://github.com/bitcoin-core/ctaes.git (branch master) - for
src/crc32c: https://github.com/google/crc32c.git (branch master)
Usage: git-subtree-check.sh DIR (COMMIT)
COMMIT may be omitted, in which case HEAD is used.
lint-all.sh
Calls other scripts with the lint- prefix.