datavo-sdk 0.22.0__py3-none-any.whl

datavo_sdk/__init__.py

@@ -0,0 +1,559 @@
+from .api_models import (
+    AddKeyGroupRequest,
+    AnyKey,
+    AttachedBy,
+    Attr,
+    AttrIn,
+    AttrRange,
+    AuthStatus,
+    AttachmentIngestCommitRequest,
+    AttachmentIngestCommitResponse,
+    AttachmentIngestReserveRequest,
+    AttachmentIngestReserveResponse,
+    AttachmentIngestStatusResponse,
+    CopySamplesToNewStoreRequest,
+    CopySamplesToNewStoreResponse,
+    DatavoEventCreateRequest,
+    DatavoEventListResponse,
+    DatavoEventResponse,
+    DatasetCreateRequest,
+    CallerTeamMembership,
+    DefaultTeamUpdateRequest,
+    ResourceGrantCreateRequest,
+    ResourceGrantListResponse,
+    ResourceGrantRevokeRequest,
+    ResourceGrantRevokeResponse,
+    ResourceGrantSummary,
+    TeamCreateRequest,
+    TeamDetailResponse,
+    TeamListResponse,
+    TeamMemberAddRequest,
+    TeamMemberSummary,
+    TeamSummary,
+    TeamUpdateRequest,
+    TransferOwnershipRequest,
+    TransferOwnershipResponse,
+    TransferPreviewResponse,
+    TransferredResource,
+    DatasetDeleteCounts,
+    DatasetDeleteResponse,
+    DatasetAttributeNamesResponse,
+    DatasetDraftAnalyzeRequest,
+    DatasetDraftAnalyzeResponse,
+    DatasetDraftKeyCoverage,
+    DatasetDraftKeyGroupEstimate,
+    DatasetDraftPreviewRequest,
+    DatasetDraftPreviewResponse,
+    DatasetDraftStoreCount,
+    DatasetListItem,
+    DatasetListResponse,
+    DatasetKeyGroupRetentionUpdateRequest,
+    DatasetKeyGroupSummary,
+    DatasetSplitDefinition,
+    DatasetSplitDraftPreviewResponse,
+    DatasetSplitDraftRequest,
+    DatasetSplitFieldSummary,
+    DatasetSplitFieldsResponse,
+    DatasetSplitNumericSummary,
+    DatasetSplitRuleResult,
+    DatasetSplitSetCreateRequest,
+    DatasetSplitSetListItem,
+    DatasetSplitSetListResponse,
+    DatasetSplitSetResponse,
+    DatasetSplitSummary,
+    DatasetScalarStatsRequest,
+    DatasetScalarStatsResponse,
+    ExclusivityRule,
+    ExclusivityRuleResult,
+    DatasetPreviewGridRequest,
+    DatasetPreviewGridResponse,
+    DatasetPreviewSelectionStats,
+    DatasetPreviewRequest,
+    DatasetPreviewResponse,
+    DatasetResponse,
+    EntityPreviewGridRequest,
+    EntityPreviewGridResponse,
+    HasKeys,
+    PrepareProduceResponse,
+    DatasetShardStatus,
+    DatasetShardListResponse,
+    SourceSpec,
+    KeyGroupSpec,
+    OpenShard,
+    OpenShardSample,
+    OpenShardSampleMember,
+    OverviewDatasetItem,
+    OverviewResponse,
+    OverviewSampleStoreItem,
+    OverviewTotals,
+    ProcessingTokenIssueRequest,
+    ProcessingTokenIssueResponse,
+    ProcessingTokenRevokeResponse,
+    PreviewCell,
+    PreviewColumn,
+    PublicServerConfig,
+    RetentionPolicy,
+    SourceUsageDatasetItem,
+    SourceUsageProtectedKeyGroup,
+    SourceUsageResponse,
+    SampleAttributeNameSummary,
+    SampleAttributeNamesResponse,
+    SampleAttributeSummary,
+    SampleAttributeValueSummary,
+    SampleAttributeValuesResponse,
+    SampleExploreResponse,
+    SampleHistoryResponse,
+    SampleIntroductionProvenance,
+    SampleKeyExploreResponse,
+    SampleKeyRevisionListResponse,
+    SampleKeySummary,
+    SampleResponse,
+    SampleResolveRevisionsRequest,
+    SampleResolvedRevisionResponse,
+    SampleRevisionExplore,
+    SampleRevisionPreviewResponse,
+    SampleRevisionProvenance,
+    SampleRevisionSummary,
+    SampleStoreCatalogVisibility,
+    SampleStoreMovementResponse,
+    SampleStoreCreateRequest,
+    SampleStoreDeleteCounts,
+    SampleStoreDeleteResponse,
+    SampleStoreDetailResponse,
+    SampleStoreKeySummary,
+    SampleStoreListResponse,
+    SampleStoreStatsResponse,
+    SampleStoreSummary,
+    SampleStoreTransferCounts,
+    SampleStoreTransferRequest,
+    SampleStoreTransferResponse,
+    SearchHistogramBin,
+    SourceViewPreviewRequest,
+    SourceViewPreviewResponse,
+    SourceViewPreviewStats,
+    SortKey,
+    SearchScalarStat,
+    SearchTopValue,
+    RepresentationClause,
+    RepresentationRule,
+    RepresentationRuleResult,
+    RepresentationUnsatisfiedValue,
+    PreviewRow,
+    Not,
+    NotAttachedBy,
+    RowFilter,
+    RowPredicate,
+    SampleFilter,
+    SampleFilterDefinition,
+    SampleKeySelector,
+    SampleSelection,
+    ShardPlan,
+    SplitAttributeSelector,
+    SplitAttributePredicate,
+    SplitNumericRangePredicate,
+    SplitOutputSpec,
+    SplitRatioSelector,
+    SplitRepresentationPlan,
+    SplitRuleSpec,
+    SplitSelector,
+    SplitSetDeleteCounts,
+    SplitSetDeleteResponse,
+    SplitTextValuesPredicate,
+    SourceImportCommitRequest,
+    SourceImportPartCompleteRequest,
+    SourceImportCreateRequest,
+    SourceImportDeleteCounts,
+    SourceImportDeleteResponse,
+    SourceImportPartResponse,
+    SourceImportResponse,
+    SourceImportSampleMapping,
+    SourceImportSampleMappingListResponse,
+    SourceImportTransferRequest,
+    SourceImportTransferResponse,
+    StratificationRule,
+    StratificationRuleResult,
+    StatsRebuildRequest,
+    StatsRebuildResponse,
+    StatsFieldSpec,
+    StatsMetricRequest,
+    StatsMetricResult,
+    StatsQueryRequest,
+    StatsQueryResponse,
+    StatsScope,
+    DatasetStatsResponse,
+    WorksetCreateRequest,
+    WorksetOpenRequest,
+    WorksetOpenResponse,
+    WorksetIssueStreamTicketsRequest,
+    WorksetIssueStreamTicketsResponse,
+    WorksetResolveShardsRequest,
+    WorksetResolveShardsResponse,
+    WorksetShardRef,
+    WorksetShardSelector,
+    WorksetScope,
+    WorksetStreamTicket,
+    WorksetResponse,
+)
+from .base_search import BaseSearchIndex, BaseSearchIndexWriter, ShardSearchEntry
+from .base_shard import (
+    BaseShard,
+    ContainerShard,
+    CreatedBy,
+    ImportMode,
+    ShardMalformedError,
+    ShardMetadata,
+)
+from .entra import (
+    EntraConfig,
+    EntraTokenProvider,
+    default_msal_cache_path,
+    discover_entra_config,
+    login_entra,
+)
+from .dataset_iter import DEFAULT_PREFETCH, SampleStream
+from .download_events import DownloadStats, ShardDownloadCallback, ShardDownloadEvent
+from .file_shard import FileShard
+from .local_manifest import (
+    LOCAL_MANIFEST_VERSION,
+    LocalShardEntry,
+    LocalShardGroup,
+    LocalShardManifest,
+    load_local_manifest,
+    resolve_local_shard_groups,
+)
+from .local_shard_writer import LocalShardWriter
+from .logical_shard import download_logical_shard_to_tar
+from .new_shard import NewShard
+from .plan_cache import CachedPlan, CachedShardRef, PlanCache, default_plan_cache_dir
+from .resolved_shardstack import ResolvedShardStackLayer, ResolvedShardStackManifest
+from .shard_cache import (
+    DEFAULT_CACHE_ROOT,
+    DEFAULT_CACHE_ROOT_ENV,
+    DEFAULT_CONFIG_PATHS,
+    DEFAULT_MAX_BYTES,
+    AzureBlobShardCacheTier,
+    GcsShardCacheTier,
+    S3ShardCacheTier,
+    ShardCacheHierarchy,
+    ShardCacheTier,
+    datavo_instance_namespace,
+    get_default_shard_cache,
+    load_shard_cache_config,
+)
+from .client import (
+    DatavoApiError,
+    DatavoNonJsonResponseError,
+    DatavoResponseParseError,
+    DatavoClient,
+)
+from .server_config import (
+    default_config_dir,
+    default_server_config_path,
+    fetch_server_config,
+    get_server_config,
+    load_server_cache,
+    save_server_cache,
+)
+from .stack import ShardStack
+from .webdataset import Decoder, TarWriter
+
+__all__ = [
+    "AddKeyGroupRequest",
+    "AnyKey",
+    "AttachedBy",
+    "Attr",
+    "AttrIn",
+    "AttrRange",
+    "AuthStatus",
+    "AttachmentIngestCommitRequest",
+    "AttachmentIngestCommitResponse",
+    "AttachmentIngestReserveRequest",
+    "AttachmentIngestReserveResponse",
+    "AttachmentIngestStatusResponse",
+    "CopySamplesToNewStoreRequest",
+    "CopySamplesToNewStoreResponse",
+    "DatavoEventCreateRequest",
+    "DatavoEventListResponse",
+    "DatavoEventResponse",
+    "BaseSearchIndex",
+    "BaseSearchIndexWriter",
+    "AzureBlobShardCacheTier",
+    "BaseShard",
+    "CachedPlan",
+    "CachedShardRef",
+    "ContainerShard",
+    "CreatedBy",
+    "DatasetCreateRequest",
+    "CallerTeamMembership",
+    "DefaultTeamUpdateRequest",
+    "ResourceGrantCreateRequest",
+    "ResourceGrantListResponse",
+    "ResourceGrantRevokeRequest",
+    "ResourceGrantRevokeResponse",
+    "ResourceGrantSummary",
+    "TeamCreateRequest",
+    "TeamDetailResponse",
+    "TeamListResponse",
+    "TeamMemberAddRequest",
+    "TeamMemberSummary",
+    "TeamSummary",
+    "TeamUpdateRequest",
+    "TransferOwnershipRequest",
+    "TransferOwnershipResponse",
+    "TransferPreviewResponse",
+    "TransferredResource",
+    "DatasetDeleteCounts",
+    "DatasetDeleteResponse",
+    "DatasetAttributeNamesResponse",
+    "DatasetDraftAnalyzeRequest",
+    "DatasetDraftAnalyzeResponse",
+    "DatasetDraftKeyCoverage",
+    "DatasetDraftKeyGroupEstimate",
+    "DatasetDraftPreviewRequest",
+    "DatasetDraftPreviewResponse",
+    "DatasetDraftStoreCount",
+    "DatasetListItem",
+    "DatasetListResponse",
+    "DatasetKeyGroupRetentionUpdateRequest",
+    "DatasetKeyGroupSummary",
+    "DatasetSplitDefinition",
+    "DatasetSplitDraftPreviewResponse",
+    "DatasetSplitDraftRequest",
+    "DatasetSplitFieldSummary",
+    "DatasetSplitFieldsResponse",
+    "DatasetSplitNumericSummary",
+    "DatasetSplitRuleResult",
+    "DatasetSplitSetCreateRequest",
+    "DatasetSplitSetListItem",
+    "DatasetSplitSetListResponse",
+    "DatasetSplitSetResponse",
+    "DatasetSplitSummary",
+    "DatasetScalarStatsRequest",
+    "DatasetScalarStatsResponse",
+    "SampleStream",
+    "DEFAULT_PREFETCH",
+    "ExclusivityRule",
+    "ExclusivityRuleResult",
+    "DatasetPreviewGridRequest",
+    "DatasetPreviewGridResponse",
+    "DatasetPreviewSelectionStats",
+    "DatasetPreviewRequest",
+    "DatasetPreviewResponse",
+    "DatasetResponse",
+    "EntityPreviewGridRequest",
+    "EntityPreviewGridResponse",
+    "HasKeys",
+    "PrepareProduceResponse",
+    "DatasetShardStatus",
+    "DatasetShardListResponse",
+    "SourceSpec",
+    "DatavoApiError",
+    "DatavoNonJsonResponseError",
+    "DatavoResponseParseError",
+    "DatavoClient",
+    "Decoder",
+    "DownloadStats",
+    "ShardDownloadCallback",
+    "ShardDownloadEvent",
+    "EntraConfig",
+    "EntraTokenProvider",
+    "FileShard",
+    "LOCAL_MANIFEST_VERSION",
+    "LocalShardEntry",
+    "LocalShardGroup",
+    "LocalShardManifest",
+    "LocalShardWriter",
+    "load_local_manifest",
+    "resolve_local_shard_groups",
+    "ImportMode",
+    "KeyGroupSpec",
+    "download_logical_shard_to_tar",
+    "NewShard",
+    "OpenShard",
+    "PlanCache",
+    "OpenShardSample",
+    "OpenShardSampleMember",
+    "OverviewDatasetItem",
+    "OverviewResponse",
+    "OverviewSampleStoreItem",
+    "OverviewTotals",
+    "ProcessingTokenIssueRequest",
+    "ProcessingTokenIssueResponse",
+    "ProcessingTokenRevokeResponse",
+    "PreviewCell",
+    "PreviewColumn",
+    "PublicServerConfig",
+    "RetentionPolicy",
+    "SourceUsageDatasetItem",
+    "SourceUsageProtectedKeyGroup",
+    "SourceUsageResponse",
+    "SampleAttributeNameSummary",
+    "SampleAttributeNamesResponse",
+    "SampleAttributeSummary",
+    "SampleAttributeValueSummary",
+    "SampleAttributeValuesResponse",
+    "SampleExploreResponse",
+    "SampleHistoryResponse",
+    "SampleIntroductionProvenance",
+    "SampleKeyExploreResponse",
+    "SampleKeyRevisionListResponse",
+    "SampleKeySummary",
+    "SampleResponse",
+    "SampleResolveRevisionsRequest",
+    "SampleResolvedRevisionResponse",
+    "SampleRevisionExplore",
+    "SampleRevisionPreviewResponse",
+    "SampleRevisionProvenance",
+    "SampleRevisionSummary",
+    "SampleStoreCatalogVisibility",
+    "SampleStoreMovementResponse",
+    "SampleStoreCreateRequest",
+    "SampleStoreDeleteCounts",
+    "SampleStoreDeleteResponse",
+    "SampleStoreDetailResponse",
+    "SampleStoreKeySummary",
+    "SampleStoreListResponse",
+    "SampleStoreStatsResponse",
+    "SampleStoreSummary",
+    "SampleStoreTransferCounts",
+    "SampleStoreTransferRequest",
+    "SampleStoreTransferResponse",
+    "SearchHistogramBin",
+    "SourceViewPreviewRequest",
+    "SourceViewPreviewResponse",
+    "SourceViewPreviewStats",
+    "SortKey",
+    "SearchScalarStat",
+    "SearchTopValue",
+    "RepresentationClause",
+    "RepresentationRule",
+    "RepresentationRuleResult",
+    "RepresentationUnsatisfiedValue",
+    "PreviewRow",
+    "SourceImportCommitRequest",
+    "SourceImportPartCompleteRequest",
+    "SourceImportCreateRequest",
+    "SourceImportDeleteCounts",
+    "SourceImportDeleteResponse",
+    "SourceImportPartResponse",
+    "SourceImportResponse",
+    "SourceImportSampleMapping",
+    "SourceImportSampleMappingListResponse",
+    "SourceImportTransferRequest",
+    "SourceImportTransferResponse",
+    "SplitAttributeSelector",
+    "SplitAttributePredicate",
+    "SplitNumericRangePredicate",
+    "SplitOutputSpec",
+    "SplitRatioSelector",
+    "SplitRepresentationPlan",
+    "SplitRuleSpec",
+    "SplitSelector",
+    "SplitSetDeleteCounts",
+    "SplitSetDeleteResponse",
+    "SplitTextValuesPredicate",
+    "StratificationRule",
+    "StratificationRuleResult",
+    "StatsRebuildRequest",
+    "StatsRebuildResponse",
+    "StatsFieldSpec",
+    "StatsMetricRequest",
+    "StatsMetricResult",
+    "StatsQueryRequest",
+    "StatsQueryResponse",
+    "StatsScope",
+    "DatasetStatsResponse",
+    "ResolvedShardStackLayer",
+    "ResolvedShardStackManifest",
+    "S3ShardCacheTier",
+    "GcsShardCacheTier",
+    "Not",
+    "NotAttachedBy",
+    "RowFilter",
+    "RowPredicate",
+    "SampleFilter",
+    "SampleFilterDefinition",
+    "SampleKeySelector",
+    "SampleSelection",
+    "ShardCacheHierarchy",
+    "ShardCacheTier",
+    "ShardMalformedError",
+    "ShardMetadata",
+    "ShardSearchEntry",
+    "ShardPlan",
+    "ShardStack",
+    "TarWriter",
+    "WorksetCreateRequest",
+    "WorksetOpenRequest",
+    "WorksetOpenResponse",
+    "WorksetIssueStreamTicketsRequest",
+    "WorksetIssueStreamTicketsResponse",
+    "WorksetResolveShardsRequest",
+    "WorksetResolveShardsResponse",
+    "WorksetShardRef",
+    "WorksetShardSelector",
+    "WorksetScope",
+    "WorksetStreamTicket",
+    "WorksetResponse",
+    "DEFAULT_CACHE_ROOT",
+    "DEFAULT_CACHE_ROOT_ENV",
+    "DEFAULT_CONFIG_PATHS",
+    "DEFAULT_MAX_BYTES",
+    "default_config_dir",
+    "default_msal_cache_path",
+    "default_plan_cache_dir",
+    "default_server_config_path",
+    "discover_entra_config",
+    "fetch_server_config",
+    "get_server_config",
+    "login_entra",
+    "datavo_instance_namespace",
+    "get_default_shard_cache",
+    "load_server_cache",
+    "load_shard_cache_config",
+    "save_server_cache",
+]
+
+
+# --- Deprecated spellings (canonicalize-sdk-vocabulary) -----------------------
+#
+# Served through PEP 562 rather than bound at module level so the deprecation
+# fires when the old name is *used* — `from datavo_sdk import DatavoDataset`
+# falls back to this hook — while the object returned is the canonical class
+# itself, leaving behaviour, identity, and isinstance checks untouched.
+_DEPRECATED_NAMES: dict[str, tuple[str, str]] = {
+    "DatasetSourceDraftSpec": (
+        "SourceSpec",
+        "DatasetSourceDraftSpec is deprecated; use SourceSpec. It is neither dataset-only "
+        "(a workset carries the same composition) nor a draft (it is the persisted spec) — "
+        "the two names are the same class, so isinstance checks are unaffected.",
+    ),
+    "DatavoDataset": (
+        "SampleStream",
+        "DatavoDataset is deprecated; use SampleStream. The handle reads datasets, "
+        "worksets, and local shards, so its name no longer says 'dataset' — the two "
+        "names are the same class, so isinstance checks and subclasses are unaffected.",
+    ),
+    # --- rename-produce-to-attach ---
+    "NotProducedBy": (
+        "NotAttachedBy",
+        "NotProducedBy is deprecated; use NotAttachedBy. The predicate names the act it "
+        "negates (attaching keys), not a second word for it — the two names are the same "
+        "class, so isinstance checks are unaffected.",
+    ),
+}
+
+
+def __getattr__(name: str):
+    entry = _DEPRECATED_NAMES.get(name)
+    if entry is None:
+        raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+    import warnings
+
+    canonical, message = entry
+    warnings.warn(message, DeprecationWarning, stacklevel=2)
+    return globals()[canonical]
+
+
+def __dir__() -> list[str]:
+    return sorted([*globals(), *_DEPRECATED_NAMES])