foster/bitcoin-bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-03 09:56:38 -05:00
Code Issues Activity
bitcoin-bitcoin-core/test/lint
History
fanquake 98b0acda0f
Merge bitcoin/bitcoin#28725: test: refactor: use built-in collection types for type hints (Python 3.9 / PEP 585) 
a478c817b2 test: replace `Callable`/`Iterable` with their `collections.abc` alternative (PEP 585) (stickies-v)
4b9afb18e6 scripted-diff: use PEP 585 built-in collection types for verify-binary script (Sebastian Falbesoner)
d516cf83ed test: use built-in collection types for type hints (Python 3.9 / PEP 585) (Sebastian Falbesoner)

Pull request description:

  With Python 3.9 / [PEP 585](https://peps.python.org/pep-0585/), [type hinting has become a little less awkward](https://docs.python.org/3.9/whatsnew/3.9.html#type-hinting-generics-in-standard-collections), as for collection types one doesn't need to import the corresponding capitalized types (`Dict`, `List`, `Set`, `Tuple`, ...) anymore, but can use the built-in types directly (see  https://peps.python.org/pep-0585/#implementation for the full list).

  This PR applies the replacement for all Python scripts (i.e. in the contrib and test folders) for the basic types, i.e.:

  - typing.Dict -> dict
  - typing.List -> list
  - typing.Set  -> set
  - typing.Tuple -> tuple

  For an additional check, I ran mypy 1.6.1 on both master and the PR branch via
  ```
  $ mypy --ignore-missing-imports --explicit-package-bases $(git ls-files "*.py")
  ```
  and verified that the output is identical -- (from the 22 identified problems, most look like false-positives, it's probably worth it to go deeper here and address them in a follow-up though).

ACKs for top commit:
  stickies-v:
    ACK a478c817b2
  fanquake:
    ACK a478c817b2

Tree-SHA512: 6948c905f6abd644d84f09fcb3661d7edb2742e8f2b28560008697d251d77a61a1146ab4b070e65b0d27acede7a5256703da7bf6eb1c7c3a897755478c76c6e8
2023-11-17 11:19:17 +00:00
..
test_runner ci: Add filesystem lint check 2023-09-14 18:58:44 +02:00
all-lint.py Use same Python executable for subprocesses as for all-lint.py 2023-01-03 23:23:07 +02:00
check-doc.py init: completely remove -zapwallettxes (remaining hidden option) 2023-11-03 20:00:44 +01:00
commit-script-check.sh scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
git-subtree-check.sh scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
lint-assertions.py doc: Remove confusing assert linter 2023-09-14 18:59:52 +02:00
lint-circular-dependencies.py refactor: Remove unused circular include dependency from validation.cpp 2023-11-01 17:45:48 +01:00
lint-files.py test: use built-in collection types for type hints (Python 3.9 / PEP 585) 2023-10-25 01:10:21 +02:00
lint-format-strings.py tidy: Integrate bicoin-tidy clang-tidy plugin 2023-08-03 17:52:24 +01:00
lint-git-commit-check.py scripted-diff: Use new python 3.7 keywords 2023-01-18 13:00:34 +01:00
lint-include-guards.py test: use built-in collection types for type hints (Python 3.9 / PEP 585) 2023-10-25 01:10:21 +02:00
lint-includes.py [lint] update expected boost includes 2023-11-03 10:17:41 +00:00
lint-locale-dependence.py fuzz: Remove legacy int parse fuzz tests 2023-03-27 16:37:31 +02:00
lint-python-dead-code.py lint: Convert Python dead code linter to Python 2022-04-06 00:55:22 +02:00
lint-python-mutable-default-parameters.py scripted-diff: Use new python 3.7 keywords 2023-01-18 13:00:34 +01:00
lint-python-utf8-encoding.py lint: Ignore check_fileopens failure on **kwargs 2023-07-20 09:15:43 +02:00
lint-python.py lint: fix custom mypy cache dir setting 2023-09-28 13:20:25 +02:00
lint-qt-translation.py lint: Add lint-qt-translation.py 2023-10-23 15:07:02 +01:00
lint-shell-locale.py refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
lint-shell.py lint: Include test_utxo_snapshots in lint_shell 2023-10-13 14:06:06 +02:00
lint-spelling.py contrib: remove builder keys 2022-12-19 17:21:35 +00:00
lint-submodule.py scripted-diff: Use new python 3.7 keywords 2023-01-18 13:00:34 +01:00
lint-tests.py scripted-diff: Use new python 3.7 keywords 2023-01-18 13:00:34 +01:00
lint-whitespace.py scripted-diff: Use new python 3.7 keywords 2023-01-18 13:00:34 +01:00
README.md Merge bitcoin/bitcoin#28076: util: Replace std::filesystem with util/fs.h 2023-11-13 14:10:54 +00:00
run-lint-format-strings.py refactor: Enforce C-str fmt strings in WalletLogPrintf() 2023-08-08 10:55:11 +02:00
spelling.ignore-words.txt doc: fix typos 2023-11-07 10:21:51 +09:00

README.md

This folder contains lint scripts.

Running locally

To run linters locally with the same versions as the CI environment, use the included Dockerfile:

DOCKER_BUILDKIT=1 docker build -t bitcoin-linter --file "./ci/lint_imagefile" ./ && docker run --rm -v $(pwd):/bitcoin -it bitcoin-linter

Building the container can be done every time, because it is fast when the result is cached and it prevents issues when the image changes.

test runner

To run the checks in the test runner outside the docker, use:

( cd ./test/lint/test_runner/ && cargo fmt && cargo clippy && cargo run )

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.

Usage: test/lint/git-subtree-check.sh [-r] DIR [COMMIT]
       test/lint/git-subtree-check.sh -?
  • DIR is the prefix within the repository to check.
  • COMMIT is the commit to check, if it is not provided, HEAD will be used.
  • -r checks that subtree commit is present in repository.

To do a full check with -r, make sure that you have fetched the upstream repository branch in which the subtree is maintained:

To do so, add the upstream repository as remote:

git remote add --fetch secp256k1 https://github.com/bitcoin-core/secp256k1.git

all-lint.py

Calls other scripts with the lint- prefix.