pUnit 1.7.2__tar.gz → 1.7.3__tar.gz

{punit-1.7.2/src/pUnit.egg-info → punit-1.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pUnit
-Version: 1.7.2
+Version: 1.7.3
 Summary: A modernized unit-test framework for Python.
 Author-email: Shaun Wilson <mrshaunwilson@msn.com>
 License: MIT License

{punit-1.7.2 → punit-1.7.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pUnit"
-version = "1.7.2"
+version = "1.7.3"
 description = "A modernized unit-test framework for Python."
 keywords = ["test", "unittest", "unit-test", "xUnit", "nUnit", "pytest"]
 authors = [

{punit-1.7.2 → punit-1.7.3/src/pUnit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pUnit
-Version: 1.7.2
+Version: 1.7.3
 Summary: A modernized unit-test framework for Python.
 Author-email: Shaun Wilson <mrshaunwilson@msn.com>
 License: MIT License

{punit-1.7.2 → punit-1.7.3}/src/punit/TestResult.py

@@ -27,6 +27,22 @@ class TextIOCapture:
 
 
 class TestResult:
+    """
+    Accumulates the outcome of a single test execution.
+
+    Example
+    -------
+
+    Create and populate a result manually:
+
+    .. code-block:: python
+
+        result = TestResult()
+        result.module_name = 'tests.example'
+        result.test_name = 'test_something'
+        result.is_success = True
+
+    """
 
     __class_name: Optional[str]
     __exception: Exception | None
@@ -175,7 +191,7 @@ class TestResult:
         elif took >= 0.000000001:
             return f'{(took*1000000):.3f}'.rstrip('0').rstrip('.') + 'μs'
         else:
-            return f'{(took*1000):.3f}'.rstrip('0').rstrip('.') + 'ms'
+            return f'{(took*1000000):.3f}'.rstrip('0').rstrip('.') + 'ns'
 
     def capture_output(self, quiet: bool = False) -> None:
         self.__stdout_capture = TextIOCapture(sys.stdout, quiet)

{punit-1.7.2 → punit-1.7.3}/src/punit/__init__.py

@@ -12,8 +12,8 @@ from .assertions.exceptions import raises
 from .assertions.numeric import approx
 
 
-__version__ = '1.7.2'
-__commit__ = 'b60afab'
+__version__ = '1.7.3'
+__commit__ = 'a403690'
 __all__ = [
     '__version__', '__commit__',
     'assertions',

{punit-1.7.2 → punit-1.7.3}/src/punit/__main__.py

@@ -16,7 +16,7 @@ from .teardowns.TeardownManager import TeardownManager
 
 
 async def async_main() -> None:
-    ts = time.time()
+    start_time = time.time()
     cli = CommandLineInterface.parse()
     if cli.help:  # pragma: no cover
         cli.print_help()
@@ -26,27 +26,27 @@ async def async_main() -> None:
         cli.print_version()
     os.chdir(cli.workdir)
     if cli.no_pathfix is not True:
-        pathbase = str(Path.cwd())
-        srcbase = os.path.join(pathbase, 'src')
-        if os.path.exists(srcbase) and srcbase not in sys.path:
-            sys.path.append(srcbase)
-        if pathbase not in sys.path:
-            sys.path.append(pathbase)
+        cwd_path = str(Path.cwd())
+        src_path = os.path.join(cwd_path, 'src')
+        if os.path.exists(src_path) and src_path not in sys.path:
+            sys.path.append(src_path)
+        if cwd_path not in sys.path:
+            sys.path.append(cwd_path)
     test_module_discovery = TestModuleDiscovery(
         os.path.join(cli.workdir, cli.test_package_name),
         cli.includePatterns,
         cli.excludePatterns,
         cli)
     test_module_discovery.discover()
-    testRunner = TestRunner(cli.test_package_name, test_module_discovery.filenames, cli)
-    results = await testRunner.run()
-    totalTime = time.time() - ts
-    failureCount = 0
+    test_runner = TestRunner(cli.test_package_name, test_module_discovery.filenames, cli)
+    results = await test_runner.run()
+    total_time = time.time() - start_time
+    failure_count = 0
     for result in results:
         if not result.is_success:
-            failureCount += 1  # pragma: no cover
+            failure_count += 1  # pragma: no cover
     if not cli.quiet:
-        print(f'Total: {len(results)}, Failures: {failureCount}, Took: {totalTime:.3f}s')
+        print(f'Total: {len(results)}, Failures: {failure_count}, Took: {total_time:.3f}s')
     if cli.reportFormat is not None:  # pragma: no cover
         report: str = ''
         match cli.reportFormat:
@@ -74,7 +74,7 @@ async def async_main() -> None:
         pass
 
     if cli.no_exitcode is not True:
-        if failureCount:
+        if failure_count:
             # test failures trigger exit code 119 (for automation gating)
             sys.exit(119)
         if TeardownManager.instance().teardown_error_count > 0:

{punit-1.7.2 → punit-1.7.3}/src/punit/cli.py

@@ -12,6 +12,20 @@ from .traits import Trait
 
 
 class CommandLineInterface:
+    """
+    Command-line argument parser and display helper for pUnit.
+
+    Example
+    -------
+
+    Parse CLI arguments from ``sys.argv``:
+
+    .. code-block:: python
+
+        cli = CommandLineInterface.parse()
+        print(cli.test_package_name)
+
+    """
 
     __aliases: dict[str, str]
     __excludePatterns: list[str]
@@ -49,6 +63,12 @@ class CommandLineInterface:
         self.__verbose = False
 
     def __parse(self, argv: list[str]) -> CommandLineInterface:
+        """
+        Parse command-line arguments using a finite-state machine.
+
+        :param argv: List of argument strings (typically ``sys.argv``).
+        :returns: ``self`` for method chaining.
+        """
         aliasName: str | None = None
         extractFilter: bool = False
         extractExcludePattern: bool = False
@@ -160,7 +180,7 @@ class CommandLineInterface:
             FilterManager.instance().add(arg)
 
     @property
-    def aliases(self) -> dict:
+    def aliases(self) -> dict[str, str]:
         return self.__aliases
 
     @property
@@ -213,16 +233,15 @@ class CommandLineInterface:
 
     @property
     def no_exitcode(self) -> bool:
-        return self.__no_exitcode is True
+        return self.__no_exitcode
 
     @property
     def no_pathfix(self) -> bool:
-        return self.__no_pathfix is True
+        return self.__no_pathfix
 
     def print_help(self) -> None:
-        if True:  # pragma: no cover
-            self.print_version()
-            print("""
+        self.print_version()
+        print("""
 Usage: python3 -m punit [-h|--help]
                         [-q|--quiet] [-v|--verbose]
                         [-z|--failfast]
@@ -281,7 +300,7 @@ Options:
         write to FILENAME. In this case `--report` does not
         suppress any program output.
 """)
-            os._exit(0)
+        os._exit(0)
 
     def print_summary(self) -> None:
         self.print_version()

{punit-1.7.2 → punit-1.7.3}/src/punit/filters/Filter.py

@@ -5,17 +5,28 @@ import re
 
 
 class Filter:
+    """
+    Wraps a glob-style filter pattern and compiles it to a case-insensitive regex.
+
+    Patterns use ``*`` for multi-character wildcards and ``?`` for single characters.
+    Prefix with ``!`` to mark the filter as an exclusion rule.
+    """
 
     __isExclude: bool
     __pattern: str
-    __re: re.Pattern
+    __re: re.Pattern[str]
 
     def __init__(self, pattern: str) -> None:
         self.__isExclude = pattern.startswith('!')
         self.__pattern = pattern
         self.__re = self.__toRegex(pattern)
 
-    def __toRegex(self, pattern: str) -> re.Pattern:
+    def __toRegex(self, pattern: str) -> re.Pattern[str]:
+        """Convert a glob-style pattern to a compiled regex.
+
+        Supports ``*`` (multi-char wildcard), ``?`` (single-char wildcard),
+        and ``!`` prefix (exclusion).  Matching is case-insensitive.
+        """
         if self.__isExclude:
             pattern = pattern[1:]
         pattern = re.escape(pattern)\

{punit-1.7.2 → punit-1.7.3}/src/punit/reports/JUnitReportGenerator.py

@@ -65,7 +65,7 @@ class JUnitTestSuite:
         result: int = 0
         if self.testCases is not None:
             for testCase in self.testCases:
-                if testCase.disabled == True:
+                if testCase.disabled is True:
                     result += 1
         return result
 
@@ -187,7 +187,7 @@ class JUnitReportGenerator:
                             ele.text = testCase.stderr
         testSuitesEle.attrib['disabled'] = str(totalDisabledCount)
         testSuitesEle.attrib['errors'] = str(totalErrorCount)
-        testSuitesEle.attrib['failures'] = str(totalErrorCount)
+        testSuitesEle.attrib['failures'] = str(totalFailureCount)
         testSuitesEle.attrib['tests'] = str(totalTestCount)
         testSuitesEle.attrib['time'] = f'{totalTime:.6f}'.rstrip('0').rstrip('.')
         et.indent(testSuitesEle, space="    ")

{punit-1.7.2 → punit-1.7.3}/src/punit/runner.py

@@ -113,7 +113,8 @@ class TestRunner:
                         )
                         print(f'Teardown Error ({target_desc}): {ex}')
 
-    def print_test_result(self, test_result: TestResult):
+    def print_test_result(self, test_result: TestResult) -> None:
+        """Print the test result using a coloured emoji and timing."""
         if self.__cli.quiet:
             return
         glyph = '🟩' if test_result.is_success else '🟥'
@@ -204,13 +205,13 @@ class TestRunner:
         test_package_path = os.path.join(os.path.abspath(os.curdir), self.__test_package_name).replace('\\', '/')
         for filename in self.__filenames:
             ts = time.time()
-            moduleImportName = filename.replace(test_package_path, '').replace('/', '.')
-            if moduleImportName.endswith('.py'):
-                moduleImportName = moduleImportName[:-3]
-            module_report_name = moduleImportName.lstrip('.')
+            module_import_name = filename.replace(test_package_path, '').replace('/', '.')
+            if module_import_name.endswith('.py'):
+                module_import_name = module_import_name[:-3]
+            module_report_name = module_import_name.lstrip('.')
             try:
                 host_name: str = socket.gethostname()
-                test_module = importlib.import_module(moduleImportName, self.__test_package_name)
+                test_module = importlib.import_module(module_import_name, self.__test_package_name)
 
                 # execute all facts
                 await self.__run_facts(host_name, test_module, filename, module_report_name, results)

{punit-1.7.2 → punit-1.7.3}/src/punit/theories/Theory.py

@@ -10,6 +10,23 @@ from ..metadata import CallableMetadata
 
 
 class Theory:
+    """
+    Wraps a parameterised test (``@theory``) and its collected data points.
+
+    Example
+    -------
+
+    .. code-block:: python
+
+        @theory
+        def add_correct(x, y): ...
+
+        @inlinedata((1, 2), (3, 4))
+        @theory
+        def add_correct(x, y):
+            assert x + y == x + y
+
+    """
 
     __datas: list[tuple]
     __target: Union[FunctionType, MethodType, BuiltinFunctionType, BuiltinMethodType, Callable]
@@ -52,7 +69,6 @@ class Theory:
                     args = (class_instance,) + data
                     coro = self.__target(*args)
         else:
-            self.__test_name = self.__target.__name__
             coro = self.__target(*data)
         if inspect.iscoroutine(coro):
             await coro