Package: responses
A utility library for mocking out therequestsPython library.NoteResponses requires Python 3.8 or newer, and requests >= 2.30.0Table of ContentsContentsTable of ContentsInstallingDeprecations and Migration PathBETA FeaturesRecord Responses to filesReplay responses (populate registry) from filesBasicsMain InterfaceShortcutsResponses as a context managerResponse ParametersException as Response bodyMatching RequestsMatching Request Body ContentsURL-encoded dataJSON encoded dataQuery Parameters MatcherQuery Parameters as a DictionaryQuery Parameters as a StringRequest Keyword Arguments MatcherRequest multipart/form-data Data ValidationRequest Fragment Identifier ValidationRequest Headers ValidationCreating Custom MatcherResponse RegistryDefault RegistryOrdered RegistryCustom RegistryDynamic ResponsesIntegration with unit test frameworksResponses as apytestfixtureAdd default responses for each testRequestMock methods: start, stop, resetAssertions on declared responsesAssert Request Call CountAssert based onResponseobjectAssert based on the exact URLAssert Request Calls dataMultiple ResponsesURL RedirectionValidateRetrymechanismUsing a callback to modify the responsePassing through real requestsViewing/Modifying registered responsesCoroutines and MultithreadingContributingEnvironment ConfigurationTests and Code Quality ValidationUnit testsType ValidationCode Quality and StyleInstallingpip install responsesDeprecations and Migration PathHere you will find a list of deprecated functionality and a migration path for each.
Please ensure to update your code according to the guidance.Deprecation and MigrationDeprecated FunctionalityDeprecated in VersionMigration Pathresponses.json_params_matcher0.14.0responses.matchers.json_params_matcherresponses.urlencoded_params_matcher0.14.0responses.matchers.urlencoded_params_matcherstreamargument inResponseandCallbackResponse0.15.0Usestreamargument in request directly.match_querystringargument inResponseandCallbackResponse.0.17.0Useresponses.matchers.query_param_matcherorresponses.matchers.query_string_matcherresponses.assert_all_requests_are_fired,responses.passthru_prefixes,responses.target0.20.0Useresponses.mock.assert_all_requests_are_fired,responses.mock.passthru_prefixes,responses.mock.targetinstead.BETA FeaturesBelow you can find a list of BETA features. Although we will try to keep the API backwards compatible
with released version, we reserve the right to change these APIs before they are considered stable. Please share your feedback viaGitHub Issues.Record Responses to filesYou can perform real requests to the server andresponseswill automatically record the output to the
file. Recorded data is stored inYAMLformat.Apply@responses._recorder.record(file_path="out.yaml")decorator to any function where you perform
requests to record responses toout.yamlfile.Following codeimportrequestsfromresponsesimport_recorderdefanother():rsp=requests.get("https://httpstat.us/500")rsp=requests.get("https://httpstat.us/202")@_recorder.record(file_path="out.yaml")deftest_recorder():rsp=requests.get("https://httpstat.us/404")rsp=requests.get("https://httpbin.org/status/wrong")another()will produce next output:responses:-response:auto_calculate_content_length:falsebody:404 Not Foundcontent_type:text/plainmethod:GETstatus:404url:https://httpstat.us/404-response:auto_calculate_content_length:falsebody:Invalid status codecontent_type:text/plainmethod:GETstatus:400url:https://httpbin.org/status/wrong-response:auto_calculate_content_length:falsebody:500 Internal Server Errorcontent_type:text/plainmethod:GETstatus:500url:https://httpstat.us/500-response:auto_calculate_content_length:falsebody:202 Acceptedcontent_type:text/plainmethod:GETstatus:202url:https://httpstat.us/202Replay responses (populate registry) from filesYou can populate your active registry from ayamlfile with recorded responses.
(SeeRecord Responses to filesto understand how to obtain a file).
To do that you need to executeresponses._add_from_file(file_path="out.yaml")within
an activated decorator or a context manager.The following code example registers apatchresponse, then all responses present inout.yamlfile and apostresponse at the end.importresponses@responses.activatedefrun():responses.patch("http://httpbin.org")responses._add_from_file(file_path="out.yaml")responses.post("http://httpbin.org/form")run()BasicsThe core ofresponsescomes from registering mock responses and covering test function
withresponses.activatedecorator.responsesprovides similar interface asrequests.Main Interfaceresponses.add(ResponseorResponse args) - allows either to registerResponseobject or directly
provide arguments ofResponseobject. SeeResponse Parametersimportresponsesimportrequests@responses.activatedeftest_simple():# Register via 'Response' objectrsp1=responses.Response(method="PUT",url="http://example.com",)responses.add(rsp1)# register via direct argumentsresponses.add(responses.GET,"http://twitter.com/api/1/foobar",json={"error":"not found"},status=404,)resp=requests.get("http://twitter.com/api/1/foobar")resp2=requests.put("http://example.com")assertresp.json()=={"error":"not found"}assertresp.status_code==404assertresp2.status_code==200assertresp2.request.method=="PUT"If you attempt to fetch a url which doesn’t hit a match,responseswill raise
aConnectionError:importresponsesimportrequestsfromrequests.exceptionsimportConnectionError@responses.activatedeftest_simple():withpytest.raises(ConnectionError):requests.get("http://twitter.com/api/1/foobar")ShortcutsShortcuts provide a shorten version ofresponses.add()where method argument is prefilledresponses.delete(Response args) - register DELETE responseresponses.get(Response args) - register GET responseresponses.head(Response args) - register HEAD responseresponses.options(Response args) - register OPTIONS responseresponses.patch(Response args) - register PATCH responseresponses.post(Response args) - register POST responseresponses.put(Response args) - register PUT responseimportresponsesimportrequests@responses.activatedeftest_simple():responses.get("http://twitter.com/api/1/foobar",json={"type":"get"},)responses.post("http://twitter.com/api/1/foobar",json={"type":"post"},)responses.patch("http://twitter.com/api/1/foobar",json={"type":"patch"},)resp_get=requests.get("http://twitter.com/api/1/foobar")resp_post=requests.post("http://twitter.com/api/1/foobar")resp_patch=requests.patch("http://twitter.com/api/1/foobar")assertresp_get.json()=={"type":"get"}assertresp_post.json()=={"type":"post"}assertresp_patch.json()=={"type":"patch"}Responses as a context managerInstead of wrapping the whole function with decorator you can use a context manager.importresponsesimportrequestsdeftest_my_api():withresponses.RequestsMock()asrsps:rsps.add(responses.GET,"http://twitter.com/api/1/foobar",body="{}",status=200,content_type="application/json",)resp=requests.get("http://twitter.com/api/1/foobar")assertresp.status_code==200# outside the context manager requests will hit the remote serverresp=requests.get("http://twitter.com/api/1/foobar")resp.status_code==404Response ParametersThe following attributes can be passed to a Response mock:method (str)The HTTP method (GET, POST, etc).url (strorcompiled regular expression)The full resource URL.match_querystring (bool)DEPRECATED: Useresponses.matchers.query_param_matcherorresponses.matchers.query_string_matcherInclude the query string when matching requests.
Enabled by default if the response URL contains a query string,
disabled if it doesn’t or the URL is a regular expression.body (strorBufferedReaderorException)The response body. Read moreException as Response bodyjsonA Python object representing the JSON response body. Automatically configures
the appropriate Content-Type.status (int)The HTTP status code.content_type (content_type)Defaults totext/plain.headers (dict)Response headers.stream (bool)DEPRECATED: usestreamargument in request directlyauto_calculate_content_length (bool)Disabled by default. Automatically calculates the length of a supplied string or JSON body.match (tuple)An iterable (tupleis recommended) of callbacks to match requests
based on request attributes.
Current module provides multiple matchers that you can use to match:body contents in JSON formatbody contents in URL encoded data formatrequest query parametersrequest query string (similar to query parameters but takes string as input)kwargs provided to request e.g.stream,verify‘multipart/form-data’ content and headers in requestrequest headersrequest fragment identifierAlternatively user can create custom matcher.
Read moreMatching RequestsException as Response bodyYou can pass anExceptionas the body to trigger an error on the request:importresponsesimportrequests@responses.activatedeftest_simple():responses.get("http://twitter.com/api/1/foobar",body=Exception("..."))withpytest.raises(Exception):requests.get("http://twitter.com/api/1/foobar")Matching RequestsMatching Request Body ContentsWhen adding responses for endpoints that are sent request data you can add
matchers to ensure your code is sending the right parameters and provide
different responses based on the request body contents.responsesprovides
matchers for JSON and URL-encoded request bodies.URL-encoded dataimportresponsesimportrequestsfromresponsesimportmatchers@responses.activatedeftest_calc_api():responses.post(url="http://calc.com/sum",body="4",match=[matchers.urlencoded_params_matcher({"left":"1","right":"3"})],)requests.post("http://calc.com/sum",data={"left":1,"right":3})JSON encoded dataMatching JSON encoded data can be done withmatchers.json_params_matcher().importresponsesimportrequestsfromresponsesimportmatchers@responses.activatedeftest_calc_api():responses.post(url="http://example.com/",body="one",match=[matchers.json_params_matcher({"page":{"name":"first","type":"json"}})],)resp=requests.request("POST","http://example.com/",headers={"Content-Type":"application/json"},json={"page":{"name":"first","type":"json"}},)Query Parameters MatcherQuery Parameters as a DictionaryYou can use thematchers.query_param_matcherfunction to match
against theparamsrequest parameter. Just use the same dictionary as you
will use inparamsargument inrequest.Note, do not use query parameters as part of the URL. Avoid usingmatch_querystringdeprecated argument.importresponsesimportrequestsfromresponsesimportmatchers@responses.activatedeftest_calc_api():url="http://example.com/test"params={"hello":"world","I am":"a big test"}responses.get(url=url,body="test",match=[matchers.query_param_matcher(params)],)resp=requests.get(url,params=params)constructed_url=r"http://example.com/test?I+am=a+big+test&hello=world"assertresp.url==constructed_urlassertresp.request.url==constructed_urlassertresp.request.params==paramsBy default, matcher will validate that all parameters match strictly.
To validate that only parameters specified in the matcher are present in original request
usestrict_match=False.Query Parameters as a StringAs alternative, you can use query string value inmatchers.query_string_matcherto match
query parameters in your requestimportrequestsimportresponsesfromresponsesimportmatchers@responses.activatedefmy_func():responses.get("https://httpbin.org/get",match=[matchers.query_string_matcher("didi=pro&test=1")],)resp=requests.get("https://httpbin.org/get",params={"test":1,"didi":"pro"})my_func()Request Keyword Arguments MatcherTo validate request arguments use thematchers.request_kwargs_matcherfunction to match
against the request kwargs.Only following arguments are supported:timeout,verify,proxies,stream,cert.Note, only arguments provided tomatchers.request_kwargs_matcherwill be validated.importresponsesimportrequestsfromresponsesimportmatcherswithresponses.RequestsMock(assert_all_requests_are_fired=False)asrsps:req_kwargs={"stream":True,"verify":False,}rsps.add("GET","http://111.com",match=[matchers.request_kwargs_matcher(req_kwargs)],)requests.get("http://111.com",stream=True)# >>>  Arguments don't match: {stream: True, verify: True} doesn't match {stream: True, verify: False}Request multipart/form-data Data ValidationTo validate request body and headers formultipart/form-datadata you can usematchers.multipart_matcher. Thedata, andfilesparameters provided will be compared
to the request:importrequestsimportresponsesfromresponses.matchersimportmultipart_matcher@responses.activatedefmy_func():req_data={"some":"other","data":"fields"}req_files={"file_name":b"Old World!"}responses.post(url="http://httpbin.org/post",match=[multipart_matcher(req_files,data=req_data)],)resp=requests.post("http://httpbin.org/post",files={"file_name":b"New World!"})my_func()# >>> raises ConnectionError: multipart/form-data doesn't match. Request body differs.Request Fragment Identifier ValidationTo validate request URL fragment identifier you can usematchers.fragment_identifier_matcher.
The matcher takes fragment string (everything after#sign) as input for comparison:importrequestsimportresponsesfromresponses.matchersimportfragment_identifier_matcher@responses.activatedefrun():url="http://example.com?ab=xy&zed=qwe#test=1&foo=bar"responses.get(url,match=[fragment_identifier_matcher("test=1&foo=bar")],body=b"test",)# two requests to check reversed order of fragment identifierresp=requests.get("http://example.com?ab=xy&zed=qwe#test=1&foo=bar")resp=requests.get("http://example.com?zed=qwe&ab=xy#foo=bar&test=1")run()Request Headers ValidationWhen adding responses you can specify matchers to ensure that your code is
sending the right headers and provide different responses based on the request
headers.importresponsesimportrequestsfromresponsesimportmatchers@responses.activatedeftest_content_type():responses.get(url="http://example.com/",body="hello world",match=[matchers.header_matcher({"Accept":"text/plain"})],)responses.get(url="http://example.com/",json={"content":"hello world"},match=[matchers.header_matcher({"Accept":"application/json"})],)# request in reverse order to how they were added!resp=requests.get("http://example.com/",headers={"Accept":"application/json"})assertresp.json()=={"content":"hello world"}resp=requests.get("http://example.com/",headers={"Accept":"text/plain"})assertresp.text=="hello world"Becauserequestswill send several standard headers in addition to what was
specified by your code, request headers that are additional to the ones
passed to the matcher are ignored by default. You can change this behaviour by
passingstrict_match=Trueto the matcher to ensure that only the headers
that you’re expecting are sent and no others. Note that you will probably have
to use aPreparedRequestin your code to ensure thatrequestsdoesn’t
include any additional headers.importresponsesimportrequestsfromresponsesimportmatchers@responses.activatedeftest_content_type():responses.get(url="http://example.com/",body="hello world",match=[matchers.header_matcher({"Accept":"text/plain"},strict_match=True)],)# this will fail because requests adds its own headerswithpytest.raises(ConnectionError):requests.get("http://example.com/",headers={"Accept":"text/plain"})# a prepared request where you overwrite the headers before sending will worksession=requests.Session()prepped=session.prepare_request(requests.Request(method="GET",url="http://example.com/",))prepped.headers={"Accept":"text/plain"}resp=session.send(prepped)assertresp.text=="hello world"Creating Custom MatcherIf your application requires other encodings or different data validation you can build
your own matcher that returnsTuple[matches: bool, reason: str].
Where boolean representsTrueorFalseif the request parameters match and
the string is a reason in case of match failure. Your matcher can
expect aPreparedRequestparameter to be provided byresponses.Note,PreparedRequestis customized and has additional attributesparamsandreq_kwargs.Response RegistryDefault RegistryBy default,responseswill search all registeredResponseobjects and
return a match. If only oneResponseis registered, the registry is kept unchanged.
However, if multiple matches are found for the same request, then first match is returned and
removed from registry.Ordered RegistryIn some scenarios it is important to preserve the order of the requests and responses.
You can useregistries.OrderedRegistryto force allResponseobjects to be dependent
on the insertion order and invocation index.
In following example we add multipleResponseobjects that target the same URL. However,
you can see, that status code will depend on the invocation order.importrequestsimportresponsesfromresponses.registriesimportOrderedRegistry@responses.activate(registry=OrderedRegistry)deftest_invocation_index():responses.get("http://twitter.com/api/1/foobar",json={"msg":"not found"},status=404,)responses.get("http://twitter.com/api/1/foobar",json={"msg":"OK"},status=200,)responses.get("http://twitter.com/api/1/foobar",json={"msg":"OK"},status=200,)responses.get("http://twitter.com/api/1/foobar",json={"msg":"not found"},status=404,)resp=requests.get("http://twitter.com/api/1/foobar")assertresp.status_code==404resp=requests.get("http://twitter.com/api/1/foobar")assertresp.status_code==200resp=requests.get("http://twitter.com/api/1/foobar")assertresp.status_code==200resp=requests.get("http://twitter.com/api/1/foobar")assertresp.status_code==404Custom RegistryBuilt-inregistriesare suitable for most of use cases, but to handle special conditions, you can
implement custom registry which must follow interface ofregistries.FirstMatchRegistry.
Redefining thefindmethod will allow you to create custom search logic and return
appropriateResponseExample that shows how to set custom registryimportresponsesfromresponsesimportregistriesclassCustomRegistry(registries.FirstMatchRegistry):passprint("Before tests:",responses.mock.get_registry())""" Before tests: <responses.registries.FirstMatchRegistry object> """# using function decorator@responses.activate(registry=CustomRegistry)defrun():print("Within test:",responses.mock.get_registry())""" Within test: <__main__.CustomRegistry object> """run()print("After test:",responses.mock.get_registry())""" After test: <responses.registries.FirstMatchRegistry object> """# using context managerwithresponses.RequestsMock(registry=CustomRegistry)asrsps:print("In context manager:",rsps.get_registry())""" In context manager: <__main__.CustomRegistry object> """print("After exit from context manager:",responses.mock.get_registry())"""
After exit from context manager: <responses.registries.FirstMatchRegistry object>
"""Dynamic ResponsesYou can utilize callbacks to provide dynamic responses. The callback must return
a tuple of (status,headers,body).importjsonimportresponsesimportrequests@responses.activatedeftest_calc_api():defrequest_callback(request):payload=json.loads(request.body)resp_body={"value":sum(payload["numbers"])}headers={"request-id":"728d329e-0e86-11e4-a748-0c84dc037c13"}return(200,headers,json.dumps(resp_body))responses.add_callback(responses.POST,"http://calc.com/sum",callback=request_callback,content_type="application/json",)resp=requests.post("http://calc.com/sum",json.dumps({"numbers":[1,2,3]}),headers={"content-type":"application/json"},)assertresp.json()=={"value":6}assertlen(responses.calls)==1assertresponses.calls[0].request.url=="http://calc.com/sum"assertresponses.calls[0].response.text=='{"value": 6}'assert(responses.calls[0].response.headers["request-id"]=="728d329e-0e86-11e4-a748-0c84dc037c13")You can also pass a compiled regex toadd_callbackto match multiple urls:importre,jsonfromfunctoolsimportreduceimportresponsesimportrequestsoperators={"sum":lambdax,y:x+y,"prod":lambdax,y:x*y,"pow":lambdax,y:x**y,}@responses.activatedeftest_regex_url():defrequest_callback(request):payload=json.loads(request.body)operator_name=request.path_url[1:]operator=operators[operator_name]resp_body={"value":reduce(operator,payload["numbers"])}headers={"request-id":"728d329e-0e86-11e4-a748-0c84dc037c13"}return(200,headers,json.dumps(resp_body))responses.add_callback(responses.POST,re.compile("http://calc.com/(sum|prod|pow|unsupported)"),callback=request_callback,content_type="application/json",)resp=requests.post("http://calc.com/prod",json.dumps({"numbers":[2,3,4]}),headers={"content-type":"application/json"},)assertresp.json()=={"value":24}test_regex_url()If you want to pass extra keyword arguments to the callback function, for example when reusing
a callback function to give a slightly different result, you can usefunctools.partial:fromfunctoolsimportpartialdefrequest_callback(request,id=None):payload=json.loads(request.body)resp_body={"value":sum(payload["numbers"])}headers={"request-id":id}return(200,headers,json.dumps(resp_body))responses.add_callback(responses.POST,"http://calc.com/sum",callback=partial(request_callback,id="728d329e-0e86-11e4-a748-0c84dc037c13"),content_type="application/json",)Integration with unit test frameworksResponses as apytestfixture@pytest.fixturedefmocked_responses():withresponses.RequestsMock()asrsps:yieldrspsdeftest_api(mocked_responses):mocked_responses.get("http://twitter.com/api/1/foobar",body="{}",status=200,content_type="application/json",)resp=requests.get("http://twitter.com/api/1/foobar")assertresp.status_code==200Add default responses for each testWhen run withunittesttests, this can be used to set up some
generic class-level responses, that may be complemented by each test.
Similar interface could be applied inpytestframework.classTestMyApi(unittest.TestCase):defsetUp(self):responses.get("https://example.com",body="within setup")# here go other self.responses.add(...)@responses.activatedeftest_my_func(self):responses.get("https://httpbin.org/get",match=[matchers.query_param_matcher({"test":"1","didi":"pro"})],body="within test",)resp=requests.get("https://example.com")resp2=requests.get("https://httpbin.org/get",params={"test":"1","didi":"pro"})print(resp.text)# >>> within setupprint(resp2.text)# >>> within testRequestMock methods: start, stop, resetresponseshasstart,stop,resetmethods very analogous tounittest.mock.patch.
These make it simpler to do requests mocking insetupmethods or where
you want to do multiple patches without nesting decorators or with statements.classTestUnitTestPatchSetup:defsetup(self):"""Creates ``RequestsMock`` instance and starts it."""self.r_mock=responses.RequestsMock(assert_all_requests_are_fired=True)self.r_mock.start()# optionally some default responses could be registeredself.r_mock.get("https://example.com",status=505)self.r_mock.put("https://example.com",status=506)defteardown(self):"""Stops and resets RequestsMock instance.

        If ``assert_all_requests_are_fired`` is set to ``True``, will raise an error
        if some requests were not processed.
        """self.r_mock.stop()self.r_mock.reset()deftest_function(self):resp=requests.get("https://example.com")assertresp.status_code==505resp=requests.put("https://example.com")assertresp.status_code==506Assertions on declared responsesWhen used as a context manager, Responses will, by default, raise an assertion
error if a url was registered but not accessed. This can be disabled by passing
theassert_all_requests_are_firedvalue:importresponsesimportrequestsdeftest_my_api():withresponses.RequestsMock(assert_all_requests_are_fired=False)asrsps:rsps.add(responses.GET,"http://twitter.com/api/1/foobar",body="{}",status=200,content_type="application/json",)Assert Request Call CountAssert based onResponseobjectEachResponseobject hascall_countattribute that could be inspected
to check how many times each request was matched.@responses.activatedeftest_call_count_with_matcher():rsp=responses.get("http://www.example.com",match=(matchers.query_param_matcher({}),),)rsp2=responses.get("http://www.example.com",match=(matchers.query_param_matcher({"hello":"world"}),),status=777,)requests.get("http://www.example.com")resp1=requests.get("http://www.example.com")requests.get("http://www.example.com?hello=world")resp2=requests.get("http://www.example.com?hello=world")assertresp1.status_code==200assertresp2.status_code==777assertrsp.call_count==2assertrsp2.call_count==2Assert based on the exact URLAssert that the request was called exactly n times.importresponsesimportrequests@responses.activatedeftest_assert_call_count():responses.get("http://example.com")requests.get("http://example.com")assertresponses.assert_call_count("http://example.com",1)isTruerequests.get("http://example.com")withpytest.raises(AssertionError)asexcinfo:responses.assert_call_count("http://example.com",1)assert("Expected URL 'http://example.com' to be called 1 times. Called 2 times."instr(excinfo.value))@responses.activatedeftest_assert_call_count_always_match_qs():responses.get("http://www.example.com")requests.get("http://www.example.com")requests.get("http://www.example.com?hello=world")# One call on each url, querystring is matched by defaultresponses.assert_call_count("http://www.example.com",1)isTrueresponses.assert_call_count("http://www.example.com?hello=world",1)isTrueAssert Request Calls dataRequestobject hascallslist which elements correspond toCallobjects
in the global list ofRegistry. This can be useful when the order of requests is not
guaranteed, but you need to check their correctness, for example in multithreaded
applications.importconcurrent.futuresimportresponsesimportrequests@responses.activatedeftest_assert_calls_on_resp():rsp1=responses.patch("http://www.foo.bar/1/",status=200)rsp2=responses.patch("http://www.foo.bar/2/",status=400)rsp3=responses.patch("http://www.foo.bar/3/",status=200)defupdate_user(uid,is_active):url=f"http://www.foo.bar/{uid}/"response=requests.patch(url,json={"is_active":is_active})returnresponsewithconcurrent.futures.ThreadPoolExecutor(max_workers=3)asexecutor:future_to_uid={executor.submit(update_user,uid,is_active):uidfor(uid,is_active)in[("3",True),("2",True),("1",False)]}forfutureinconcurrent.futures.as_completed(future_to_uid):uid=future_to_uid[future]response=future.result()print(f"{uid}updated with{response.status_code}status code")assertlen(responses.calls)==3# total calls countassertrsp1.call_count==1assertrsp1.calls[0]inresponses.callsassertrsp1.calls[0].response.status_code==200assertjson.loads(rsp1.calls[0].request.body)=={"is_active":False}assertrsp2.call_count==1assertrsp2.calls[0]inresponses.callsassertrsp2.calls[0].response.status_code==400assertjson.loads(rsp2.calls[0].request.body)=={"is_active":True}assertrsp3.call_count==1assertrsp3.calls[0]inresponses.callsassertrsp3.calls[0].response.status_code==200assertjson.loads(rsp3.calls[0].request.body)=={"is_active":True}Multiple ResponsesYou can also add multiple responses for the same url:importresponsesimportrequests@responses.activatedeftest_my_api():responses.get("http://twitter.com/api/1/foobar",status=500)responses.get("http://twitter.com/api/1/foobar",body="{}",status=200,content_type="application/json",)resp=requests.get("http://twitter.com/api/1/foobar")assertresp.status_code==500resp=requests.get("http://twitter.com/api/1/foobar")assertresp.status_code==200URL RedirectionIn the following example you can see how to create a redirection chain and add custom exception that will be raised
in the execution chain and contain the history of redirects.A -> 301 redirect -> B
B -> 301 redirect -> C
C -> connection issueimportpytestimportrequestsimportresponses@responses.activatedeftest_redirect():# create multiple Response objects where first two contain redirect headersrsp1=responses.Response(responses.GET,"http://example.com/1",status=301,headers={"Location":"http://example.com/2"},)rsp2=responses.Response(responses.GET,"http://example.com/2",status=301,headers={"Location":"http://example.com/3"},)rsp3=responses.Response(responses.GET,"http://example.com/3",status=200)# register above generated Responses in ``response`` moduleresponses.add(rsp1)responses.add(rsp2)responses.add(rsp3)# do the first request in order to generate genuine ``requests`` response# this object will contain genuine attributes of the response, like ``history``rsp=requests.get("http://example.com/1")responses.calls.reset()# customize exception with ``response`` attributemy_error=requests.ConnectionError("custom error")my_error.response=rsp# update body of the 3rd response with Exception, this will be raised during executionrsp3.body=my_errorwithpytest.raises(requests.ConnectionError)asexc_info:requests.get("http://example.com/1")assertexc_info.value.args[0]=="custom error"assertrsp1.urlinexc_info.value.response.history[0].urlassertrsp2.urlinexc_info.value.response.history[1].urlValidateRetrymechanismIf you are using theRetryfeatures ofurllib3and want to cover scenarios that test your retry limits, you can test those scenarios withresponsesas well. The best approach will be to use anOrdered Registryimportrequestsimportresponsesfromresponsesimportregistriesfromurllib3.utilimportRetry@responses.activate(registry=registries.OrderedRegistry)deftest_max_retries():url="https://example.com"rsp1=responses.get(url,body="Error",status=500)rsp2=responses.get(url,body="Error",status=500)rsp3=responses.get(url,body="Error",status=500)rsp4=responses.get(url,body="OK",status=200)session=requests.Session()adapter=requests.adapters.HTTPAdapter(max_retries=Retry(total=4,backoff_factor=0.1,status_forcelist=[500],method_whitelist=["GET","POST","PATCH"],))session.mount("https://",adapter)resp=session.get(url)assertresp.status_code==200assertrsp1.call_count==1assertrsp2.call_count==1assertrsp3.call_count==1assertrsp4.call_count==1Using a callback to modify the responseIf you use customized processing inrequestsvia subclassing/mixins, or if you
have library tools that interact withrequestsat a low level, you may need
to add extended processing to the mocked Response object to fully simulate the
environment for your tests.  Aresponse_callbackcan be used, which will be
wrapped by the library before being returned to the caller.  The callback
accepts aresponseas it’s single argument, and is expected to return a
singleresponseobject.importresponsesimportrequestsdefresponse_callback(resp):resp.callback_processed=Truereturnrespwithresponses.RequestsMock(response_callback=response_callback)asm:m.add(responses.GET,"http://example.com",body=b"test")resp=requests.get("http://example.com")assertresp.text=="test"asserthasattr(resp,"callback_processed")assertresp.callback_processedisTruePassing through real requestsIn some cases you may wish to allow for certain requests to pass through responses
and hit a real server. This can be done with theadd_passthrumethods:importresponses@responses.activatedeftest_my_api():responses.add_passthru("https://percy.io")This will allow any requests matching that prefix, that is otherwise not
registered as a mock response, to passthru using the standard behavior.Pass through endpoints can be configured with regex patterns if you
need to allow an entire domain or path subtree to send requests:responses.add_passthru(re.compile("https://percy.io/\\w+"))Lastly, you can use thepassthroughargument of theResponseobject
to force a response to behave as a pass through.# Enable passthrough for a single responseresponse=Response(responses.GET,"http://example.com",body="not used",passthrough=True,)responses.add(response)# Use PassthroughResponseresponse=PassthroughResponse(responses.GET,"http://example.com")responses.add(response)Viewing/Modifying registered responsesRegistered responses are available as a public method of the RequestMock
instance. It is sometimes useful for debugging purposes to view the stack of
registered responses which can be accessed viaresponses.registered().Thereplacefunction allows a previously registeredresponseto be
changed. The method signature is identical toadd.responses are
identified usingmethodandurl. Only the first matchedresponseis
replaced.importresponsesimportrequests@responses.activatedeftest_replace():responses.get("http://example.org",json={"data":1})responses.replace(responses.GET,"http://example.org",json={"data":2})resp=requests.get("http://example.org")assertresp.json()=={"data":2}Theupsertfunction allows a previously registeredresponseto be
changed likereplace. If the response is registered, theupsertfunction
will registered it likeadd.removetakes amethodandurlargument and will removeallmatched responses from the registered list.Finally,resetwill reset all registered responses.Coroutines and Multithreadingresponsessupports both Coroutines and Multithreading out of the box.
Note,responseslocks threading onRequestMockobject allowing only
single thread to access it.asyncdeftest_async_calls():@responses.activateasyncdefrun():responses.get("http://twitter.com/api/1/foobar",json={"error":"not found"},status=404,)resp=requests.get("http://twitter.com/api/1/foobar")assertresp.json()=={"error":"not found"}assertresponses.calls[0].request.url=="http://twitter.com/api/1/foobar"awaitrun()ContributingEnvironment ConfigurationResponses uses several linting and autoformatting utilities, so it’s important that when
submitting patches you use the appropriate toolchain:Clone the repository:gitclonehttps://github.com/getsentry/responses.gitCreate an environment (e.g. withvirtualenv):virtualenv.env&&source.env/bin/activateConfigure development requirements:makedevelopTests and Code Quality ValidationThe easiest way to validate your code is to run tests viatox.
Currenttoxconfiguration runs the same checks that are used in
GitHub Actions CI/CD pipeline.Please execute the following command line from the project root to validate
your code against:Unit tests in all Python versions that are supported by this projectType validation viamypyAllpre-commithookstoxAlternatively, you can always run a single test. See documentation below.Unit testsResponses usesPytestfor
testing. You can run all tests by:tox-epy37tox-epy310OR manually activate required version of Python and runpytestAnd run a single test by:pytest-k'<test_function_name>'Type ValidationTo verifytypecompliance, runmypylinter:tox-emypyORmypy--config-file=./mypy.ini-presponsesCode Quality and StyleTo check code style and reformat it run:tox-eprecomORpre-commitrun--all-files