boto3-stubs 1.34.65__py3-none-any.whl → 1.36.1__py3-none-any.whl

boto3-stubs/compat.pyi

@@ -1,7 +1,12 @@
+"""
+Type annotations for boto3.compat module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
 import os
-from typing import Type
 
-SOCKET_ERROR: Type[ConnectionError]
+SOCKET_ERROR: type[ConnectionError]
 
 def filter_python_deprecation_warnings() -> None: ...
 

boto3-stubs/crt.pyi

@@ -1,11 +1,17 @@
+"""
+Type annotations for boto3.crt module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
 import threading
-from typing import Any, Optional
+from typing import Any
 
 from botocore.client import BaseClient
 from s3transfer.crt import BotocoreCRTRequestSerializer, CRTTransferManager
 
-CRT_S3_CLIENT: Optional[CRTS3Client] = ...
-BOTOCORE_CRT_SERIALIZER: Optional[BotocoreCRTRequestSerializer] = ...
+CRT_S3_CLIENT: CRTS3Client | None = ...
+BOTOCORE_CRT_SERIALIZER: BotocoreCRTRequestSerializer | None = ...
 
 CLIENT_CREATION_LOCK: threading.Lock = ...
 PROCESS_LOCK_NAME: str = ...
@@ -19,6 +25,4 @@ class CRTS3Client:
 
 def is_crt_compatible_request(client: BaseClient, crt_s3_client: CRTS3Client) -> bool: ...
 def compare_identity(boto3_creds: Any, crt_s3_creds: Any) -> bool: ...
-def create_crt_transfer_manager(
-    client: BaseClient, config: Any
-) -> Optional[CRTTransferManager]: ...
+def create_crt_transfer_manager(client: BaseClient, config: Any) -> CRTTransferManager | None: ...

boto3-stubs/docs/__init__.pyi

@@ -1,3 +1,9 @@
+"""
+Type annotations for boto3.docs module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
 from boto3.session import Session
 
 def generate_docs(root_dir: str, session: Session) -> None: ...

boto3-stubs/docs/action.pyi

@@ -0,0 +1,37 @@
+"""
+Type annotations for boto3.docs.action module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from boto3.resources.model import Action
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.hooks import BaseEventHooks
+from botocore.model import ServiceModel
+
+from .base import NestedDocumenter
+
+PUT_DATA_WARNING_MESSAGE: str
+WARNING_MESSAGES: dict[str, dict[str, str]]
+IGNORE_PARAMS: dict[str, dict[str, list[str]]]
+
+class ActionDocumenter(NestedDocumenter):
+    def document_actions(self, section: DocumentStructure) -> None: ...
+
+def document_action(
+    section: DocumentStructure,
+    resource_name: str,
+    event_emitter: BaseEventHooks,
+    action_model: Action,
+    service_model: ServiceModel,
+    include_signature: bool = ...,
+) -> None: ...
+def document_load_reload_action(
+    section: DocumentStructure,
+    action_name: str,
+    resource_name: str,
+    event_emitter: BaseEventHooks,
+    load_model: Action,
+    service_model: ServiceModel,
+    include_signature: bool = ...,
+) -> None: ...

boto3-stubs/docs/attr.pyi

@@ -0,0 +1,33 @@
+"""
+Type annotations for boto3.docs.attr module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from boto3.resources.model import Identifier
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.docs.params import ResponseParamsDocumenter
+from botocore.hooks import BaseEventHooks
+from botocore.model import Shape
+
+class ResourceShapeDocumenter(ResponseParamsDocumenter):
+    EVENT_NAME: str
+
+def document_attribute(
+    section: DocumentStructure,
+    service_name: str,
+    resource_name: str,
+    attr_name: str,
+    event_emitter: BaseEventHooks,
+    attr_model: Shape,
+    include_signature: bool = True,
+) -> None: ...
+def document_identifier(
+    section: DocumentStructure,
+    resource_name: str,
+    identifier_model: Identifier,
+    include_signature: bool = ...,
+) -> None: ...
+def document_reference(
+    section: DocumentStructure, reference_model: Shape, include_signature: bool = ...
+) -> None: ...

boto3-stubs/docs/base.pyi

@@ -0,0 +1,19 @@
+"""
+Type annotations for boto3.docs.base module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any
+
+class BaseDocumenter:
+    member_map: dict[str, Any]
+    represents_service_resource: Any
+    def __init__(self, resource: Any) -> None: ...
+    @property
+    def class_name(self) -> str: ...
+
+class NestedDocumenter(BaseDocumenter):
+    def __init__(self, resource: Any, root_docs_path: str) -> None: ...
+    @property
+    def class_name(self) -> str: ...

boto3-stubs/docs/client.pyi

@@ -0,0 +1,9 @@
+"""
+Type annotations for boto3.docs.client module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from botocore.docs.client import ClientDocumenter
+
+class Boto3ClientDocumenter(ClientDocumenter): ...

boto3-stubs/docs/collection.pyi

@@ -0,0 +1,37 @@
+"""
+Type annotations for boto3.docs.collection module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from boto3.resources.model import Action, Collection
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.hooks import BaseEventHooks
+from botocore.model import ServiceModel
+
+from .base import NestedDocumenter
+
+class CollectionDocumenter(NestedDocumenter):
+    def document_collections(self, section: DocumentStructure) -> None: ...
+
+def document_collection_object(
+    section: DocumentStructure, collection_model: Collection, include_signature: bool = ...
+) -> None: ...
+def document_batch_action(
+    section: DocumentStructure,
+    resource_name: str,
+    event_emitter: BaseEventHooks,
+    batch_action_model: Action,
+    service_model: ServiceModel,
+    collection_model: Collection,
+    include_signature: bool = ...,
+) -> None: ...
+def document_collection_method(
+    section: DocumentStructure,
+    resource_name: str,
+    action_name: str,
+    event_emitter: BaseEventHooks,
+    collection_model: Collection,
+    service_model: ServiceModel,
+    include_signature: bool = ...,
+) -> None: ...

boto3-stubs/docs/docstring.pyi

@@ -0,0 +1,18 @@
+"""
+Type annotations for boto3.docs.docstring module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from botocore.docs.docstring import LazyLoadedDocstring
+
+class ActionDocstring(LazyLoadedDocstring): ...
+class LoadReloadDocstring(LazyLoadedDocstring): ...
+class SubResourceDocstring(LazyLoadedDocstring): ...
+class AttributeDocstring(LazyLoadedDocstring): ...
+class IdentifierDocstring(LazyLoadedDocstring): ...
+class ReferenceDocstring(LazyLoadedDocstring): ...
+class CollectionDocstring(LazyLoadedDocstring): ...
+class CollectionMethodDocstring(LazyLoadedDocstring): ...
+class BatchActionDocstring(LazyLoadedDocstring): ...
+class ResourceWaiterDocstring(LazyLoadedDocstring): ...

boto3-stubs/docs/method.pyi

@@ -0,0 +1,27 @@
+"""
+Type annotations for boto3.docs.method module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any
+
+from boto3.resources.model import Action
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.hooks import BaseEventHooks
+
+def document_model_driven_resource_method(
+    section: DocumentStructure,
+    method_name: str,
+    operation_model: Any,
+    event_emitter: BaseEventHooks,
+    method_description: str | None = ...,
+    example_prefix: str | None = ...,
+    include_input: Any | None = ...,
+    include_output: Any | None = ...,
+    exclude_input: Any | None = ...,
+    exclude_output: Any | None = ...,
+    document_output: bool = ...,
+    resource_action_model: Action | None = ...,
+    include_signature: bool = ...,
+) -> None: ...

boto3-stubs/docs/resource.pyi

@@ -0,0 +1,20 @@
+"""
+Type annotations for boto3.docs.resource module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any
+
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.session import Session
+
+from .base import BaseDocumenter
+
+class ResourceDocumenter(BaseDocumenter):
+    def __init__(self, resource: Any, botocore_session: Session, root_docs_path: str) -> None: ...
+    def document_resource(self, section: DocumentStructure) -> None: ...
+
+class ServiceResourceDocumenter(ResourceDocumenter):
+    @property
+    def class_name(self) -> str: ...

boto3-stubs/docs/service.pyi

@@ -0,0 +1,17 @@
+"""
+Type annotations for boto3.docs.service module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.docs.service import ServiceDocumenter as BaseServiceDocumenter
+from botocore.session import Session
+
+class ServiceDocumenter(BaseServiceDocumenter):
+    EXAMPLE_PATH: str
+    sections: list[str]
+    def __init__(self, service_name: str, session: Session, root_docs_path: str) -> None: ...
+    def document_service(self) -> bytes: ...
+    def client_api(self, section: DocumentStructure) -> None: ...
+    def resource_section(self, section: DocumentStructure) -> None: ...

boto3-stubs/docs/subresource.pyi

@@ -0,0 +1,22 @@
+"""
+Type annotations for boto3.docs.subresource module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from boto3.resources.model import ResourceModel
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.model import ServiceModel
+
+from .base import NestedDocumenter
+
+class SubResourceDocumenter(NestedDocumenter):
+    def document_sub_resources(self, section: DocumentStructure) -> None: ...
+
+def document_sub_resource(
+    section: DocumentStructure,
+    resource_name: str,
+    sub_resource_model: ResourceModel,
+    service_model: ServiceModel,
+    include_signature: bool = ...,
+) -> None: ...

boto3-stubs/docs/utils.pyi

@@ -1,13 +1,24 @@
-from typing import Any, Iterable, List, Mapping, Optional
+"""
+Type annotations for boto3.docs.utils module.
 
-def get_resource_ignore_params(params: Mapping[str, Any]) -> List[str]: ...
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any, Iterable, Mapping
+
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+
+def get_resource_ignore_params(params: Mapping[str, Any]) -> list[str]: ...
 def is_resource_action(action_handle: Any) -> bool: ...
-def get_resource_public_actions(resource_class: Any) -> List[Any]: ...
+def get_resource_public_actions(resource_class: Any) -> list[Any]: ...
 def get_identifier_values_for_example(identifier_names: Iterable[str]) -> str: ...
 def get_identifier_args_for_signature(identifier_names: Iterable[str]) -> str: ...
 def get_identifier_description(resource_name: str, identifier_name: str) -> str: ...
 def add_resource_type_overview(
-    section: Any, resource_type: str, description: str, intro_link: Optional[str] = ...
+    section: DocumentStructure,
+    resource_type: str,
+    description: str,
+    intro_link: str | None = ...,
 ) -> None: ...
 
 class DocumentModifiedShape:
@@ -15,5 +26,5 @@ class DocumentModifiedShape:
         self, shape_name: str, new_type: str, new_description: str, new_example_value: str
     ) -> None: ...
     def replace_documentation_for_matching_shape(
-        self, event_name: str, section: Any, **kwargs: Any
+        self, event_name: str, section: DocumentStructure, **kwargs: Any
     ) -> None: ...

boto3-stubs/docs/waiter.pyi

@@ -0,0 +1,33 @@
+"""
+Type annotations for boto3.docs.waiter module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any
+
+from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.hooks import BaseEventHooks
+from botocore.model import ServiceModel
+from botocore.waiter import WaiterModel
+
+from .base import NestedDocumenter
+
+class WaiterResourceDocumenter(NestedDocumenter):
+    def __init__(
+        self,
+        resource: Any,
+        service_waiter_model: WaiterModel,
+        root_docs_path: str,
+    ) -> None: ...
+    def document_resource_waiters(self, section: DocumentStructure) -> None: ...
+
+def document_resource_waiter(
+    section: DocumentStructure,
+    resource_name: str,
+    event_emitter: BaseEventHooks,
+    service_model: ServiceModel,
+    resource_waiter_model: Any,
+    service_waiter_model: WaiterModel,
+    include_signature: bool = ...,
+) -> None: ...

boto3-stubs/dynamodb/conditions.pyi

@@ -1,32 +1,29 @@
-import sys
-from typing import Any, Dict, List, NamedTuple, Pattern
-
-if sys.version_info >= (3, 12):
-    from typing import Literal
-else:
-    from typing_extensions import Literal
-if sys.version_info >= (3, 12):
-    from typing import TypedDict
-else:
-    from typing_extensions import TypedDict
+"""
+Type annotations for boto3.dynamodb.conditions module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any, Literal, NamedTuple, Pattern, TypedDict
 
 ATTR_NAME_REGEX: Pattern[str]
 
-_ConditionBaseExpressionType = TypedDict(
-    "_ConditionBaseExpressionType", {"format": str, "operator": str, "values": List[Any]}
-)
+class _ConditionBaseExpressionType(TypedDict):
+    format: str
+    operator: str
+    values: list[Any]
 
 class ConditionBase:
     expression_format: str
     expression_operator: str
     has_grouped_values: bool
     def __init__(self, *values: Any) -> None: ...
-    def __and__(self, other: ConditionBase) -> "And": ...
-    def __or__(self, other: ConditionBase) -> "Or": ...
-    def __invert__(self) -> "Not": ...
+    def __and__(self, other: ConditionBase) -> And: ...
+    def __or__(self, other: ConditionBase) -> Or: ...
+    def __invert__(self) -> Not: ...
     def get_expression(self) -> _ConditionBaseExpressionType: ...
-    def __eq__(self, other: Any) -> bool: ...
-    def __ne__(self, other: Any) -> bool: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
 
 class AttributeBase:
     def __init__(self, name: str) -> None:
@@ -35,20 +32,20 @@ class AttributeBase:
     def __and__(self, value: Any) -> Any: ...
     def __or__(self, value: Any) -> Any: ...
     def __invert__(self) -> Any: ...
-    def eq(self, value: Any) -> "Equals": ...
-    def lt(self, value: Any) -> "LessThan": ...
-    def lte(self, value: Any) -> "LessThanEquals": ...
-    def gt(self, value: Any) -> "GreaterThan": ...
-    def gte(self, value: Any) -> "GreaterThanEquals": ...
-    def begins_with(self, value: Any) -> "BeginsWith": ...
-    def between(self, low_value: Any, high_value: Any) -> "Between": ...
-    def __eq__(self, other: Any) -> bool: ...
-    def __ne__(self, other: Any) -> bool: ...
+    def eq(self, value: Any) -> Equals: ...
+    def lt(self, value: Any) -> LessThan: ...
+    def lte(self, value: Any) -> LessThanEquals: ...
+    def gt(self, value: Any) -> GreaterThan: ...
+    def gte(self, value: Any) -> GreaterThanEquals: ...
+    def begins_with(self, value: Any) -> BeginsWith: ...
+    def between(self, low_value: Any, high_value: Any) -> Between: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
 
 class ConditionAttributeBase(ConditionBase, AttributeBase):
     def __init__(self, *values: Any) -> None: ...
-    def __eq__(self, other: Any) -> bool: ...
-    def __ne__(self, other: Any) -> bool: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
 
 class ComparisonCondition(ConditionBase):
     expression_format: Literal["{0} {operator} {1}"]  # type: ignore [override]
@@ -126,14 +123,10 @@ class Attr(AttributeBase):
     def size(self) -> Size: ...
     def attribute_type(self, value: Any) -> AttributeType: ...
 
-BuiltConditionExpression = NamedTuple(
-    "BuiltConditionExpression",
-    [
-        ("condition_expression", str),
-        ("attribute_name_placeholders", Dict[str, str]),
-        ("attribute_value_placeholders", Dict[str, Any]),
-    ],
-)
+class BuiltConditionExpression(NamedTuple):
+    condition_expression: str
+    attribute_name_placeholders: dict[str, str]
+    attribute_value_placeholders: dict[str, Any]
 
 class ConditionExpressionBuilder:
     def __init__(self) -> None: ...

boto3-stubs/dynamodb/table.pyi

@@ -1,16 +1,22 @@
+"""
+Type annotations for boto3.dynamodb.table module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
 import logging
 from types import TracebackType
-from typing import Any, Dict, List, Optional, Type, TypeVar
+from typing import Any, TypeVar
 
 from botocore.client import BaseClient
 
 logger: logging.Logger
 
-def register_table_methods(base_classes: List[Any], **kwargs: Any) -> None: ...
+def register_table_methods(base_classes: list[Any], **kwargs: Any) -> None: ...
 
 class TableResource:
     def __init__(self, *args: Any, **kwargs: Any) -> None: ...
-    def batch_writer(self, overwrite_by_pkeys: Optional[List[str]] = ...) -> "BatchWriter": ...
+    def batch_writer(self, overwrite_by_pkeys: list[str] | None = ...) -> BatchWriter: ...
 
 _R = TypeVar("_R")
 
@@ -20,14 +26,14 @@ class BatchWriter:
         table_name: str,
         client: BaseClient,
         flush_amount: int = ...,
-        overwrite_by_pkeys: Optional[List[str]] = ...,
+        overwrite_by_pkeys: list[str] | None = ...,
     ) -> None: ...
-    def put_item(self, Item: Dict[str, Any]) -> None: ...
-    def delete_item(self, Key: Dict[str, Any]) -> None: ...
+    def put_item(self, Item: dict[str, Any]) -> None: ...
+    def delete_item(self, Key: dict[str, Any]) -> None: ...
     def __enter__(self: _R) -> _R: ...
     def __exit__(
         self,
-        exc_type: Optional[Type[Exception]],
-        exc_value: Optional[Exception],
-        tb: Optional[TracebackType],
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        tb: TracebackType | None,
     ) -> None: ...

boto3-stubs/dynamodb/transform.pyi

@@ -1,11 +1,17 @@
-from typing import Any, Callable, Dict, List, Optional
+"""
+Type annotations for boto3.dynamodb.transform module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
+from typing import Any, Callable
 
 from boto3.dynamodb.conditions import ConditionExpressionBuilder
 from boto3.dynamodb.types import TypeDeserializer, TypeSerializer
 from boto3.resources.model import ResourceModel
 from botocore.model import Shape
 
-def register_high_level_interface(base_classes: List[Any], **kwargs: Any) -> None: ...
+def register_high_level_interface(base_classes: list[Any], **kwargs: Any) -> None: ...
 def copy_dynamodb_params(params: Any, **kwargs: Any) -> Any: ...
 
 class DynamoDBHighLevelResource:
@@ -14,27 +20,27 @@ class DynamoDBHighLevelResource:
 class TransformationInjector:
     def __init__(
         self,
-        transformer: Optional[ParameterTransformer] = ...,
-        condition_builder: Optional[ConditionExpressionBuilder] = ...,
-        serializer: Optional[TypeSerializer] = ...,
-        deserializer: Optional[TypeDeserializer] = ...,
+        transformer: ParameterTransformer | None = ...,
+        condition_builder: ConditionExpressionBuilder | None = ...,
+        serializer: TypeSerializer | None = ...,
+        deserializer: TypeDeserializer | None = ...,
     ) -> None: ...
     def inject_condition_expressions(
-        self, params: Dict[str, Any], model: ResourceModel
+        self, params: dict[str, Any], model: ResourceModel
     ) -> None: ...
     def inject_attribute_value_input(
-        self, params: Dict[str, Any], model: ResourceModel
+        self, params: dict[str, Any], model: ResourceModel
     ) -> None: ...
     def inject_attribute_value_output(
-        self, parsed: Dict[str, Any], model: ResourceModel
+        self, parsed: dict[str, Any], model: ResourceModel
     ) -> None: ...
 
 class ConditionExpressionTransformation:
     def __init__(
         self,
         condition_builder: ConditionExpressionBuilder,
-        placeholder_names: List[str],
-        placeholder_values: List[str],
+        placeholder_names: list[str],
+        placeholder_values: list[str],
         is_key_condition: bool = ...,
     ) -> None: ...
     def __call__(self, value: Any) -> Any: ...
@@ -42,7 +48,7 @@ class ConditionExpressionTransformation:
 class ParameterTransformer:
     def transform(
         self,
-        params: Dict[str, Any],
+        params: dict[str, Any],
         model: Shape,
         transformation: Callable[[Any], Any],
         target_shape: str,

boto3-stubs/dynamodb/types.pyi

@@ -1,32 +1,23 @@
-import sys
+"""
+Type annotations for boto3.dynamodb.types module.
+
+Copyright 2024 Vlad Emelianov
+"""
+
 from decimal import Context
-from typing import Any, Mapping, Sequence, Tuple
-
-if sys.version_info >= (3, 12):
-    from typing import Literal
-else:
-    from typing_extensions import Literal
-if sys.version_info >= (3, 12):
-    from typing import TypedDict
-else:
-    from typing_extensions import TypedDict
-
-_AttributeValueTypeDef = TypedDict(
-    "_AttributeValueTypeDef",
-    {
-        "S": str,
-        "N": str,
-        "B": bytes,
-        "SS": Sequence[str],
-        "NS": Sequence[str],
-        "BS": Sequence[bytes],
-        "M": Mapping[str, Any],
-        "L": Sequence[Any],
-        "NULL": bool,
-        "BOOL": bool,
-    },
-    total=False,
-)
+from typing import Any, Literal, Mapping, Sequence, TypedDict
+
+class _AttributeValueTypeDef(TypedDict, total=False):
+    S: str
+    N: str
+    B: bytes
+    SS: Sequence[str]
+    NS: Sequence[str]
+    BS: Sequence[bytes]
+    M: Mapping[str, Any]
+    L: Sequence[Any]
+    NULL: bool
+    BOOL: bool
 
 STRING: Literal["S"]
 NUMBER: Literal["N"]
@@ -41,14 +32,12 @@ LIST: Literal["L"]
 
 DYNAMODB_CONTEXT: Context
 
-BINARY_TYPES: Tuple[Any, ...]
+BINARY_TYPES: tuple[Any, ...]
 
 class Binary:
     def __init__(self, value: Any) -> None: ...
-    def __eq__(self, other: Any) -> bool: ...
-    def __ne__(self, other: Any) -> bool: ...
-    def __repr__(self) -> str: ...
-    def __str__(self) -> str: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
     def __bytes__(self) -> str: ...
     def __hash__(self) -> int: ...