Mirroring/vcrpy
1
0
Fork 0
mirror of https://github.com/kevin1024/vcrpy.git synced 2025-12-11 01:53:01 +00:00
Code Releases Activity

update the documentation of custom matchers

Browse Source 
Add documentation on creating a matcher with an `assert` statement that provides assertion messages in case of failures.
This commit is contained in:
Arthur Hamon
2019-06-13 15:14:11 +02:00
parent 28d9899b9b
commit f414e04f49
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/advanced.rst
View File

@@ -97,8 +97,12 @@ Create your own method with the following signature
def my_matcher(r1, r2): def my_matcher(r1, r2):
Your method receives the two requests and must return ``True`` if they Your method receives the two requests and can return :
match, ``False`` if they don't.
- Use an ``assert`` statement in the matcher, then we have ``None`` if they match, raise an `AssertionError`` if they don't.
- A boolean, ``True`` if they match, ``False`` if they don't.
Note : You should use an ``assert`` statement in order to have feedback when a matcher is failing.
Finally, register your method with VCR to use your new request matcher. Finally, register your method with VCR to use your new request matcher.
@@ -107,7 +111,7 @@ Finally, register your method with VCR to use your new request matcher.
import vcr import vcr
def jurassic_matcher(r1, r2): def jurassic_matcher(r1, r2):
return r1.uri == r2.uri and 'JURASSIC PARK' in r1.body assert r1.uri == r2.uri and 'JURASSIC PARK' in r1.body
my_vcr = vcr.VCR() my_vcr = vcr.VCR()
my_vcr.register_matcher('jurassic', jurassic_matcher) my_vcr.register_matcher('jurassic', jurassic_matcher)