Manual:Pywikibot/upload.py

From MediaWiki.org
Jump to navigation Jump to search
Git logo
Wikimedia Git repository has this file: scripts/upload.py

upload.py is a Pywikibot script used to upload images to a wiki.

Usage[edit]

python upload.py [Global-arguments] [-keep] [-filename:targetFilename] [-ignorewarn] [-noverify] [-chunked:64m] [-summary:SummaryOfTheUpload] [URL-or-filename [description-text]]

Arguments[edit]

-keep Keep the filename as is
-filename Target filename
-recursive A recursive search in folders ?
-noverify Do not ask for verification of the upload description if one is given
-summary Summary of the upload
-noverify Not proofread the description
-ignorewarn Upload even if another file would be overwritten or another mistake would be risked
-chunked Upload the file in chunks (more overhead, but restartable) ; If no value is specified the file will be uploaded as whole ; regex : ^-chunked(?::(\d+(?:\.\d+)?)[ \t]*(k|ki|m|mi)?b?)?$
-always Save without confirmation ; Enable keepFilename and disable verifyDescription
-abortonwarn ...

If any other arguments are given, the first is the URL or filename to upload, and the rest is a proposed description to go with the upload. If none of these are given, the user is asked for the file or URL to upload. The bot will then upload the image to the wiki.

The script will ask for the location of an image, if not given as a parameter, and for a description.

If the -filename argument is given, then it is used as the name of the image on the wiki; otherwise it is based on the filename or url of the input file.

If -keep is not specified, then the target filename undergoes some further checking, and the user is asked for confirmation. The / character is forbidden, and the filename extension (after the dot) must be one of these: gif, jpg, jpeg, mid, midi, ogg, png, svg, xcf, djvu. If the check is failed, then the user is prompted for a new filename.

If an image with the target filename already exists, the description will not be overwritten with the supplied description text. Instead, the description text will be added as a comment.

Spaces in the filename will automatically be converted to underscores, since mediawiki doesn't allow spaces. The encoding of the filename will also be converted to the encoding used on the target site (typically unicode). The script also attempts to convert the description to the wiki's target encoding, or, as a last resort, will convert characters to html entities.

Error detection is based on both the http status and the contents of the response, which is assumed to be in English; error detection may fail if the bot's account has been set not to show an English interface.

Output example[edit]

Example of output if no file name is given:

C:\Users\t\Desktop\pywikipedia>upload.py
No input filename given
File or URL where image is now: C:\Users\t\Desktop\Dead7.jpg
Reading file C:\Users\t\Desktop\Dead7.jpg
The filename on the target wiki will default to: Dead7.jpg
Enter a better name, or press enter to accept:
The suggested description is:

Do you want to change this description? ([y]es, [N]o) n
Uploading file to dead:en via API....
Upload successful.

C:\Users\t\Desktop\pywikipedia>


Global arguments available

These options will override the configuration in user-config.pyManual:Pywikibot/user-config.py settings.

Global options
Parameter Description Config 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.

See also[edit]