Changeset 1833:99f58d4e1866

Timestamp:

11/06/09 15:54:17 (9 months ago)

Author:

Pablo Hoffman <pablo@…>

Branch:

default

Message:

renamed CloseDomain? extension to CloseSpider?, and renamed CLOSEDOMAIN_* settings to CLOSESPIDER_*

Files:

• docs/topics/extensions.rst (modified) (4 diffs)
• scrapy/conf/default_settings.py (modified) (2 diffs)
• scrapy/contrib/closespider.py (moved) (moved from scrapy/contrib/closedomain.py) (3 diffs)

docs/topics/extensions.rst

@@ -280 +280 @@
 ~~~~~~~~~~~~~~~~~~~~~~
 
-.. module:: scrapy.contrib.closedomain
+.. module:: scrapy.contrib.closespider
    :synopsis: Close domain extension
 
-.. class:: scrapy.contrib.closedomain.CloseDomain
+.. class:: scrapy.contrib.closespider.CloseSpider
 
 Closes a domain/spider automatically when some conditions are met, using a
@@ -291 +291 @@
 settings. Other conditions will be supported in the future.
 
-.. setting:: CLOSEDOMAIN_TIMEOUT
-
-CLOSEDOMAIN_TIMEOUT
+.. setting:: CLOSESPIDER_TIMEOUT
+
+CLOSESPIDER_TIMEOUT
 """""""""""""""""""
 
@@ -300 +300 @@
 An integer which specifies a number of seconds. If the domain remains open for
 more than that number of second, it will be automatically closed with the
-reason ``closedomain_timeout``. If zero (or non set) domains won't be closed by
+reason ``closespider_timeout``. If zero (or non set) domains won't be closed by
 timeout.
 
-.. setting:: CLOSEDOMAIN_ITEMPASSED
-
-CLOSEDOMAIN_ITEMPASSED
+.. setting:: CLOSESPIDER_ITEMPASSED
+
+CLOSESPIDER_ITEMPASSED
 """"""""""""""""""""""
 
@@ -312 +312 @@
 An integer which specifies a number of items. If the spider scrapes more than
 that amount if items and those items are passed by the item pipeline, the
-domain will be closed with the reason ``closedomain_itempassed``. If zero (or
+domain will be closed with the reason ``closespider_itempassed``. If zero (or
 non set) domains won't be closed by number of passed items.
 

scrapy/conf/default_settings.py

@@ -19 +19 @@
 BOT_VERSION = '1.0'
 
-CLOSEDOMAIN_TIMEOUT = 0
-CLOSEDOMAIN_ITEMPASSED = 0
+CLOSESPIDER_TIMEOUT = 0
+CLOSESPIDER_ITEMPASSED = 0
 
 COMMANDS_MODULE = ''
@@ -87 +87 @@
     'scrapy.contrib.memusage.MemoryUsage': 0,
     'scrapy.contrib.memdebug.MemoryDebugger': 0,
-    'scrapy.contrib.closedomain.CloseDomain': 0,
+    'scrapy.contrib.closespider.CloseSpider': 0,
 }
 

scrapy/contrib/closespider.py

@@ -1 @@
-"""CloseDomain is an extension that forces spiders to be closed after certain
+"""CloseSpider is an extension that forces spiders to be closed after certain
 conditions are met.
 
@@ -14 +14 @@
 from scrapy.conf import settings
 
-class CloseDomain(object):
+class CloseSpider(object):
 
     def __init__(self):
-        self.timeout = settings.getint('CLOSEDOMAIN_TIMEOUT')
-        self.itempassed = settings.getint('CLOSEDOMAIN_ITEMPASSED')
+        self.timeout = settings.getint('CLOSESPIDER_TIMEOUT')
+        self.itempassed = settings.getint('CLOSESPIDER_ITEMPASSED')
 
         self.counts = defaultdict(int)
@@ -31 +31 @@
     def spider_opened(self, spider):
         self.tasks[spider] = reactor.callLater(self.timeout, scrapyengine.close_spider, \
-            spider=spider, reason='closedomain_timeout')
+            spider=spider, reason='closespider_timeout')
         
     def item_passed(self, item, spider):
         self.counts[spider] += 1
         if self.counts[spider] == self.itempassed:
-            scrapyengine.close_spider(spider, 'closedomain_itempassed')
+            scrapyengine.close_spider(spider, 'closespider_itempassed')
 
     def spider_closed(self, spider):