Scrapy, a fast high-level web crawling & scraping framework for Python.
Document how to write custom spider templates (#8049)
Adrianda7c2fc59e28
diff --git a/docs/topics/commands.rst b/docs/topics/commands.rstindex 75d377a8e..c5ff19c26 100644--- a/docs/topics/commands.rst+++ b/docs/topics/commands.rst@@ -262,6 +262,39 @@ pre-defined templates, but certainly not the only way to create spiders. Youcan just create the spider source code files yourself, instead of using thiscommand.+.. _spider-templates:++Custom spider templates+~~~~~~~~~~~~~~~~~~~~~~~++To define your own spider templates, point :setting:`TEMPLATES_DIR` at a+directory with a :file:`spiders` subdirectory, and write a :file:`{name}.tmpl`+file there for every template, where *name* is the value to pass to ``-t``.+Your templates replace the built-in ones, which live in the :file:`templates`+directory of the ``scrapy`` package, so copy over any of those that you want to+keep.++Templates are rendered with :class:`string.Template`: ``$variable`` and+``${variable}`` are replaced, and ``$$`` renders as a single ``$``, which+regular expressions often need. Rendering fails on any variable other than the+following:++- ``name``: the spider name, as passed to the command.++- ``module``: *name* as a valid module name, also used as the file name of+ the generated spider.++- ``classname``: *module* in camel case, with a ``Spider`` suffix.++- ``url``: the URL passed to the command, with an ``https`` scheme added if+ it had none.++- ``domain``: the domain of *url*.++- ``project_name``: :setting:`BOT_NAME`.++- ``ProjectName``: *project_name* in camel case.+.. command:: crawlcrawldiff --git a/docs/topics/settings.rst b/docs/topics/settings.rstindex ffa8e6075..06a03e69e 100644--- a/docs/topics/settings.rst+++ b/docs/topics/settings.rst@@ -2188,7 +2188,7 @@ Default: ``templates`` dir inside scrapy moduleThe directory where to look for templates when creating new projects with:command:`startproject` command and new spiders with :command:`genspider`-command.+command. See :ref:`spider-templates`.The project name must not conflict with the name of custom files or directoriesin the ``project`` subdirectory.