Once you've written code that uses the civis.APIClient, you've got to test it. We should have a page of Sphinx documentation (as a subheader on the "User Guide" page, or its own page if large enough) about how to test code that uses the APIClient. Include examples which both use the APIClient object and higher-level helpers such as the ones in civis.io.
A couple of best practices to mention:
Write functions which use the APIClient so that they take a client object as an optional parameter. For testing, you can pass in a unittest.mock.Mock object.
Use civis.tests.mocks.create_client_mock to create an autospecced Mock for testing. (Gotcha: By default, this relies on the API spec bundled with civis-python, so specs could be a bit out of date.)
Once you've written code that uses the
civis.APIClient, you've got to test it. We should have a page of Sphinx documentation (as a subheader on the "User Guide" page, or its own page if large enough) about how to test code that uses theAPIClient. Include examples which both use theAPIClientobject and higher-level helpers such as the ones incivis.io.A couple of best practices to mention:
APIClientso that they take aclientobject as an optional parameter. For testing, you can pass in aunittest.mock.Mockobject.civis.tests.mocks.create_client_mockto create an autospeccedMockfor testing. (Gotcha: By default, this relies on the API spec bundled with civis-python, so specs could be a bit out of date.)