Dekker1/Fourmi
Archived
1
0
Fork 0
Code

Added documentation to the basic Source

Browse Source
This commit is contained in:
Jip J. Dekker 2014-06-01 20:24:54 +02:00
parent c27a875d68
commit f7d0fb4a45
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
FourmiCrawler/sources/source.py
View File

@ -7,15 +7,32 @@ class Source:
_spider = None _spider = None
def __init__(self): def __init__(self):
"""
Initiation of a new Source
"""
pass pass
def parse(self, reponse): def parse(self, reponse):
"""
This function should be able to parse all Scrapy Response objects with a URL matching the website Regex.
:param reponse: A Scrapy Response object
:return: A list of Result items and new Scrapy Requests
"""
log.msg("The parse function of the empty parser was used.", level=log.WARNING) log.msg("The parse function of the empty parser was used.", level=log.WARNING)
pass pass
def new_compound_request(self, compound): def new_compound_request(self, compound):
"""
This function should return a Scrapy Request for the given compound request.
:param compound: A compound name.
:return: A new Scrapy Request
"""
# return Request(url=self.website[:-1] + compound, callback=self.parse) # return Request(url=self.website[:-1] + compound, callback=self.parse)
pass pass
def set_spider(self, spider): def set_spider(self, spider):
"""
A Function to save the associated spider.
:param spider: A FourmiSpider object
"""
self._spider = spider self._spider = spider