aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Falbesoner <sebastian.falbesoner@gmail.com>2022-08-09 18:04:20 +0200
committerSebastian Falbesoner <sebastian.falbesoner@gmail.com>2022-08-09 18:04:20 +0200
commit4edc6893825fd8c45c53c81c73a6a7801e1b458c (patch)
tree404e3b0b69f0fba602485751a2852e3abc1d9348
parentc012875b9ded0a5183602f002738ca823d559518 (diff)
downloadbitcoin-4edc6893825fd8c45c53c81c73a6a7801e1b458c.tar.xz
doc: test: suggest multi-line imports in functional test style guide
-rw-r--r--test/functional/README.md4
-rwxr-xr-xtest/functional/example_test.py11
2 files changed, 12 insertions, 3 deletions
diff --git a/test/functional/README.md b/test/functional/README.md
index 914dbfd977..1bd618a0c3 100644
--- a/test/functional/README.md
+++ b/test/functional/README.md
@@ -28,7 +28,9 @@ don't have test cases for.
could lead to bugs and issues in the test code.
- Use [type hints](https://docs.python.org/3/library/typing.html) in your code to improve code readability
and to detect possible bugs earlier.
-- Avoid wildcard imports
+- Avoid wildcard imports.
+- If more than one name from a module is needed, use lexicographically sorted multi-line imports
+ in order to reduce the possibility of potential merge conflicts.
- Use a module-level docstring to describe what the test is testing, and how it
is testing it.
- When subclassing the BitcoinTestFramework, place overrides for the
diff --git a/test/functional/example_test.py b/test/functional/example_test.py
index 2ad96da854..9cf756060e 100755
--- a/test/functional/example_test.py
+++ b/test/functional/example_test.py
@@ -14,8 +14,15 @@ is testing and *how* it's being tested
from collections import defaultdict
# Avoid wildcard * imports
-from test_framework.blocktools import (create_block, create_coinbase)
-from test_framework.messages import CInv, MSG_BLOCK
+# Use lexicographically sorted multi-line imports
+from test_framework.blocktools import (
+ create_block,
+ create_coinbase,
+)
+from test_framework.messages import (
+ CInv,
+ MSG_BLOCK,
+)
from test_framework.p2p import (
P2PInterface,
msg_block,