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

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.103.0](https://github.com/nominal-io/nominal-client/compare/v1.102.0...v1.103.0) (2026-01-06)
+
+
+### Features
+
+* add clone/copy run ([#563](https://github.com/nominal-io/nominal-client/issues/563)) ([276c511](https://github.com/nominal-io/nominal-client/commit/276c511d10c73b9f80ea2efed32d4047fe33795b))
+* universally support paths and strings, and add PathLike alias ([#566](https://github.com/nominal-io/nominal-client/issues/566)) ([860dd3d](https://github.com/nominal-io/nominal-client/commit/860dd3d67456d269356b66b5434b904647e5a2ff))
+
 ## [1.102.0](https://github.com/nominal-io/nominal-client/compare/v1.101.0...v1.102.0) (2026-01-05)
 
 

nominal/core/_types.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+import pathlib
+from typing import TypeAlias
+
+PathLike: TypeAlias = pathlib.Path | str

nominal/core/attachment.py

@@ -10,6 +10,7 @@ from nominal_api import attachments_api
 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.ts import IntegralNanosecondsUTC, _SecondsNanos
 
@@ -69,11 +70,12 @@ class Attachment(HasRid, RefreshableMixin[attachments_api.Attachment]):
         # this acts like a file-like object in binary-mode.
         return cast(BinaryIO, response)
 
-    def write(self, path: Path, mkdir: bool = True) -> None:
+    def write(self, path: PathLike, mkdir: bool = True) -> None:
         """Write an attachment to the filesystem.
 
         `path` should be the path you want to save to, i.e. a file, not a directory.
         """
+        path = Path(path)
         if mkdir:
             path.parent.mkdir(exist_ok=True, parents=True)
         with open(path, "wb") as wf:

nominal/core/client.py

@@ -37,6 +37,7 @@ from nominal.config import NominalConfig, _config
 from nominal.core._clientsbunch import ClientsBunch
 from nominal.core._constants import DEFAULT_API_BASE_URL
 from nominal.core._event_types import EventType
+from nominal.core._types import PathLike
 from nominal.core._utils.api_tools import (
     Link,
     LinkDict,
@@ -853,7 +854,7 @@ class NominalClient:
 
     def create_attachment(
         self,
-        attachment_file: Path | str,
+        attachment_file: PathLike,
         *,
         description: str | None = None,
         properties: Mapping[str, str] | None = None,
@@ -965,7 +966,7 @@ class NominalClient:
     )
     def create_video_from_mcap(
         self,
-        path: Path | str,
+        path: PathLike,
         topic: str,
         name: str | None = None,
         description: str | None = None,

nominal/core/connection.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import pathlib
 from dataclasses import dataclass
 from datetime import timedelta
 from typing import Literal, Sequence, overload
@@ -8,6 +7,7 @@ from typing import Literal, Sequence, overload
 from nominal_api import scout_datasource_connection_api
 
 from nominal.core._stream.write_stream import DataStream
+from nominal.core._types import PathLike
 from nominal.core.datasource import DataSource, _get_write_stream
 
 
@@ -71,7 +71,7 @@ class StreamingConnection(Connection):
         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: ...
@@ -80,7 +80,7 @@ class StreamingConnection(Connection):
         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:

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/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/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:

nominal/experimental/migration/migration_utils.py

@@ -23,6 +23,9 @@ from nominal.core import (
     WorkbookTemplate,
 )
 from nominal.core._event_types import EventType, SearchEventOriginType
+from nominal.core._utils.api_tools import Link, LinkDict
+from nominal.core.attachment import Attachment
+from nominal.core.run import Run
 from nominal.ts import (
     IntegralNanosecondsDuration,
     IntegralNanosecondsUTC,
@@ -523,6 +526,75 @@ def copy_event_from(
     return new_event
 
 
+def clone_run(source_run: Run, destination_client: NominalClient) -> Run:
+    """Clones a run, maintaining all properties, linked assets, and attachments.
+
+    Args:
+        source_run: The run to copy from.
+        destination_client: The destination client.
+
+    Returns:
+        The cloned run.
+    """
+    return copy_run_from(source_run=source_run, destination_client=destination_client)
+
+
+def copy_run_from(
+    source_run: Run,
+    destination_client: NominalClient,
+    *,
+    new_name: str | None = None,
+    new_start: datetime | IntegralNanosecondsUTC | None = None,
+    new_end: datetime | IntegralNanosecondsUTC | None = None,
+    new_description: str | None = None,
+    new_properties: Mapping[str, str] | None = None,
+    new_labels: Sequence[str] = (),
+    new_links: Sequence[str | Link | LinkDict] = (),
+    new_attachments: Iterable[Attachment] | Iterable[str] = (),
+    new_assets: Sequence[Asset | str] = (),
+) -> Run:
+    """Copy a run from the source to the destination client.
+
+    Args:
+        source_run: The source Run to copy.
+        destination_client: The NominalClient to create the copied run in.
+        new_name: Optionally override the name of the copied run. Defaults to original name.
+        new_start: Optionally override the start time of the copied run. Defaults to original start time.
+        new_end: Optionally override the end time of the copied run. Defaults to original end time.
+        new_description: Optionally override the description of the copied run. Defaults to original description.
+        new_properties: Optionally override the properties of the copied run. Defaults to original properties.
+        new_labels: Optionally override the labels of the copied run. Defaults to original labels.
+        new_links: Optionally override the links of the copied run. Defaults to original links.
+        new_attachments: Optionally override the attachments of the copied run. Defaults to original attachments.
+        new_assets: Optionally override the linked assets of the copied run. Defaults to original linked assets.
+
+    Returns:
+        The newly created Run in the destination client.
+    """
+    log_extras = {
+        "destination_client_workspace": destination_client.get_workspace(destination_client._clients.workspace_rid).rid
+    }
+    logger.debug(
+        "Copying run %s (rid: %s)",
+        source_run.name,
+        source_run.rid,
+        extra=log_extras,
+    )
+    new_run = destination_client.create_run(
+        name=new_name or source_run.name,
+        start=new_start or source_run.start,
+        end=new_end or source_run.end,
+        description=new_description or source_run.description,
+        properties=new_properties or source_run.properties,
+        labels=new_labels or source_run.labels,
+        assets=new_assets or source_run.assets,
+        links=new_links or source_run.links,
+        attachments=new_attachments or source_run.list_attachments(),
+    )
+    logger.debug("New run created: %s (rid: %s)", new_run.name, new_run.rid, extra=log_extras)
+    return new_run
+
+
 def clone_asset(
     source_asset: Asset,
     destination_client: NominalClient,
@@ -537,7 +609,11 @@ def clone_asset(
         The newly created Asset in the target client.
     """
     return copy_asset_from(
-        source_asset=source_asset, destination_client=destination_client, include_data=True, include_events=True
+        source_asset=source_asset,
+        destination_client=destination_client,
+        include_data=True,
+        include_events=True,
+        include_runs=True,
     )
 
 
@@ -551,6 +627,7 @@ def copy_asset_from(
     new_asset_labels: Sequence[str] | None = None,
     include_data: bool = False,
     include_events: bool = False,
+    include_runs: bool = False,
 ) -> Asset:
     """Copy an asset from the source to the destination client.
 
@@ -563,6 +640,7 @@ def copy_asset_from(
         new_asset_labels: Optional new labels for the copied asset. If not provided, the original labels are used.
         include_data: Whether to include data in the copied asset.
         include_events: Whether to include events in the copied dataset.
+        include_runs: Whether to include runs in the copied asset.
 
     Returns:
         The new asset created.
@@ -579,21 +657,23 @@ def copy_asset_from(
     )
     if include_data:
         source_datasets = source_asset.list_datasets()
-        new_datasets = []
         for data_scope, source_dataset in source_datasets:
             new_dataset = clone_dataset(
                 source_dataset=source_dataset,
                 destination_client=destination_client,
             )
-            new_datasets.append(new_dataset)
             new_asset.add_dataset(data_scope, new_dataset)
+    source_asset._list_dataset_scopes
 
     if include_events:
         source_events = source_asset.search_events(origin_types=SearchEventOriginType.get_manual_origin_types())
-        new_events = []
         for source_event in source_events:
-            new_event = copy_event_from(source_event, destination_client, new_assets=[new_asset])
-            new_events.append(new_event)
+            copy_event_from(source_event, destination_client, new_assets=[new_asset])
+
+    if include_runs:
+        source_runs = source_asset.list_runs()
+        for source_run in source_runs:
+            copy_run_from(source_run, destination_client, new_assets=[new_asset])
 
     logger.debug("New asset created: %s (rid: %s)", new_asset, new_asset.rid, extra=log_extras)
     return new_asset

nominal/experimental/rust_streaming/rust_write_stream.py

@@ -6,6 +6,7 @@ import pathlib
 from nominal_streaming import NominalDatasetStream
 
 from nominal.core._stream.write_stream import DataStream
+from nominal.core._types import PathLike
 from nominal.core.datasource import DataSource
 
 
@@ -22,7 +23,7 @@ class RustWriteStream(NominalDatasetStream, DataStream):
         datasource_clients: DataSource._Clients,
         batch_size: int,
         max_wait: datetime.timedelta,
-        file_fallback: pathlib.Path | None = None,
+        file_fallback: PathLike | None = None,
         log_level: str | None = None,
         num_workers: int | None = None,
     ) -> RustWriteStream:
@@ -41,7 +42,7 @@ class RustWriteStream(NominalDatasetStream, DataStream):
         ).with_core_consumer(datasource_rid)
 
         if file_fallback is not None:
-            stream = stream.with_file_fallback(file_fallback)
+            stream = stream.with_file_fallback(pathlib.Path(file_fallback))
 
         if log_level is not None:
             stream = stream.enable_logging(log_level)

nominal/experimental/video_processing/video_conversion.py

@@ -6,6 +6,7 @@ import shlex
 
 import ffmpeg
 
+from nominal.core._types import PathLike
 from nominal.experimental.video_processing.resolution import (
     AnyResolutionType,
     scale_factor_from_resolution,
@@ -20,8 +21,8 @@ DEFAULT_KEY_FRAME_INTERVAL_SEC = 2
 
 
 def normalize_video(
-    input_path: pathlib.Path,
-    output_path: pathlib.Path,
+    input_path: PathLike,
+    output_path: PathLike,
     key_frame_interval: int | None = DEFAULT_KEY_FRAME_INTERVAL_SEC,
     force: bool = True,
     resolution: AnyResolutionType | None = None,
@@ -59,6 +60,8 @@ def normalize_video(
 
     NOTE: this requires that you have installed ffmpeg on your system with support for H264.
     """
+    input_path = pathlib.Path(input_path)
+    output_path = pathlib.Path(output_path)
     assert input_path.exists(), "Input path must exist"
     assert output_path.suffix.lower() in (".mkv", ".mp4")
 

nominal/nominal.py

@@ -24,6 +24,7 @@ from nominal.core import (
     poll_until_ingestion_completed,
 )
 from nominal.core._constants import DEFAULT_API_BASE_URL
+from nominal.core._types import PathLike
 from nominal.core.connection import StreamingConnection
 from nominal.core.data_review import DataReview, DataReviewBuilder
 
@@ -102,7 +103,7 @@ def get_user() -> User:
     "Use `nominal.thirdparty.tdms.upload_tdms` instead."
 )
 def upload_tdms(
-    file: Path | str,
+    file: PathLike,
     name: str | None = None,
     description: str | None = None,
     timestamp_column: str | None = None,
@@ -213,7 +214,7 @@ def create_dataset(
     "Use `nominal.create_dataset` or `nominal.get_dataset`, add data to an existing dataset instead."
 )
 def upload_csv(
-    file: Path | str,
+    file: PathLike,
     name: str | None,
     timestamp_column: str,
     timestamp_type: ts._AnyTimestampType,
@@ -245,7 +246,7 @@ def upload_csv(
 
 def _upload_csv(
     client: NominalClient,
-    file: Path | str,
+    file: PathLike,
     name: str | None,
     timestamp_column: str,
     timestamp_type: ts._AnyTimestampType,
@@ -317,7 +318,7 @@ def create_run(
     f"see {AUTHENTICATION_DOCS_LINK}"
 )
 def create_run_csv(
-    file: Path | str,
+    file: PathLike,
     name: str,
     timestamp_column: str,
     timestamp_type: ts._LiteralAbsolute | ts.Iso8601 | ts.Epoch,
@@ -379,7 +380,7 @@ def search_runs(
     f"Use `nominal.NominalClient.create_attachment` instead, see {AUTHENTICATION_DOCS_LINK}"
 )
 def upload_attachment(
-    file: Path | str,
+    file: PathLike,
     name: str,
     description: str | None = None,
 ) -> Attachment:
@@ -406,7 +407,7 @@ def get_attachment(rid: str) -> Attachment:
     "Use `nominal.NominalClient.get_attachment` and `nominal.core.Attachment.write` instead, "
     f"see {AUTHENTICATION_DOCS_LINK}"
 )
-def download_attachment(rid: str, file: Path | str) -> None:
+def download_attachment(rid: str, file: PathLike) -> None:
     """Retrieve an attachment from the Nominal platform and save it to `file`."""
     client = _get_default_client()
     attachment = client.get_attachment(rid)
@@ -418,7 +419,7 @@ def download_attachment(rid: str, file: Path | str) -> None:
     f"Use `nominal.NominalClient.create_video` instead, see {AUTHENTICATION_DOCS_LINK}"
 )
 def upload_video(
-    file: Path | str, name: str, start: datetime | str | ts.IntegralNanosecondsUTC, description: str | None = None
+    file: PathLike, name: str, start: datetime | str | ts.IntegralNanosecondsUTC, description: str | None = None
 ) -> Video:
     """Upload a video to Nominal from a file."""
     client = _get_default_client()
@@ -542,7 +543,7 @@ def get_checklist(checklist_rid: str) -> Checklist:
     f"Use `nominal.NominalClient.create_mcap_video` instead, see {AUTHENTICATION_DOCS_LINK}"
 )
 def upload_mcap_video(
-    file: Path | str,
+    file: PathLike,
     topic: str,
     name: str | None = None,
     description: str | None = None,

nominal/thirdparty/tdms/_tdms.py

@@ -10,6 +10,7 @@ import pandas as pd
 from nptdms import TdmsChannel, TdmsFile, TdmsGroup
 
 from nominal import ts
+from nominal.core._types import PathLike
 from nominal.core.client import NominalClient
 from nominal.core.dataset import Dataset
 from nominal.core.dataset_file import DatasetFile
@@ -19,7 +20,7 @@ logger = logging.getLogger(__name__)
 
 
 def _tdms_to_dataframe(
-    file: Path | str,
+    file: PathLike,
     timestamp_column: str | None = None,
     timestamp_type: ts._AnyTimestampType | None = None,
 ) -> Tuple[str, ts._AnyTimestampType, pd.DataFrame]:
@@ -46,7 +47,7 @@ def _tdms_to_dataframe(
 
 def upload_tdms_to_dataset(
     dataset: Dataset,
-    file: Path | str,
+    file: PathLike,
     timestamp_column: str | None = None,
     timestamp_type: ts._AnyTimestampType | None = None,
     *,
@@ -91,7 +92,7 @@ def upload_tdms_to_dataset(
 
 def upload_tdms(
     client: NominalClient,
-    file: Path | str,
+    file: PathLike,
     name: str | None = None,
     description: str | None = None,
     timestamp_column: str | None = None,

{nominal-1.102.0.dist-info → nominal-1.103.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nominal
-Version: 1.102.0
+Version: 1.103.0
 Summary: Automate Nominal workflows in Python
 Project-URL: Homepage, https://nominal.io
 Project-URL: Documentation, https://docs.nominal.io

{nominal-1.102.0.dist-info → nominal-1.103.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
-CHANGELOG.md,sha256=VVSixbZ3ayFrWHceTSkabfHQYIkY1HU3GRSszsywUXQ,85986
+CHANGELOG.md,sha256=dZLFxX1LixFKq5t-wqt4IkqEptjE12o8iDYP-SFO6L4,86532
 LICENSE,sha256=zEGHG9mjDjaIS3I79O8mweQo-yiTbqx8jJvUPppVAwk,1067
 README.md,sha256=KKe0dxh_pHXCtB7I9G4qWGQYvot_BZU8yW6MJyuyUHM,311
 nominal/__init__.py,sha256=rbraORnXUrNn1hywLXM0XwSQCd9UmQt20PDYlsBalfE,2167
 nominal/__main__.py,sha256=Q0LHBl9ecbFcF6q0ef83f65WEYEQ55q1gfHhp4IUqy0,285
-nominal/nominal.py,sha256=YKtGgWQt3Fm2hVWOoIRf7GLm3VCAGdj7nz-ET_JGt_c,23128
+nominal/nominal.py,sha256=sbN7clV3OHfsaf72OXnTbP5R54B_WlzZlDUlRzTrPuk,23153
 nominal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nominal/_utils/README.md,sha256=1qJE6MSjrHb-JF4L7TJC2r8_OXwnb3gaLvuevXMOOK0,364
 nominal/_utils/__init__.py,sha256=v4WWEY4uC37KX_3xfHEJoF-qfIZ3dftMcuIdGnvtX_8,465
@@ -31,27 +31,28 @@ nominal/core/__init__.py,sha256=1MiCC44cxHYFofP4hf2fz4EIkepK-OAhDzpPFIzHbWw,2422
 nominal/core/_clientsbunch.py,sha256=YwciugX7rQ9AOPHyvKuavG7b9SlX1PURRquP37nvLqE,8458
 nominal/core/_constants.py,sha256=SrxgaSqAEB1MvTSrorgGam3eO29iCmRr6VIdajxX3gI,56
 nominal/core/_event_types.py,sha256=Cq_8x-zv_5EDvRo9UTbaOpenAy92bTfQxlsEuHPOhtE,3706
+nominal/core/_types.py,sha256=FktMmcQ5_rD2rbXv8_p-WISzSo8T2NtO-exsLm-iadU,122
 nominal/core/asset.py,sha256=-hNMGXiU1dPWfrzmOngbab-Hf6vfq2Rm_j0FP-woJ-s,23120
-nominal/core/attachment.py,sha256=iJaDyF6JXsKxxBLA03I0WMmQF8U0bA-wRwvXMEhfWLU,4284
+nominal/core/attachment.py,sha256=yOtDUdkLY5MT_Rk9kUlr1yupIJN7a5pt5sJWx4RLQV8,4355
 nominal/core/bounds.py,sha256=742BWmGL3FBryRAjoiJRg2N6aVinjYkQLxN7kfnJ40Q,581
 nominal/core/channel.py,sha256=dbe8wpfMiWqHu98x66w6GOmC9Ro33Wv9AhBVx2DvtVk,18970
 nominal/core/checklist.py,sha256=rO1RPDYV3o2miPKF7DcCiYpj6bUN-sdtZNhJkXzkfYE,7110
-nominal/core/client.py,sha256=34AhkJmnftU1dumVg80jPv9fnP7W5mQrkgOR8zI0VoU,68291
-nominal/core/connection.py,sha256=ySbPN_a2takVa8wIU9mK4fB6vYLyZnN-qSmXVkLUxAY,5157
+nominal/core/client.py,sha256=Awt9WPkE-YXBfOwJMTL7Su8AZFJY3UMH7IKp5hI26YQ,68328
+nominal/core/connection.py,sha256=LYllr3a1H2xp8-i4MaX1M7yK8X-HnwuIkciyK9XgLtQ,5175
 nominal/core/containerized_extractors.py,sha256=fUz3-NHoNWYKqOCD15gLwGXDKVfdsW-x_kpXnkOI3BE,10224
 nominal/core/data_review.py,sha256=bEnRsd8LI4x9YOBPcF2H3h5-e12A7Gh8gQfsNUAZmPQ,7922
-nominal/core/dataset.py,sha256=Rt20H2ekUbF0_YyF-OkJhs3KaRTqQzNNxyneRjIEOJk,46627
-nominal/core/dataset_file.py,sha256=oENANJ17A4K63cZ8Fr7lUm_kVPyA4fL2rUsZ3oXXk2U,16396
-nominal/core/datasource.py,sha256=k13B6u6uw5pd49SuVM3gXtATgqO_BUnqGUMGiiW6Moc,16920
+nominal/core/dataset.py,sha256=NRAKKoO6L3fiwd3voo_U-Ow6FZzW2UrfRXcyF2kPR3o,46636
+nominal/core/dataset_file.py,sha256=8rCW6MO89MFbQ2NH0WtFWmJfRWeTxhmyuoGojuQQ4Qg,16545
+nominal/core/datasource.py,sha256=V5UahbqsCNIdml978kOHiY6boIxKxbp76KscNBpN5xc,16934
 nominal/core/event.py,sha256=8trZXyuAqRlKedgcqSgDIimXAAJBmEfDLyHkOOBwUC0,7762
 nominal/core/exceptions.py,sha256=GUpwXRgdYamLl6684FE8ttCRHkBx6WEhOZ3NPE-ybD4,2671
-nominal/core/filetype.py,sha256=uzKe4iNHSv27mvz8-5EJEsvGOn3msEm_IhCj8OsCAPY,5526
+nominal/core/filetype.py,sha256=R8goHGW4SP0iO6AoQiUil2tNVuDgaQoHclftRbw44oc,5558
 nominal/core/log.py,sha256=z3hI3CIEyMwpUSWjwBsJ6a3JNGzBbsmrVusSU6uI7CY,3885
 nominal/core/run.py,sha256=IqXCP24UhdHKkss0LbXU_zAhx-7Pf2MIQI-lic_-quw,17987
 nominal/core/secret.py,sha256=Ckq48m60i7rktxL9GY-nxHU5v8gHv9F1-JN7_MSf4bM,2863
 nominal/core/unit.py,sha256=Wa-Bvu0hD-nzxVaQJSnn5YqAfnhUd2kWw2SswXnbMHY,3161
 nominal/core/user.py,sha256=FV333TN4pQzcLh5b2CfxvBnnXyB1TrOP8Ppx1-XdaiE,481
-nominal/core/video.py,sha256=zkxOZ5gerFWZ28tpudoMuV3ELz9cLYxvGnvQcew5efY,16086
+nominal/core/video.py,sha256=xQhDAiKzKuLsS3O6orKMvxejWVwDNK1ik56j4phMobE,16113
 nominal/core/video_file.py,sha256=dNAxFNAYwCBUiloCVt62fQymJtI_hK0NGgBXaVWqCXU,5669
 nominal/core/workbook.py,sha256=lJo9ZaYm0TevAyIs239ZA-_1WUriTkj8i1lxvxH9TJw,8902
 nominal/core/workbook_template.py,sha256=PBgQjEDVVQdZMlVea99BbhHdAr_bawknSvNKhNtDAq0,7125
@@ -86,15 +87,15 @@ nominal/experimental/logging/click_log_handler.py,sha256=ANLf4IGgmh95V0kJlr756wQ
 nominal/experimental/logging/nominal_log_handler.py,sha256=hyTxyjsvFnE7vtyrDJpunAqADHmXekNWALwxXPIJGCk,5120
 nominal/experimental/logging/rich_log_handler.py,sha256=8yz_VtxNgJg2oiesnXz2iXoBvQrUP5pAsYkxknOXgXA,1231
 nominal/experimental/migration/__init__.py,sha256=E2IgWJLwJ5bN6jbl8k5nHECKFx5aT11jKAzVYcyXn3o,460
-nominal/experimental/migration/migration_utils.py,sha256=Xuu9NilMxZQU_o8tqOn9WfM25Yz720HteiyN5L9Bbhs,26792
+nominal/experimental/migration/migration_utils.py,sha256=hCfajIYn91U2_Q9UaXkYhbd5-u8HLEVA6aD7o5_ota8,30223
 nominal/experimental/rust_streaming/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nominal/experimental/rust_streaming/rust_write_stream.py,sha256=E-L5JtcwPWnCEm0o4_k-AVzw173sRSgElzKrgHoYwbs,1490
+nominal/experimental/rust_streaming/rust_write_stream.py,sha256=oQ6ixwm8ct8ZDc_qNB7AucDt8o5-_aBVlW2fFCQ_nmA,1541
 nominal/experimental/stream_v2/__init__.py,sha256=W39vK46pssx5sXvmsImMuJiEPs7iGtwrbYBI0bWnXCY,2313
 nominal/experimental/stream_v2/_serializer.py,sha256=DcGimcY1LsXNeCzOWrel3SwuvoRV4XLdOFjqjM7MgPY,1035
 nominal/experimental/stream_v2/_write_stream.py,sha256=-EncNPXUDYaL1YpFlJFEkuLgcxMdyKEXS5JJzP_2LlI,9981
 nominal/experimental/video_processing/__init__.py,sha256=08ksIeYuv4BbgTRqA5cnetKr8DRsPuuoAas0OTHirt0,654
 nominal/experimental/video_processing/resolution.py,sha256=Z-34DaGDnJUcg-FvnxP-uNuNjXiE-7LvxZRugIvgOqk,3974
-nominal/experimental/video_processing/video_conversion.py,sha256=tkDpNjfRNZSq9DCoOKwfhnNZKJd0uFkwe6ChNPhIR9k,5895
+nominal/experimental/video_processing/video_conversion.py,sha256=JU7ELZjyFKQ7ij7nbyrpwwZCOiwYcQ3nrDk_Xh3GULY,6014
 nominal/thirdparty/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nominal/thirdparty/matlab/__init__.py,sha256=RANJJ6wbpGOrKRohcoFbRlOF8S4sZpSLWswElK954es,113
 nominal/thirdparty/matlab/_matlab.py,sha256=qtrO_wP_o9J2oqiwhriSfL0LYO7rBzssoHygYQJiT30,10400
@@ -103,10 +104,10 @@ nominal/thirdparty/pandas/_pandas.py,sha256=QcM1tk-Z5W8bKd9oYz5rD6M3qIHZ0N5uUe_U
 nominal/thirdparty/polars/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nominal/thirdparty/polars/polars_export_handler.py,sha256=hGCSwXX9dC4MG01CmmjlTbcajktMYDb-GpNNTwLUsRw,32951
 nominal/thirdparty/tdms/__init__.py,sha256=6n2ImFr2Wiil6JM1P5Q7Mpr0VzLcnDkmup_ftNpPq-s,142
-nominal/thirdparty/tdms/_tdms.py,sha256=eiHFTUviyDPDClckNldjs_jTTSH_sdmboKDq0oIGChQ,8711
+nominal/thirdparty/tdms/_tdms.py,sha256=m4gxbpxB9MTLi2FuYvGlbUGSyDAZKFxbM3ia2x1wIz0,8746
 nominal/ts/__init__.py,sha256=hmd0ENvDhxRnzDKGLxIub6QG8LpcxCgcyAct029CaEs,21442
-nominal-1.102.0.dist-info/METADATA,sha256=vO-itznAaNKlS3Awvzo8S81LTu7iPKIyLrxEi2y5ZFs,2277
-nominal-1.102.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-nominal-1.102.0.dist-info/entry_points.txt,sha256=-mCLhxgg9R_lm5efT7vW9wuBH12izvY322R0a3TYxbE,66
-nominal-1.102.0.dist-info/licenses/LICENSE,sha256=zEGHG9mjDjaIS3I79O8mweQo-yiTbqx8jJvUPppVAwk,1067
-nominal-1.102.0.dist-info/RECORD,,
+nominal-1.103.0.dist-info/METADATA,sha256=EigPuLvTA5TUP2SCA0vo49uLWuq4GDil1fN8D118I40,2277
+nominal-1.103.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+nominal-1.103.0.dist-info/entry_points.txt,sha256=-mCLhxgg9R_lm5efT7vW9wuBH12izvY322R0a3TYxbE,66
+nominal-1.103.0.dist-info/licenses/LICENSE,sha256=zEGHG9mjDjaIS3I79O8mweQo-yiTbqx8jJvUPppVAwk,1067
+nominal-1.103.0.dist-info/RECORD,,