[STYLE] Fixes and style improvements (- WIP PR #448 -)

Changes in file .coderabbit.yaml:
 * reviewed and approved sugested grammar changes (see AI policy requirements for changes)
 * implemented approved grammar changes

Changes in file .github/actions/checkout-and-rebuild/action.yml:
 * minor changes

Changes in file pyproject.toml:
 * fixed a version typo

Changes in file tests/MulticastUDPClient.py:
 * fixed a version header

Changes in file tests/__init__.py:
 * minor fixes

Changes in file tests/test_basic.py:
 * fixed a version header

Changes in file tests/test_build.py:
 * fixed a version header

Changes in file tests/test_deps.py:
 * fixed a version header

Changes in file tests/test_extra.py:
 * minor style changes

Changes in file tests/test_hear_cleanup.py:
 * minor style changes

Changes in file tests/test_hear_keyboard_interrupt.py:
 * minor style changes

Changes in file tests/test_manifest.py:
 * minor style changes

Changes in file tox.ini:
 * more fixes and cleanup

Author: reactive-firewall

.coderabbit.yaml

@@ -86,7 +86,7 @@ reviews:
         message prefixed with "[DOCUMENTATION] "
     - label: CI
       instructions: >-
-        Apply whenever project CI/CD components (namely GitHub Action source-code) is
+        Apply whenever any project CI/CD components (namely GitHub Action source-code) are
         updated by the PR/MR. Also apply when PR contains a commit with a commit
         message prefixed with "[CI] "
     - label: Linter
@@ -179,8 +179,8 @@ reviews:
         4. Consider these 'requirements.txt' files the records of truth regarding project
            dependencies.
         5. Consider the 'requirements.txt' file in the base of the git repository
-           (e.g., './requirements.txt') the required python dependencies regarding Multicast project
-           dependencies.
+           (e.g., './requirements.txt') the required python dependencies regarding Multicast
+           project dependencies.
     - path: tests/requirements.txt
       instructions: >-
         1. The multicast project's own dependencies are recorded in './requirements.txt'

.github/actions/checkout-and-rebuild/action.yml

@@ -40,22 +40,22 @@ inputs:
     required: true
 outputs:
   branch-name:
-    description: "The name of the branch that was checked-out"
+    description: "The name of the branch that was checked-out."
     value: ${{ steps.output_branch_name.outputs.branch-name || '' }}
   sha:
-    description: "The SHA of the commit checked-out"
+    description: "The SHA of the commit checked-out."
     value: ${{ steps.output_sha.outputs.sha || 'HEAD' }}
   python-version:
     description: "The python version that was used in the run."
     value: ${{ steps.cp313.outputs.python-version || '' }}
   python-path:
-    description: "The python version that was installed in the run"
+    description: "Absolute path to the Python executable installed for the run."
     value: ${{ steps.cp313.outputs.python-path }}
   artifact-name:
     description: "The downloaded artifact-name"
     value: "multicast-build-${{ steps.output_sha.outputs.sha }}.zip"
   artifact-files:
-    description: "The downloaded artifact-files"
+    description: "The downloaded artifact-files."
     value: ${{ steps.output_artifact_files.outputs.files }}
 
 runs:

pyproject.toml

@@ -10,7 +10,7 @@ keywords = ["multicast", "RFC-1112", "udp-protocol", "network-programming", "POS
 license-files = ["LICENSE.md"]
 maintainers = [{ "name" = "reactive-firewall", "email" = "[email protected]" }]
 name = "multicast"
-requires-python = ">=3.9.6, !=3.9.7, !=3.9.8, !=3.9.8, !=3.9.10, !=3.9.11, !=3.9.12, !=3.9.13, !=3.9.14, !=3.9.15, !=3.9.16, !=3.9.17, !=3.9.18, !=3.9.19, !=3.13.0, <3.14.0"
+requires-python = ">=3.9.6, !=3.9.7, !=3.9.8, !=3.9.9, !=3.9.10, !=3.9.11, !=3.9.12, !=3.9.13, !=3.9.14, !=3.9.15, !=3.9.16, !=3.9.17, !=3.9.18, !=3.9.19, !=3.13.0, <3.14.0"
 scripts = { "multicast" = "multicast.__main__:cli" }
 version = "v2.0.9a7"
 

tests/MulticastUDPClient.py

@@ -1,4 +1,4 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 # Multicast Python Module (Testing)

tests/__init__.py

@@ -60,7 +60,7 @@
 		>>> output = _tests.get_test_suite()
 		>>> output is not None
 		True
-		>>> type(output) == type(_unittest.TestSuite())
+		>>> isinstance(output, _unittest.TestSuite)
 		True
 		>>>
 

tests/test_basic.py

@@ -1,4 +1,4 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 # Python Test Repo Template

tests/test_build.py

@@ -1,4 +1,4 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 # Multicast PEP-517 Tests

tests/test_deps.py

@@ -1,4 +1,4 @@
-#! /usr/bin/env python
+#! /usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 # Multicast Python Module (Testing)

tests/test_extra.py

@@ -56,7 +56,7 @@
 	raise ImportError("[CWE-758] Failed to import test context") from baton
 
 
-_has_docs: bool = False
+_HAS_DOCS: bool = False
 """
 This module optionally provides extra test cases for the docs.utils module, focusing on the
 utils.sanitize_url method for url encoding.
@@ -76,12 +76,12 @@
 """
 
 
-if not _has_docs:
+if not _HAS_DOCS:
 	try:
 		import docs.utils
-		_has_docs = True
+		_HAS_DOCS = True
 	except ImportError:  # pragma: no branch
-		_has_docs = False
+		_HAS_DOCS = False
 
 
 def onlyIfHasDocs(has_docs: bool) -> callable:
@@ -118,7 +118,7 @@ def decorator(cls: callable) -> callable:
 
 
 @context.markWithMetaTag("extra", "security")
-@onlyIfHasDocs(has_docs=_has_docs)
+@onlyIfHasDocs(has_docs=_HAS_DOCS)
 class ExtraDocsUtilsTestSuite(context.BasicUsageTestSuite):
 	"""Test cases for docs.utils module."""
 

tests/test_hear_cleanup.py

@@ -177,12 +177,20 @@ def test_cleanup_on_exit(self) -> None:
 	def get_default_ip() -> str:
 		"""Get the default IP address of the machine.
 
+		Determines the machine's default IP address by creating a UDP socket connection
+		to a reserved test IP address and retrieving the local socket address.
+
+		Uses 203.0.113.1 (TEST-NET-3) for RFC 5737 compliance. Port 59095 is chosen as an
+		arbitrary high port number.
+
+		Args:
+			None
+
 		Returns:
 			str: The IP address of the default network interface.
 
-		Note:
-			Uses 203.0.113.1 (TEST-NET-3) for RFC 5737 compliance.
-			Port 59095 is chosen as an arbitrary high port number.
+		Raises:
+			CommandExecutionError: If the IP address cannot be determined.
 		"""
 		s = None
 		try:
@@ -192,7 +200,7 @@ def get_default_ip() -> str:
 			s.connect(("203.0.113.1", 59095))
 			# Get the IP address of the default interface
 			ip = s.getsockname()[0]
-		except socket.error as _cause:
+		except socket.error as _cause:  # pragma: no branch
 			raise multicast.exceptions.CommandExecutionError("Failed to determine IP", 69) from _cause
 		finally:
 			if s is not None:
@@ -202,8 +210,17 @@ def get_default_ip() -> str:
 	def test_should_invoke_kill_func_when_handle_error_called(self) -> None:
 		"""Test that kill_func calls shutdown on the server instance.
 
-		Verifies that the server properly handles requests without
+		Verifies that the server properly handles mocked requests with
 		the STOP command and calls the kill_func to free up server resources.
+
+		Args:
+			None (self is implicit)
+
+		Returns:
+			None
+
+		Raises:
+			AssertionError: If the test conditions are not met.
 		"""
 		theResult = False
 		fail_fixture = "Mock(STOP) --> Handler-HEAR --X shutdown"
@@ -212,7 +229,7 @@ def test_should_invoke_kill_func_when_handle_error_called(self) -> None:
 			self.assertIsNotNone(_fixture_port_num)
 			self.assertIsInstance(_fixture_port_num, int)
 			# Create an instance of McastServer
-			server_address = ('224.0.0.1', _fixture_port_num)
+			server_address = (self.TEST_MULTICAST_GROUP, _fixture_port_num)
 			self.server = multicast.hear.McastServer(server_address, None, False)
 			self.server.shutdown = MagicMock()  # Mock the shutdown method
 			client_address = (self.get_default_ip(), _fixture_port_num)