class TestClientDocumenter(BaseDocsTest):
def setUp(self):
super(TestClientDocumenter, self).setUp()
self.add_shape_to_params('Biz', 'String')
self.setup_client()
self.client_documenter = ClientDocumenter(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::',
' client = session.create_client(\'myservice\')',
' These are the available methods:',
' * :py:meth:`can_paginate`', ' * :py:meth:`get_paginator`',
' * :py:meth:`get_waiter`', ' * :py:meth:`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(',
' Biz=\'string\'', ' )', ' :type Biz: string',
' :param Biz:', ' :rtype: dict', ' :returns:',
' **Response Syntax**', ' ::', ' {',
' \'Biz\': \'string\'', ' }',
' **Response Structure**', ' - *(dict) --*',
' - **Biz** *(string) --*'
])
def setUp(self):
super(TestClientDocumenter, self).setUp()
exception_shape = {
'SomeException': {
'exception': True,
'type': 'structure',
'members': {
'Message': {'shape': 'String'}
},
}
}
self.add_shape(exception_shape)
self.add_shape_to_params('Biz', 'String')
self.add_shape_to_errors('SomeException')
self.setup_client()
self.client_documenter = ClientDocumenter(self.client)
def client_api(self, section):
examples = None
try:
examples = self.get_examples(self._service_name)
except DataNotFoundError:
pass
ClientDocumenter(self._client, examples).document_client(section)
class TestClientDocumenter(BaseDocsTest):
def setUp(self):
super(TestClientDocumenter, self).setUp()
self.add_shape_to_params('Biz', 'String')
self.setup_client()
self.client_documenter = ClientDocumenter(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::',
' client = session.create_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(',
' Biz=\'string\'',
' )',
' :type Biz: string',
' :param Biz:',
' :rtype: dict',
' :returns:',
' **Response Syntax**',
' ::',
' {',
' \'Biz\': \'string\'',
' }',
' **Response Structure**',
' - *(dict) --*',
' - **Biz** *(string) --*'
])
def setUp(self):
super(TestClientDocumenter, self).setUp()
self.add_shape_to_params('Biz', 'String')
self.setup_client()
self.client_documenter = ClientDocumenter(self.client)
def client_api(self, section):
ClientDocumenter(self._client).document_client(section)
def setUp(self):
super(TestClientDocumenter, self).setUp()
self.add_shape_to_params('Biz', 'String')
self.setup_client()
self.client_documenter = ClientDocumenter(self.client)
