diff options
| author | Justin Turner Arthur <justinarthur@gmail.com> | 2018-09-26 22:13:06 -0500 |
|---|---|---|
| committer | Justin Turner Arthur <justinarthur@gmail.com> | 2018-09-26 22:13:06 -0500 |
| commit | e46023287689fc8e79b9a82fe1a827d87c769423 (patch) | |
| tree | 256f9255fc05255d190f1955f4ffc25001e3e81f /test/functional/README.md | |
| parent | 17b42f4122740a7d9c91f3b42f77907e9cdcf680 (diff) | |
Document fixed attribute behavior in critical test framework classes.
Per @jimmysong's suggestion in bitcoin/bitcoin#14305. Also corrects
module for network objects and wrappers.
Diffstat (limited to 'test/functional/README.md')
| -rw-r--r-- | test/functional/README.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/test/functional/README.md b/test/functional/README.md index 6929ab5991..d40052ac93 100644 --- a/test/functional/README.md +++ b/test/functional/README.md @@ -60,6 +60,11 @@ don't have test cases for. - When calling RPCs with lots of arguments, consider using named keyword arguments instead of positional arguments to make the intent of the call clear to readers. +- Many of the core test framework classes such as `CBlock` and `CTransaction` + don't allow new attributes to be added to their objects at runtime like + typical Python objects allow. This helps prevent unpredictable side effects + from typographical errors or usage of the objects outside of their intended + purpose. #### RPC and P2P definitions @@ -72,7 +77,7 @@ P2P messages. These can be found in the following source files: #### Using the P2P interface -- `mininode.py` contains all the definitions for objects that pass +- `messages.py` contains all the definitions for objects that pass over the network (`CBlock`, `CTransaction`, etc, along with the network-level wrappers for them, `msg_block`, `msg_tx`, etc). |