Merge branch 'develop'

.github/workflows/build.yml

@@ -8,9 +8,9 @@ jobs:
   builddist:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: 3.x
 

.github/workflows/ci.yml

@@ -24,9 +24,9 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python 3.x
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.x
     - name: Windows Venv
@@ -58,9 +58,9 @@ jobs:
       matrix:
         python-version: [ "pypy-3.10", "3.8", "3.9", "3.10", "3.11"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install
@@ -89,9 +89,9 @@ jobs:
     needs: versions
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Setup Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
     - name: Install phmutest
@@ -107,12 +107,9 @@ jobs:
         isort -
     - name: Formatting
       # Show reformatting changes.
-      # Make the changes.
-      # Subsequent steps run with the modified files.
       # Don't run black on the generated test files.
       run: |
-        black **/*.py --check --force-exclude="tests/py"
-        black **/*.py --force-exclude="tests/py"
+        black **/*.py --diff --force-exclude="tests/py"
       continue-on-error: true
     - name: Code Style
       run: |
@@ -130,7 +127,7 @@ jobs:
         python docs/premkdocs.py
         mkdocs build
     - name: Upload mkdocs site
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: site
         path: site
@@ -141,10 +138,10 @@ jobs:
     needs: inspect
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python 3.x
       id: setuppython
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.x
     - name: Install phmutest
@@ -167,7 +164,7 @@ jobs:
       continue-on-error: true
 
     - name: Upload coverage reports to Codecov
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./coverage.xml # optional

.github/workflows/coverage.yml

@@ -14,10 +14,10 @@ jobs:
   coverage:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python 3.x
       id: setuppython
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.x
     - name: Install phmutest
@@ -40,7 +40,7 @@ jobs:
       continue-on-error: true
 
     - name: Upload coverage reports to Codecov
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./coverage.xml # optional

.github/workflows/publish.yml

@@ -6,17 +6,17 @@ on:
   workflow_dispatch:
 
 env:
-  ref: v0.0.3
+  ref: v0.0.4
 
 jobs:
   builddist:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         ref: ${{ env.ref }}
 
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: 3.x
 
@@ -27,7 +27,7 @@ jobs:
         python -m pip hash dist/*
 
     - name: Upload dist
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: dist-${{ env.ref }}
         path: dist/*

.github/workflows/wheel.yml

@@ -5,14 +5,14 @@ on:
 
 env:
   project: phmutest
-  version: 0.0.3
+  version: 0.0.4
   command: phmutest
 
 jobs:
   pypi-install:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: "3.10"
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Mark Taylor
+Copyright (c) 2024 Mark Taylor
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,4 @@
-# phmutest 0.0.3
+# phmutest 0.0.4
 
 ## Detect broken Python examples in Markdown
 

docs/api.md

@@ -1,4 +1,4 @@
-# Tool API for phmutest version 0.0.3
+# Tool API for phmutest version 0.0.4
 
 ## API - phmutest.tool
 

docs/fixture_py.md

@@ -1,7 +1,7 @@
 # src/phmutest/fixture.py
 
 ```python
-"""v0.0.3 Keyword arguments passed to --fixture function and return type Fixture.
+"""v0.0.4 Keyword arguments passed to --fixture function and return type Fixture.
 
 These are passed to the fixture function as keyword arguments:
 
@@ -21,6 +21,7 @@ is_replmode
     Python bool. True when commandline argument --replmode is present.
 
 """
+
 from dataclasses import dataclass
 from typing import Callable, MutableMapping, Optional
 

docs/generated_project_py.md

@@ -10,6 +10,7 @@ from phmutest.skip import sys_tool as _phm_sys
 
 _phm_globals = None
 _phm_testcase = unittest.TestCase()
+_phm_testcase.maxDiff = None
 _phm_log = []
 
 

docs/generated_share_demo_py.md

@@ -10,6 +10,7 @@ from phmutest.skip import sys_tool as _phm_sys
 
 _phm_globals = None
 _phm_testcase = unittest.TestCase()
+_phm_testcase.maxDiff = None
 _phm_log = []
 
 

docs/make_wrapped_examples.py

@@ -1,4 +1,5 @@
 """Create Markdown wrappers around the project's example .py files."""
+
 from pathlib import Path
 
 top = "# <put filename here>\n\n```python\n"

docs/premkdocs.py

@@ -6,6 +6,7 @@
 - enter Ctrl-C to discontinue watching and shut down the mkdocs server
 Suggest adding the mkdocs.yml docs_dir to .gitignore.
 """
+
 import subprocess
 import sys
 from multiprocessing import Process

docs/recent_changes.md

@@ -22,3 +22,9 @@
 0.0.3 - 2023-09-24
 
 - Add test_importer.py. Cleanups
+
+0.0.4 - 2024-09-05
+
+- Bugfix- Issue- The generated expected output check in code mode
+  asserts if the FCB length is greater than a fairly small value.
+- Python source formatting updates per Black 24.3.0.

mkdocs.yml

@@ -1,6 +1,6 @@
-site_name: phmutest 0.0.3
+site_name: phmutest 0.0.4
 site_description: Detect broken Python examples in Markdown
-copyright: Copyright (c) 2023 Mark Taylor
+copyright: Copyright (c) 2024 Mark Taylor
 docs_dir: _mkdocsin
 theme: readthedocs
 nav:

setup.cfg

@@ -7,7 +7,7 @@ license_files = LICENSE
 
 # https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html
 name = phmutest
-version = 0.0.3
+version = 0.0.4
 author = Mark Taylor
 author_email = [email protected]
 description = Detect broken Python examples in Markdown.

src/phmutest/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.3"
+__version__ = "0.0.4"

src/phmutest/cases.py

@@ -1,4 +1,5 @@
 """Generate test cases as a unittest test file."""
+
 import argparse
 from pathlib import Path
 
@@ -75,12 +76,12 @@ def render_setup_module(
     replacements["shareid"] = shareid
     replacements["setupblocks"] = deindented_setup_blocks
     if args.progress:
-        replacements[
-            "showprogressenter"
-        ] = '_phm_sys.stderr_printer("setUpModule()...")'
-        replacements[
-            "showprogressexit"
-        ] = '_phm_sys.stderr_printer("leaving setUpModule.")'
+        replacements["showprogressenter"] = (
+            '_phm_sys.stderr_printer("setUpModule()...")'
+        )
+        replacements["showprogressexit"] = (
+            '_phm_sys.stderr_printer("leaving setUpModule.")'
+        )
 
     if args.fixture:
         replacements["userfixtureglobs"] = phmutest.subtest.justify(
@@ -128,12 +129,12 @@ def render_teardown_module(
     replacements["teardownblocks"] = deindented_teardown_blocks
 
     if args.progress:
-        replacements[
-            "showprogressenter"
-        ] = '_phm_sys.stderr_printer("tearDownModule()...")'
-        replacements[
-            "showprogressexit"
-        ] = '_phm_sys.stderr_printer("leaving tearDownModule.")'
+        replacements["showprogressenter"] = (
+            '_phm_sys.stderr_printer("tearDownModule()...")'
+        )
+        replacements["showprogressexit"] = (
+            '_phm_sys.stderr_printer("leaving tearDownModule.")'
+        )
 
     return phmutest.subtest.fill_in(
         teardown_module_form,
@@ -319,6 +320,7 @@ def markdown_file(
 $callfixture
 _phm_globals = None
 _phm_testcase = unittest.TestCase()
+_phm_testcase.maxDiff = None
 _phm_log = []
 $setupmodule
 $teardownmodule

src/phmutest/code.py

@@ -1,4 +1,5 @@
 """Run the generated unittest source file with unittest.main."""
+
 import argparse
 import copy
 import importlib

src/phmutest/config.py

@@ -16,6 +16,7 @@
           --generate, --progress, --sharing,
           --log, --summary, --report
 """
+
 import argparse
 from pathlib import Path
 from typing import List

src/phmutest/direct.py

@@ -1,4 +1,5 @@
 """Find phmutest Directives in HTML comment Nodes."""
+
 import re
 from dataclasses import dataclass
 from enum import Enum, auto

src/phmutest/fixture.py

@@ -1,4 +1,4 @@
-"""v0.0.3 Keyword arguments passed to --fixture function and return type Fixture.
+"""v0.0.4 Keyword arguments passed to --fixture function and return type Fixture.
 
 These are passed to the fixture function as keyword arguments:
 
@@ -18,6 +18,7 @@
     Python bool. True when commandline argument --replmode is present.
 
 """
+
 from dataclasses import dataclass
 from typing import Callable, MutableMapping, Optional
 

src/phmutest/globs.py

@@ -1,4 +1,5 @@
 """Imported by the generated test file to manage test module globals."""
+
 import inspect
 import sys
 import types

src/phmutest/importer.py

@@ -1,4 +1,5 @@
 """Import user's fixture function given the relative dotted path."""
+
 import importlib.util
 import sys
 from pathlib import Path

src/phmutest/main.py

@@ -1,4 +1,5 @@
 """Command line parsing, main entry point, and top level operations."""
+
 import argparse
 import pathlib
 import sys

src/phmutest/printer.py

@@ -1,4 +1,5 @@
 """Context manager to print and log entry and exit status of a code block run."""
+
 import contextlib
 import io
 import sys

src/phmutest/select.py

@@ -1,4 +1,5 @@
 """Identify/select/deselect FCBs per info string, test groups and directives."""
+
 import argparse
 from dataclasses import dataclass
 from pathlib import Path

src/phmutest/session.py

@@ -1,4 +1,5 @@
 """Generate and run docstests for Python interactive session FCBs."""
+
 import argparse
 import doctest
 import itertools