def _add_waiters(self, section):
section = section.add_new_section("waiters")
waiters = self._resource.meta.resource_model.waiters
if waiters:
service_waiter_model = self._botocore_session.get_waiter_model(self._service_name)
documenter = WaiterResourceDocumenter(self._resource, service_waiter_model)
documenter.member_map = self.member_map
documenter.document_resource_waiters(section)
def _add_waiters(self, section):
section = section.add_new_section('waiters')
waiters = self._resource.meta.resource_model.waiters
if waiters:
service_waiter_model = self._botocore_session.get_waiter_model(
self._service_name)
documenter = WaiterResourceDocumenter(self._resource,
service_waiter_model)
documenter.member_map = self.member_map
documenter.document_resource_waiters(section)
def test_document_resource_waiters(self):
service_waiter_model = self.botocore_session.get_waiter_model(
'myservice')
subresource = self.resource.Sample('mysample')
waiter_documenter = WaiterResourceDocumenter(subresource,
service_waiter_model)
waiter_documenter.document_resource_waiters(self.doc_structure)
self.assert_contains_lines_in_order([
'.. py:method:: wait_until_complete(**kwargs)',
(' Waits until this Sample is complete. This method calls '
':py:meth:`MyService.Waiter.sample_operation_complete.wait` '
'which polls. :py:meth:`MyService.Client.sample_operation` '
'every 15 seconds until a successful state is reached. An '
'error is returned after 40 failed checks.'),
' **Request Syntax** ', ' ::', ' sample.wait_until_complete(',
" Bar='string'", ' )', ' :type Bar: string',
' :param Bar: Documents Bar', ' :returns: None'
])
def test_document_resource_waiters(self):
service_waiter_model = self.botocore_session.get_waiter_model(
'myservice')
subresource = self.resource.Sample('mysample')
waiter_documenter = WaiterResourceDocumenter(
subresource, service_waiter_model)
waiter_documenter.document_resource_waiters(self.doc_structure)
self.assert_contains_lines_in_order([
'.. py:method:: wait_until_complete(**kwargs)',
(' Waits until this Sample is complete. This method calls '
':py:meth:`MyService.Waiter.sample_operation_complete.wait` '
'which polls. :py:meth:`MyService.Client.sample_operation` '
'every 15 seconds until a successful state is reached. An '
'error is returned after 40 failed checks.'),
' **Request Syntax** ',
' ::',
' sample.wait_until_complete(',
" Bar='string'",
' )',
' :type Bar: string',
' :param Bar: Documents Bar',
' :returns: None'
])