Initial commit

2019-11-17 12:44:16 +01:00
parent e41eae7301
commit a3ef27c7a0
4894 changed files with 1771218 additions and 0 deletions
--- a/parkingkonceptvenv/lib/python3.7/site-packages/boto3/docs/action.py
+++ b/parkingkonceptvenv/lib/python3.7/site-packages/boto3/docs/action.py
@@ -0,0 +1,148 @@
+# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+from botocore import xform_name
+from botocore.model import OperationModel
+from botocore.utils import get_service_module_name
+from botocore.docs.method import document_model_driven_method
+from botocore.docs.method import document_custom_method
+
+from boto3.docs.base import BaseDocumenter
+from boto3.docs.method import document_model_driven_resource_method
+from boto3.docs.utils import get_resource_ignore_params
+from boto3.docs.utils import get_resource_public_actions
+from boto3.docs.utils import add_resource_type_overview
+
+
+class ActionDocumenter(BaseDocumenter):
+    def document_actions(self, section):
+        modeled_actions_list = self._resource_model.actions
+        modeled_actions = {}
+        for modeled_action in modeled_actions_list:
+            modeled_actions[modeled_action.name] = modeled_action
+        resource_actions = get_resource_public_actions(
+            self._resource.__class__)
+        self.member_map['actions'] = sorted(resource_actions)
+        add_resource_type_overview(
+            section=section,
+            resource_type='Actions',
+            description=(
+                'Actions call operations on resources.  They may '
+                'automatically handle the passing in of arguments set '
+                'from identifiers and some attributes.'),
+            intro_link='actions_intro')
+
+        for action_name in sorted(resource_actions):
+            action_section = section.add_new_section(action_name)
+            if action_name in ['load', 'reload'] and self._resource_model.load:
+                document_load_reload_action(
+                    section=action_section,
+                    action_name=action_name,
+                    resource_name=self._resource_name,
+                    event_emitter=self._resource.meta.client.meta.events,
+                    load_model=self._resource_model.load,
+                    service_model=self._service_model
+                )
+            elif action_name in modeled_actions:
+                document_action(
+                    section=action_section,
+                    resource_name=self._resource_name,
+                    event_emitter=self._resource.meta.client.meta.events,
+                    action_model=modeled_actions[action_name],
+                    service_model=self._service_model,
+                )
+            else:
+                document_custom_method(
+                    action_section, action_name, resource_actions[action_name])
+
+
+def document_action(section, resource_name, event_emitter, action_model,
+                    service_model, include_signature=True):
+    """Documents a resource action
+
+    :param section: The section to write to
+
+    :param resource_name: The name of the resource
+
+    :param event_emitter: The event emitter to use to emit events
+
+    :param action_model: The model of the action
+
+    :param service_model: The model of the service
+
+    :param include_signature: Whether or not to include the signature.
+        It is useful for generating docstrings.
+    """
+    operation_model = service_model.operation_model(
+        action_model.request.operation)
+    ignore_params = get_resource_ignore_params(action_model.request.params)
+
+    example_return_value = 'response'
+    if action_model.resource:
+        example_return_value = xform_name(action_model.resource.type)
+    example_resource_name = xform_name(resource_name)
+    if service_model.service_name == resource_name:
+        example_resource_name = resource_name
+    example_prefix = '%s = %s.%s' % (
+        example_return_value, example_resource_name, action_model.name)
+    document_model_driven_resource_method(
+        section=section, method_name=action_model.name,
+        operation_model=operation_model,
+        event_emitter=event_emitter,
+        method_description=operation_model.documentation,
+        example_prefix=example_prefix,
+        exclude_input=ignore_params,
+        resource_action_model=action_model,
+        include_signature=include_signature
+    )
+
+
+def document_load_reload_action(section, action_name, resource_name,
+                                event_emitter, load_model, service_model,
+                                include_signature=True):
+    """Documents the resource load action
+
+    :param section: The section to write to
+
+    :param action_name: The name of the loading action should be load or reload
+
+    :param resource_name: The name of the resource
+
+    :param event_emitter: The event emitter to use to emit events
+
+    :param load_model: The model of the load action
+
+    :param service_model: The model of the service
+
+    :param include_signature: Whether or not to include the signature.
+        It is useful for generating docstrings.
+    """
+    description = (
+        'Calls  :py:meth:`%s.Client.%s` to update the attributes of the'
+        ' %s resource. Note that the load and reload methods are '
+        'the same method and can be used interchangeably.' % (
+            get_service_module_name(service_model),
+            xform_name(load_model.request.operation),
+            resource_name)
+    )
+    example_resource_name = xform_name(resource_name)
+    if service_model.service_name == resource_name:
+        example_resource_name = resource_name
+    example_prefix = '%s.%s' % (example_resource_name, action_name)
+    document_model_driven_method(
+        section=section, method_name=action_name,
+        operation_model=OperationModel({}, service_model),
+        event_emitter=event_emitter,
+        method_description=description,
+        example_prefix=example_prefix,
+        include_signature=include_signature
+    )