def waiter_api(self, section): if self._client.waiter_names: service_waiter_model = self._session.get_waiter_model( self._service_name) waiter_documenter = WaiterDocumenter( self._client, service_waiter_model) waiter_documenter.document_waiters(section)
class TestWaiterDocumenter(BaseDocsTest): def setUp(self): super(TestWaiterDocumenter, self).setUp() self.add_shape_to_params('Biz', 'String') self.setup_client() waiter_model = WaiterModel(self.waiter_json_model) self.waiter_documenter = WaiterDocumenter( client=self.client, service_waiter_model=waiter_model) def test_document_waiters(self): self.waiter_documenter.document_waiters( self.doc_structure) self.assert_contains_lines_in_order([ '=======', 'Waiters', '=======', 'The available waiters are:', '* :py:class:`MyService.Waiter.SampleOperationComplete`', '.. py:class:: MyService.Waiter.SampleOperationComplete', ' ::', ' waiter = client.get_waiter(\'sample_operation_complete\')', ' .. py:method:: wait(**kwargs)', (' 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**', ' ::', ' waiter.wait(', ' Biz=\'string\'', ' )', ' :type Biz: string', ' :param Biz:', ' :returns: None' ])
def _document_waiters(self, section): if self._client.waiter_names: service_waiter_model = self._botocore_session.get_waiter_model( self._service_name) waiter_documenter = WaiterDocumenter(self._client, service_waiter_model) waiter_documenter.document_waiters(section)
class TestWaiterDocumenter(BaseDocsTest): def setUp(self): super(TestWaiterDocumenter, self).setUp() self.add_shape_to_params("Biz", "String") self.setup_client() waiter_model = WaiterModel(self.waiter_json_model) self.waiter_documenter = WaiterDocumenter(client=self.client, service_waiter_model=waiter_model) def test_document_waiters(self): self.waiter_documenter.document_waiters(self.doc_structure) self.assert_contains_lines_in_order( [ "=======", "Waiters", "=======", "The available waiters are:", "* :py:class:`MyService.Waiter.SampleOperationComplete`", ".. py:class:: MyService.Waiter.SampleOperationComplete", " ::", " waiter = client.get_waiter('sample_operation_complete')", " .. py:method:: wait(**kwargs)", ( " 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**", " ::", " waiter.wait(", " Biz='string'", " )", " :type Biz: string", " :param Biz:", " :returns: None", ] )