Manual:Pywikibot/templatecount.py

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

File:Git icon.svg

<translate> Wikimedia [[<tvar|1>Special:MyLanguage/Gerrit</>|Git repository]] has this file:</translate> scripts/templatecount.py

templatecount.py is a Pywikibot script used to display the list of pages transcluding a given list of templates.

It can also be used to simply count the number of pages (rather than listing each individually).

Syntax: python pwb.py templatecount [options] <templates>

Command line options:

<translate> Parameter</translate>	<translate> Description</translate>
`-count`	Counts the number of times each template (passed in as an argument) is transcluded.
`-list`	Gives the list of all of the pages transcluding the templates (rather than just counting them).
`-namespace:`	Filters the search to a given namespace. If this is specified multiple times it will search all given namespaces.

Examples

Imagine you wanted to find out how often the templates {{Reflist }}, {{Quote }} and {{Tl }} were used on your wiki, across all namespaces. You didn't care about where they were used, just how many times. You'd then type:

$ python pwb.py templatecount -count reflist quote tl

Counts how many times {{Ref }} and {{Note }} are transcluded in articles:

$ python pwb.py templatecount -count -namespace:0 ref note

Lists all the category pages that transclude {{Cfd }} and {{Cfdu }}:

$ python pwb.py templatecount -list -namespace:14 cfd cfdu

<translate> Global arguments available</translate>

<translate> These options will override the configuration in <tvar|1>user-config.py </> settings. </translate>

<translate> Global options</translate>
<translate> Parameter</translate>	<translate> Description</translate>	<translate> Config variable</translate>
`-dir:<translate> PATH</translate>`	<translate> Read the bot's configuration data from directory given by PATH, instead of from the default directory.</translate>
`-config:<translate> file</translate>`	<translate> The user config filename.</translate> Default is user-config.py.	`user-config.py`
`-configfile>user-config.py</>. <tvar`	xx>xx</> should be the language code.</translate>	`mylang`
`-configfile>user-config.py</>.</translate>`	<translate> Set the family of the wiki you want to work on, e.g. wikipedia, wiktionary, wikitravel, ...</translate> <translate> This will override the configuration in <tvar	`family`
`-xyz>xyz</>' instead of the default username.</translate>`	<translate> Log in as user '<tvar	`usernames`
`-xyz>xyz</>. (only use for bots that require no input from stdin).</translate>`	<translate> Immediately return control to the terminal and redirect stdout and stderr to file <tvar
`-help`	<translate> Show the help text.</translate>
`-1>-bot.log</>' Logs will be stored in the logs subdirectory.</translate>`	<translate> Enable the log file, using the default filename 'script_name<tvar	`log`
`-xyz>xyz</>' as the filename.</translate>`	<translate> Enable the log file, using '<tvar	`logfilename`
`-nolog`	<translate> Disable the log file (if it is enabled by default).</translate>
`-1>config.py</></translate>`	<translate> Sets a new maxlag parameter to a number of seconds.</translate> <translate> Defer bot edits during periods of database server lag. Default is set by <tvar	`maxlag`
`-putthrottle:n` `-pt:n` `-put_throttle:n`	<translate> Set the minimum time (in seconds) the bot will wait between saving pages.</translate>	`put_throttle`
`-debug:item` `-debug`	<translate> Enable the log file and include extensive debugging data for component "item" (for all components if the second form is used).</translate>	`debug_log`
`-verbose` `-v`	<translate> Have the bot provide additional console output that may be useful in debugging.</translate>	`verbose_output`
`-cosmetic>cosmetic_changes</> setting made in <tvar` `-cc`	config>config.py</> or <tvar	`cosmetic_changes`
`-simulate`	<translate> Disables writing to the server.</translate> <translate> Useful for testing and debugging of new code (if given, doesn't do any real changes, but only shows what would have been changed).</translate>	`simulate`
`-<<translate> config var</translate>>:n`	<translate> You may use all given numeric config variables as option and modify it with command line.</translate>