Manual:Pywikibot/pagegenerators.py
| File:Git icon.svg | <translate> Wikimedia [[<tvar|1>Special:MyLanguage/Gerrit</>|Git repository]] has this file:</translate> pywikibot/pagegenerators.py |
| File:Pywikibot MW gear icon.svg |
| <translate> Pywikibot scripts</translate> |
|---|
|
| · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> e</translate> |
pagegenerators.py is a Pywikibot script used to generate list of pages for other scripts.
This module offers a wide variety of page generators. A page generator is an object that is iterable (see https://www.python.org/dev/peps/pep-0255/) and that yields page objects which other scripts can then use.
Command line usage
The pagegenerators.py may not be executed directly. Instead, the script listpages.py can be used.
Example:
$ python pwb.py listpages -search:'foobar'
This will return, in standard output, a list of all pages containing "foobar", as returned by MediaWiki's search engine.
See listpages.py for more details.
Calls from another script
Category crawler:
from pywikibot import pagegenerators
site = pywikibot.Site()
cat = pywikibot.Category(site, 'Category name')
pages = cat.articles()
for page in pagegenerators.PreloadingGenerator(pages, 100):
# some treatment of generated pages
Subcategories explorer:
gen = pagegenerators.CategorizedPageGenerator(cat, recurse=True)
MySQL requests (see Manual:Pywikibot/MySQL):
gen = pagegenerators.MySQLPageGenerator(query)
Unicode recommendation
The following code returns KeyError: 'query' because of the special character:
gen = pagegenerators.SearchPageGenerator('´', namespaces = [0])
If searching in user and mediawiki namespaces, it would look like
gen = pagegenerators.SearchPageGenerator('´', namespaces = [2, 8])
Consequently, an encoding conversion is needed:
gen = pagegenerators.SearchPageGenerator("´", namespaces = [0])
