Manual:Pywikibot/unusedfiles.py

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
English • ‎한국어
Git logo
Wikimedia Git repository has this file: scripts/unusedfiles.py

unusedfiles.py is a Pywikibot script used to append some text to all unused images and notify uploaders.

Bot finds unused media using Special:UnusedFiles. It places a template (it:Template:Immagine orfana) on the image, and notifies the user with a template (it:Utente:Filbot/Immagine orfana).

When run on an English project, it uses templates "No-use2" and "img-sem-uso", but these are not known to exist anywhere. On English Wikipedia there isn't any appropriate template, as w:Template:Orphan image is strictly for use by free media, and w:Template:orfud is used for fair use media.

Special:Unusedimages is known to not correctly skip media used by Extension:ProofreadPage , making it unsuitable for automated use on Wikisource projects.

Parameters:

ParameterDescription
-always Don't be asked every time.
-nouserwarning Do not warn uploader about orphaned file.
-total Specify number of pages to work on with "-total:n" where n is the maximum number of articles to work on. If not used, all pages are used.

Global arguments available

These options will override the configuration in user-config.py settings.

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