family — MediaWiki families

Objects representing MediaWiki families.

family.AutoFamily(name, url)

Family that automatically loads the site configuration.

Parameters:

• name (str) – Name for the family

• url (str) – API endpoint URL of the wiki

Returns:

Generated family class

Return type:

SingleSiteFamily

class family.Family

Bases: object

Parent singleton class for all wiki families.

Changed in version 8.0: alphabetic, alphabetic_revised and fyinterwiki attributes where removed.

Allocator.

apipath(code)

Return path to api.php.

Return type:

str

archived_page_templates: Dict[str, Tuple[str, ...]] = {}

base_url(code, uri, protocol=None)

Prefix uri with port and hostname.

Parameters:

• code (str) – The site code

• uri (str) – The absolute path after the hostname

• protocol – The protocol which is used. If None it’ll determine the protocol from the code.

Returns:

The full URL ending with uri

Return type:

str

categories_last: List[str] = []

category_attop: List[str] = []

category_on_one_line: List[str] = []

category_redirect_templates = {'_default': []}

category_redirects(code, fallback='_default')

Return list of category redirect templates.

Parameters:

fallback (str) –

category_text_separator = '\n\n'

codes = {}

cross_allowed: List[str] = []

cross_projects = []

cross_projects_cookie_username = 'centralauth_User'

cross_projects_cookies = ['centralauth_Session', 'centralauth_Token', 'centralauth_User']

crossnamespace = {}

dbName(code)

Return the name of the MySQL database.

Return type:

str

disambcatname: Dict[str, str] = {}

disambig(code, fallback='_default')

Return list of disambiguation templates.

Parameters:

fallback (str) –

disambiguationTemplates = {'_default': []}

domains = {}

edit_restricted_templates: Dict[str, Tuple[str, ...]] = {}

encoding(code)

Return the encoding for a specific language wiki.

Return type:

str

encodings(code)

Return list of historical encodings for a specific language wiki.

eventstreams_host(code)

Hostname for EventStreams.

New in version 3.0.

eventstreams_path(code)

Return path for EventStreams.

New in version 3.0.

from_url(url)

Return whether this family matches the given url.

It is first checking if a domain of this family is in the domain of the URL. If that is the case it’s checking all codes and verifies that a path generated via APISite.articlepath and Family.path matches the path of the URL together with the hostname for that code.

It is using Family.domains to first check if a domain applies and then iterates over Family.codes to actually determine which code applies.

Parameters:

url (str) – the URL which may contain a $1. If it’s missing it is assumed to be at the end.

Returns:

The language code of the url. None if that url is not from this family.

Raises:

RuntimeError – When there are multiple languages in this family which would work with the given URL.

Return type:

Optional[str]

get_address(code, title)

Return the path to title using index.php with redirects disabled.

Return type:

str

get_archived_page_templates(code)

Return tuple of archived page templates.

New in version 3.0.

get_edit_restricted_templates(code)

Return tuple of edit restricted templates.

New in version 3.0.

hostname(code)

The hostname to use for standard http connections.

instance

Get the singleton instance.

interface(code)

Return interface to use for code.

Return type:

str

interwiki_attop: List[str] = []

interwiki_forward = None

interwiki_on_one_line: List[str] = []

interwiki_putfirst = {}

interwiki_removals: List[str] = []

interwiki_replacements: Dict[str, str] = {}

interwiki_text_separator = '\n\n'

isPublic(code)

Check the wiki require logging in before viewing it.

Return type:

bool

langs: Dict[str, str] = {}

language_groups = {'arab': ['ar', 'ary', 'arz', 'azb', 'ckb', 'fa', 'glk', 'ks', 'lrc', 'mzn', 'ps', 'sd', 'ur', 'ha', 'kk', 'ku', 'pnb', 'ug'], 'chinese': ['wuu', 'zh', 'zh-classical', 'zh-yue', 'gan', 'ii', 'ja', 'za'], 'cyril': ['ab', 'av', 'ba', 'be', 'be-tarask', 'bg', 'bxr', 'ce', 'cu', 'cv', 'kbd', 'koi', 'kv', 'ky', 'mk', 'lbe', 'mdf', 'mn', 'mo', 'myv', 'mhr', 'mrj', 'os', 'ru', 'rue', 'sah', 'tg', 'tk', 'udm', 'uk', 'xal', 'ha', 'kk', 'sh', 'sr', 'tt'], 'grec': ['el', 'grc', 'pnt'], 'latin': ['aa', 'ace', 'af', 'ak', 'als', 'an', 'ang', 'ast', 'ay', 'bar', 'bat-smg', 'bcl', 'bi', 'bm', 'br', 'bs', 'ca', 'cbk-zam', 'cdo', 'ceb', 'ch', 'cho', 'chy', 'co', 'crh', 'cs', 'csb', 'cy', 'da', 'de', 'diq', 'dsb', 'ee', 'eml', 'en', 'eo', 'es', 'et', 'eu', 'ext', 'ff', 'fi', 'fiu-vro', 'fj', 'fo', 'fr', 'frp', 'frr', 'fur', 'fy', 'ga', 'gag', 'gd', 'gl', 'gn', 'gv', 'hak', 'haw', 'hif', 'ho', 'hr', 'hsb', 'ht', 'hu', 'hz', 'ia', 'id', 'ie', 'ig', 'ik', 'ilo', 'io', 'is', 'it', 'jbo', 'jv', 'kaa', 'kab', 'kg', 'ki', 'kj', 'kl', 'kr', 'ksh', 'kw', 'la', 'lad', 'lb', 'lg', 'li', 'lij', 'lmo', 'ln', 'lt', 'ltg', 'lv', 'map-bms', 'mg', 'mh', 'mi', 'ms', 'mt', 'mus', 'mwl', 'na', 'nah', 'nap', 'nds', 'nds-nl', 'ng', 'nl', 'nn', 'no', 'nov', 'nrm', 'nv', 'ny', 'oc', 'om', 'pag', 'pam', 'pap', 'pcd', 'pdc', 'pfl', 'pih', 'pl', 'pms', 'pt', 'qu', 'rm', 'rn', 'ro', 'roa-rup', 'roa-tara', 'rw', 'sc', 'scn', 'sco', 'se', 'sg', 'simple', 'sk', 'sl', 'sm', 'sn', 'so', 'sq', 'srn', 'ss', 'st', 'stq', 'su', 'sv', 'sw', 'szl', 'tet', 'tl', 'tn', 'to', 'tpi', 'tr', 'ts', 'tum', 'tw', 'ty', 'uz', 've', 'vec', 'vi', 'vls', 'vo', 'wa', 'war', 'wo', 'xh', 'yo', 'zea', 'zh-min-nan', 'zu', 'az', 'chr', 'ckb', 'ha', 'iu', 'kk', 'ku', 'rmy', 'sh', 'sr', 'tt', 'ug', 'za'], 'scand': ['da', 'fo', 'is', 'nb', 'nn', 'no', 'sv']}

languages_by_size: List[str] = []

ldapDomain = ()

linktrail(code)

Return regex for trailing chars displayed as part of a link.

Returns a string, not a compiled regular expression object.

Deprecated since version 7.3.

Parameters:

code (str) –

Return type:

str

static load(fam=None)

Import the named family.

Parameters:

fam (Optional[str]) – family name (if omitted, uses the configured default)

Returns:

a Family instance configured for the named family.

Raises:

pywikibot.exceptions.UnknownFamilyError – family not known

maximum_GET_length(code)

Return the maximum URL length for GET instead of POST.

Deprecated since version 8.0: Use config.maximum_GET_length instead.

name = None

property obsolete: Dict[str, Optional[str]]

Old codes that are not part of the family.

Interwiki replacements override removals for the same code.

Returns:

mapping of old codes to new codes (or None)

path(code)

Return path to index.php.

Return type:

str

post_get_convert(site, getText)

Do a conversion on the retrieved text from the Wiki.

For example a X-conversion in Esperanto https://en.wikipedia.org/wiki/Esperanto_orthography#X-system.

pre_put_convert(site, putText)

Do a conversion on the text to insert on the Wiki.

For example a X-conversion in Esperanto https://en.wikipedia.org/wiki/Esperanto_orthography#X-system.

protocol(code)

The protocol to use to connect to the site.

May be overridden to return ‘https’. Other protocols are not supported.

Parameters:

code (str) – language code

Returns:

protocol that this family uses

Return type:

str

querypath(code)

Return path to query.php.

Return type:

str

scriptpath(code)

The prefix used to locate scripts on this wiki.

This is the value displayed when you enter {{SCRIPTPATH}} on a wiki page (often displayed at [[Help:Variables]] if the wiki has copied the master help page correctly).

The default value is the one used on Wikimedia Foundation wikis, but needs to be overridden in the family file for any wiki that uses a different value.

Parameters:

code (str) – Site code

Raises:

KeyError – code is not recognised

Returns:

URL path without ending ‘/’

Return type:

str

shared_image_repository(code)

Return the shared image repository, if any.

shared_urlshortner_wiki: Optional[Tuple[str, str]] = None

ssl_hostname(code)

The hostname to use for SSL connections.

ssl_pathprefix(code)

The path prefix for secure HTTP access.

Return type:

str

title_delimiter_and_aliases = ' _'

Titles usually are delimited by a space and the alias is replaced to this delimiter; e.g. “Main page” is the title with spaces as delimiters but “Main_page” also works. Other families may have different settings.

Note

The first character is used as delimiter, the others are aliases.

Warning

This attribute is used within re.sub() method. Use escape sequence if necessary

New in version 7.0.

use_hard_category_redirects = []

verify_SSL_certificate(code)

Return whether a HTTPS certificate should be verified.

New in version 5.3: renamed from ignore_certificate_error

Parameters:

code (str) – language code

Returns:

flag to verify the SSL certificate; set it to False to allow access if certificate has an error.

Return type:

bool

class family.FandomFamily

Bases: Family

Common features of Fandom families.

New in version 3.0: renamed from WikiaFamily

Allocator.

langs: Dict[str, str]

Property listing family languages.

protocol(code)

Return ‘https’ as the protocol.

Return type:

str

scriptpath(code)

Return the script path for this family.

class family.SingleSiteFamily

Bases: Family

Single site family.

domains

Return the full domain name of the site.

hostname(code)

Return the domain as the hostname.

class family.SubdomainFamily

Bases: Family

Multi site wikis that are subdomains of the same top level domain.

codes

Property listing family codes.

domains

Return the domain name of the sites in this family.

langs: Dict[str, str]

Property listing family languages.

class family.WikimediaFamily

Bases: Family

Class for all wikimedia families.

Changed in version 8.0: knows_codes attribute was added.

Allocator.

closed_wikis: List[str] = []

code_aliases = {'be-x-old': 'be-tarask', 'dk': 'da', 'jp': 'ja', 'minnan': 'zh-min-nan', 'mo': 'ro', 'nan': 'zh-min-nan', 'nb': 'no', 'nds_nl': 'nds-nl', 'zh-cn': 'zh', 'zh-tw': 'zh'}

content_families = {'commons', 'incubator', 'lingualibre', 'mediawiki', 'species', 'wikibooks', 'wikidata', 'wikinews', 'wikipedia', 'wikiquote', 'wikisource', 'wikiversity', 'wikivoyage', 'wiktionary'}

cross_projects = {'commons', 'incubator', 'lingualibre', 'mediawiki', 'meta', 'outreach', 'species', 'strategy', 'wikibooks', 'wikidata', 'wikimania', 'wikimediachapter', 'wikinews', 'wikipedia', 'wikiquote', 'wikisource', 'wikiversity', 'wikivoyage', 'wiktionary'}

disambcatname: Dict[str, str] = {'wikidata': 'Q1982926'}

domain

Domain property.

eventstreams_host(code)

Return ‘https://stream.wikimedia.org’ as the stream hostname.

Return type:

str

eventstreams_path(code)

Return path for EventStreams.

Return type:

str

interwiki_removals: List[str] = frozenset({})

interwiki_replacements: Dict[str, str] = mappingproxy({'dk': 'da', 'jp': 'ja', 'nb': 'no', 'mo': 'ro', 'minnan': 'zh-min-nan', 'nan': 'zh-min-nan', 'zh-tw': 'zh', 'zh-cn': 'zh', 'nds_nl': 'nds-nl', 'be-x-old': 'be-tarask'})

known_codes = ['aa', 'ab', 'ace', 'ady', 'af', 'ak', 'als', 'alt', 'am', 'ami', 'an', 'ang', 'ar', 'arc', 'ary', 'arz', 'as', 'ast', 'atj', 'av', 'avk', 'awa', 'ay', 'az', 'azb', 'ba', 'ban', 'bar', 'bat-smg', 'bcl', 'be', 'be-tarask', 'bg', 'bh', 'bi', 'bjn', 'blk', 'bm', 'bn', 'bo', 'bpy', 'br', 'bs', 'bug', 'bxr', 'ca', 'cbk-zam', 'cdo', 'ce', 'ceb', 'ch', 'cho', 'chr', 'chy', 'ckb', 'co', 'cr', 'crh', 'cs', 'csb', 'cu', 'cv', 'cy', 'da', 'dag', 'de', 'din', 'diq', 'dk', 'dsb', 'dty', 'dv', 'dz', 'ee', 'el', 'eml', 'en', 'eo', 'es', 'et', 'eu', 'ext', 'fa', 'ff', 'fi', 'fiu-vro', 'fj', 'fo', 'fr', 'frp', 'frr', 'fur', 'fy', 'ga', 'gag', 'gan', 'gcr', 'gd', 'gl', 'glk', 'gn', 'gom', 'gor', 'got', 'gu', 'guw', 'gv', 'ha', 'hak', 'haw', 'he', 'hi', 'hif', 'ho', 'hr', 'hsb', 'ht', 'hu', 'hy', 'hyw', 'hz', 'ia', 'id', 'ie', 'ig', 'ii', 'ik', 'ilo', 'inh', 'io', 'is', 'it', 'iu', 'ja', 'jam', 'jbo', 'jv', 'ka', 'kaa', 'kab', 'kbd', 'kbp', 'kcg', 'kg', 'ki', 'kj', 'kk', 'kl', 'km', 'kn', 'ko', 'koi', 'kr', 'krc', 'ks', 'ksh', 'ku', 'kv', 'kw', 'ky', 'la', 'lad', 'lb', 'lbe', 'lez', 'lfn', 'lg', 'li', 'lij', 'lld', 'lmo', 'ln', 'lo', 'lrc', 'lt', 'ltg', 'lv', 'mad', 'mai', 'map-bms', 'mdf', 'mg', 'mh', 'mhr', 'mi', 'min', 'mk', 'ml', 'mn', 'mni', 'mnw', 'mo', 'mr', 'mrj', 'ms', 'mt', 'mus', 'mwl', 'my', 'myv', 'mzn', 'na', 'nah', 'nan', 'nap', 'nb', 'nds', 'nds-nl', 'ne', 'new', 'ng', 'nia', 'nl', 'nn', 'no', 'nov', 'nqo', 'nrm', 'nso', 'nv', 'ny', 'oc', 'olo', 'om', 'or', 'os', 'pa', 'pag', 'pam', 'pap', 'pcd', 'pcm', 'pdc', 'pfl', 'pi', 'pih', 'pl', 'pms', 'pnb', 'pnt', 'ps', 'pt', 'pwn', 'qu', 'rm', 'rmy', 'rn', 'ro', 'roa-rup', 'roa-tara', 'ru', 'rue', 'rw', 'sa', 'sah', 'sat', 'sc', 'scn', 'sco', 'sd', 'se', 'sg', 'sh', 'shi', 'shn', 'si', 'simple', 'sk', 'skr', 'sl', 'sm', 'smn', 'sn', 'so', 'sq', 'sr', 'srn', 'ss', 'st', 'stq', 'su', 'sv', 'sw', 'szl', 'szy', 'ta', 'tay', 'tcy', 'te', 'tet', 'tg', 'th', 'ti', 'tk', 'tl', 'tn', 'to', 'tpi', 'tr', 'trv', 'ts', 'tt', 'tum', 'tw', 'ty', 'tyv', 'udm', 'ug', 'uk', 'ur', 'uz', 've', 'vec', 'vep', 'vi', 'vls', 'vo', 'wa', 'war', 'wo', 'wuu', 'xal', 'xh', 'xmf', 'yi', 'yo', 'za', 'zea', 'zh', 'zh-classical', 'zh-cn', 'zh-min-nan', 'zh-tw', 'zh-yue', 'zu']

multi_language_content_families = ['wikipedia', 'wiktionary', 'wikisource', 'wikibooks', 'wikinews', 'wikiquote', 'wikiversity', 'wikivoyage']

other_content_families = ['wikidata', 'mediawiki', 'lingualibre']

protocol(code)

Return ‘https’ as the protocol.

Return type:

str

removed_wikis: List[str] = []

shared_image_repository(code)

Return Wikimedia Commons as the shared image repository.

shared_urlshortner_wiki: Optional[Tuple[str, str]] = ('meta', 'meta')

wikimedia_org_content_families = ['commons', 'incubator', 'species']

wikimedia_org_families = {'commons', 'incubator', 'meta', 'outreach', 'species', 'strategy', 'wikimania', 'wikimediachapter', 'wikitech'}

wikimedia_org_meta_families = ['meta', 'outreach', 'strategy', 'wikimediachapter', 'wikimania']

wikimedia_org_other_families = ['wikitech']

class family.WikimediaOrgFamily

Bases: SingleSiteFamily, WikimediaFamily

Single site family for sites hosted at *.wikimedia.org.

domain = 'None.wikimedia.org'

langs: Dict[str, str] = {None: 'None.wikimedia.org'}