Fix a billion type checking issues

Author: Fingel

codegen/lco/generator.py

@@ -3,14 +3,15 @@
 import json
 import sys
 from pathlib import Path
+from typing import Any
 
 import textcase
 from jinja2 import Environment, FileSystemLoader
 
 VALID_FACILITIES = ["SOAR", "LCO", "SAAO", "BLANCO"]
 
 
-def get_modes(ins: dict, type: str) -> list[str]:
+def get_modes(ins: dict[str, Any], type: str) -> list[str]:
     try:
         return [m["code"] for m in ins["modes"][type]["modes"]]
     except Exception:
@@ -38,7 +39,7 @@ def generate_instrument_configs(ins_s: str, facility: str) -> str:
     )
     template = j_env.get_template("instruments.jinja")
     ins_data = json.loads(ins_s)
-    instruments = []
+    instruments: list[dict[str, Any]] = []
     if facility == "SOAR":
         # Soar instruments look like SoarGhtsBluecam, already prefixed, so no need to add a prefix.
         prefix = ""
@@ -95,7 +96,9 @@ def generate_instrument_configs(ins_s: str, facility: str) -> str:
         # Accepts input from stdin or a file argument
         with fileinput.input() as f:
             ins_json = "".join(list(f))
-            sys.stdout.write(generate_instrument_configs(ins_json, facility=facility))
+            _ = sys.stdout.write(
+                generate_instrument_configs(ins_json, facility=facility)
+            )
     except IndexError:
-        sys.stdout.write("Usage: python generator.py <facility>")
+        _ = sys.stdout.write("Usage: python generator.py <facility>")
         exit(1)

codegen/lco/templates/instruments.jinja

@@ -1,6 +1,7 @@
+# pyright:  reportUnannotatedClassAttribute=false
 # This file is generated automatically and should not be edited by hand.
 
-from typing import Any, Annotated, Literal, Union
+from typing import Any, Annotated, Literal
 
 from annotated_types import Le
 from pydantic import BaseModel, ConfigDict
@@ -72,8 +73,4 @@ class {{ ctx.class_name }}(BaseModel):
 
 {% endfor %}
 # Export a type that encompasses all instruments
-{{ facility }}_INSTRUMENTS = Union[
-{% for ctx in instruments %}
-    {{ ctx.class_name }},
-{% endfor %}
-]
+{{ facility }}_INSTRUMENTS = {% for ctx in instruments %}{{ ctx.class_name }}{% if not loop.last%} | {% endif %}{% endfor %}

pyproject.toml

@@ -49,3 +49,8 @@ exclude = [
     "*.ipynb",
     "src/aeonlib/ocs/*/instruments.py",
 ]
+
+[tool.pyright]
+reportExplicitAny = false
+reportAny = false
+reportMissingTypeStubs = false

src/aeonlib/conf.py

@@ -1,8 +1,12 @@
+from typing import ClassVar
+
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 
 class Settings(BaseSettings):
-    model_config = SettingsConfigDict(env_prefix="AEON_", env_file=".env")
+    model_config: ClassVar[SettingsConfigDict] = SettingsConfigDict(
+        env_prefix="AEON_", env_file=".env"
+    )
 
     # Las Cumbres Observatory
     lco_token: str = ""

src/aeonlib/eso/__init__.py

@@ -1,7 +1,10 @@
+# pyright: reportUnknownMemberType=false
+# pyright: reportUnannotatedClassAttribute=false
 import logging
 import tempfile
-from typing import BinaryIO
+from typing import Any, BinaryIO
 
+from aeonlib.conf import Settings
 from aeonlib.conf import settings as default_settings
 from aeonlib.exceptions import ServiceNetworkError
 
@@ -28,7 +31,7 @@ class ESONetworkError(ServiceNetworkError):
 
 
 class EsoFacility:
-    def __init__(self, settings=default_settings):
+    def __init__(self, settings: Settings = default_settings):
         self.api = p2api.ApiConnection(
             settings.eso_environment,
             settings.eso_username,
@@ -58,7 +61,7 @@ def get_container(self, container_id: int) -> Container:
 
     def delete_container(self, container: Container) -> None:
         try:
-            self.api.deleteContainer(container.container_id, container.version)
+            _ = self.api.deleteContainer(container.container_id, container.version)
         except Exception as e:
             raise ESONetworkError("Failed to delete ESO container") from e
 
@@ -96,7 +99,7 @@ def save_ob(self, ob: ObservationBlock) -> ObservationBlock:
 
     def delete_ob(self, ob: ObservationBlock) -> None:
         try:
-            self.api.deleteOB(ob.ob_id, ob.version)
+            _ = self.api.deleteOB(ob.ob_id, ob.version)
         except Exception as e:
             raise ESONetworkError("Failed to delete ESO observation block") from e
 
@@ -112,7 +115,9 @@ def create_template(self, ob: ObservationBlock, name: str) -> Template:
 
     def delete_template(self, ob: ObservationBlock, template: Template) -> None:
         try:
-            self.api.deleteTemplate(ob.ob_id, template.template_id, template.version)
+            _ = self.api.deleteTemplate(
+                ob.ob_id, template.template_id, template.version
+            )
         except Exception as e:
             raise ESONetworkError("Failed to delete ESO template") from e
 
@@ -127,7 +132,7 @@ def get_template(self, ob: ObservationBlock, template_id: str) -> Template:
         return Template.model_validate({**template_dict, "version": version})
 
     def update_template_params(
-        self, ob: ObservationBlock, template: Template, params: dict
+        self, ob: ObservationBlock, template: Template, params: dict[Any, Any]
     ) -> Template:
         """
         This method simply updates the parameter dictionary in the template object and saves it.
@@ -252,11 +257,11 @@ def save_ephemeris(self, ob: ObservationBlock, ephemeris: Ephemeris):
             # This is a new ephemeris file so we need to request a version
             ephemeris.version = self.get_ephemeris(ob).version
         with tempfile.NamedTemporaryFile() as temp_file:
-            temp_file.write(ephemeris.text.encode())
+            _ = temp_file.write(ephemeris.text.encode())
             temp_file.flush()
             logger.debug("Saved ephemeris file to %s", temp_file.name)
             try:
-                _, version = self.api.saveEphemerisFile(
+                _, version = self.api.saveEphemerisFile(  # pyright: ignore[reportUnknownVariableType]
                     ob.ob_id, temp_file.name, ephemeris.version
                 )
                 assert version
@@ -276,17 +281,19 @@ def delete_ephemeris(self, ob: ObservationBlock, ephemeris: Ephemeris) -> None:
             raise ESONetworkError("Failed to delete ESO ephemeris file") from e
         logger.debug("<- %s", version)
 
-    def add_finding_chart(self, ob: ObservationBlock, chart: BinaryIO, name="") -> None:
+    def add_finding_chart(
+        self, ob: ObservationBlock, chart: BinaryIO, name: str = ""
+    ) -> None:
         """Add a finding chart and return a list of all charts"""
         prefix = "aeon_fc"
         if name:
             prefix += f"_{name}_"
         with tempfile.NamedTemporaryFile(delete=False, prefix=prefix) as temp_file:
-            temp_file.write(chart.read())
+            _ = temp_file.write(chart.read())
             temp_file.flush()
             logger.debug("Saved finding chart to %s", temp_file.name)
             try:
-                self.api.addFindingChart(ob.ob_id, temp_file.name)
+                _ = self.api.addFindingChart(ob.ob_id, temp_file.name)  # pyright: ignore[reportUnknownVariableType]
             except Exception as e:
                 raise ESONetworkError("Failed to add ESO finding chart") from e
 
@@ -304,7 +311,7 @@ def get_finding_chart_names(self, ob: ObservationBlock) -> list[str]:
     def delete_finding_chart(self, ob: ObservationBlock, index: int) -> None:
         """Delete a finding chart from the ESO api."""
         try:
-            self.api.deleteFindingChart(ob.ob_id, index)
+            _ = self.api.deleteFindingChart(ob.ob_id, index)
         except Exception as e:
             raise ESONetworkError("Failed to delete ESO finding chart") from e
 

src/aeonlib/eso/facility.py

@@ -1,5 +1,5 @@
 from datetime import datetime, time
-from typing import Any, Self
+from typing import Any, ClassVar, Self
 
 from astropy.coordinates import Angle
 from pydantic import BaseModel, ConfigDict, Field
@@ -9,7 +9,7 @@
 
 
 class EsoModel(BaseModel):
-    model_config = ConfigDict(
+    model_config: ClassVar[ConfigDict] = ConfigDict(
         alias_generator=to_camel, validate_by_name=True, serialize_by_alias=True
     )
 
@@ -49,8 +49,8 @@ def construct_from(self, st: SiderealTarget) -> None:
         # Format angles the way ESO wants them.
         assert isinstance(st.ra, Angle)
         assert isinstance(st.dec, Angle)
-        self.ra = st.ra.to_string(sep=":", precision=3)
-        self.dec = st.dec.to_string(sep=":", precision=3)
+        self.ra = st.ra.to_string(sep=":", precision=3)  # pyright: ignore[reportUnknownMemberType]
+        self.dec = st.dec.to_string(sep=":", precision=3)  # pyright: ignore[reportUnknownMemberType]
         self.epoch = st.epoch
         self.name = st.name
         self.proper_motion_dec = st.proper_motion_dec

src/aeonlib/eso/models.py

@@ -1,3 +1,4 @@
+# pyright: reportPrivateUsage=false
 import time
 from logging import getLogger
 
@@ -31,7 +32,7 @@ def __init__(self):
         url = "{0}://{1}:{2}/node_agent2/node_agent?wsdl".format(
             "http", settings.lt_host, settings.lt_port
         )
-        self.client = Client(url, headers=headers)
+        self.client: Client = Client(url, headers=headers)
 
     def submit_observation(
         self, cfg: LTConfig, ins: LT_INSTRUMENTS, target: SiderealTarget, window: Window
@@ -118,7 +119,7 @@ def _build_project(self, project_id: str) -> etree._Element:
         contact = etree.SubElement(project, "Contact")
         etree.SubElement(contact, "Username").text = settings.lt_username
         etree.SubElement(contact, "Name").text = ""
-        etree.SubElement(contact, "Communication")
+        _ = etree.SubElement(contact, "Communication")
 
         return project
 
@@ -167,9 +168,9 @@ def _build_constraints(
         etree.SubElement(photom_const, "Clouds").text = lt_observation.photometric
         date_const = etree.Element("DateTimeConstraint", type="include")
         assert window.start
-        start = window.start.strftime("%Y-%m-%dT%H:%M:00+00:00")
-        end = window.end.strftime("%Y-%m-%dT%H:%M:00+00:00")
-        etree.SubElement(date_const, "DateTimeStart", system="UT", value=str(start))
-        etree.SubElement(date_const, "DateTimeEnd", system="UT", value=str(end))
+        start = window.start.strftime("%Y-%m-%dT%H:%M:00+00:00")  # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
+        end = window.end.strftime("%Y-%m-%dT%H:%M:00+00:00")  # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
+        _ = etree.SubElement(date_const, "DateTimeStart", system="UT", value=str(start))  # pyright: ignore[reportUnknownArgumentType]
+        _ = etree.SubElement(date_const, "DateTimeEnd", system="UT", value=str(end))  # pyright: ignore[reportUnknownArgumentType]
 
         return [airmass_const, sky_const, seeing_const, photom_const, date_const]

src/aeonlib/lt/__init__.py

@@ -1,4 +1,5 @@
-from typing import Annotated, Literal, Tuple, Union
+# pyright: reportPrivateUsage=false
+from typing import Annotated, Literal
 
 from annotated_types import Ge, Le
 from lxml import etree
@@ -16,7 +17,7 @@ class LTConfig(BaseModel):
     photometric: Literal["clear", "light"] = "clear"
 
 
-IooFilterTimeCnt = Tuple[Annotated[float, Ge(0.0)], Annotated[int, Ge(1)]]
+IooFilterTimeCnt = tuple[Annotated[float, Ge(0.0)], Annotated[int, Ge(1)]]
 """Tuple of exposure time, exposure count"""
 
 
@@ -45,7 +46,7 @@ def build_schedule(self, filter: str, cfg: IooFilterTimeCnt) -> etree._Element:
         device = etree.SubElement(schedule, "Device", name="IO:O", type="camera")
         etree.SubElement(device, "SpectralRegion").text = "optical"
         setup = etree.SubElement(device, "Setup")
-        etree.SubElement(setup, "Filter", type=filter)
+        _ = etree.SubElement(setup, "Filter", type=filter)
         detector = etree.SubElement(setup, "Detector")
         binning = etree.SubElement(detector, "Binning")
         etree.SubElement(binning, "X", units="pixels").text = self.binning.split("x")[0]
@@ -66,7 +67,7 @@ def build_inst_schedule(self) -> list[etree._Element]:
         device = etree.SubElement(schedule, "Device", name="Sprat", type="spectrograph")
         etree.SubElement(device, "SpectralRegion").text = "optical"
         setup = etree.SubElement(device, "Setup")
-        etree.SubElement(setup, "Grating", name=self.grating)
+        _ = etree.SubElement(setup, "Grating", name=self.grating)
         detector = etree.SubElement(setup, "Detector")
         binning = etree.SubElement(detector, "Binning")
         etree.SubElement(binning, "X", units="pixels").text = "1"
@@ -104,15 +105,11 @@ def build_schedule(
         )
         etree.SubElement(device, "SpectralRegion").text = "optical"
         setup = etree.SubElement(device, "Setup")
-        etree.SubElement(setup, "Grating", name=grating)
+        _ = etree.SubElement(setup, "Grating", name=grating)
         exposure = etree.SubElement(schedule, "Exposure", count=str(exp_count))
         etree.SubElement(exposure, "Value", units="seconds").text = str(exp_time)
 
         return schedule
 
 
-LT_INSTRUMENTS = Union[
-    Ioo,
-    Frodo,
-    Sprat,
-]
+LT_INSTRUMENTS = Ioo | Frodo | Sprat