botocore-stubs 1.34.65__py3-none-any.whl → 1.35.98__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of botocore-stubs might be problematic. Click here for more details.

Files changed (72) hide show
  1. botocore-stubs/__init__.pyi +8 -2
  2. botocore-stubs/args.pyi +27 -26
  3. botocore-stubs/auth.pyi +38 -29
  4. botocore-stubs/awsrequest.pyi +29 -23
  5. botocore-stubs/client.pyi +44 -35
  6. botocore-stubs/compat.pyi +23 -13
  7. botocore-stubs/compress.pyi +8 -3
  8. botocore-stubs/config.pyi +29 -29
  9. botocore-stubs/configloader.pyi +11 -5
  10. botocore-stubs/configprovider.pyi +40 -28
  11. botocore-stubs/credentials.pyi +105 -93
  12. botocore-stubs/crt/__init__.pyi +6 -2
  13. botocore-stubs/crt/auth.pyi +6 -2
  14. botocore-stubs/discovery.pyi +30 -14
  15. botocore-stubs/docs/__init__.pyi +6 -2
  16. botocore-stubs/docs/bcdoc/__init__.pyi +6 -0
  17. botocore-stubs/docs/bcdoc/docstringparser.pyi +13 -7
  18. botocore-stubs/docs/bcdoc/restdoc.pyi +27 -17
  19. botocore-stubs/docs/bcdoc/style.pyi +13 -7
  20. botocore-stubs/docs/client.pyi +10 -4
  21. botocore-stubs/docs/docstring.pyi +6 -2
  22. botocore-stubs/docs/example.pyi +34 -25
  23. botocore-stubs/docs/method.pyi +23 -16
  24. botocore-stubs/docs/paginator.pyi +9 -2
  25. botocore-stubs/docs/params.pyi +31 -22
  26. botocore-stubs/docs/service.pyi +14 -9
  27. botocore-stubs/docs/shape.pyi +11 -4
  28. botocore-stubs/docs/sharedexample.pyi +19 -5
  29. botocore-stubs/docs/translator.pyi +8 -2
  30. botocore-stubs/docs/utils.pyi +15 -10
  31. botocore-stubs/docs/waiter.pyi +8 -3
  32. botocore-stubs/endpoint.pyi +24 -14
  33. botocore-stubs/endpoint_provider.pyi +41 -40
  34. botocore-stubs/errorfactory.pyi +9 -3
  35. botocore-stubs/eventstream.pyi +22 -16
  36. botocore-stubs/exceptions.pyi +10 -10
  37. botocore-stubs/handlers.pyi +36 -14
  38. botocore-stubs/history.pyi +8 -2
  39. botocore-stubs/hooks.pyi +28 -22
  40. botocore-stubs/httpchecksum.pyi +15 -10
  41. botocore-stubs/httpsession.pyi +23 -17
  42. botocore-stubs/loaders.pyi +19 -13
  43. botocore-stubs/model.pyi +60 -44
  44. botocore-stubs/monitoring.pyi +29 -22
  45. botocore-stubs/paginate.pyi +38 -24
  46. botocore-stubs/parsers.pyi +13 -7
  47. botocore-stubs/regions.pyi +38 -29
  48. botocore-stubs/response.pyi +10 -4
  49. botocore-stubs/retries/adaptive.pyi +7 -1
  50. botocore-stubs/retries/base.pyi +9 -3
  51. botocore-stubs/retries/bucket.pyi +13 -9
  52. botocore-stubs/retries/quota.pyi +11 -5
  53. botocore-stubs/retries/special.pyi +9 -2
  54. botocore-stubs/retries/standard.pyi +32 -24
  55. botocore-stubs/retries/throttling.pyi +6 -0
  56. botocore-stubs/retryhandler.pyi +12 -6
  57. botocore-stubs/serialize.pyi +14 -8
  58. botocore-stubs/session.pyi +53 -55
  59. botocore-stubs/signers.pyi +40 -23
  60. botocore-stubs/stub.pyi +15 -15
  61. botocore-stubs/tokens.pyi +12 -6
  62. botocore-stubs/translate.pyi +12 -5
  63. botocore-stubs/useragent.pyi +11 -5
  64. botocore-stubs/utils.pyi +86 -76
  65. botocore-stubs/validate.pyi +7 -1
  66. botocore-stubs/waiter.pyi +11 -5
  67. {botocore_stubs-1.34.65.dist-info → botocore_stubs-1.35.98.dist-info}/METADATA +39 -20
  68. botocore_stubs-1.35.98.dist-info/RECORD +73 -0
  69. {botocore_stubs-1.34.65.dist-info → botocore_stubs-1.35.98.dist-info}/WHEEL +2 -1
  70. botocore_stubs-1.35.98.dist-info/top_level.txt +1 -0
  71. botocore_stubs-1.34.65.dist-info/RECORD +0 -72
  72. {botocore_stubs-1.34.65.dist-info → botocore_stubs-1.35.98.dist-info}/LICENSE +0 -0
@@ -1,13 +1,19 @@
1
+ """
2
+ Type annotations for botocore.discovery module.
3
+
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
1
7
  from logging import Logger
2
- from typing import Any, Callable, Dict, List, Optional
8
+ from typing import Any, Callable, Mapping
3
9
 
4
10
  from botocore.client import BaseClient
5
11
  from botocore.exceptions import BotoCoreError as BotoCoreError
6
12
  from botocore.exceptions import ConnectionError as ConnectionError
7
13
  from botocore.exceptions import HTTPClientError as HTTPClientError
8
- from botocore.model import OperationModel
14
+ from botocore.hooks import BaseEventHooks
15
+ from botocore.model import OperationModel, ServiceModel
9
16
  from botocore.model import OperationNotFoundError as OperationNotFoundError
10
- from botocore.model import ServiceModel
11
17
  from botocore.utils import CachedProperty as CachedProperty
12
18
 
13
19
  logger: Logger = ...
@@ -20,37 +26,47 @@ class EndpointDiscoveryRequired(EndpointDiscoveryException):
20
26
  class EndpointDiscoveryRefreshFailed(EndpointDiscoveryException):
21
27
  fmt: str = ...
22
28
 
23
- def block_endpoint_discovery_required_operations(model: Any, **kwargs: Any) -> None: ...
29
+ def block_endpoint_discovery_required_operations(model: OperationModel, **kwargs: Any) -> None: ...
24
30
 
25
31
  class EndpointDiscoveryModel:
26
32
  def __init__(self, service_model: ServiceModel) -> None: ...
27
33
  @CachedProperty
28
34
  def discovery_operation_name(self) -> str: ...
29
35
  @CachedProperty
30
- def discovery_operation_keys(self) -> List[str]: ...
36
+ def discovery_operation_keys(self) -> list[str]: ...
31
37
  def discovery_required_for(self, operation_name: str) -> bool: ...
32
- def discovery_operation_kwargs(self, **kwargs: Any) -> Dict[str, Any]: ...
33
- def gather_identifiers(self, operation: OperationModel, params: Any) -> Dict[str, Any]: ...
38
+ def discovery_operation_kwargs(self, **kwargs: Any) -> dict[str, Any]: ...
39
+ def gather_identifiers(
40
+ self, operation: OperationModel, params: Mapping[str, Any]
41
+ ) -> dict[str, Any]: ...
34
42
 
35
43
  class EndpointDiscoveryManager:
36
44
  def __init__(
37
45
  self,
38
46
  client: BaseClient,
39
- cache: Optional[Any] = ...,
40
- current_time: Optional[Callable[[], float]] = ...,
47
+ cache: Any | None = ...,
48
+ current_time: Callable[[], float] | None = ...,
41
49
  always_discover: bool = ...,
42
50
  ) -> None: ...
43
- def gather_identifiers(self, operation: OperationModel, params: Any) -> Any: ...
51
+ def gather_identifiers(self, operation: OperationModel, params: Mapping[str, Any]) -> Any: ...
44
52
  def delete_endpoints(self, **kwargs: Any) -> None: ...
45
53
  def describe_endpoint(self, **kwargs: Any) -> Any: ...
46
54
 
47
55
  class EndpointDiscoveryHandler:
48
- def __init__(self, manager: Any) -> None: ...
49
- def register(self, events: Any, service_id: str) -> None: ...
56
+ def __init__(self, manager: EndpointDiscoveryManager) -> None: ...
57
+ def register(self, events: BaseEventHooks, service_id: str) -> None: ...
50
58
  def gather_identifiers(
51
- self, params: Any, model: OperationModel, context: Any, **kwargs: Any
59
+ self,
60
+ params: Mapping[str, Any],
61
+ model: OperationModel,
62
+ context: Mapping[str, Any],
63
+ **kwargs: Any,
52
64
  ) -> None: ...
53
65
  def discover_endpoint(self, request: Any, operation_name: str, **kwargs: Any) -> None: ...
54
66
  def handle_retries(
55
- self, request_dict: Any, response: Any, operation: OperationModel, **kwargs: Any
67
+ self,
68
+ request_dict: Mapping[str, Any],
69
+ response: Mapping[str, Any],
70
+ operation: OperationModel,
71
+ **kwargs: Any,
56
72
  ) -> Any: ...
@@ -1,7 +1,11 @@
1
- from typing import Set
1
+ """
2
+ Type annotations for botocore.docs module.
3
+
4
+ Copyright 2024 Vlad Emelianov
5
+ """
2
6
 
3
7
  from botocore.session import Session
4
8
 
5
- DEPRECATED_SERVICE_NAMES: Set[str] = ...
9
+ DEPRECATED_SERVICE_NAMES: set[str] = ...
6
10
 
7
11
  def generate_docs(root_dir: str, session: Session) -> None: ...
@@ -1 +1,7 @@
1
+ """
2
+ Type annotations for botocore.docs.bcdoc module.
3
+
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
1
7
  __version__: str = ...
@@ -1,12 +1,18 @@
1
+ """
2
+ Type annotations for botocore.docs.bcdoc.docstringparser module.
3
+
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
1
7
  from html.parser import HTMLParser
2
- from typing import Any, List, Tuple
8
+ from typing import Any
3
9
 
4
10
  from botocore.docs.bcdoc.restdoc import ReSTDocument
5
11
 
6
- PRIORITY_PARENT_TAGS: Tuple[str, ...] = ...
7
- OMIT_NESTED_TAGS: Tuple[str, ...] = ...
8
- OMIT_SELF_TAGS: Tuple[str, ...] = ...
9
- HTML_BLOCK_DISPLAY_TAGS: Tuple[str, ...] = ...
12
+ PRIORITY_PARENT_TAGS: tuple[str, ...] = ...
13
+ OMIT_NESTED_TAGS: tuple[str, ...] = ...
14
+ OMIT_SELF_TAGS: tuple[str, ...] = ...
15
+ HTML_BLOCK_DISPLAY_TAGS: tuple[str, ...] = ...
10
16
 
11
17
  class DocStringParser(HTMLParser):
12
18
  def __init__(self, doc: Any) -> None: ...
@@ -32,8 +38,8 @@ class StemNode(Node):
32
38
  def add_child(self, child: Any) -> None: ...
33
39
  def write(self, doc: ReSTDocument) -> None: ...
34
40
  def is_whitespace(self) -> bool: ...
35
- def startswith_whitespace(self) -> List[Any]: ...
36
- def endswith_whitespace(self) -> List[Any]: ...
41
+ def startswith_whitespace(self) -> list[Any]: ...
42
+ def endswith_whitespace(self) -> list[Any]: ...
37
43
  def lstrip(self) -> None: ...
38
44
  def rstrip(self) -> None: ...
39
45
  def collapse_whitespace(self) -> None: ...
@@ -1,12 +1,19 @@
1
+ """
2
+ Type annotations for botocore.docs.bcdoc.restdoc module.
3
+
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
7
+ import re
1
8
  from logging import Logger
2
- from typing import Any, Dict, List, Optional
9
+ from typing import Any, Iterable, Mapping
3
10
 
4
11
  DEFAULT_AWS_DOCS_LINK: str = ...
5
- DOCUMENTATION_LINK_REGEX: Any = ...
12
+ DOCUMENTATION_LINK_REGEX: re.Pattern[str] = ...
6
13
  LARGE_SECTION_MESSAGE: str = ...
7
14
  LOG: Logger = ...
8
- SECTION_LINE_LIMIT_CONFIG: Dict[str, Any] = ...
9
- SECTION_METHOD_PATH_DEPTH: Dict[str, int] = ...
15
+ SECTION_LINE_LIMIT_CONFIG: dict[str, Any] = ...
16
+ SECTION_METHOD_PATH_DEPTH: dict[str, int] = ...
10
17
 
11
18
  class ReSTDocument:
12
19
  def __init__(self, target: str = ...) -> None: ...
@@ -16,8 +23,8 @@ class ReSTDocument:
16
23
  def pop_write(self) -> None: ...
17
24
  def push_write(self, s: str) -> None: ...
18
25
  def getvalue(self) -> bytes: ...
19
- def translate_words(self, words: Any) -> list[Any]: ...
20
- def handle_data(self, data: Any) -> None: ...
26
+ def translate_words(self, words: Iterable[str]) -> list[str]: ...
27
+ def handle_data(self, data: str | None) -> None: ...
21
28
  def include_doc_string(self, doc_string: str) -> None: ...
22
29
  def remove_last_doc_string(self) -> None: ...
23
30
 
@@ -25,26 +32,29 @@ class DocumentStructure(ReSTDocument):
25
32
  def __init__(
26
33
  self,
27
34
  name: str,
28
- section_names: Optional[List[str]] = ...,
29
- target: Any = ...,
30
- context: Any = ...,
35
+ section_names: list[str] | None = ...,
36
+ target: str = ...,
37
+ context: Mapping[str, Any] | None = ...,
31
38
  ) -> None: ...
32
39
  @property
33
40
  def name(self) -> str: ...
34
41
  @property
35
- def path(self) -> list[Any]: ...
42
+ def path(self) -> list[str]: ...
36
43
  @path.setter
37
- def path(self, value: Any) -> None: ...
44
+ def path(self, value: list[str]) -> None: ...
38
45
  @property
39
- def available_sections(self) -> list[Any]: ...
46
+ def available_sections(self) -> list[str]: ...
40
47
  @property
41
- def context(self) -> Dict[str, Any]: ...
42
- def add_new_section(self, name: str, context: Any = ...) -> Any: ...
43
- def get_section(self, name: str) -> Any: ...
48
+ def context(self) -> dict[str, Any]: ...
49
+ def add_new_section(
50
+ self, name: str, context: Mapping[str, Any] | None = ...
51
+ ) -> DocumentStructure: ...
52
+ def get_section(self, name: str) -> DocumentStructure: ...
53
+ def has_section(self, name: str) -> bool: ...
44
54
  def delete_section(self, name: str) -> None: ...
45
- def flush_structure(self, docs_link: Optional[str] = ...) -> bytes: ...
55
+ def flush_structure(self, docs_link: str | None = ...) -> bytes: ...
46
56
  def getvalue(self) -> bytes: ...
47
57
  def remove_all_sections(self) -> None: ...
48
58
  def clear_text(self) -> None: ...
49
- def add_title_section(self, title: str) -> Any: ...
59
+ def add_title_section(self, title: str) -> DocumentStructure: ...
50
60
  def write_to_file(self, full_path: str, file_name: str) -> None: ...
@@ -1,10 +1,16 @@
1
+ """
2
+ Type annotations for botocore.docs.bcdoc.style module.
3
+
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
1
7
  from logging import Logger
2
- from typing import Any, Optional, Tuple
8
+ from typing import Any
3
9
 
4
10
  from botocore.docs.bcdoc.restdoc import ReSTDocument
5
11
 
6
12
  logger: Logger = ...
7
- PUNCTUATION_CHARACTERS: Tuple[str, ...] = ...
13
+ PUNCTUATION_CHARACTERS: tuple[str, ...] = ...
8
14
 
9
15
  class BaseStyle:
10
16
  def __init__(self, doc: ReSTDocument, indent_width: int = ...) -> None: ...
@@ -17,7 +23,7 @@ class BaseStyle:
17
23
  def dedent(self) -> None: ...
18
24
  def spaces(self) -> str: ...
19
25
  def bold(self, s: str) -> str: ...
20
- def ref(self, link: Optional[str], title: Optional[str] = ...) -> str: ...
26
+ def ref(self, link: str | None, title: str | None = ...) -> str: ...
21
27
  def h2(self, s: str) -> str: ...
22
28
  def h3(self, s: str) -> str: ...
23
29
  def underline(self, s: str) -> str: ...
@@ -33,7 +39,7 @@ class ReSTStyle(BaseStyle):
33
39
  def start_b(self, attrs: Any = ...) -> None: ...
34
40
  def end_b(self) -> None: ...
35
41
  def bold(self, s: str) -> None: ... # type: ignore[override]
36
- def ref(self, title: str, link: Optional[str] = ...) -> None: ... # type: ignore[override]
42
+ def ref(self, title: str, link: str | None = ...) -> None: ... # type: ignore[override]
37
43
  def h1(self, s: str) -> None: ...
38
44
  def h2(self, s: str) -> None: ... # type: ignore[override]
39
45
  def h3(self, s: str) -> None: ... # type: ignore[override]
@@ -53,7 +59,7 @@ class ReSTStyle(BaseStyle):
53
59
  def end_danger(self) -> None: ...
54
60
  def start_a(self, attrs: Any = ...) -> None: ...
55
61
  def link_target_definition(self, refname: str, link: str) -> None: ...
56
- def sphinx_reference_label(self, label: str, text: Optional[str] = ...) -> None: ...
62
+ def sphinx_reference_label(self, label: str, text: str | None = ...) -> None: ...
57
63
  def end_a(self, next_child: Any = ...) -> None: ...
58
64
  def start_i(self, attrs: Any = ...) -> None: ...
59
65
  def end_i(self) -> None: ...
@@ -72,10 +78,10 @@ class ReSTStyle(BaseStyle):
72
78
  def end_codeblock(self) -> None: ...
73
79
  def codeblock(self, code: str) -> None: ...
74
80
  def toctree(self) -> None: ...
75
- def tocitem(self, item: str, file_name: Optional[str] = ...) -> None: ...
81
+ def tocitem(self, item: str, file_name: str | None = ...) -> None: ...
76
82
  def hidden_toctree(self) -> None: ...
77
83
  def hidden_tocitem(self, item: str) -> None: ...
78
- def table_of_contents(self, title: Optional[str] = ..., depth: Optional[int] = ...) -> None: ...
84
+ def table_of_contents(self, title: str | None = ..., depth: int | None = ...) -> None: ...
79
85
  def start_sphinx_py_class(self, class_name: str) -> None: ...
80
86
  def end_sphinx_py_class(self) -> None: ...
81
87
  def start_sphinx_py_method(self, method_name: str, parameters: Any = ...) -> None: ...
@@ -1,16 +1,22 @@
1
- from typing import Any, Callable, Dict, List, Optional, Tuple
1
+ """
2
+ Type annotations for botocore.docs.client module.
3
+
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
7
+ from typing import Any, Callable
2
8
 
3
9
  from botocore.client import BaseClient
4
10
  from botocore.docs.bcdoc.restdoc import DocumentStructure
5
11
  from botocore.docs.utils import DocumentedShape
6
12
 
7
13
  class ClientDocumenter:
8
- _CLIENT_METHODS_FILTERS: List[Callable[..., bool]] = ...
14
+ _CLIENT_METHODS_FILTERS: list[Callable[..., bool]] = ...
9
15
  def __init__(
10
16
  self,
11
17
  client: BaseClient,
12
18
  root_docs_path: str,
13
- shared_examples: Optional[Dict[str, Any]] = ...,
19
+ shared_examples: dict[str, Any] | None = ...,
14
20
  ) -> None: ...
15
21
  def document_client(self, section: DocumentStructure) -> None: ...
16
22
 
@@ -22,6 +28,6 @@ class ClientExceptionsDocumenter:
22
28
 
23
29
  class ClientContextParamsDocumenter:
24
30
  _CONFIG_GUIDE_LINK: str = ...
25
- OMITTED_CONTEXT_PARAMS: Dict[str, Tuple[str, ...]] = ...
31
+ OMITTED_CONTEXT_PARAMS: dict[str, tuple[str, ...]] = ...
26
32
  def __init__(self, service_name: str, context_params: Any) -> None: ...
27
33
  def document_context_params(self, section: DocumentStructure) -> None: ...
@@ -1,11 +1,15 @@
1
+ """
2
+ Type annotations for botocore.docs.docstring module.
3
+
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
1
7
  from typing import Any
2
8
 
3
9
  class LazyLoadedDocstring(str):
4
10
  def __init__(self, *args: Any, **kwargs: Any) -> None: ...
5
11
  def __new__(cls, *args: Any, **kwargs: Any) -> Any: ...
6
12
  def expandtabs(self, tabsize: Any = ...) -> str: ...
7
- def __str__(self) -> str: ...
8
- def __repr__(self) -> str: ...
9
13
 
10
14
  class ClientMethodDocstring(LazyLoadedDocstring): ...
11
15
  class WaiterDocstring(LazyLoadedDocstring): ...
@@ -1,61 +1,70 @@
1
- from typing import Any, List, Optional
1
+ """
2
+ Type annotations for botocore.docs.example module.
2
3
 
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
7
+ from typing import Any
8
+
9
+ from botocore.docs.bcdoc.restdoc import DocumentStructure
3
10
  from botocore.docs.shape import ShapeDocumenter
4
11
  from botocore.model import Shape
5
12
 
6
13
  class BaseExampleDocumenter(ShapeDocumenter):
7
14
  def document_example(
8
15
  self,
9
- section: Any,
16
+ section: DocumentStructure,
10
17
  shape: Shape,
11
- prefix: Optional[str] = ...,
12
- include: Optional[List[str]] = ...,
13
- exclude: Optional[List[str]] = ...,
18
+ prefix: str | None = ...,
19
+ include: list[str] | None = ...,
20
+ exclude: list[str] | None = ...,
21
+ ) -> None: ...
22
+ def document_recursive_shape(
23
+ self, section: DocumentStructure, shape: Shape, **kwargs: Any
14
24
  ) -> None: ...
15
- def document_recursive_shape(self, section: Any, shape: Shape, **kwargs: Any) -> None: ...
16
25
  def document_shape_default(
17
26
  self,
18
- section: Any,
27
+ section: DocumentStructure,
19
28
  shape: Shape,
20
29
  history: Any,
21
- include: Optional[List[str]] = ...,
22
- exclude: Optional[List[str]] = ...,
30
+ include: list[str] | None = ...,
31
+ exclude: list[str] | None = ...,
23
32
  **kwargs: Any,
24
33
  ) -> None: ...
25
34
  def document_shape_type_string(
26
35
  self,
27
- section: Any,
36
+ section: DocumentStructure,
28
37
  shape: Shape,
29
38
  history: Any,
30
- include: Optional[List[str]] = ...,
31
- exclude: Optional[List[str]] = ...,
39
+ include: list[str] | None = ...,
40
+ exclude: list[str] | None = ...,
32
41
  **kwargs: Any,
33
42
  ) -> None: ...
34
43
  def document_shape_type_list(
35
44
  self,
36
- section: Any,
45
+ section: DocumentStructure,
37
46
  shape: Shape,
38
47
  history: Any,
39
- include: Optional[List[str]] = ...,
40
- exclude: Optional[List[str]] = ...,
48
+ include: list[str] | None = ...,
49
+ exclude: list[str] | None = ...,
41
50
  **kwargs: Any,
42
51
  ) -> None: ...
43
52
  def document_shape_type_structure(
44
53
  self,
45
- section: Any,
54
+ section: DocumentStructure,
46
55
  shape: Shape,
47
56
  history: Any,
48
- include: Optional[List[str]] = ...,
49
- exclude: Optional[List[str]] = ...,
57
+ include: list[str] | None = ...,
58
+ exclude: list[str] | None = ...,
50
59
  **kwargs: Any,
51
60
  ) -> None: ...
52
61
  def document_shape_type_map(
53
62
  self,
54
- section: Any,
63
+ section: DocumentStructure,
55
64
  shape: Shape,
56
65
  history: Any,
57
- include: Optional[List[str]] = ...,
58
- exclude: Optional[List[str]] = ...,
66
+ include: list[str] | None = ...,
67
+ exclude: list[str] | None = ...,
59
68
  **kwargs: Any,
60
69
  ) -> None: ...
61
70
 
@@ -63,7 +72,7 @@ class ResponseExampleDocumenter(BaseExampleDocumenter):
63
72
  EVENT_NAME: str = ...
64
73
  def document_shape_type_event_stream(
65
74
  self,
66
- section: Any,
75
+ section: DocumentStructure,
67
76
  shape: Shape,
68
77
  history: Any,
69
78
  **kwargs: Any,
@@ -73,10 +82,10 @@ class RequestExampleDocumenter(BaseExampleDocumenter):
73
82
  EVENT_NAME: str = ...
74
83
  def document_shape_type_structure(
75
84
  self,
76
- section: Any,
85
+ section: DocumentStructure,
77
86
  shape: Shape,
78
87
  history: Any,
79
- include: Optional[List[str]] = ...,
80
- exclude: Optional[List[str]] = ...,
88
+ include: list[str] | None = ...,
89
+ exclude: list[str] | None = ...,
81
90
  **kwargs: Any,
82
91
  ) -> None: ...
@@ -1,37 +1,44 @@
1
- from typing import Any, Dict, Optional, Sequence
1
+ """
2
+ Type annotations for botocore.docs.method module.
2
3
 
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
7
+ from typing import Any, Sequence
8
+
9
+ from botocore.docs.bcdoc.restdoc import DocumentStructure
3
10
  from botocore.hooks import BaseEventHooks
4
11
  from botocore.model import OperationModel
5
12
 
6
13
  AWS_DOC_BASE: str = ...
7
14
 
8
- def get_instance_public_methods(instance: Any) -> Dict[str, Any]: ...
15
+ def get_instance_public_methods(instance: Any) -> dict[str, Any]: ...
9
16
  def document_model_driven_signature(
10
- section: Any,
17
+ section: DocumentStructure,
11
18
  name: str,
12
19
  operation_model: OperationModel,
13
- include: Optional[Sequence[str]] = ...,
14
- exclude: Optional[Sequence[str]] = ...,
20
+ include: Sequence[str] | None = ...,
21
+ exclude: Sequence[str] | None = ...,
15
22
  ) -> None: ...
16
23
  def document_custom_signature(
17
- section: Any,
24
+ section: DocumentStructure,
18
25
  name: str,
19
26
  method: Any,
20
- include: Optional[Sequence[str]] = ...,
21
- exclude: Optional[Sequence[str]] = ...,
27
+ include: Sequence[str] | None = ...,
28
+ exclude: Sequence[str] | None = ...,
22
29
  ) -> None: ...
23
- def document_custom_method(section: Any, method_name: str, method: Any) -> None: ...
30
+ def document_custom_method(section: DocumentStructure, method_name: str, method: Any) -> None: ...
24
31
  def document_model_driven_method(
25
- section: Any,
32
+ section: DocumentStructure,
26
33
  method_name: str,
27
34
  operation_model: OperationModel,
28
35
  event_emitter: BaseEventHooks,
29
- method_description: Optional[str] = ...,
30
- example_prefix: Optional[str] = ...,
31
- include_input: Optional[Dict[str, Any]] = ...,
32
- include_output: Optional[Dict[str, Any]] = ...,
33
- exclude_input: Optional[Sequence[str]] = ...,
34
- exclude_output: Optional[Sequence[str]] = ...,
36
+ method_description: str | None = ...,
37
+ example_prefix: str | None = ...,
38
+ include_input: dict[str, Any] | None = ...,
39
+ include_output: dict[str, Any] | None = ...,
40
+ exclude_input: Sequence[str] | None = ...,
41
+ exclude_output: Sequence[str] | None = ...,
35
42
  document_output: bool = ...,
36
43
  include_signature: bool = ...,
37
44
  ) -> None: ...
@@ -1,6 +1,13 @@
1
+ """
2
+ Type annotations for botocore.docs.paginator module.
3
+
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
1
7
  from typing import Any
2
8
 
3
9
  from botocore.client import BaseClient
10
+ from botocore.docs.bcdoc.restdoc import DocumentStructure
4
11
  from botocore.hooks import BaseEventHooks
5
12
  from botocore.model import ServiceModel
6
13
 
@@ -8,10 +15,10 @@ class PaginatorDocumenter:
8
15
  def __init__(
9
16
  self, client: BaseClient, service_paginator_model: ServiceModel, root_docs_path: str
10
17
  ) -> None: ...
11
- def document_paginators(self, section: Any) -> None: ...
18
+ def document_paginators(self, section: DocumentStructure) -> None: ...
12
19
 
13
20
  def document_paginate_method(
14
- section: Any,
21
+ section: DocumentStructure,
15
22
  paginator_name: str,
16
23
  event_emitter: BaseEventHooks,
17
24
  service_model: ServiceModel,
@@ -1,52 +1,61 @@
1
- from typing import Any, Optional, Sequence
1
+ """
2
+ Type annotations for botocore.docs.params module.
2
3
 
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
7
+ from typing import Any, Sequence
8
+
9
+ from botocore.docs.bcdoc.restdoc import DocumentStructure
3
10
  from botocore.docs.shape import ShapeDocumenter
4
11
  from botocore.model import Shape
5
12
 
6
13
  class BaseParamsDocumenter(ShapeDocumenter):
7
14
  def document_params(
8
15
  self,
9
- section: Any,
16
+ section: DocumentStructure,
10
17
  shape: Shape,
11
- include: Optional[Sequence[str]] = ...,
12
- exclude: Optional[Sequence[str]] = ...,
18
+ include: Sequence[str] | None = ...,
19
+ exclude: Sequence[str] | None = ...,
20
+ ) -> None: ...
21
+ def document_recursive_shape(
22
+ self, section: DocumentStructure, shape: Shape, **kwargs: Any
13
23
  ) -> None: ...
14
- def document_recursive_shape(self, section: Any, shape: Shape, **kwargs: Any) -> None: ...
15
24
  def document_shape_default(
16
25
  self,
17
- section: Any,
26
+ section: DocumentStructure,
18
27
  shape: Shape,
19
28
  history: Any,
20
- include: Optional[Sequence[str]] = ...,
21
- exclude: Optional[Sequence[str]] = ...,
29
+ include: Sequence[str] | None = ...,
30
+ exclude: Sequence[str] | None = ...,
22
31
  **kwargs: Any,
23
32
  ) -> None: ...
24
33
  def document_shape_type_list(
25
34
  self,
26
- section: Any,
35
+ section: DocumentStructure,
27
36
  shape: Shape,
28
37
  history: Any,
29
- include: Optional[Sequence[str]] = ...,
30
- exclude: Optional[Sequence[str]] = ...,
38
+ include: Sequence[str] | None = ...,
39
+ exclude: Sequence[str] | None = ...,
31
40
  **kwargs: Any,
32
41
  ) -> None: ...
33
42
  def document_shape_type_map(
34
43
  self,
35
- section: Any,
44
+ section: DocumentStructure,
36
45
  shape: Shape,
37
46
  history: Any,
38
- include: Optional[Sequence[str]] = ...,
39
- exclude: Optional[Sequence[str]] = ...,
47
+ include: Sequence[str] | None = ...,
48
+ exclude: Sequence[str] | None = ...,
40
49
  **kwargs: Any,
41
50
  ) -> None: ...
42
51
  def document_shape_type_structure(
43
52
  self,
44
- section: Any,
53
+ section: DocumentStructure,
45
54
  shape: Shape,
46
55
  history: Any,
47
- include: Optional[Sequence[str]] = ...,
48
- exclude: Optional[Sequence[str]] = ...,
49
- name: Optional[str] = ...,
56
+ include: Sequence[str] | None = ...,
57
+ exclude: Sequence[str] | None = ...,
58
+ name: str | None = ...,
50
59
  **kwargs: Any,
51
60
  ) -> None: ...
52
61
 
@@ -54,7 +63,7 @@ class ResponseParamsDocumenter(BaseParamsDocumenter):
54
63
  EVENT_NAME: str = ...
55
64
  def document_shape_type_event_stream(
56
65
  self,
57
- section: Any,
66
+ section: DocumentStructure,
58
67
  shape: Shape,
59
68
  history: Any,
60
69
  **kwargs: Any,
@@ -64,10 +73,10 @@ class RequestParamsDocumenter(BaseParamsDocumenter):
64
73
  EVENT_NAME: str = ...
65
74
  def document_shape_type_structure( # type: ignore[override]
66
75
  self,
67
- section: Any,
76
+ section: DocumentStructure,
68
77
  shape: Shape,
69
78
  history: Any,
70
- include: Optional[Sequence[str]] = ...,
71
- exclude: Optional[Sequence[str]] = ...,
79
+ include: Sequence[str] | None = ...,
80
+ exclude: Sequence[str] | None = ...,
72
81
  **kwargs: Any,
73
82
  ) -> None: ...
@@ -1,15 +1,20 @@
1
- from typing import Any, List, Optional
1
+ """
2
+ Type annotations for botocore.docs.service module.
2
3
 
4
+ Copyright 2024 Vlad Emelianov
5
+ """
6
+
7
+ from botocore.docs.bcdoc.restdoc import DocumentStructure
3
8
  from botocore.session import Session
4
9
 
5
10
  class ServiceDocumenter:
6
11
  def __init__(self, service_name: str, session: Session, root_docs_path: str) -> None: ...
7
12
  def document_service(self) -> bytes: ...
8
- def title(self, section: Any) -> None: ...
9
- def table_of_contents(self, section: Any) -> None: ...
10
- def client_api(self, section: Any) -> None: ...
11
- def client_exceptions(self, section: Any) -> None: ...
12
- def paginator_api(self, section: Any) -> None: ...
13
- def waiter_api(self, section: Any) -> None: ...
14
- def get_examples(self, service_name: str, api_version: Optional[str] = ...) -> List[str]: ...
15
- def client_context_params(self, section: Any) -> None: ...
13
+ def title(self, section: DocumentStructure) -> None: ...
14
+ def table_of_contents(self, section: DocumentStructure) -> None: ...
15
+ def client_api(self, section: DocumentStructure) -> None: ...
16
+ def client_exceptions(self, section: DocumentStructure) -> None: ...
17
+ def paginator_api(self, section: DocumentStructure) -> None: ...
18
+ def waiter_api(self, section: DocumentStructure) -> None: ...
19
+ def get_examples(self, service_name: str, api_version: str | None = ...) -> list[str]: ...
20
+ def client_context_params(self, section: DocumentStructure) -> None: ...