linting

Author: eleanorjboyd

.github/instructions/python-quality-checks.instructions.md

@@ -69,8 +69,29 @@ nox --session install_python_libs
 
 **Type errors in ignored files**: Legacy files in `pyproject.toml` ignore list—fix if working on them
 
+## When Writing Tests
+
+**Always format your test files before committing:**
+
+```bash
+cd python_files
+ruff format tests/  # Format all test files
+# or format specific files:
+ruff format tests/unittestadapter/test_utils.py
+```
+
+**Best practice workflow:**
+
+1. Write your test code
+2. Run `ruff format` on the test files
+3. Run the tests to verify they pass
+4. Run `npm run check-python` to catch any remaining issues
+
+This ensures your tests pass both functional checks and quality checks in CI.
+
 ## Learnings
 
 -   Always run `npm run check-python` before pushing to catch CI failures early (1)
 -   Use `ruff check . --fix` to auto-fix most linting issues before manual review (1)
 -   Pyright version must match CI (1.1.308) to avoid inconsistent results between local and CI runs (1)
+-   Always run `ruff format` on test files after writing them to avoid formatting CI failures (1)

python_files/tests/unittestadapter/test_utils.py

@@ -320,6 +320,7 @@ def test_doctest_patched_works() -> None:
 
     # Should successfully build a tree with the patched doctest
     assert tests is not None
+
     # The patched doctests should have proper IDs and be included
     # We should find at least one test child (the doctests that were patched)
     def count_tests(node):

python_files/unittestadapter/pvsc_utils.py

@@ -218,7 +218,8 @@ def build_test_tree(
             # Check if this is a doctest with insufficient components that would cause unpacking to fail
             if len(components) < 3 and isinstance(test_case, doctest.DocTestCase):
                 print(
-                    "Skipping doctest as it is not supported for the extension. Test case: ", test_case
+                    "Skipping doctest as it is not supported for the extension. Test case: ",
+                    test_case,
                 )
                 error = ["Skipping doctest as it is not supported for the extension."]
                 continue