Merge #17378: TestShell: Fix typos & implement cleanups

2493770e365a7e30117dc1b8d228f9cbed97f7e1 TestShell: Return self from setup() (James Chiang)
a8dea4552412668c2914b6395ef543341a9898cd TestShell: Simplify default setting of num_nodes (James Chiang)
9c7806e4bf113bee6c32cff7b46493fd1a5aa0ba Doc: Remove backticks in test-shell.md code block (James Chiang)
d3ed06e2cdb31dcecf5e647f7e1e52185cc76733 TestShell: Fix typo in TestShell warning printout (James Chiang)

Pull request description:

  This PR follows up on #17288 and fixes typos and implements code clean-ups suggested by reviewers of 19139ee.

  - Typo in `test_shell.py` warning
  - Typo in `test-shell.md` code block
  - Simplified default setting of `num_nodes` in `TestShell.setup()`
  - Enable initializer chaining: `TestShell().setup()`

ACKs for top commit:
  MarcoFalke:
    ACK 2493770e365a7e30117dc1b8d228f9cbed97f7e1
  instagibbs:
    tACK https://github.com/bitcoin/bitcoin/pull/17378/commits/2493770e365a7e30117dc1b8d228f9cbed97f7e1
  jnewbery:
    utACK 2493770e365a7e30117dc1b8d228f9cbed97f7e1

Tree-SHA512: 8fa7c2c550dbc3ec899de9dc328cd55cfa6daafe3b888aa5427e72fea69f064d938ec68e15bfa57109c0f6c3583e627ac4bd69303a11575d056941bd253adee0

2 files changed, 6 insertions, 8 deletions

diff --git a/test/functional/test-shell.md b/test/functional/test-shell.md
index aefcdc5ec8..f6ea9ef682 100644
--- a/test/functional/test-shell.md
+++ b/test/functional/test-shell.md
@@ -31,7 +31,7 @@ importing the `TestShell` class from the `test_shell` sub-package.
 ```
 >>> import sys
 >>> sys.path.insert(0, "/path/to/bitcoin/test/functional")
->>> from test_framework.test_shell import `TestShell`
+>>> from test_framework.test_shell import TestShell
 ```
 
 The following `TestShell` methods manage the lifetime of the underlying bitcoind
@@ -51,8 +51,7 @@ The following sections demonstrate how to initialize, run, and shut down a
 ## 3. Initializing a `TestShell` object
 
 ```
->>> test = TestShell()
->>> test.setup(num_nodes=2, setup_clean_chain=True)
+>>> test = TestShell().setup(num_nodes=2, setup_clean_chain=True)
 20XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Initializing test directory /path/to/bitcoin_func_test_XXXXXXX
 ```
 The `TestShell` forwards all functional test parameters of the parent
@@ -66,8 +65,7 @@ temporary folder. If you need more bitcoind nodes than set by default (1),
 simply increase the `num_nodes` parameter during setup.
 
 ```
->>> test2 = TestShell()
->>> test2.setup()
+>>> test2 = TestShell().setup()
 TestShell is already running!
 ```
 
diff --git a/test/functional/test_framework/test_shell.py b/test/functional/test_framework/test_shell.py
index 79da35b364..26df128f1f 100644
--- a/test/functional/test_framework/test_shell.py
+++ b/test/functional/test_framework/test_shell.py
@@ -29,8 +29,7 @@ class TestShell:
 
             # Num_nodes parameter must be set
             # by BitcoinTestFramework child class.
-            self.num_nodes = kwargs.get('num_nodes', 1)
-            kwargs.pop('num_nodes', None)
+            self.num_nodes = 1
 
             # User parameters override default values.
             for key, value in kwargs.items():
@@ -43,6 +42,7 @@ class TestShell:
 
             super().setup()
             self.running = True
+            return self
 
         def shutdown(self):
             if not self.running:
@@ -53,7 +53,7 @@ class TestShell:
 
         def reset(self):
             if self.running:
-                print("Shutdown TestWrapper before resetting!")
+                print("Shutdown TestShell before resetting!")
             else:
                 self.num_nodes = None
                 super().__init__()