Manual:Pywikibot/Compat/query.py
From mediawiki.org
This page is documentation for Pywikipedia Compat, which is no longer supported. This page is kept for historical interest. It may document scripts and features that are obsolete and/or no longer supported. Do not rely on the information here being up-to-date.
query.py is a library for pywikibot compat branch used by several scripts
Methods
[edit ]| Method | Params | Description |
|---|---|---|
| GetData | lang params verbose = False |
Get data from the query api, and convert it into a data object |
| GetInterwikies | lang titles extraParams = None |
Uses GetData to fetch "redirects" and "langlinks" for the given titles. |
| GetLinks | lang titles extraParams = None |
Uses GetData to fetch "redirects" and "links" for the given titles. |
| GetDisambigTemplates | lang | This method will return a set of disambiguation templates. is always assumed to be default, and will be appended (in localized format) regardless of its existence. The rest will be acquired from the Wikipedia:Disambiguation Templates page.(Note: this page was deleted in August 2006) Only links to templates will be used from that page. |
| Helper Utilities | ||
| CleanParams | params | Params may be either a tuple, a list of tuples or a dictionary. This method will convert it into a dictionary |
| CombineParams | params1 params2 |
Merge two dictionaries. If they have the same keys, their values will be appended one after another separated by the '|' symbol. |
| ConvToList | item | Ensure the output is a list |
| ListToParam | list | Convert a list of unicode strings into a UTF8 string separated by the '|' symbols |
| ToUtf8 | s | Convert s to Unicode |
| IsString | s | Boolean test |