nominal 1.101.0__py3-none-any.whl → 1.103.0__py3-none-any.whl

nominal/core/dataset.py

@@ -14,6 +14,7 @@ from typing_extensions import Self, deprecated
 
 from nominal.core._stream.batch_processor import process_log_batch
 from nominal.core._stream.write_stream import LogStream, WriteStream
+from nominal.core._types import PathLike
 from nominal.core._utils.api_tools import RefreshableMixin
 from nominal.core._utils.multipart import path_upload_name, upload_multipart_file, upload_multipart_io
 from nominal.core.bounds import Bounds
@@ -112,7 +113,7 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
 
     def add_tabular_data(
         self,
-        path: Path | str,
+        path: PathLike,
         timestamp_column: str,
         timestamp_type: _AnyTimestampType,
         tag_columns: Mapping[str, str] | None = None,
@@ -206,7 +207,7 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
 
     def add_avro_stream(
         self,
-        path: Path | str,
+        path: PathLike,
     ) -> DatasetFile:
         """Upload an avro stream file with a specific schema, described below.
 
@@ -278,7 +279,7 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
 
     def add_journal_json(
         self,
-        path: Path | str,
+        path: PathLike,
     ) -> DatasetFile:
         """Add a journald jsonl file to an existing dataset."""
         log_path = Path(path)
@@ -310,7 +311,7 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
 
     def add_mcap(
         self,
-        path: Path | str,
+        path: PathLike,
         include_topics: Iterable[str] | None = None,
         exclude_topics: Iterable[str] | None = None,
     ) -> DatasetFile:
@@ -384,7 +385,7 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
 
     def add_ardupilot_dataflash(
         self,
-        path: Path | str,
+        path: PathLike,
         tags: Mapping[str, str] | None = None,
     ) -> DatasetFile:
         """Add a Dataflash file to an existing dataset.
@@ -415,7 +416,7 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
     def add_containerized(
         self,
         extractor: str | ContainerizedExtractor,
-        sources: Mapping[str, Path | str],
+        sources: Mapping[str, PathLike],
         tag: str | None = None,
         *,
         arguments: Mapping[str, str] | None = None,
@@ -425,7 +426,7 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
     def add_containerized(
         self,
         extractor: str | ContainerizedExtractor,
-        sources: Mapping[str, Path | str],
+        sources: Mapping[str, PathLike],
         tag: str | None = None,
         *,
         arguments: Mapping[str, str] | None = None,
@@ -436,7 +437,7 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
     def add_containerized(
         self,
         extractor: str | ContainerizedExtractor,
-        sources: Mapping[str, Path | str],
+        sources: Mapping[str, PathLike],
         tag: str | None = None,
         *,
         arguments: Mapping[str, str] | None = None,
@@ -708,7 +709,7 @@ class _DatasetWrapper(abc.ABC):
     def add_tabular_data(
         self,
         data_scope_name: str,
-        path: Path | str,
+        path: PathLike,
         *,
         timestamp_column: str,
         timestamp_type: _AnyTimestampType,
@@ -735,7 +736,7 @@ class _DatasetWrapper(abc.ABC):
     def add_avro_stream(
         self,
         data_scope_name: str,
-        path: Path | str,
+        path: PathLike,
     ) -> DatasetFile:
         """Upload an avro stream file to the dataset selected by `data_scope_name`.
 
@@ -761,7 +762,7 @@ class _DatasetWrapper(abc.ABC):
     def add_journal_json(
         self,
         data_scope_name: str,
-        path: Path | str,
+        path: PathLike,
     ) -> DatasetFile:
         """Add a journald json file to the dataset selected by `data_scope_name`.
 
@@ -787,7 +788,7 @@ class _DatasetWrapper(abc.ABC):
     def add_mcap(
         self,
         data_scope_name: str,
-        path: Path | str,
+        path: PathLike,
         *,
         include_topics: Iterable[str] | None = None,
         exclude_topics: Iterable[str] | None = None,
@@ -815,7 +816,7 @@ class _DatasetWrapper(abc.ABC):
     def add_ardupilot_dataflash(
         self,
         data_scope_name: str,
-        path: Path | str,
+        path: PathLike,
         tags: Mapping[str, str] | None = None,
     ) -> DatasetFile:
         """Add a Dataflash file to the dataset selected by `data_scope_name`.
@@ -835,7 +836,7 @@ class _DatasetWrapper(abc.ABC):
         self,
         data_scope_name: str,
         extractor: str | ContainerizedExtractor,
-        sources: Mapping[str, Path | str],
+        sources: Mapping[str, PathLike],
         *,
         tag: str | None = None,
         tags: Mapping[str, str] | None = None,
@@ -845,7 +846,7 @@ class _DatasetWrapper(abc.ABC):
         self,
         data_scope_name: str,
         extractor: str | ContainerizedExtractor,
-        sources: Mapping[str, Path | str],
+        sources: Mapping[str, PathLike],
         *,
         tag: str | None = None,
         tags: Mapping[str, str] | None = None,
@@ -856,7 +857,7 @@ class _DatasetWrapper(abc.ABC):
         self,
         data_scope_name: str,
         extractor: str | ContainerizedExtractor,
-        sources: Mapping[str, Path | str],
+        sources: Mapping[str, PathLike],
         *,
         tag: str | None = None,
         tags: Mapping[str, str] | None = None,

nominal/core/dataset_file.py

@@ -13,6 +13,7 @@ from nominal_api import api, ingest_api, scout_catalog
 from typing_extensions import Self
 
 from nominal.core._clientsbunch import HasScoutParams
+from nominal.core._types import PathLike
 from nominal.core._utils.api_tools import RefreshableMixin
 from nominal.core._utils.multipart import DEFAULT_CHUNK_SIZE
 from nominal.core._utils.multipart_downloader import (
@@ -128,7 +129,7 @@ class DatasetFile(RefreshableMixin[scout_catalog.DatasetFile]):
 
     def download(
         self,
-        output_directory: pathlib.Path,
+        output_directory: PathLike,
         *,
         part_size: int = DEFAULT_CHUNK_SIZE,
         num_retries: int = 3,
@@ -148,6 +149,7 @@ class DatasetFile(RefreshableMixin[scout_catalog.DatasetFile]):
             FileExistsError: File already exists at destination
             RuntimeError: Error downloading file
         """
+        output_directory = pathlib.Path(output_directory)
         if output_directory.exists() and not output_directory.is_dir():
             raise NotADirectoryError(f"Output directory is not a directory: {output_directory}")
 
@@ -160,7 +162,7 @@ class DatasetFile(RefreshableMixin[scout_catalog.DatasetFile]):
 
     def download_original_files(
         self,
-        output_directory: pathlib.Path,
+        output_directory: PathLike,
         *,
         part_size: int = DEFAULT_CHUNK_SIZE,
         num_retries: int = 3,
@@ -184,6 +186,7 @@ class DatasetFile(RefreshableMixin[scout_catalog.DatasetFile]):
         NOTE: any file that fails to download will result in an error log and will not be returned
               as an output path
         """
+        output_directory = pathlib.Path(output_directory)
         if output_directory.exists() and not output_directory.is_dir():
             raise NotADirectoryError(f"Output directory is not a directory: {output_directory}")
 

nominal/core/datasource.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import logging
-import pathlib
 from dataclasses import dataclass, field
 from datetime import timedelta
 from typing import Iterable, Literal, Mapping, Protocol, Sequence, overload
@@ -27,6 +26,7 @@ from nominal._utils import batched
 from nominal.core._clientsbunch import HasScoutParams, ProtoWriteService
 from nominal.core._stream.batch_processor import process_batch_legacy
 from nominal.core._stream.write_stream import DataStream, WriteStream
+from nominal.core._types import PathLike
 from nominal.core._utils.api_tools import HasRid
 from nominal.core.channel import Channel, ChannelDataType
 from nominal.core.unit import UnitMapping, _build_unit_update, _error_on_invalid_units
@@ -125,7 +125,7 @@ class DataSource(HasRid):
         batch_size: int = 50_000,
         max_wait: timedelta = timedelta(seconds=1),
         data_format: Literal["rust_experimental"] | None = None,
-        file_fallback: pathlib.Path | None = None,
+        file_fallback: PathLike | None = None,
         log_level: str | None = None,
         num_workers: int | None = None,
     ) -> DataStream: ...
@@ -134,7 +134,7 @@ class DataSource(HasRid):
         batch_size: int = 50_000,
         max_wait: timedelta = timedelta(seconds=1),
         data_format: Literal["json", "protobuf", "experimental", "rust_experimental"] | None = None,
-        file_fallback: pathlib.Path | None = None,
+        file_fallback: PathLike | None = None,
         log_level: str | None = None,
         num_workers: int | None = None,
     ) -> DataStream:
@@ -327,7 +327,7 @@ def _get_write_stream(
     batch_size: int,
     max_wait: timedelta,
     data_format: Literal["json", "protobuf", "experimental", "rust_experimental"] | None,
-    file_fallback: pathlib.Path | None,
+    file_fallback: PathLike | None,
     log_level: str | None,
     num_workers: int | None,
     write_rid: str,

nominal/core/event.py

@@ -3,16 +3,18 @@ from __future__ import annotations
 import warnings
 from dataclasses import dataclass, field
 from datetime import datetime, timedelta
-from enum import Enum
 from typing import Iterable, Mapping, Protocol, Sequence
 
-from nominal_api import api, event
+from nominal_api import event
 from typing_extensions import Self
 
 from nominal.core import asset as core_asset
 from nominal.core._clientsbunch import HasScoutParams
+from nominal.core._event_types import EventType as EventType  # noqa: PLC0414
+from nominal.core._event_types import SearchEventOriginType as SearchEventOriginType  # noqa: PLC0414
 from nominal.core._utils.api_tools import HasRid, RefreshableMixin, rid_from_instance_or_string
 from nominal.core._utils.pagination_tools import search_events_paginated
+from nominal.core._utils.query_tools import _create_search_events_query
 from nominal.ts import IntegralNanosecondsDuration, IntegralNanosecondsUTC, _SecondsNanos, _to_api_duration
 
 
@@ -124,39 +126,6 @@ class Event(HasRid, RefreshableMixin[event.Event]):
         )
 
 
-class EventType(Enum):
-    INFO = "INFO"
-    FLAG = "FLAG"
-    ERROR = "ERROR"
-    SUCCESS = "SUCCESS"
-    UNKNOWN = "UNKNOWN"
-
-    @classmethod
-    def from_api_event_type(cls, event: event.EventType) -> EventType:
-        if event.name == "INFO":
-            return cls.INFO
-        elif event.name == "FLAG":
-            return cls.FLAG
-        elif event.name == "ERROR":
-            return cls.ERROR
-        elif event.name == "SUCCESS":
-            return cls.SUCCESS
-        else:
-            return cls.UNKNOWN
-
-    def _to_api_event_type(self) -> event.EventType:
-        if self.name == "INFO":
-            return event.EventType.INFO
-        elif self.name == "FLAG":
-            return event.EventType.FLAG
-        elif self.name == "ERROR":
-            return event.EventType.ERROR
-        elif self.name == "SUCCESS":
-            return event.EventType.SUCCESS
-        else:
-            return event.EventType.UNKNOWN
-
-
 def _create_event(
     clients: Event._Clients,
     *,
@@ -203,6 +172,7 @@ def _search_events(
     data_review_rid: str | None = None,
     assignee_rid: str | None = None,
     event_type: EventType | None = None,
+    origin_types: Iterable[SearchEventOriginType] | None = None,
     workspace_rid: str | None = None,
 ) -> Sequence[Event]:
     query = _create_search_events_query(
@@ -216,53 +186,10 @@ def _search_events(
         workbook_rid=workbook_rid,
         data_review_rid=data_review_rid,
         assignee_rid=assignee_rid,
-        event_type=event_type,
+        event_type=event_type._to_api_event_type() if event_type else None,
+        origin_types=[origin_type._to_api_search_event_origin_type() for origin_type in origin_types]
+        if origin_types
+        else None,
         workspace_rid=workspace_rid,
     )
     return list(_iter_search_events(clients, query))
-
-
-def _create_search_events_query(  # noqa: PLR0912
-    search_text: str | None = None,
-    after: str | datetime | IntegralNanosecondsUTC | None = None,
-    before: str | datetime | IntegralNanosecondsUTC | None = None,
-    asset_rids: Iterable[str] | None = None,
-    labels: Iterable[str] | None = None,
-    properties: Mapping[str, str] | None = None,
-    created_by_rid: str | None = None,
-    workbook_rid: str | None = None,
-    data_review_rid: str | None = None,
-    assignee_rid: str | None = None,
-    event_type: EventType | None = None,
-    workspace_rid: str | None = None,
-) -> event.SearchQuery:
-    queries = []
-    if search_text is not None:
-        queries.append(event.SearchQuery(search_text=search_text))
-    if after is not None:
-        queries.append(event.SearchQuery(after=_SecondsNanos.from_flexible(after).to_api()))
-    if before is not None:
-        queries.append(event.SearchQuery(before=_SecondsNanos.from_flexible(before).to_api()))
-    if asset_rids:
-        for asset in asset_rids:
-            queries.append(event.SearchQuery(asset=asset))
-    if labels:
-        for label in labels:
-            queries.append(event.SearchQuery(label=label))
-    if properties:
-        for name, value in properties.items():
-            queries.append(event.SearchQuery(property=api.Property(name=name, value=value)))
-    if created_by_rid:
-        queries.append(event.SearchQuery(created_by=created_by_rid))
-    if workbook_rid is not None:
-        queries.append(event.SearchQuery(workbook=workbook_rid))
-    if data_review_rid is not None:
-        queries.append(event.SearchQuery(data_review=data_review_rid))
-    if assignee_rid is not None:
-        queries.append(event.SearchQuery(assignee=assignee_rid))
-    if event_type is not None:
-        queries.append(event.SearchQuery(event_type=event_type._to_api_event_type()))
-    if workspace_rid is not None:
-        queries.append(event.SearchQuery(workspace=workspace_rid))
-
-    return event.SearchQuery(and_=queries)

nominal/core/filetype.py

@@ -5,6 +5,8 @@ import mimetypes
 from pathlib import Path
 from typing import NamedTuple
 
+from nominal.core._types import PathLike
+
 logger = logging.getLogger(__name__)
 
 
@@ -13,7 +15,7 @@ class FileType(NamedTuple):
     mimetype: str
 
     @classmethod
-    def from_path(cls, path: Path | str, default_mimetype: str = "application/octect-stream") -> FileType:
+    def from_path(cls, path: PathLike, default_mimetype: str = "application/octect-stream") -> FileType:
         path = Path(path)
 
         # Note: not using path.suffix because this fails for files with multiple suffixes,
@@ -70,7 +72,7 @@ class FileType(NamedTuple):
         return self in FileTypes._VIDEO_TYPES
 
     @classmethod
-    def from_path_dataset(cls, path: Path | str) -> FileType:
+    def from_path_dataset(cls, path: PathLike) -> FileType:
         file_type = cls.from_path(path)
         if not file_type.is_parquet_file() and not file_type.is_csv():
             allowed_extensions = (*FileTypes._PARQUET_FILE_TYPES, *FileTypes._CSV_TYPES)
@@ -79,7 +81,7 @@ class FileType(NamedTuple):
         return file_type
 
     @classmethod
-    def from_tabular(cls, path: Path | str) -> FileType:
+    def from_tabular(cls, path: PathLike) -> FileType:
         file_type = cls.from_path(path)
         if not file_type.is_csv() and not file_type.is_parquet():
             allowed_extensions = (
@@ -92,7 +94,7 @@ class FileType(NamedTuple):
         return file_type
 
     @classmethod
-    def from_path_journal_json(cls, path: Path | str) -> FileType:
+    def from_path_journal_json(cls, path: PathLike) -> FileType:
         file_type = cls.from_path(path)
         if not file_type.is_journal():
             raise ValueError(
@@ -102,7 +104,7 @@ class FileType(NamedTuple):
         return file_type
 
     @classmethod
-    def from_video(cls, path: Path | str) -> FileType:
+    def from_video(cls, path: PathLike) -> FileType:
         file_type = cls.from_path(path)
         if not file_type.is_video():
             raise ValueError(f"video path '{path}' must end in one of {[f.extension for f in FileTypes._VIDEO_TYPES]}")

nominal/core/run.py

@@ -13,6 +13,7 @@ from typing_extensions import Self
 
 from nominal.core import asset as core_asset
 from nominal.core._clientsbunch import HasScoutParams
+from nominal.core._event_types import EventType
 from nominal.core._utils.api_tools import (
     HasRid,
     Link,
@@ -25,7 +26,7 @@ from nominal.core.asset import _filter_scopes
 from nominal.core.attachment import Attachment, _iter_get_attachments
 from nominal.core.connection import Connection, _get_connections
 from nominal.core.dataset import Dataset, _DatasetWrapper, _get_datasets
-from nominal.core.event import Event, EventType, _create_event
+from nominal.core.event import Event, _create_event
 from nominal.core.video import Video, _get_video
 from nominal.ts import IntegralNanosecondsDuration, IntegralNanosecondsUTC, _SecondsNanos, _to_api_duration
 
@@ -372,11 +373,13 @@ class Run(HasRid, RefreshableMixin[scout_run_api.Run], _DatasetWrapper):
     def archive(self) -> None:
         """Archive this run.
         Archived runs are not deleted, but are hidden from the UI.
-
-        NOTE: currently, it is not possible (yet) to unarchive a run once archived.
         """
         self._clients.run.archive_run(self._clients.auth_header, self.rid)
 
+    def unarchive(self) -> None:
+        """Unarchive this run, allowing it to appear on the UI."""
+        self._clients.run.unarchive_run(self._clients.auth_header, self.rid)
+
     @classmethod
     def _from_conjure(cls, clients: _Clients, run: scout_run_api.Run) -> Self:
         return cls(

nominal/core/video.py

@@ -14,6 +14,7 @@ from nominal_api import api, ingest_api, scout_video, scout_video_api, upload_ap
 from typing_extensions import Self
 
 from nominal.core._clientsbunch import HasScoutParams
+from nominal.core._types import PathLike
 from nominal.core._utils.api_tools import HasRid, RefreshableMixin
 from nominal.core._utils.multipart import path_upload_name, upload_multipart_io
 from nominal.core.exceptions import NominalIngestError, NominalIngestFailed
@@ -118,7 +119,7 @@ class Video(HasRid, RefreshableMixin[scout_video_api.Video]):
 
     def add_file(
         self,
-        path: pathlib.Path | str,
+        path: PathLike,
         start: datetime | IntegralNanosecondsUTC | None = None,
         frame_timestamps: Sequence[IntegralNanosecondsUTC] | None = None,
         description: str | None = None,
@@ -212,7 +213,7 @@ class Video(HasRid, RefreshableMixin[scout_video_api.Video]):
 
     def add_mcap(
         self,
-        path: pathlib.Path,
+        path: PathLike,
         topic: str,
         description: str | None = None,
     ) -> VideoFile: