chore: capitalize comments in Python files

Author: mkoura

cardano_node_tests/cardano_cli_coverage.py

@@ -92,7 +92,7 @@ def merge_coverage(dict_a: dict, dict_b: dict) -> dict:
             dict_a[key] = sorted(new_list)
         elif key in dict_a and isinstance(value, addable) and isinstance(dict_a[key], addable):
             dict_a[key] += value
-        # skipped arguments and commands are not in the available commands dict
+        # Skipped arguments and commands are not in the available commands dict
         elif key not in dict_a:
             continue
         elif not isinstance(value, dict):
@@ -120,17 +120,17 @@ def parse_cmd_output(output: str) -> list[str]:
             section_start = True
             continue
         if section_start:
-            # skip line with wrapped description from previous command
+            # Skip line with wrapped description from previous command
             if line.startswith("    "):
                 continue
-            # skip line with subsection description
+            # Skip line with subsection description
             if not line.startswith(" "):
                 continue
             line_s = line.strip()
             if not line_s:
                 continue
             item = line_s.split()[0]
-            # in case the item looks like "-h,--help", take only the long option
+            # In case the item looks like "-h,--help", take only the long option
             arg = item.split(",")[-1].strip()
             cli_args.append(arg)
 

cardano_node_tests/cluster_management/cache.py

@@ -11,9 +11,9 @@ class ClusterManagerCache:
     Here goes only data that makes sense to reuse in multiple tests.
     """
 
-    # single `ClusterLib` instance can be used in multiple tests executed on the same worker
+    # Single `ClusterLib` instance can be used in multiple tests executed on the same worker
     cluster_obj: clusterlib.ClusterLib | None = None
-    # data for initialized cluster instance
+    # Data for initialized cluster instance
     test_data: dict = dataclasses.field(default_factory=dict)
     addrs_data: dict = dataclasses.field(default_factory=dict)
     last_checksum: str = ""
@@ -22,7 +22,7 @@ class ClusterManagerCache:
 class CacheManager:
     """Set of cache management methods."""
 
-    # every pytest worker has its own cache, i.e. this cache is local to single worker
+    # Every pytest worker has its own cache, i.e. this cache is local to single worker
     cache: tp.ClassVar[dict[int, ClusterManagerCache]] = {}
 
     @classmethod

cardano_node_tests/cluster_management/cluster_getter.py

@@ -36,7 +36,7 @@
 
 def _get_manager_fixture_line_str() -> str:
     """Get `filename#lineno` of current fixture, called from contextmanager."""
-    # get past `cache_fixture` and `contextmanager` to the fixture
+    # Get past `cache_fixture` and `contextmanager` to the fixture
     calling_frame = inspect.currentframe().f_back.f_back.f_back  # type: ignore
     assert calling_frame
     return helpers.get_line_str_from_frame(frame=calling_frame)
@@ -173,7 +173,7 @@ def stop_all_clusters(self) -> None:
         """Stop all cluster instances."""
         self.log("called `stop_all_clusters`")
 
-        # don't stop cluster if it was started outside of test framework
+        # Don't stop cluster if it was started outside of test framework
         if configuration.DEV_CLUSTER_RUNNING:
             LOGGER.warning("Ignoring request to stop clusters as 'DEV_CLUSTER_RUNNING' is set.")
             return
@@ -261,26 +261,26 @@ def on_test_stop(self) -> None:
             if not list(self.instance_dir.glob(f"{common.RESPIN_NEEDED_GLOB}_*")):
                 logfiles.clean_ignore_rules(ignore_file_id=self.worker_id)
 
-            # remove resource locking files created by the worker, ignore resources that have mark
+            # Remove resource locking files created by the worker, ignore resources that have mark
             resource_locking_files = list(
                 self.instance_dir.glob(f"{common.RESOURCE_LOCKED_GLOB}_@@*@@_{self.worker_id}")
             )
             for f in resource_locking_files:
                 f.unlink()
 
-            # remove "resource in use" files created by the worker, ignore resources that have mark
+            # Remove "resource in use" files created by the worker, ignore resources that have mark
             resource_in_use_files = list(
                 self.instance_dir.glob(f"{common.RESOURCE_IN_USE_GLOB}_@@*@@_{self.worker_id}")
             )
             for f in resource_in_use_files:
                 f.unlink()
 
-            # remove file that indicates that a test is running on the worker
+            # Remove file that indicates that a test is running on the worker
             next(
                 iter(self.instance_dir.glob(f"{common.TEST_RUNNING_GLOB}*_{self.worker_id}"))
             ).unlink(missing_ok=True)
 
-            # log names of tests that keep running on the cluster instance
+            # Log names of tests that keep running on the cluster instance
             tnames = [
                 tf.read_text().strip()
                 for tf in self.instance_dir.glob(f"{common.TEST_RUNNING_GLOB}*")
@@ -339,14 +339,14 @@ def _save_cli_coverage(self) -> None:
     def _reload_cluster_obj(self, state_dir: pl.Path) -> None:
         """Reload cluster instance data if necessary."""
         addrs_data_checksum = helpers.checksum(state_dir / cluster_nodes.ADDRS_DATA)
-        # the checksum will not match when cluster was respun
+        # The checksum will not match when cluster was respun
         if addrs_data_checksum == self.cache.last_checksum:
             return
 
-        # save CLI coverage collected by the old `cluster_obj` instance
+        # Save CLI coverage collected by the old `cluster_obj` instance
         self._save_cli_coverage()
 
-        # replace the old `cluster_obj` instance and reload data
+        # Replace the old `cluster_obj` instance and reload data
         self.cache.cluster_obj = cluster_nodes.get_cluster_type().get_cluster_obj()
         self.cache.test_data = {}
         self.cache.addrs_data = cluster_nodes.load_addrs_data()
@@ -367,7 +367,7 @@ def init(
 
         **IMPORTANT**: This method must be called before any other method of this class.
         """
-        # get number of initialized cluster instance once it is possible to start a test
+        # Get number of initialized cluster instance once it is possible to start a test
         instance_num = cluster_getter.ClusterGetter(
             worker_id=self.worker_id,
             pytest_config=self.pytest_config,
@@ -383,11 +383,11 @@ def init(
         )
         self._cluster_instance_num = instance_num
 
-        # reload cluster instance data if necessary
+        # Reload cluster instance data if necessary
         state_dir = cluster_nodes.get_cluster_env().state_dir
         self._reload_cluster_obj(state_dir=state_dir)
 
-        # initialize `cardano_clusterlib.ClusterLib` object
+        # Initialize `cardano_clusterlib.ClusterLib` object
         cluster_obj = self.cache.cluster_obj
         if not cluster_obj:
             msg = "`cluster_obj` not available, that cannot happen"

cardano_node_tests/cluster_management/manager.py

@@ -53,7 +53,7 @@ def _split_scope(self, nodeid: str) -> str:
         Example:
             example/loadsuite/test/test_gamma.py::test_beta0[param]@group_name@long
         """
-        # check the index of ']' to avoid the case: parametrize mark value has '@'
+        # Check the index of ']' to avoid the case: parametrize mark value has '@'
         param_end_idx = nodeid.rfind("]")
         scope_start_idx = param_end_idx if param_end_idx != -1 else 0
 
@@ -105,11 +105,11 @@ def _assign_work_unit(self, node: workermanage.WorkerController) -> None:
         assigned_to_node = self.assigned_work.setdefault(node, collections.OrderedDict())
         scope, work_unit = None, None
 
-        # check if there are any long-running tests already pending
+        # Check if there are any long-running tests already pending
         long_pending = self._is_long_pending(assigned_to_node)
 
         if long_pending:
-            # try to find a work unit with no long-running test if there is already a long-running
+            # Try to find a work unit with no long-running test if there is already a long-running
             # test pending
             scope = self._get_short_scope()
             if scope:
@@ -121,14 +121,14 @@ def _assign_work_unit(self, node: workermanage.WorkerController) -> None:
             if scope:
                 work_unit = self.workqueue.pop(scope)
 
-        # grab the first unit of work if none was grabbed above
+        # Grab the first unit of work if none was grabbed above
         if work_unit is None:
             scope, work_unit = self.workqueue.popitem(last=False)
 
-        # keep track of the assigned work
+        # Keep track of the assigned work
         assigned_to_node[scope] = work_unit
 
-        # ask the node to execute the workload
+        # Ask the node to execute the workload
         worker_collection = self.registered_collections[node]
         nodeids_indexes = [
             worker_collection.index(nodeid)
@@ -150,7 +150,7 @@ def pytest_collection_modifyitems(items: list) -> None:
 
         comps = [item.nodeid]
 
-        # add the group name to nodeid as suffix
+        # Add the group name to nodeid as suffix
         if group_marker:
             gname = (
                 group_marker.args[0]
@@ -159,7 +159,7 @@ def pytest_collection_modifyitems(items: list) -> None:
             )
             comps.append(gname)
 
-        # add "long" to nodeid as suffix
+        # Add "long" to nodeid as suffix
         if long_marker:
             comps.append(LONG_MARKER)
 

cardano_node_tests/pytest_plugins/xdist_scheduler.py

@@ -30,7 +30,7 @@
     _BLD_SKIP_REASON = "transaction era must be the same as node era"
 BUILD_UNUSABLE = bool(_BLD_SKIP_REASON)
 
-# common `skipif`s
+# Common `skipif`s
 SKIPIF_BUILD_UNUSABLE = pytest.mark.skipif(
     BUILD_UNUSABLE,
     reason=(
@@ -79,7 +79,7 @@
 )
 
 
-# common parametrization
+# Common parametrization
 PARAM_USE_BUILD_CMD = pytest.mark.parametrize(
     "use_build_cmd",
     (
@@ -118,16 +118,16 @@
 )
 
 
-# intervals for `wait_for_epoch_interval` (negative values are counted from the end of an epoch)
+# Intervals for `wait_for_epoch_interval` (negative values are counted from the end of an epoch)
 if cluster_nodes.get_cluster_type().type == cluster_nodes.ClusterType.LOCAL:
-    # time buffer at the end of an epoch, enough to do something that takes several transactions
+    # Time buffer at the end of an epoch, enough to do something that takes several transactions
     EPOCH_STOP_SEC_BUFFER = -40
-    # time when all ledger state info is available for the current epoch
+    # Time when all ledger state info is available for the current epoch
     EPOCH_START_SEC_LEDGER_STATE = -19
-    # time buffer at the end of an epoch after getting ledger state info
+    # Time buffer at the end of an epoch after getting ledger state info
     EPOCH_STOP_SEC_LEDGER_STATE = -15
 else:
-    # we can be more generous on testnets
+    # We can be more generous on testnets
     EPOCH_STOP_SEC_BUFFER = -200
     EPOCH_START_SEC_LEDGER_STATE = -300
     EPOCH_STOP_SEC_LEDGER_STATE = -200
@@ -166,7 +166,7 @@ def get_test_id(cluster_obj: clusterlib.ClusterLib) -> str:
         f"{curr_test.test_function}{curr_test.test_params}_ci{cluster_obj.cluster_id}_{rand_str}"
     )
 
-    # log test ID to cluster manager log file - getting test ID happens early
+    # Log test ID to cluster manager log file - getting test ID happens early
     # after the start of a test, so the log entry can be used for determining
     # time of the test start
     cm: cluster_management.ClusterManager = cluster_obj._cluster_manager  # type: ignore
@@ -294,7 +294,7 @@ def fail_on_fork(
         err_msg.append(f"Following nodes appear to be out of sync: {sorted(unsynced_nodes)}")
 
     if err_msg:
-        # the local cluster needs to be respun before it is usable again
+        # The local cluster needs to be respun before it is usable again
         cluster_manager.set_needs_respin()
         raise AssertionError("\n".join(err_msg))
 

cardano_node_tests/tests/common.py

@@ -32,10 +32,10 @@
 LOGGER = logging.getLogger(__name__)
 INTERRUPTED_NAME = ".session_interrupted"
 
-# make sure there's enough time to stop all cluster instances at the end of session
+# Make sure there's enough time to stop all cluster instances at the end of session
 workermanage.NodeManager.EXIT_TIMEOUT = 30
 
-# use custom xdist scheduler
+# Use custom xdist scheduler
 pytest_plugins = ("cardano_node_tests.pytest_plugins.xdist_scheduler",)
 
 
@@ -67,7 +67,7 @@ def pytest_addoption(parser: tp.Any) -> None:
 
 
 def pytest_configure(config: tp.Any) -> None:
-    # don't bother collecting metadata if all tests are skipped
+    # Don't bother collecting metadata if all tests are skipped
     if config.getvalue("skipall"):
         return
 
@@ -144,7 +144,7 @@ def _skip_all_tests(config: tp.Any, items: list) -> bool:
 
 @pytest.hookimpl(tryfirst=True)
 def pytest_collection_modifyitems(config: tp.Any, items: list) -> None:  # noqa: C901
-    # prevent on slave nodes (xdist)
+    # Prevent on slave nodes (xdist)
     if hasattr(config, "slaveinput"):
         return
 
@@ -158,12 +158,12 @@ def _mark_needs_dbsync(item: tp.Any) -> None:
         if "needs_dbsync" not in item.keywords:
             return
 
-        # all tests marked with 'needs_dbsync' are db-sync tests, and should be marked
+        # All tests marked with 'needs_dbsync' are db-sync tests, and should be marked
         # with the 'dbsync' marker as well
         if "dbsync" not in item.keywords:
             item.add_marker(pytest.mark.dbsync)
 
-        # skip all tests that require db-sync when db-sync is not available
+        # Skip all tests that require db-sync when db-sync is not available
         if not configuration.HAS_DBSYNC:
             item.add_marker(skip_dbsync_marker)
 
@@ -218,7 +218,7 @@ def _save_all_cluster_instances_artifacts(
     """Save artifacts of all cluster instances after all tests are finished."""
     cluster_manager_obj.log("running `_save_all_cluster_instances_artifacts`")
 
-    # stop all cluster instances
+    # Stop all cluster instances
     with helpers.ignore_interrupt():
         cluster_manager_obj.save_all_clusters_artifacts()
 
@@ -227,7 +227,7 @@ def _stop_all_cluster_instances(cluster_manager_obj: cluster_management.ClusterM
     """Stop all cluster instances after all tests are finished."""
     cluster_manager_obj.log("running `_stop_all_cluster_instances`")
 
-    # stop all cluster instances
+    # Stop all cluster instances
     with helpers.ignore_interrupt():
         cluster_manager_obj.stop_all_clusters()
 
@@ -237,7 +237,7 @@ def _testnet_cleanup(pytest_root_tmp: pl.Path) -> None:
     if cluster_nodes.get_cluster_type().type != cluster_nodes.ClusterType.TESTNET:
         return
 
-    # there's only one cluster instance for testnets, so we don't need to use cluster manager
+    # There's only one cluster instance for testnets, so we don't need to use cluster manager
     cluster_obj = cluster_nodes.get_cluster_type().get_cluster_obj()
 
     destdir = pytest_root_tmp.parent / f"cleanup-{pytest_root_tmp.stem}-{helpers.get_rand_str(8)}"
@@ -339,7 +339,7 @@ def testfile_temp_dir() -> pl.Path:
 
     The dir is specific to a single test file.
     """
-    # get a dir path based on the test file running
+    # Get a dir path based on the test file running
     dir_path = (
         (os.environ.get("PYTEST_CURRENT_TEST") or "unknown")
         .split("::")[0]
@@ -368,7 +368,7 @@ def cluster_manager(
     request: FixtureRequest,
 ) -> tp.Generator[cluster_management.ClusterManager, None, None]:
     """Return instance of `cluster_management.ClusterManager`."""
-    # hide from traceback to make logs errors more readable
+    # Hide from traceback to make logs errors more readable
     __tracebackhide__ = True  # pylint: disable=unused-variable
 
     cluster_manager_obj = cluster_management.ClusterManager(