-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
147 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
from typing import Dict, List, Any | ||
from boto3.docs.base import NestedDocumenter | ||
from botocore.hooks import BaseEventHooks | ||
|
||
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: Any) -> None: ... | ||
|
||
def document_action( | ||
section: Any, | ||
resource_name: str, | ||
event_emitter: BaseEventHooks, | ||
action_model: Any, | ||
service_model: Any, | ||
include_signature: bool = ..., | ||
) -> None: ... | ||
def document_load_reload_action( | ||
section: Any, | ||
action_name: str, | ||
resource_name: str, | ||
event_emitter: BaseEventHooks, | ||
load_model: Any, | ||
service_model: Any, | ||
include_signature: bool = ..., | ||
) -> None: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
from typing import Any | ||
from botocore.docs.params import ResponseParamsDocumenter | ||
from botocore.hooks import BaseEventHooks | ||
|
||
class ResourceShapeDocumenter(ResponseParamsDocumenter): | ||
EVENT_NAME: str | ||
|
||
def document_attribute( | ||
section: Any, | ||
service_name: str, | ||
resource_name: str, | ||
attr_name: str, | ||
event_emitter: BaseEventHooks, | ||
attr_model: Any, | ||
include_signature: bool = True, | ||
) -> None: ... | ||
def document_identifier( | ||
section: Any, resource_name: str, identifier_model: Any, include_signature: bool = ... | ||
) -> None: ... | ||
def document_reference( | ||
section: Any, reference_model: Any, include_signature: bool = ... | ||
) -> None: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
from typing import Any, Dict | ||
|
||
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: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
from botocore.docs.client import ClientDocumenter | ||
|
||
class Boto3ClientDocumenter(ClientDocumenter): ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
from typing import Any | ||
from boto3.docs.base import NestedDocumenter | ||
from botocore.hooks import BaseEventHooks | ||
|
||
class CollectionDocumenter(NestedDocumenter): | ||
def document_collections(self, section: Any) -> None: ... | ||
|
||
def document_collection_object( | ||
section: Any, collection_model: Any, include_signature: bool = ... | ||
) -> None: ... | ||
def document_batch_action( | ||
section: Any, | ||
resource_name: str, | ||
event_emitter: BaseEventHooks, | ||
batch_action_model: Any, | ||
service_model: Any, | ||
collection_model: Any, | ||
include_signature: bool = ..., | ||
) -> None: ... | ||
def document_collection_method( | ||
section: Any, | ||
resource_name: str, | ||
action_name: str, | ||
event_emitter: BaseEventHooks, | ||
collection_model: Any, | ||
service_model: Any, | ||
include_signature: bool = ..., | ||
) -> None: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
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): ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
from typing import Any, Optional | ||
from botocore.hooks import BaseEventHooks | ||
|
||
def document_model_driven_resource_method( | ||
section: Any, | ||
method_name: str, | ||
operation_model: Any, | ||
event_emitter: BaseEventHooks, | ||
method_description: Optional[str] = ..., | ||
example_prefix: Optional[str] = ..., | ||
include_input: Optional[Any] = ..., | ||
include_output: Optional[Any] = ..., | ||
exclude_input: Optional[Any] = ..., | ||
exclude_output: Optional[Any] = ..., | ||
document_output: bool = ..., | ||
resource_action_model: Optional[Any] = ..., | ||
include_signature: bool = ..., | ||
) -> None: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
from typing import Any | ||
from boto3.docs.base import BaseDocumenter | ||
|
||
class ResourceDocumenter(BaseDocumenter): | ||
def __init__(self, resource: Any, botocore_session: Any, root_docs_path: str) -> None: ... | ||
def document_resource(self, section: Any) -> None: ... | ||
|
||
class ServiceResourceDocumenter(ResourceDocumenter): | ||
@property | ||
def class_name(self) -> str: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
from typing import Any, List | ||
from botocore.docs.service import ServiceDocumenter as BaseServiceDocumenter | ||
|
||
class ServiceDocumenter(BaseServiceDocumenter): | ||
EXAMPLE_PATH: str | ||
sections: List[str] | ||
def __init__(self, service_name: str, session: Any, root_docs_path: str) -> None: ... | ||
def document_service(self) -> bytes: ... | ||
def client_api(self, section: Any) -> None: ... | ||
def resource_section(self, section: Any) -> None: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters