Fixed some config issues with __version__ reenabled strict type checking and docs building

Author: ptsOSL

.github/workflows/_docs.yml

@@ -44,7 +44,7 @@ jobs:
         run: python .github/pages/make_switcher.py --add $DOCS_VERSION ${{ github.repository }} .github/pages/switcher.json
 
       - name: Publish Docs to gh-pages
-        # if: github.ref_type == 'tag' || github.ref_name == 'main'
+        if: github.ref_type == 'tag' || github.ref_name == 'main'
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0

.vscode/launch.json

@@ -7,6 +7,13 @@
             "program": "${file}",
             "console": "integratedTerminal"
         },
+        {
+            "name": "Python Debugger: Virtac",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "/venv/bin/virtac",
+            "console": "integratedTerminal"
+        },
         {
             "name": "Debug Unit Test",
             "type": "debugpy",

pyproject.toml

@@ -64,8 +64,9 @@ name = "Phil Smith"
 version_file = "src/atip/_version.py"
 
 [tool.pyright]
-typeCheckingMode = "off" # TODO: This should be switched back to "standard" at some point!
+typeCheckingMode = "standard" # TODO: This should be switched back to "standard" at some point!
 reportMissingImports = false # Ignore missing stubs in imported modules
+ignore = ["tests"] #Not currently type checking tests
 
 [tool.pytest.ini_options]
 # Run pytest with all our checkers, and don't spam us with massive tracebacks on error
@@ -105,9 +106,11 @@ commands =
     pre-commit: pre-commit run --all-files --show-diff-on-failure {posargs}
     type-checking: pyright src tests {posargs}
     tests: pytest --cov=atip --cov-report term --cov-report xml:cov.xml {posargs}
-    docs: sphinx-{posargs:build -E --keep-going} -T docs build/html
+    docs: sphinx-{posargs:build -EW --keep-going} -T docs build/html
 """
 
+#TODO: ^ Add/remove the -W flag from sphinx to enable/disable exiting on docs build errors
+
 [tool.ruff]
 src = ["src", "tests"]
 line-length = 88

src/atip/__init__.py

@@ -1,5 +1,5 @@
 """ATIP: Accelerator Toolbox Interface for Pytac.
-See README.rst & INSTALL.rst for more information.
+See README.md for more information.
 
 .. data:: __version__
     :type: str

src/atip/__main__.py

@@ -7,7 +7,6 @@
 import pytac
 
 import atip
-from atip import __version__
 
 __all__ = ["main"]
 
@@ -19,7 +18,7 @@ def main(args: Sequence[str] | None = None) -> None:
         "-v",
         "--version",
         action="version",
-        version=__version__,
+        version=atip.__version__,
     )
     parser.parse_args(args)
 

src/virtac/__init__.py

@@ -7,12 +7,9 @@
     Version number as calculated by https://github.com/pypa/setuptools_scm
 """
 
-from atip._version import __version__
-
 from . import __main__, atip_server, create_csv, masks, mirror_objects
 
 __all__ = [
-    "__version__",
     "__main__",
     "atip_server",
     "create_csv",

src/virtac/__main__.py

@@ -12,7 +12,7 @@
 
 from softioc import builder, softioc
 from . import atip_server
-from atip._version import __version__
+from atip import __version__
 
 __all__ = ["main"]
 

src/virtac/create_csv.py

@@ -126,7 +126,9 @@ def generate_mirrored_pvs(lattice):
 
     value: The inital value of the output record.
     """
-    data = [("output type", "mirror type", "in", "out", "value")]
+    data: list[tuple[str, str, str, str, int]] = [
+        ("output type", "mirror type", "in", "out", 0)
+    ]
     # Tune PV aliases.
     tune = [
         lattice.get_value("tune_x", pytac.RB, data_source=pytac.SIM),
@@ -171,7 +173,9 @@ def generate_mirrored_pvs(lattice):
         )
     )
     # Electron BPMs enabled.
-    bpm_enabled_pvs = lattice.get_element_pv_names("BPM", "enabled", pytac.RB)
+    bpm_enabled_pvs: list[str] = lattice.get_element_pv_names(
+        "BPM", "enabled", pytac.RB
+    )
     data.append(
         (
             "Waveform",