From cbfec4bb0e96cce60197580adf1650ca067c2b98 Mon Sep 17 00:00:00 2001 From: Pablo Hoffman Date: Sun, 22 Aug 2010 05:48:03 -0300 Subject: [PATCH] Renamed webservice ManagerResource to CrawlerResource --HG-- rename : scrapy/contrib/webservice/manager.py => scrapy/contrib/webservice/crawler.py --- docs/topics/webservice.rst | 33 +++++++++++++++------------- scrapy/conf/default_settings.py | 2 +- scrapy/contrib/webservice/crawler.py | 10 +++++++++ scrapy/contrib/webservice/manager.py | 10 --------- 4 files changed, 29 insertions(+), 26 deletions(-) create mode 100644 scrapy/contrib/webservice/crawler.py delete mode 100644 scrapy/contrib/webservice/manager.py diff --git a/docs/topics/webservice.rst b/docs/topics/webservice.rst index 0d824be89..0306190c9 100644 --- a/docs/topics/webservice.rst +++ b/docs/topics/webservice.rst @@ -45,17 +45,20 @@ Available JSON-RPC resources These are the JSON-RPC resources available by default in Scrapy: -Execution Manager JSON-RPC resource -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. _topics-webservice-crawler: -.. module:: scrapy.contrib.webservice.manager - :synopsis: Execution Manager JSON-RPC resource +Crawler JSON-RPC resource +~~~~~~~~~~~~~~~~~~~~~~~~~ -.. class:: ManagerResource +.. module:: scrapy.contrib.webservice.crawler + :synopsis: Crawler JSON-RPC resource - Provides access to the Execution Manager that controls the crawler. +.. class:: CrawlerResource - Available by default at: http://localhost:6080/manager + Provides access to the main Crawler object that controls the Scrapy + process. + + Available by default at: http://localhost:6080/crawler Stats Collector JSON-RPC resource ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -72,29 +75,29 @@ Stats Collector JSON-RPC resource Spider Manager JSON-RPC resource ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can access the spider manager JSON-RPC resource through the Execution -Manager resource at: http://localhost:6080/manager/spiders +You can access the spider manager JSON-RPC resource through the +:ref:`topics-webservice-crawler` at: http://localhost:6080/crawler/spiders Extension Manager JSON-RPC resource ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can access the extension manager JSON-RPC resource through the Execution -Manager resource at: http://localhost:6080/manager/extensions +You can access the extension manager JSON-RPC resource through the +:ref:`topics-webservice-crawler` at: http://localhost:6080/crawler/spiders Available JSON resources ------------------------ These are the JSON resources available by default: -Extension Manager JSON-RPC resource -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Engine status JSON resource +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. module:: scrapy.contrib.webservice.enginestatus :synopsis: Engine Status JSON resource .. class:: EngineStatusResource - Provides access to the Extension Manager used by the crawler. + Provides access to engine status metrics. Available by default at: http://localhost:6080/enginestatus @@ -148,7 +151,7 @@ WEBSERVICE_RESOURCES_BASE Default:: { - 'scrapy.contrib.webservice.manager.ManagerResource': 1, + 'scrapy.contrib.webservice.crawler.CrawlerResource': 1, 'scrapy.contrib.webservice.enginestatus.EngineStatusResource': 1, 'scrapy.contrib.webservice.stats.StatsResource': 1, } diff --git a/scrapy/conf/default_settings.py b/scrapy/conf/default_settings.py index d24447447..d2a922d8f 100644 --- a/scrapy/conf/default_settings.py +++ b/scrapy/conf/default_settings.py @@ -257,7 +257,7 @@ WEBSERVICE_LOGFILE = None WEBSERVICE_PORT = 6080 WEBSERVICE_RESOURCES = {} WEBSERVICE_RESOURCES_BASE = { - 'scrapy.contrib.webservice.manager.ManagerResource': 1, + 'scrapy.contrib.webservice.crawler.CrawlerResource': 1, 'scrapy.contrib.webservice.enginestatus.EngineStatusResource': 1, 'scrapy.contrib.webservice.stats.StatsResource': 1, } diff --git a/scrapy/contrib/webservice/crawler.py b/scrapy/contrib/webservice/crawler.py new file mode 100644 index 000000000..04c38ce02 --- /dev/null +++ b/scrapy/contrib/webservice/crawler.py @@ -0,0 +1,10 @@ +from scrapy.webservice import JsonRpcResource +from scrapy.project import crawler + +class CrawlerResource(JsonRpcResource): + + ws_name = 'crawler' + + def __init__(self, _crawler=crawler): + JsonRpcResource.__init__(self) + self._target = _crawler diff --git a/scrapy/contrib/webservice/manager.py b/scrapy/contrib/webservice/manager.py deleted file mode 100644 index 520f9f808..000000000 --- a/scrapy/contrib/webservice/manager.py +++ /dev/null @@ -1,10 +0,0 @@ -from scrapy.webservice import JsonRpcResource -from scrapy.project import crawler - -class ManagerResource(JsonRpcResource): - - ws_name = 'manager' - - def __init__(self, _manager=crawler): - JsonRpcResource.__init__(self) - self._target = _manager