scrapy.commands.ScrapyCommand

class documentation

class ScrapyCommand: (source)

Known subclasses: scrapy.commands.BaseRunSpiderCommand, scrapy.commands.bench.Command, scrapy.commands.check.Command, scrapy.commands.edit.Command, scrapy.commands.fetch.Command, scrapy.commands.genspider.Command, scrapy.commands.list.Command, scrapy.commands.settings.Command, scrapy.commands.shell.Command, scrapy.commands.startproject.Command, scrapy.commands.version.Command

View In Hierarchy

Undocumented

Method	`__init__`	Undocumented
Method	`add_options`	Populate option parse with options available for this command
Method	`help`	An extensive help for the command. It will be shown when using the "help" command. It can contain newlines since no post-formatting will be applied to its contents.
Method	`long_desc`	A long description of the command. Return short description when not available. It cannot contain newlines since contents will be formatted by optparser which removes newlines and wraps text.
Method	`process_options`	Undocumented
Method	`run`	Entry point for running commands
Method	`set_crawler`	Undocumented
Method	`short_desc`	A short description of the command
Method	`syntax`	Command syntax (preferably one-line). Do not include command name.
Class Variable	`crawler_process`	Undocumented
Class Variable	`default_settings`	Undocumented
Class Variable	`exitcode`	Undocumented
Class Variable	`requires_project`	Undocumented
Instance Variable	`settings`	Undocumented
Instance Variable	`_crawler`	Undocumented

def __init__(self): (source) ¶

Undocumented

def add_options(self, parser): (source) ¶

overridden in scrapy.commands.BaseRunSpiderCommand, scrapy.commands.check.Command, scrapy.commands.fetch.Command, scrapy.commands.genspider.Command, scrapy.commands.settings.Command, scrapy.commands.shell.Command, scrapy.commands.version.Command

Populate option parse with options available for this command

def help(self): (source) ¶

An extensive help for the command. It will be shown when using the "help" command. It can contain newlines since no post-formatting will be applied to its contents.

def long_desc(self): (source) ¶

overridden in scrapy.commands.edit.Command, scrapy.commands.fetch.Command, scrapy.commands.runspider.Command, scrapy.commands.shell.Command

A long description of the command. Return short description when not available. It cannot contain newlines since contents will be formatted by optparser which removes newlines and wraps text.

def process_options(self, args, opts): (source) ¶

overridden in scrapy.commands.BaseRunSpiderCommand

Undocumented

def run(self, args, opts): (source) ¶

overridden in scrapy.commands.bench.Command, scrapy.commands.check.Command, scrapy.commands.crawl.Command, scrapy.commands.edit.Command, scrapy.commands.fetch.Command, scrapy.commands.genspider.Command, scrapy.commands.list.Command, scrapy.commands.parse.Command, scrapy.commands.runspider.Command, scrapy.commands.settings.Command, scrapy.commands.shell.Command, scrapy.commands.startproject.Command, scrapy.commands.version.Command

Entry point for running commands

def set_crawler(self, crawler): (source) ¶

Undocumented

def short_desc(self): (source) ¶

A short description of the command

def syntax(self): (source) ¶

overridden in scrapy.commands.check.Command, scrapy.commands.crawl.Command, scrapy.commands.edit.Command, scrapy.commands.fetch.Command, scrapy.commands.genspider.Command, scrapy.commands.parse.Command, scrapy.commands.runspider.Command, scrapy.commands.settings.Command, scrapy.commands.shell.Command, scrapy.commands.startproject.Command, scrapy.commands.version.Command

Command syntax (preferably one-line). Do not include command name.

crawler_process: Optional[CrawlerProcess] = (source) ¶

Undocumented

default_settings: Dict[str, Any] = (source) ¶

overridden in scrapy.commands.bench.Command, scrapy.commands.check.Command, scrapy.commands.edit.Command, scrapy.commands.genspider.Command, scrapy.commands.list.Command, scrapy.commands.runspider.Command, scrapy.commands.settings.Command, scrapy.commands.shell.Command, scrapy.commands.startproject.Command, scrapy.commands.version.Command

Undocumented

exitcode: int = (source) ¶

overridden in scrapy.commands.crawl.Command, scrapy.commands.edit.Command, scrapy.commands.genspider.Command, scrapy.commands.runspider.Command, scrapy.commands.startproject.Command

Undocumented

requires_project: bool = (source) ¶

overridden in scrapy.commands.check.Command, scrapy.commands.crawl.Command, scrapy.commands.edit.Command, scrapy.commands.fetch.Command, scrapy.commands.genspider.Command, scrapy.commands.list.Command, scrapy.commands.parse.Command, scrapy.commands.runspider.Command, scrapy.commands.settings.Command, scrapy.commands.shell.Command, scrapy.commands.startproject.Command

Undocumented

settings: Any = (source) ¶

Undocumented

_crawler = (source) ¶

Undocumented