Scrapy, a fast high-level web crawling & scraping framework for Python.
Add the API documentation of ContractFail to the contracts topic
Adrián Chavesa0bbbe8ffa78
diff --git a/docs/topics/contracts.rst b/docs/topics/contracts.rstindex 9337375bb..05b1d161b 100644--- a/docs/topics/contracts.rst+++ b/docs/topics/contracts.rst@@ -69,7 +69,7 @@ create and load your own contracts in the project by using the'myproject.contracts.ItemValidate': 10,}-Each contract must inherit from :class:`scrapy.contracts.Contract` and can+Each contract must inherit from :class:`~scrapy.contracts.Contract` and canoverride three methods:.. module:: scrapy.contracts@@ -102,9 +102,14 @@ override three methods:This allows processing the output of the callback. Iterators areconverted listified before being passed to this hook.+Raise :class:`~scrapy.exceptions.ContractFail` from+:class:`~scrapy.contracts.Contract.pre_process` or+:class:`~scrapy.contracts.Contract.post_process` if expectations are not met:++.. autoclass:: scrapy.exceptions.ContractFail+Here is a demo contract which checks the presence of a custom header in the-response received. Raise :class:`scrapy.exceptions.ContractFail` in order to-get the failures pretty printed::+response received::from scrapy.contracts import Contractfrom scrapy.exceptions import ContractFail