fix tests and apply suggestions from code review

Author: bshaffer

packages/help/docfx_helper.py

@@ -12,16 +12,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
+import argparse
 import pathlib
 import shutil
-import sys
+from typing import Dict, Union
 import yaml
 import pypandoc
 
-def build_docfx(current_dir, repo_root, docs_map):
+def build_docfx(
+    current_dir: Union[str, pathlib.Path],
+    docs_map: Dict[str, str],
+) -> None:
     current_dir = pathlib.Path(current_dir)
-    repo_root = pathlib.Path(repo_root)
     output_dir = current_dir / "docs" / "_build"
 
     if output_dir.exists():
@@ -35,7 +37,7 @@ def build_docfx(current_dir, repo_root, docs_map):
         print("Pandoc not found. Downloading...")
         pypandoc.download_pandoc()
 
-    toc = []
+    doc_items = []
 
     for title, source in docs_map.items():
         source_path = pathlib.Path(source)
@@ -54,7 +56,7 @@ def build_docfx(current_dir, repo_root, docs_map):
                     'gfm',
                     format='rst'
                 )
-                (output_dir / target_filename).write_text(output)
+                (output_dir / target_filename).write_text(output, encoding="utf-8")
             else:
                 print(f"Warning: Source {source_path} not found.")
                 (output_dir / target_filename).write_text(f"# {title}\n\nContent missing.")
@@ -68,22 +70,32 @@ def build_docfx(current_dir, repo_root, docs_map):
                 (output_dir / filename).write_text(f"# {title}\n\nContent missing.")
             href = filename
 
-        toc.append({"name": title, "href": href})
+        doc_items.append({"name": title, "href": href})
+
+    # Create the structured TOC
+    toc = [
+        {
+            "uid": "product-neutral-guides",
+            "name": "Client library help",
+            "items": doc_items
+        }
+    ]
 
     # Write toc.yaml
     toc_path = output_dir / "toc.yaml"
-    with open(toc_path, "w") as f:
+    with open(toc_path, "w", encoding="utf-8") as f:
+        # Using block style for YAML as requested
         yaml.dump(toc, f, default_flow_style=False)
 
     print(f"DocFX build complete in {output_dir}")
     print(f"Generated TOC: {toc}")
 
 if __name__ == "__main__":
-    # Simple argument parsing: current_dir, repo_root, then pairs of Title,Source
-    curr = sys.argv[1]
-    root = sys.argv[2]
-    d_map = {}
-    for i in range(3, len(sys.argv), 2):
-        d_map[sys.argv[i]] = sys.argv[i+1]
+    parser = argparse.ArgumentParser(description="Build DocFX documentation.")
+    parser.add_argument("--current-dir", required=True, help="Current package directory")
+    parser.add_argument("--doc", action="append", nargs=2, metavar=("TITLE", "PATH"), help="Add a document title and its source path")
+
+    args = parser.parse_args()
 
-    build_docfx(curr, root, d_map)
+    docs_map = {title: path for title, path in args.doc} if args.doc else {}
+    build_docfx(args.current_dir, docs_map)

packages/help/help/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2022 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

packages/help/help/version.py

@@ -0,0 +1,8 @@
+[mypy]
+python_version = 3.9
+ignore_missing_imports = True
+strict = True
+disallow_untyped_decorators = False
+show_error_codes = True
+explicit_package_bases = True
+namespace_packages = True

packages/help/mypy.ini

@@ -14,12 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from __future__ import absolute_import
-
 import pathlib
 import nox
 
 DEFAULT_PYTHON_VERSION = "3.14"
+ALL_PYTHON = ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
 CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute()
 REPO_ROOT = CURRENT_DIRECTORY.parent.parent
 
@@ -31,26 +30,76 @@
 
 nox.options.sessions = [
     "lint",
+    "lint_setup_py",
+    "unit",
+    "mypy",
+    "prerelease_deps",
+    "core_deps_from_source",
     "docfx",
+    "docs",
 ]
 
 # Error if a python version is missing
 nox.options.error_on_missing_interpreters = True
 
 @nox.session(python=DEFAULT_PYTHON_VERSION)
-def lint(session):
+def lint_setup_py(session: nox.Session) -> None:
+    """Verify that setup.py is valid."""
+    session.install("setuptools")
+    session.run("python", "setup.py", "check", "--strict")
+
+@nox.session(python=ALL_PYTHON)
+def unit(session: nox.Session) -> None:
+    """Run unit tests."""
+    session.install("pytest", "pytest-cov")
+    session.install("-e", ".")
+    session.run("pytest", "tests")
+
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def mypy(session: nox.Session) -> None:
+    """Run mypy."""
+    session.install("mypy", "types-PyYAML")
+    session.install("-e", ".")
+    session.run("mypy", "help", "tests", "noxfile.py", "docfx_helper.py")
+
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def prerelease_deps(session: nox.Session) -> None:
+    """Run unit tests with prerelease dependencies."""
+    # Since we have no dependencies, this is just a normal unit test run
+    # but with --pre enabled for any test tools.
+    session.install("pytest", "pytest-cov")
+    session.install("-e", ".")
+    session.run("pytest", "tests")
+
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def core_deps_from_source(session: nox.Session) -> None:
+    """Run unit tests with core dependencies installed from source."""
+    # We don't depend on core, so we just run unit tests.
+    session.install("pytest", "pytest-cov")
+    session.install("-e", ".")
+    session.run("pytest", "tests")
+
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def lint(session: nox.Session) -> None:
     """Run linters."""
     session.install("ruff")
     session.run("ruff", "check", ".")
 
 @nox.session(python="3.10")
-def docfx(session):
+def docfx(session: nox.Session) -> None:
     """Build the docfx yaml files for this library."""
     session.install("PyYAML", "pypandoc")
 
     # Construct arguments for the helper script
-    args = [str(CURRENT_DIRECTORY), str(REPO_ROOT)]
+    args = [
+        "--current-dir", str(CURRENT_DIRECTORY),
+    ]
     for title, source in DOCS_MAP.items():
-        args.extend([title, str(source)])
+        args.extend(["--doc", title, str(source)])
 
     session.run("python", "docfx_helper.py", *args)
+
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def docs(session: nox.Session) -> None:
+    """No-op session for docs."""
+    session.log("This package does not have Sphinx documentation.")

packages/help/noxfile.py

@@ -67,7 +67,7 @@
         "Topic :: Internet",
     ],
     install_requires=dependencies,
-    python_requires=">=3.10",
+    python_requires=">=3.9",
     include_package_data=True,
     zip_safe=False,
     packages=["help"],

packages/help/setup.py

@@ -0,0 +1,18 @@
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from help import version
+
+def test_version() -> None:
+    assert version.__version__ is not None