67 lines
2.7 KiB
Python
67 lines
2.7 KiB
Python
# 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
|
|
#
|
|
# https://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 boto3.docs.client import Boto3ClientDocumenter
|
|
from tests.unit.docs import BaseDocsTest
|
|
|
|
|
|
class TestBoto3ClientDocumenter(BaseDocsTest):
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.client_documenter = Boto3ClientDocumenter(self.client)
|
|
|
|
def test_document_client(self):
|
|
self.client_documenter.document_client(self.doc_structure)
|
|
self.assert_contains_lines_in_order(
|
|
[
|
|
'======',
|
|
'Client',
|
|
'======',
|
|
'.. py:class:: MyService.Client',
|
|
' A low-level client representing AWS MyService',
|
|
' ::',
|
|
' import boto3',
|
|
' client = boto3.client(\'myservice\')',
|
|
' These are the available methods:',
|
|
' * :py:meth:`~MyService.Client.can_paginate`',
|
|
' * :py:meth:`~MyService.Client.get_paginator`',
|
|
' * :py:meth:`~MyService.Client.get_waiter`',
|
|
' * :py:meth:`~MyService.Client.sample_operation`',
|
|
' .. py:method:: can_paginate(operation_name)',
|
|
' .. py:method:: get_paginator(operation_name)',
|
|
' .. py:method:: get_waiter(waiter_name)',
|
|
' .. py:method:: sample_operation(**kwargs)',
|
|
' **Request Syntax**',
|
|
' ::',
|
|
' response = client.sample_operation(',
|
|
' Foo=\'string\'',
|
|
' Bar=\'string\'',
|
|
' )',
|
|
' :type Foo: string',
|
|
' :param Foo: Documents Foo',
|
|
' :type Bar: string',
|
|
' :param Bar: Documents Bar',
|
|
' :rtype: dict',
|
|
' :returns:',
|
|
' **Response Syntax**',
|
|
' ::',
|
|
' {',
|
|
' \'Foo\': \'string\'',
|
|
' \'Bar\': \'string\'',
|
|
' }',
|
|
' **Response Structure**',
|
|
' - *(dict) --*',
|
|
' - **Foo** *(string) --*',
|
|
' - **Bar** *(string) --*',
|
|
]
|
|
)
|