gpp-client 26.5.0.dev2__tar.gz → 26.5.1.dev2__tar.gz

{gpp_client-26.5.0.dev2 → gpp_client-26.5.1.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gpp-client
-Version: 26.5.0.dev2
+Version: 26.5.1.dev2
 Summary: Gemini Program Platform client.
 Project-URL: Homepage, https://github.com/gemini-hlsw/gpp-client
 Project-URL: Source, https://github.com/gemini-hlsw/gpp-client

{gpp_client-26.5.0.dev2 → gpp_client-26.5.1.dev2}/src/gpp_client/client.py

@@ -142,6 +142,8 @@ class GPPClient:
             url=graphql_url,
             headers=headers,
             ws_url=ws_url,
+            ws_headers=headers,
+            ws_connection_init_payload=headers,
         )
 
     def _build_rest_client(self) -> RESTClient:

{gpp_client-26.5.0.dev2 → gpp_client-26.5.1.dev2}/src/gpp_client/domains/scheduler.py

@@ -5,9 +5,10 @@ Module for retrieving scheduler information.
 __all__ = ["SchedulerDomain"]
 
 from datetime import datetime
-from typing import Any
+from typing import Any, AsyncIterator
 
 from gpp_client.domains.base import BaseDomain
+from gpp_client.generated import SchedulerObservationsUpdates
 from gpp_client.generated.get_scheduler_all_programs_id import (
     GetSchedulerAllProgramsId,
 )
@@ -91,6 +92,8 @@ class SchedulerDomain(BaseDomain):
                 time_estimate,
                 step_types,
                 lamp_types,
+                step_index,
+                step_count,
             ) = atom_digest.split("\t")
             obs_atoms_mapping.setdefault(obs_id, [])
             obs_atoms_mapping[obs_id].append(
@@ -101,6 +104,8 @@ class SchedulerDomain(BaseDomain):
                     "time_estimate": time_estimate,
                     "step_types": step_types,
                     "lamp_types": lamp_types,
+                    "step_index": step_index,
+                    "step_count": step_count,
                 }
             )
 
@@ -278,3 +283,20 @@ class SchedulerDomain(BaseDomain):
         today = datetime.today().date().isoformat() if date is None else date
         response = await self.get_program_ids(today=today)
         return [(p.reference.label, p.id) for p in response.programs.matches]
+
+    async def subscribe_to_calculation_updates(
+        self,
+    ) -> AsyncIterator[SchedulerObservationsUpdates]:
+        """
+        Subscribe to observation calculation update events with the
+        execution flag set to true so only executed events are sent.
+
+        Yields
+        ------
+        SchedulerObservationsUpdates
+            Observation calculation update events.
+        """
+        async for event in self._graphql.scheduler_observations_updates(
+            executable_only=True
+        ):
+            yield event

{gpp_client-26.5.0.dev2 → gpp_client-26.5.1.dev2}/src/gpp_client/generated/__init__.py

@@ -230,6 +230,15 @@ from .fragments import (
     ConstraintSetDetailsElevationRange,
     ConstraintSetDetailsElevationRangeAirMass,
     ConstraintSetDetailsElevationRangeHourAngle,
+    ExecutionDetails,
+    ExecutionDetailsDigest,
+    ExecutionDetailsDigestValue,
+    ExecutionDetailsDigestValueAcquisition,
+    ExecutionDetailsDigestValueAcquisitionTimeEstimate,
+    ExecutionDetailsDigestValueAcquisitionTimeEstimateTotal,
+    ExecutionDetailsDigestValueSetup,
+    ExecutionDetailsDigestValueSetupFull,
+    ExecutionDetailsDigestValueSetupReacquisition,
     ExposureTimeModeDetails,
     ExposureTimeModeDetailsSignalToNoise,
     ExposureTimeModeDetailsSignalToNoiseAt,
@@ -268,6 +277,8 @@ from .fragments import (
     ObservationDetailsTargetEnvironment,
     ObservationDetailsTimingWindows,
     ObservationDetailsWorkflow,
+    ObservationExecution,
+    ObservationExecutionExecution,
     ObservationWorkflowCore,
     ObservationWorkflowDetails,
     ObservationWorkflowDetailsValidationErrors,
@@ -1127,6 +1138,17 @@ from .restore_target_by_id import (
     RestoreTargetByIdUpdateTargetsTargets,
     RestoreTargetByIdUpdateTargetsTargetsProgram,
 )
+from .scheduler_observations_updates import (
+    SchedulerObservationsUpdates,
+    SchedulerObservationsUpdatesObscalcUpdate,
+    SchedulerObservationsUpdatesObscalcUpdateValue,
+    SchedulerObservationsUpdatesObscalcUpdateValueExecution,
+    SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisits,
+    SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatches,
+    SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesAtomRecords,
+    SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesAtomRecordsMatches,
+    SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesObservation,
+)
 from .set_observation_workflow_state import (
     SetObservationWorkflowState,
     SetObservationWorkflowStateSetObservationWorkflowState,
@@ -1324,6 +1346,15 @@ __all__ = [
     "EmissionLinesSurfaceInput",
     "EnumeratedTelescopeConfigGeneratorInput",
     "EphemerisKeyType",
+    "ExecutionDetails",
+    "ExecutionDetailsDigest",
+    "ExecutionDetailsDigestValue",
+    "ExecutionDetailsDigestValueAcquisition",
+    "ExecutionDetailsDigestValueAcquisitionTimeEstimate",
+    "ExecutionDetailsDigestValueAcquisitionTimeEstimateTotal",
+    "ExecutionDetailsDigestValueSetup",
+    "ExecutionDetailsDigestValueSetupFull",
+    "ExecutionDetailsDigestValueSetupReacquisition",
     "ExecutionEventAddedInput",
     "ExecutionEventType",
     "ExecutionState",
@@ -1923,6 +1954,8 @@ __all__ = [
     "ObservationEditObservationEditValueTimingWindowsEndTimingWindowEndAfterRepeat",
     "ObservationEditObservationEditValueTimingWindowsEndTimingWindowEndAfterRepeatPeriod",
     "ObservationEditObservationEditValueTimingWindowsEndTimingWindowEndAt",
+    "ObservationExecution",
+    "ObservationExecutionExecution",
     "ObservationPropertiesInput",
     "ObservationTimesInput",
     "ObservationValidationCode",
@@ -2045,6 +2078,15 @@ __all__ = [
     "RevokeUserInvitationInput",
     "RightAscensionArcInput",
     "RightAscensionInput",
+    "SchedulerObservationsUpdates",
+    "SchedulerObservationsUpdatesObscalcUpdate",
+    "SchedulerObservationsUpdatesObscalcUpdateValue",
+    "SchedulerObservationsUpdatesObscalcUpdateValueExecution",
+    "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisits",
+    "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatches",
+    "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesAtomRecords",
+    "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesAtomRecordsMatches",
+    "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesObservation",
     "ScienceBand",
     "ScienceMode",
     "ScienceRequirementsDetails",

{gpp_client-26.5.0.dev2 → gpp_client-26.5.1.dev2}/src/gpp_client/generated/client.py

@@ -80,6 +80,7 @@ from .restore_observation_by_id import RestoreObservationById
 from .restore_observation_by_reference import RestoreObservationByReference
 from .restore_program_by_id import RestoreProgramById
 from .restore_target_by_id import RestoreTargetById
+from .scheduler_observations_updates import SchedulerObservationsUpdates
 from .set_observation_workflow_state import SetObservationWorkflowState
 from .target_edit import TargetEdit
 from .update_call_for_proposals_by_id import UpdateCallForProposalsById
@@ -98,6 +99,46 @@ def gql(q: str) -> str:
 
 
 class GraphQLClient(AsyncBaseClient):
+    async def scheduler_observations_updates(
+        self, executable_only: Union[Optional[bool], UnsetType] = UNSET, **kwargs: Any
+    ) -> AsyncIterator[SchedulerObservationsUpdates]:
+        query = gql("""
+            subscription SchedulerObservationsUpdates($executableOnly: Boolean) {
+              obscalcUpdate(input: {executableOnly: $executableOnly}) {
+                oldCalculationState
+                newCalculationState
+                editType
+                value {
+                  id
+                  observationTime
+                  execution {
+                    visits {
+                      matches {
+                        observation {
+                          id
+                        }
+                        atomRecords {
+                          matches {
+                            executionState
+                            id
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+            """)
+        variables: dict[str, object] = {"executableOnly": executable_only}
+        async for data in self.execute_ws(
+            query=query,
+            operation_name="SchedulerObservationsUpdates",
+            variables=variables,
+            **kwargs,
+        ):
+            yield SchedulerObservationsUpdates.model_validate(data)
+
     async def get_observation_attachments_by_id(
         self, observation_id: Any, **kwargs: Any
     ) -> GetObservationAttachmentsById:

{gpp_client-26.5.0.dev2 → gpp_client-26.5.1.dev2}/src/gpp_client/generated/fragments.py

@@ -101,6 +101,46 @@ class ConstraintSetDetailsElevationRangeHourAngle(BaseModel):
     max_hours: Any = Field(alias="maxHours")
 
 
+class ExecutionDetails(BaseModel):
+    digest: Optional["ExecutionDetailsDigest"]
+
+
+class ExecutionDetailsDigest(BaseModel):
+    value: Optional["ExecutionDetailsDigestValue"]
+
+
+class ExecutionDetailsDigestValue(BaseModel):
+    acquisition: Optional["ExecutionDetailsDigestValueAcquisition"]
+    setup: "ExecutionDetailsDigestValueSetup"
+
+
+class ExecutionDetailsDigestValueAcquisition(BaseModel):
+    time_estimate: "ExecutionDetailsDigestValueAcquisitionTimeEstimate" = Field(
+        alias="timeEstimate"
+    )
+
+
+class ExecutionDetailsDigestValueAcquisitionTimeEstimate(BaseModel):
+    total: "ExecutionDetailsDigestValueAcquisitionTimeEstimateTotal"
+
+
+class ExecutionDetailsDigestValueAcquisitionTimeEstimateTotal(BaseModel):
+    seconds: Any
+
+
+class ExecutionDetailsDigestValueSetup(BaseModel):
+    full: "ExecutionDetailsDigestValueSetupFull"
+    reacquisition: "ExecutionDetailsDigestValueSetupReacquisition"
+
+
+class ExecutionDetailsDigestValueSetupFull(BaseModel):
+    seconds: Any
+
+
+class ExecutionDetailsDigestValueSetupReacquisition(BaseModel):
+    seconds: Any
+
+
 class ExposureTimeModeDetails(BaseModel):
     signal_to_noise: Optional["ExposureTimeModeDetailsSignalToNoise"] = Field(
         alias="signalToNoise"
@@ -490,6 +530,14 @@ class ObservationDetailsTargetEnvironment(TargetEnvironmentDetails):
     pass
 
 
+class ObservationExecution(BaseModel):
+    execution: "ObservationExecutionExecution"
+
+
+class ObservationExecutionExecution(ExecutionDetails):
+    pass
+
+
 class ObservationWorkflowCore(BaseModel):
     state: ObservationWorkflowState
 
@@ -654,6 +702,7 @@ AttachmentDetails.model_rebuild()
 CallForProposalsCore.model_rebuild()
 CallForProposalsDetails.model_rebuild()
 ConstraintSetDetails.model_rebuild()
+ExecutionDetails.model_rebuild()
 ExposureTimeModeDetails.model_rebuild()
 Flamingos2LongSlitDetails.model_rebuild()
 GmosNorthImagingDetails.model_rebuild()
@@ -671,6 +720,7 @@ TimingWindowDetails.model_rebuild()
 WorkflowCore.model_rebuild()
 WorkflowDetails.model_rebuild()
 ObservationDetails.model_rebuild()
+ObservationExecution.model_rebuild()
 ObservationWorkflowCore.model_rebuild()
 ObservationWorkflowDetails.model_rebuild()
 OpportunityTargetDetails.model_rebuild()

gpp_client-26.5.1.dev2/src/gpp_client/generated/scheduler_observations_updates.py

@@ -0,0 +1,76 @@
+from typing import Any, Optional
+
+from pydantic import Field
+
+from .base_model import BaseModel
+from .enums import AtomExecutionState, CalculationState, EditType
+
+
+class SchedulerObservationsUpdates(BaseModel):
+    obscalc_update: "SchedulerObservationsUpdatesObscalcUpdate" = Field(
+        alias="obscalcUpdate"
+    )
+
+
+class SchedulerObservationsUpdatesObscalcUpdate(BaseModel):
+    old_calculation_state: Optional[CalculationState] = Field(
+        alias="oldCalculationState"
+    )
+    new_calculation_state: Optional[CalculationState] = Field(
+        alias="newCalculationState"
+    )
+    edit_type: EditType = Field(alias="editType")
+    value: Optional["SchedulerObservationsUpdatesObscalcUpdateValue"]
+
+
+class SchedulerObservationsUpdatesObscalcUpdateValue(BaseModel):
+    id: Any
+    observation_time: Optional[Any] = Field(alias="observationTime")
+    execution: "SchedulerObservationsUpdatesObscalcUpdateValueExecution"
+
+
+class SchedulerObservationsUpdatesObscalcUpdateValueExecution(BaseModel):
+    visits: "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisits"
+
+
+class SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisits(BaseModel):
+    matches: list[
+        "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatches"
+    ]
+
+
+class SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatches(BaseModel):
+    observation: "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesObservation"
+    atom_records: "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesAtomRecords" = Field(
+        alias="atomRecords"
+    )
+
+
+class SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesObservation(
+    BaseModel
+):
+    id: Any
+
+
+class SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesAtomRecords(
+    BaseModel
+):
+    matches: list[
+        "SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesAtomRecordsMatches"
+    ]
+
+
+class SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesAtomRecordsMatches(
+    BaseModel
+):
+    execution_state: AtomExecutionState = Field(alias="executionState")
+    id: Any
+
+
+SchedulerObservationsUpdates.model_rebuild()
+SchedulerObservationsUpdatesObscalcUpdate.model_rebuild()
+SchedulerObservationsUpdatesObscalcUpdateValue.model_rebuild()
+SchedulerObservationsUpdatesObscalcUpdateValueExecution.model_rebuild()
+SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisits.model_rebuild()
+SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatches.model_rebuild()
+SchedulerObservationsUpdatesObscalcUpdateValueExecutionVisitsMatchesAtomRecords.model_rebuild()