mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-10 03:47:29 -03:00
bd7e530f01
Support for type hints was introduced in Python 3.5. Type hints make it easier to read and review code in my opinion. Also an IDE may discover a potential bug sooner. Yet, as PEP 484 says: "It should also be emphasized that Python will remain a dynamically typed language, and the authors have no desire to ever make type hints mandatory, even by convention." Mypy is used in lint-python.sh to do the type checking. The package is standard so there is little chance that it will be abandoned. Mypy checks that type hints in source code are correct when they are not, it fails with an error. Useful resources: * https://docs.python.org/3.5/library/typing.html * https://www.python.org/dev/peps/pep-0484/ |
||
|---|---|---|
| .. | ||
| 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-filenames.sh | ||
| lint-format-strings.py | ||
| lint-format-strings.sh | ||
| lint-include-guards.sh | ||
| lint-includes.sh | ||
| lint-locale-dependence.sh | ||
| lint-logs.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.