types-boto3 1.0.1__py3-none-any.whl → 1.35.99__py3-none-any.whl

boto3-stubs/exceptions.pyi

@@ -0,0 +1,46 @@
+"""
+Type annotations for boto3.exceptions module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any, Iterable
+
+import botocore.exceptions
+
+class Boto3Error(Exception): ...
+class ResourceLoadException(Boto3Error): ...
+class NoVersionFound(Boto3Error): ...
+
+class UnknownAPIVersionError(Boto3Error, botocore.exceptions.DataNotFoundError):
+    def __init__(
+        self,
+        service_name: str,
+        bad_api_version: str,
+        available_api_versions: Iterable[str],
+    ) -> None: ...
+
+class ResourceNotExistsError(Boto3Error, botocore.exceptions.DataNotFoundError):
+    def __init__(
+        self,
+        service_name: str,
+        available_services: Iterable[str],
+        has_low_level_client: bool,
+    ) -> None: ...
+
+class RetriesExceededError(Boto3Error):
+    def __init__(self, last_exception: Boto3Error, msg: str = ...) -> None: ...
+
+class S3TransferFailedError(Boto3Error): ...
+class S3UploadFailedError(Boto3Error): ...
+
+class DynamoDBOperationNotSupportedError(Boto3Error):
+    def __init__(self, operation: str, value: Any) -> None: ...
+
+DynanmoDBOperationNotSupportedError = DynamoDBOperationNotSupportedError
+
+class DynamoDBNeedsConditionError(Boto3Error):
+    def __init__(self, value: Any) -> None: ...
+
+class DynamoDBNeedsKeyConditionError(Boto3Error): ...
+class PythonDeprecationWarning(Warning): ...

boto3-stubs/resources/action.pyi

@@ -0,0 +1,53 @@
+"""
+Type annotations for boto3.resources.action module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import logging
+from typing import Any, Callable, Sequence
+
+from boto3.resources.base import ServiceResource
+from boto3.resources.collection import ResourceCollection
+from boto3.resources.factory import ResourceFactory
+from boto3.resources.model import Action, Waiter
+from boto3.utils import ServiceContext
+from botocore.hooks import BaseEventHooks
+
+logger: logging.Logger
+
+class ServiceAction:
+    def __init__(
+        self,
+        action_model: Action,
+        factory: ResourceFactory | None = ...,
+        service_context: ServiceContext | None = ...,
+    ) -> None: ...
+    def __call__(
+        self, parent: ServiceResource, *args: Any, **kwargs: Any
+    ) -> ServiceResource | list[ServiceResource] | dict[str, Any]: ...
+
+class BatchAction(ServiceAction):
+    def __call__(  # type: ignore [override]
+        self, parent: ResourceCollection, *args: Any, **kwargs: Any
+    ) -> list[dict[str, Any]]: ...
+
+class WaiterAction:
+    def __init__(self, waiter_model: Waiter, waiter_resource_name: str) -> None: ...
+    def __call__(self, parent: ServiceResource, *args: Any, **kwargs: Any) -> None: ...
+
+class CustomModeledAction:
+    def __init__(
+        self,
+        action_name: str,
+        action_model: dict[str, Any],
+        function: Callable[..., Any],
+        event_emitter: BaseEventHooks,
+    ) -> None: ...
+    def inject(
+        self,
+        class_attributes: Sequence[Any],
+        service_context: ServiceContext,
+        event_name: str,
+        **kwargs: Any,
+    ) -> None: ...

boto3-stubs/resources/base.pyi

@@ -0,0 +1,40 @@
+"""
+Type annotations for boto3.resources.base module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import logging
+from typing import Any, TypeVar
+
+from boto3.resources.model import ResourceModel
+from botocore.client import BaseClient
+
+logger: logging.Logger
+
+_ResourceMeta = TypeVar("_ResourceMeta")
+
+class ResourceMeta:
+    client: BaseClient
+    def __init__(
+        self,
+        service_name: str,
+        identifiers: list[str] | None = ...,
+        client: BaseClient | None = ...,
+        data: dict[str, Any] | None = ...,
+        resource_model: ResourceModel | None = ...,
+    ) -> None:
+        self.service_name: str
+        self.identifiers: list[str]
+        self.data: dict[str, Any]
+        self.resource_model: ResourceModel
+
+    def __eq__(self, other: object) -> bool: ...
+    def copy(self: _ResourceMeta) -> _ResourceMeta: ...
+
+class ServiceResource:
+    meta: ResourceMeta = ...  # type: ignore
+
+    def __init__(self, *args: Any, client: BaseClient | None = ..., **kwargs: Any) -> None: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __hash__(self) -> int: ...

boto3-stubs/resources/collection.pyi

@@ -0,0 +1,54 @@
+"""
+Type annotations for boto3.resources.collection module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import logging
+from typing import Any, Iterator, TypeVar
+
+from boto3.resources.base import ServiceResource
+from boto3.resources.factory import ResourceFactory
+from boto3.resources.model import Collection
+from boto3.resources.response import ResourceHandler
+from boto3.utils import ServiceContext
+from botocore.hooks import BaseEventHooks
+
+logger: logging.Logger
+
+_ResourceCollection = TypeVar("_ResourceCollection", bound=ResourceCollection)
+
+class ResourceCollection:
+    def __init__(
+        self, model: Collection, parent: ServiceResource, handler: ResourceHandler, **kwargs: Any
+    ) -> None: ...
+    def __iter__(self) -> Iterator[Any]: ...
+    def pages(self) -> Iterator[list[Any]]: ...
+    def all(self: _ResourceCollection) -> _ResourceCollection: ...
+    def filter(self: _ResourceCollection, **kwargs: Any) -> _ResourceCollection: ...
+    def limit(self: _ResourceCollection, count: int) -> _ResourceCollection: ...
+    def page_size(self: _ResourceCollection, count: int) -> _ResourceCollection: ...
+
+class CollectionManager:
+    def __init__(
+        self,
+        collection_model: Collection,
+        parent: ServiceResource,
+        factory: ResourceFactory,
+        service_context: ServiceContext,
+    ) -> None: ...
+    def iterator(self, **kwargs: Any) -> ResourceCollection: ...
+    def all(self) -> ResourceCollection: ...
+    def filter(self, **kwargs: Any) -> ResourceCollection: ...
+    def limit(self, count: int) -> ResourceCollection: ...
+    def page_size(self, count: InterruptedError) -> ResourceCollection: ...
+    def pages(self) -> list[ServiceResource]: ...
+
+class CollectionFactory:
+    def load_from_definition(
+        self,
+        resource_name: str,
+        collection_model: Collection,
+        service_context: ServiceContext,
+        event_emitter: BaseEventHooks,
+    ) -> CollectionManager: ...

boto3-stubs/resources/factory.pyi

@@ -0,0 +1,23 @@
+"""
+Type annotations for boto3.resources.factory module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import logging
+from typing import Any
+
+from boto3.resources.base import ServiceResource
+from boto3.utils import ServiceContext
+from botocore.hooks import BaseEventHooks
+
+logger: logging.Logger
+
+class ResourceFactory:
+    def __init__(self, emitter: BaseEventHooks) -> None: ...
+    def load_from_definition(
+        self,
+        resource_name: str,
+        single_resource_json_definition: dict[str, Any],
+        service_context: ServiceContext,
+    ) -> type[ServiceResource]: ...

boto3-stubs/resources/model.pyi

@@ -0,0 +1,123 @@
+"""
+Type annotations for boto3.resources.model module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import logging
+from typing import Any, Literal, TypedDict
+
+from botocore.model import Shape
+
+logger: logging.Logger
+
+class _ActionDefinition(TypedDict, total=False):
+    request: dict[str, Any]
+    resource: dict[str, Any]
+    path: str
+
+class _DefinitionWithParamsDefinition(TypedDict, total=False):
+    params: list[dict[str, Any]]
+
+class _RequestDefinition(TypedDict, total=False):
+    operation: str
+
+class _WaiterDefinition(TypedDict, total=False):
+    waiterName: str
+
+class _ResponseResourceDefinition(TypedDict, total=False):
+    type: str
+    path: str
+
+class _ResourceModelDefinition(TypedDict, total=False):
+    shape: str
+
+class Identifier:
+    def __init__(self, name: str, member_name: str | None = ...) -> None:
+        self.name: str
+        self.member_name: str
+
+class Action:
+    def __init__(
+        self, name: str, definition: _ActionDefinition, resource_defs: dict[str, dict[str, Any]]
+    ) -> None:
+        self.name: str
+        self.request: Request | None
+        self.resource: ResponseResource | None
+        self.path: str | None
+
+class DefinitionWithParams:
+    def __init__(self, definition: _DefinitionWithParamsDefinition) -> None: ...
+    @property
+    def params(self) -> list[Parameter]: ...
+
+class Parameter:
+    def __init__(
+        self,
+        target: str,
+        source: str,
+        name: str | None = ...,
+        path: str | None = ...,
+        value: str | float | bool | None = ...,
+        **kwargs: Any,
+    ) -> None:
+        self.target: str
+        self.source: str
+        self.name: str | None
+        self.path: str | None
+        self.value: str | int | float | bool | None
+
+class Request(DefinitionWithParams):
+    def __init__(self, definition: _RequestDefinition) -> None:
+        self.operation: str
+
+class Waiter(DefinitionWithParams):
+    PREFIX: Literal["WaitUntil"]
+    def __init__(self, name: str, definition: _WaiterDefinition) -> None:
+        self.name: str
+        self.waiter_name: str
+
+class ResponseResource:
+    def __init__(
+        self, definition: _ResponseResourceDefinition, resource_defs: dict[str, dict[str, Any]]
+    ) -> None:
+        self.type: str
+        self.path: str
+
+    @property
+    def identifiers(self) -> list[Identifier]: ...
+    @property
+    def model(self) -> ResourceModel: ...
+
+class Collection(Action):
+    @property
+    def batch_actions(self) -> list[Action]: ...
+
+class ResourceModel:
+    def __init__(
+        self,
+        name: str,
+        definition: _ResourceModelDefinition,
+        resource_defs: dict[str, dict[str, Any]],
+    ) -> None:
+        self.name: str
+        self.shape: str | None
+
+    def load_rename_map(self, shape: Shape | None = ...) -> None: ...
+    def get_attributes(self, shape: Shape) -> dict[str, tuple[str, Shape]]: ...
+    @property
+    def identifiers(self) -> list[Identifier]: ...
+    @property
+    def load(self) -> Action | None: ...
+    @property
+    def actions(self) -> list[Action]: ...
+    @property
+    def batch_actions(self) -> list[Action]: ...
+    @property
+    def subresources(self) -> list[ResponseResource]: ...
+    @property
+    def references(self) -> list[Action]: ...
+    @property
+    def collections(self) -> list[Collection]: ...
+    @property
+    def waiters(self) -> list[Waiter]: ...

boto3-stubs/resources/params.pyi

@@ -0,0 +1,23 @@
+"""
+Type annotations for boto3.resources.params module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any, Pattern
+
+from boto3.resources.base import ServiceResource
+from boto3.resources.model import Request
+
+INDEX_RE: Pattern[str]
+
+def get_data_member(parent: ServiceResource, path: str) -> dict[str, Any] | None: ...
+def create_request_parameters(
+    parent: ServiceResource,
+    request_model: Request,
+    params: dict[str, Any] | None = ...,
+    index: int | None = ...,
+) -> dict[str, Any]: ...
+def build_param_structure(
+    params: dict[str, Any], target: str, value: Any, index: int | None = ...
+) -> None: ...

boto3-stubs/resources/response.pyi

@@ -0,0 +1,50 @@
+"""
+Type annotations for boto3.resources.response module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any, Iterable
+
+from boto3.resources.base import ServiceResource
+from boto3.resources.factory import ResourceFactory
+from boto3.resources.model import Parameter, ResponseResource
+from boto3.utils import ServiceContext
+from botocore.model import ServiceModel
+
+def all_not_none(iterable: Iterable[Any]) -> bool: ...
+def build_identifiers(
+    identifiers: list[Parameter],
+    parent: ServiceResource,
+    params: dict[str, Any] | None = ...,
+    raw_response: dict[str, Any] | None = ...,
+) -> list[tuple[str, Any]]: ...
+def build_empty_response(
+    search_path: str, operation_name: str, service_model: ServiceModel
+) -> dict[str, Any] | list[Any] | None: ...
+
+class RawHandler:
+    def __init__(self, search_path: str) -> None: ...
+    def __call__(
+        self, parent: ServiceResource, params: dict[str, Any], response: dict[str, Any]
+    ) -> dict[str, Any]: ...
+
+class ResourceHandler:
+    def __init__(
+        self,
+        search_path: str,
+        factory: ResourceFactory,
+        resource_model: ResponseResource,
+        service_context: ServiceContext,
+        operation_name: str | None = ...,
+    ) -> None: ...
+    def __call__(
+        self, parent: ServiceResource, params: dict[str, Any], response: dict[str, Any]
+    ) -> ServiceResource | list[ServiceResource]: ...
+    def handle_response_item(
+        self,
+        resource_cls: type[ServiceResource],
+        parent: ServiceResource,
+        identifiers: dict[str, Any],
+        resource_data: dict[str, Any] | None,
+    ) -> ServiceResource: ...

boto3-stubs/s3/constants.pyi

@@ -0,0 +1,8 @@
+"""
+Type annotations for boto3.s3.constants module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+CLASSIC_TRANSFER_CLIENT: str = ...
+AUTO_RESOLVE_TRANSFER_CLIENT: str = ...

boto3-stubs/s3/inject.pyi

@@ -0,0 +1,145 @@
+"""
+Type annotations for boto3.s3.inject module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import IO, Any, Callable
+
+from boto3 import utils as utils
+from boto3.s3.transfer import ProgressCallbackInvoker as ProgressCallbackInvoker
+from boto3.s3.transfer import S3Transfer as S3Transfer
+from boto3.s3.transfer import TransferConfig as TransferConfig
+from boto3.s3.transfer import create_transfer_manager as create_transfer_manager
+from botocore.client import BaseClient
+from botocore.exceptions import ClientError as ClientError
+
+def inject_s3_transfer_methods(class_attributes: dict[str, Any], **kwargs: Any) -> None: ...
+def inject_bucket_methods(class_attributes: dict[str, Any], **kwargs: Any) -> None: ...
+def inject_object_methods(class_attributes: dict[str, Any], **kwargs: Any) -> None: ...
+def inject_object_summary_methods(class_attributes: dict[str, Any], **kwargs: Any) -> None: ...
+def bucket_load(self: Any, *args: Any, **kwargs: Any) -> None: ...
+def object_summary_load(self: Any, *args: Any, **kwargs: Any) -> None: ...
+def upload_file(
+    self: Any,
+    Filename: str,
+    Bucket: str,
+    Key: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def download_file(
+    self: Any,
+    Bucket: str,
+    Key: str,
+    Filename: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def bucket_upload_file(
+    self: Any,
+    Filename: str,
+    Key: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def bucket_download_file(
+    self: Any,
+    Key: str,
+    Filename: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def object_upload_file(
+    self: Any,
+    Filename: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def object_download_file(
+    self: Any,
+    Filename: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def copy(
+    self: Any,
+    CopySource: dict[str, Any],
+    Bucket: str,
+    Key: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    SourceClient: BaseClient | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def bucket_copy(
+    self: Any,
+    CopySource: dict[str, Any],
+    Key: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    SourceClient: BaseClient | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def object_copy(
+    self: Any,
+    CopySource: dict[str, Any],
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    SourceClient: BaseClient | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def upload_fileobj(
+    self: Any,
+    Fileobj: IO[Any],
+    Bucket: str,
+    Key: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def bucket_upload_fileobj(
+    self: Any,
+    Fileobj: IO[Any],
+    Key: str,
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def object_upload_fileobj(
+    self: Any,
+    Fileobj: IO[Any],
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def download_fileobj(
+    self: Any,
+    Bucket: str,
+    Key: str,
+    Fileobj: IO[Any],
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def bucket_download_fileobj(
+    self: Any,
+    Key: str,
+    Fileobj: IO[Any],
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...
+def object_download_fileobj(
+    self: Any,
+    Fileobj: IO[Any],
+    ExtraArgs: dict[str, Any] | None = ...,
+    Callback: Callable[..., Any] | None = ...,
+    Config: TransferConfig | None = ...,
+) -> None: ...

boto3-stubs/s3/transfer.pyi

@@ -0,0 +1,90 @@
+"""
+Type annotations for boto3.s3.transfer module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+import logging
+from types import TracebackType
+from typing import Any, Callable, Mapping, TypeVar
+
+from botocore.client import BaseClient
+from botocore.config import Config
+from s3transfer.manager import TransferConfig as S3TransferConfig
+from s3transfer.manager import TransferManager
+from s3transfer.subscribers import BaseSubscriber
+from s3transfer.utils import OSUtils
+
+_R = TypeVar("_R")
+
+KB: int
+MB: int
+
+logger: logging.Logger = ...
+
+def create_transfer_manager(
+    client: BaseClient,
+    config: TransferConfig,
+    osutil: OSUtils | None = ...,
+) -> TransferManager: ...
+def has_minimum_crt_version(minimum_version: str) -> bool: ...
+
+class TransferConfig(S3TransferConfig):
+    ALIAS: dict[str, str]
+
+    def __init__(
+        self,
+        multipart_threshold: int = ...,
+        max_concurrency: int = ...,
+        multipart_chunksize: int = ...,
+        num_download_attempts: int = ...,
+        max_io_queue: int = ...,
+        io_chunksize: int = ...,
+        use_threads: bool = ...,
+        max_bandwidth: int | None = ...,
+        preferred_transfer_client: str = ...,
+    ) -> None:
+        self.use_threads: bool
+
+    def __setattr__(self, name: str, value: int) -> None: ...
+
+class S3Transfer:
+    ALLOWED_DOWNLOAD_ARGS: list[str]
+    ALLOWED_UPLOAD_ARGS: list[str]
+    def __init__(
+        self,
+        client: BaseClient | None = ...,
+        config: Config | None = ...,
+        osutil: OSUtils | None = ...,
+        manager: TransferManager | None = ...,
+    ) -> None: ...
+    def upload_file(
+        self,
+        filename: str,
+        bucket: str,
+        key: str,
+        callback: Callable[[int], Any] | None = ...,
+        extra_args: Mapping[str, Any] | None = ...,
+    ) -> None: ...
+    def download_file(
+        self,
+        bucket: str,
+        key: str,
+        filename: str,
+        extra_args: Mapping[str, Any] | None = ...,
+        callback: Callable[[int], Any] | None = ...,
+    ) -> None: ...
+    def __enter__(self: _R) -> _R: ...
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        tb: TracebackType | None,
+    ) -> None: ...
+
+class ProgressCallbackInvoker(BaseSubscriber):
+    def __init__(self, callback: Callable[[int], Any]) -> None: ...
+    # FIXME: signature incompatible with BaseSubscriber
+    def on_progress(  # type: ignore [override]
+        self, bytes_transferred: int, **kwargs: Any
+    ) -> None: ...