Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805375 )
Change subject: [doc] Update pagegenerators documentation
......................................................................
[doc] Update pagegenerators documentation
Remove porting hint. pagegenerators is not just for backwards-compatibility.
Also update hint for listpages.py.
Change-Id: Ie3544c06e5e2624a68a8173b843d5e35b6a3120f
---
M pywikibot/pagegenerators.py
1 file changed, 3 insertions(+), 6 deletions(-)
Approvals:
DannyS712: Looks good to me, but someone else must approve
Xqt: Verified; Looks good to me, approved
diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py
index 390fd2e..3450499 100644
--- a/pywikibot/pagegenerators.py
+++ b/pywikibot/pagegenerators.py
@@ -4,8 +4,9 @@
A page generator is an object that is iterable (see :pep:`255`) and
that yields page objects on which other scripts can then work.
-Pagegenerators.py cannot be run as script. For testing purposes listpages.py
-can be used instead, to print page titles to standard output.
+Most of these functions just wrap a Site or Page method that returns a
+generator. For testing purposes listpages.py can be used, to print page
+titles to standard output.
These parameters are supported to specify which pages titles to print:
@@ -67,10 +68,6 @@
)
-# ported from version 1 for backwards-compatibility
-# most of these functions just wrap a Site or Page method that returns
-# a generator
-
parameterHelp = """\
GENERATOR OPTIONS
=================
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805375
To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: Ie3544c06e5e2624a68a8173b843d5e35b6a3120f
Gerrit-Change-Number: 805375
Gerrit-PatchSet: 2
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: DannyS712 <dannys712.wiki(a)gmail.com>
Gerrit-Reviewer: Multichill <maarten(a)mdammers.nl>
Gerrit-Reviewer: Russell Blau <russblau(a)imapmail.org>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged
Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805804 )
Change subject: [IMPR] detach api generators part 2
......................................................................
[IMPR] detach api generators part 2
Change-Id: Id9e72cf003635d67703718f4bebc1096af55c4bb
---
M pywikibot/CONTENT.rst
R pywikibot/data/api/__init__.py
M pywikibot/data/api/_generators.py
3 files changed, 24 insertions(+), 2,490 deletions(-)
Approvals:
jenkins-bot: Verified
Xqt: Verified; Looks good to me, approved
diff --git a/pywikibot/CONTENT.rst b/pywikibot/CONTENT.rst
index 6b9f18f..3f8eaff 100644
--- a/pywikibot/CONTENT.rst
+++ b/pywikibot/CONTENT.rst
@@ -90,11 +90,15 @@
| data | Module providing layers of data access to wiki |
+============================+======================================================+
| api.py | Interface Module to MediaWiki's api |
- | +--------------+---------------------------------------+
- | | __init__.py | Interface to MediaWiki's api.php |
- | +--------------+---------------------------------------+
- | | paraminfo.py | API parameter information data object |
- +----------------------------+--------------+---------------------------------------+
+ | +----------------+-------------------------------------+
+ | | __init__.py | Interface to MediaWiki's api.php |
+ | +----------------+-------------------------------------+
+ | | _generators.py | API/Query generators |
+ | +----------------+-------------------------------------+
+ | | _optionset.py | Boolean API option |
+ | +----------------+-------------------------------------+
+ | | _paraminfo.py | API information data object |
+ +----------------------------+----------------+-------------------------------------+
| mysql.py | Miscellaneous helper functions for mysql queries |
+----------------------------+------------------------------------------------------+
| sparql.py | Objects representing SPARQL query API |
diff --git a/pywikibot/data/api/__init.py b/pywikibot/data/api/__init__.py
similarity index 61%
rename from pywikibot/data/api/__init.py
rename to pywikibot/data/api/__init__.py
index acaf7ba..dc5abdc 100644
--- a/pywikibot/data/api/__init.py
+++ b/pywikibot/data/api/__init__.py
@@ -16,7 +16,6 @@
from email.generator import BytesGenerator
from email.mime.multipart import MIMEMultipart as MIMEMultipartOrig
from email.mime.nonmultipart import MIMENonMultipart
-from inspect import getfullargspec
from io import BytesIO
from typing import Any, Optional, Union
from urllib.parse import unquote, urlencode
@@ -26,19 +25,26 @@
from pywikibot import config, login
from pywikibot.backports import Callable, Dict, Match, Tuple, removeprefix
from pywikibot.comms import http
+from pywikibot.data.api._generators import (
+ APIGenerator,
+ ListGenerator,
+ LogEntryListGenerator,
+ PageGenerator,
+ PropertyGenerator,
+ QueryGenerator,
+ update_page,
+)
from pywikibot.data.api._paraminfo import ParamInfo
from pywikibot.data.api._optionset import OptionSet
from pywikibot.exceptions import (
Error,
FatalServerError,
- InvalidTitleError,
MaxlagTimeoutError,
NoUsernameError,
Server414Error,
Server504Error,
SiteDefinitionError,
TimeoutError,
- UnsupportedPageError,
)
from pywikibot.family import SubdomainFamily
from pywikibot.login import LoginStatus
@@ -364,7 +370,7 @@
for super_cls in inspect.getmro(cls):
if not super_cls.__name__.endswith('Request'):
break
- args |= set(getfullargspec(super_cls.__init__).args)
+ args |= set(inspect.getfullargspec(super_cls.__init__).args)
else:
raise ValueError('Request was not a super class of '
'{!r}'.format(cls))
@@ -1338,811 +1344,6 @@
return self._data
-class _RequestWrapper:
-
- """A wrapper class to handle the usage of the ``parameters`` parameter."""
-
- def _clean_kwargs(self, kwargs, **mw_api_args):
- """Clean kwargs, define site and request class."""
- if 'site' not in kwargs:
- warn('{} invoked without a site'.format(self.__class__.__name__),
- RuntimeWarning, 3)
- kwargs['site'] = pywikibot.Site()
- assert(not hasattr(self, 'site') or self.site == kwargs['site'])
- self.site = kwargs['site']
- self.request_class = kwargs['site']._request_class(kwargs)
- kwargs = self.request_class.clean_kwargs(kwargs)
- kwargs['parameters'].update(mw_api_args)
- return kwargs
-
- def set_maximum_items(self, value: Union[int, str, None]) -> None:
- raise NotImplementedError
-
-
-class APIGenerator(_RequestWrapper):
-
- """
- Iterator that handle API responses containing lists.
-
- The iterator will iterate each item in the query response and use the
- continue request parameter to retrieve the next portion of items
- automatically. If the limit attribute is set, the iterator will stop
- after iterating that many values.
- """
-
- def __init__(
- self,
- action: str,
- continue_name: str = 'continue',
- limit_name: str = 'limit',
- data_name: str = 'data',
- **kwargs
- ) -> None:
- """
- Initialize an APIGenerator object.
-
- kwargs are used to create a Request object; see that object's
- documentation for values.
-
- :param action: API action name.
- :param continue_name: Name of the continue API parameter.
- :param limit_name: Name of the limit API parameter.
- :param data_name: Name of the data in API response.
- """
- kwargs = self._clean_kwargs(kwargs, action=action)
-
- self.continue_name = continue_name
- self.limit_name = limit_name
- self.data_name = data_name
-
- if config.step > 0:
- self.query_increment = config.step
- else:
- self.query_increment = None
- self.limit = None
- self.starting_offset = kwargs['parameters'].pop(self.continue_name, 0)
- self.request = self.request_class(**kwargs)
- self.request[self.limit_name] = self.query_increment
-
- def set_query_increment(self, value: int) -> None:
- """
- Set the maximum number of items to be retrieved per API query.
-
- If not called, the default is config.step.
-
- :param value: The value of maximum number of items to be retrieved
- per API request to set.
- """
- self.query_increment = int(value)
- self.request[self.limit_name] = self.query_increment
- pywikibot.debug('{}: Set query_increment to {}.'
- .format(type(self).__name__, self.query_increment))
-
- def set_maximum_items(self, value: Union[int, str, None]) -> None:
- """
- Set the maximum number of items to be retrieved from the wiki.
-
- If not called, most queries will continue as long as there is
- more data to be retrieved from the API.
-
- :param value: The value of maximum number of items to be retrieved
- in total to set. Ignores None value.
- """
- if value is not None and int(value) > 0:
- self.limit = int(value)
- if self.query_increment and self.limit < self.query_increment:
- self.request[self.limit_name] = self.limit
- pywikibot.debug('{}: Set request item limit to {}'
- .format(type(self).__name__, self.limit))
- pywikibot.debug('{}: Set limit (maximum_items) to {}.'
- .format(type(self).__name__, self.limit))
-
- def __iter__(self):
- """
- Submit request and iterate the response.
-
- Continues response as needed until limit (if defined) is reached.
- """
- offset = self.starting_offset
- n = 0
- while True:
- self.request[self.continue_name] = offset
- pywikibot.debug('{}: Request: {}'
- .format(type(self).__name__, self.request))
- data = self.request.submit()
-
- n_items = len(data[self.data_name])
- pywikibot.debug('{}: Retrieved {} items'
- .format(type(self).__name__, n_items))
- if n_items > 0:
- for item in data[self.data_name]:
- yield item
- n += 1
- if self.limit is not None and n >= self.limit:
- pywikibot.debug('{}: Stopped iterating due to '
- 'exceeding item limit.'
- .format(type(self).__name__))
- return
- offset += n_items
- else:
- pywikibot.debug('{}: Stopped iterating due to empty list in '
- 'response.'.format(type(self).__name__))
- break
-
-
-class QueryGenerator(_RequestWrapper):
-
- """
- Base class for iterators that handle responses to API action=query.
-
- By default, the iterator will iterate each item in the query response,
- and use the (query-)continue element, if present, to continue iterating as
- long as the wiki returns additional values. However, if the iterator's
- limit attribute is set to a positive int, the iterator will stop after
- iterating that many values. If limit is negative, the limit parameter
- will not be passed to the API at all.
-
- Most common query types are more efficiently handled by subclasses, but
- this class can be used directly for custom queries and miscellaneous
- types (such as "meta=...") that don't return the usual list of pages or
- links. See the API documentation for specific query options.
-
- """
-
- # Should results be filtered during iteration according to set_namespace?
- # Used if the API module does not support multiple namespaces.
- # Override in subclasses by defining a function that returns True if
- # the result's namespace is in self._namespaces.
- _check_result_namespace = NotImplemented
-
- # Set of allowed namespaces will be assigned to _namespaces during
- # set_namespace call. Only to be used by _check_result_namespace.
- _namespaces = None
-
- def __init__(self, **kwargs) -> None:
- """
- Initialize a QueryGenerator object.
-
- kwargs are used to create a Request object; see that object's
- documentation for values. 'action'='query' is assumed.
-
- """
- if not hasattr(self, 'site'):
- kwargs = self._clean_kwargs(kwargs) # hasn't been called yet
- parameters = kwargs['parameters']
- if 'action' in parameters and parameters['action'] != 'query':
- raise Error("{}: 'action' must be 'query', not {}"
- .format(self.__class__.__name__, kwargs['action']))
- parameters['action'] = 'query'
- # make sure request type is valid, and get limit key if any
- for modtype in ('generator', 'list', 'prop', 'meta'):
- if modtype in parameters:
- self.modules = parameters[modtype].split('|')
- break
- else:
- raise Error('{}: No query module name found in arguments.'
- .format(self.__class__.__name__))
-
- parameters['indexpageids'] = True # always ask for list of pageids
- self.continue_name = 'continue'
- self.continue_update = self._continue
- # Explicitly enable the simplified continuation
- parameters['continue'] = True
- self.request = self.request_class(**kwargs)
-
- self.site._paraminfo.fetch('query+' + mod for mod in self.modules)
-
- limited_modules = {mod for mod in self.modules
- if self.site._paraminfo.parameter('query+' + mod,
- 'limit')}
-
- if not limited_modules:
- self.limited_module = None
- elif len(limited_modules) == 1:
- self.limited_module = limited_modules.pop()
- else:
- # Select the first limited module in the request.
- # Query will continue as needed until limit (if any) for this
- # module is reached.
- for module in self.modules:
- if module in limited_modules:
- self.limited_module = module
- limited_modules.remove(module)
- break
- pywikibot.log('{}: multiple requested query modules support limits'
- "; using the first such module '{}' of {!r}"
- .format(self.__class__.__name__, self.limited_module,
- self.modules))
-
- # Set limits for all remaining limited modules to max value.
- # Default values will only cause more requests and make the query
- # slower.
- for module in limited_modules:
- param = self.site._paraminfo.parameter('query+' + module,
- 'limit')
- prefix = self.site._paraminfo['query+' + module]['prefix']
- if self.site.logged_in() \
- and self.site.has_right('apihighlimits'):
- self.request[prefix + 'limit'] = int(param['highmax'])
- else:
- self.request[prefix + 'limit'] = int(param['max'])
-
- if config.step > 0:
- self.api_limit = config.step
- else:
- self.api_limit = None
-
- if self.limited_module:
- self.prefix = self.site._paraminfo['query+'
- + self.limited_module]['prefix']
- self._update_limit()
-
- if self.api_limit is not None and 'generator' in parameters:
- self.prefix = 'g' + self.prefix
-
- self.limit = None
- self.query_limit = self.api_limit
- if 'generator' in parameters:
- # name of the "query" subelement key to look for when iterating
- self.resultkey = 'pages'
- else:
- self.resultkey = self.modules[0]
-
- # usually the (query-)continue key is the same as the querymodule,
- # but not always
- # API can return more than one query-continue key, if multiple
- # properties are requested by the query, e.g.
- # "query-continue":{
- # "langlinks":{"llcontinue":"12188973|pt"},
- # "templates":{"tlcontinue":"310820|828|Namespace_detect"}}
- # self.continuekey is a list
- self.continuekey = self.modules
- self._add_slots()
-
- def _add_slots(self) -> None:
- """Add slots to params if the site supports multi-content revisions.
-
- On MW 1.32+ the following query parameters require slots to be given
- when content or contentmodel is requested.
-
- * prop=revisions
- * prop=deletedrevisions or
- * list=allrevisions
- * list=alldeletedrevisions
-
- More info:
- https://lists.wikimedia.org/hyperkitty/list/mediawiki-api-announce@lists.wi…
- """
- if self.site.mw_version < '1.32':
- return
- request = self.request
- # If using any deprecated_params, do not add slots. Usage of
- # these parameters together with slots is forbidden and the user will
- # get an API warning anyway.
- props = request.get('prop')
- if props:
- if 'revisions' in props:
- deprecated_params = {
- 'rvexpandtemplates', 'rvparse', 'rvdiffto', 'rvdifftotext',
- 'rvdifftotextpst', 'rvcontentformat', 'parsetree'}
- if not set(request) & deprecated_params:
- request['rvslots'] = '*'
- if 'deletedrevisions' in props:
- deprecated_params = {
- 'drvexpandtemplates', 'drvparse', 'drvdiffto',
- 'drvdifftotext', 'drvdifftotextpst', 'drvcontentformat',
- 'parsetree'}
- if not set(request) & deprecated_params:
- request['drvslots'] = '*'
- lists = request.get('list')
- if lists:
- if 'allrevisions' in lists:
- deprecated_params = {
- 'arvexpandtemplates', 'arvparse', 'arvdiffto',
- 'arvdifftotext', 'arvdifftotextpst', 'arvcontentformat',
- 'parsetree'}
- if not set(request) & deprecated_params:
- request['arvslots'] = '*'
- if 'alldeletedrevisions' in lists:
- deprecated_params = {
- 'adrexpandtemplates', 'adrparse', 'adrdiffto',
- 'adrdifftotext', 'adrdifftotextpst', 'adrcontentformat',
- 'parsetree'}
- if not set(request) & deprecated_params:
- request['adrslots'] = '*'
-
- def set_query_increment(self, value) -> None:
- """Set the maximum number of items to be retrieved per API query.
-
- If not called, the default is to ask for "max" items and let the
- API decide how many to send.
- """
- limit = int(value)
-
- # don't update if limit is greater than maximum allowed by API
- if self.api_limit is None:
- self.query_limit = limit
- else:
- self.query_limit = min(self.api_limit, limit)
- pywikibot.debug('{}: Set query_limit to {}.'
- .format(type(self).__name__, self.query_limit))
-
- def set_maximum_items(self, value: Union[int, str, None]) -> None:
- """Set the maximum number of items to be retrieved from the wiki.
-
- If not called, most queries will continue as long as there is
- more data to be retrieved from the API.
-
- If set to -1 (or any negative value), the "limit" parameter will be
- omitted from the request. For some request types (such as
- prop=revisions), this is necessary to signal that only current
- revision is to be returned.
-
- :param value: The value of maximum number of items to be retrieved
- in total to set. Ignores None value.
- """
- if value is not None:
- self.limit = int(value)
-
- def _update_limit(self) -> None:
- """Set query limit for self.module based on api response."""
- param = self.site._paraminfo.parameter('query+' + self.limited_module,
- 'limit')
- if self.site.logged_in() and self.site.has_right('apihighlimits'):
- limit = int(param['highmax'])
- else:
- limit = int(param['max'])
- if self.api_limit is None or limit < self.api_limit:
- self.api_limit = limit
- pywikibot.debug('{}: Set query_limit to {}.'
- .format(type(self).__name__, self.api_limit))
-
- def support_namespace(self) -> bool:
- """Check if namespace is a supported parameter on this query.
-
- Note: this function will be removed when self.set_namespace() will
- throw TypeError() instead of just giving a warning.
- See T196619.
-
- :return: True if yes, False otherwise
- """
- assert self.limited_module # some modules do not have a prefix
- return bool(
- self.site._paraminfo.parameter('query+' + self.limited_module,
- 'namespace'))
-
- def set_namespace(self, namespaces):
- """Set a namespace filter on this query.
-
- :param namespaces: namespace identifiers to limit query results
- :type namespaces: iterable of str or Namespace key, or a single
- instance of those types. May be a '|' separated list of
- namespace identifiers. An empty iterator clears any
- namespace restriction.
- :raises KeyError: a namespace identifier was not resolved
- """
- # TODO: T196619
- # :raises TypeError: module does not support a namespace parameter
- # or a namespace identifier has an inappropriate
- # type such as NoneType or bool, or more than one namespace
- # if the API module does not support multiple namespaces
- assert self.limited_module # some modules do not have a prefix
- param = self.site._paraminfo.parameter('query+' + self.limited_module,
- 'namespace')
- if not param:
- pywikibot.warning('{} module does not support a namespace '
- 'parameter'.format(self.limited_module))
- warn('set_namespace() will be modified to raise TypeError '
- 'when namespace parameter is not supported. '
- 'It will be a Breaking Change, please update your code '
- 'ASAP, due date July, 31st 2019.', FutureWarning, 2)
-
- # TODO: T196619
- # raise TypeError('{} module does not support a namespace '
- # 'parameter'.format(self.limited_module))
-
- return False
-
- if isinstance(namespaces, str):
- namespaces = namespaces.split('|')
-
- # Use Namespace id (int) here; Request will cast int to str
- namespaces = [ns.id for ns in
- self.site.namespaces.resolve(namespaces)]
-
- if 'multi' not in param and len(namespaces) != 1:
- if self._check_result_namespace is NotImplemented:
- raise TypeError('{} module does not support multiple '
- 'namespaces'.format(self.limited_module))
- self._namespaces = set(namespaces)
- namespaces = None
-
- if namespaces:
- self.request[self.prefix + 'namespace'] = namespaces
- elif self.prefix + 'namespace' in self.request:
- del self.request[self.prefix + 'namespace']
-
- return None
-
- def _query_continue(self) -> bool:
- if all(key not in self.data[self.continue_name]
- for key in self.continuekey):
- pywikibot.log(
- "Missing '{}' key(s) in ['{}'] value."
- .format(self.continuekey, self.continue_name))
- return True
-
- for query_continue_pair in self.data['query-continue'].values():
- self._add_continues(query_continue_pair)
- return False # a new request with query-continue is needed
-
- def _continue(self) -> bool:
- self._add_continues(self.data['continue'])
- return False # a new request with continue is needed
-
- def _add_continues(self, continue_pair) -> None:
- for key, value in continue_pair.items():
- # query-continue can return ints (continue too?)
- if isinstance(value, int):
- value = str(value)
- self.request[key] = value
-
- def _handle_query_limit(self, prev_limit, new_limit, had_data):
- """Handle query limit."""
- if self.query_limit is None or self.limited_module is None:
- return prev_limit, new_limit
-
- prev_limit = new_limit
- if self.limit is None:
- new_limit = self.query_limit
- elif self.limit > 0:
- if had_data:
- # self.resultkey in data in last request.submit()
- new_limit = min(self.query_limit, self.limit - self._count)
- else:
- # only "(query-)continue" returned. See Bug T74209.
- # increase new_limit to advance faster until new
- # useful data are found again.
- new_limit = min(new_limit * 2, self.query_limit)
- else:
- new_limit = None
-
- if new_limit and 'rvprop' in self.request \
- and 'content' in self.request['rvprop']:
- # queries that retrieve page content have lower limits
- # Note: although API allows up to 500 pages for content
- # queries, these sometimes result in server-side errors
- # so use 250 as a safer limit
- new_limit = min(new_limit, self.api_limit // 10, 250)
-
- if new_limit is not None:
- self.request[self.prefix + 'limit'] = str(new_limit)
-
- if prev_limit != new_limit:
- pywikibot.debug(
- '{name}: query_limit: {query}, api_limit: {api}, '
- 'limit: {limit}, new_limit: {new}, count: {count}\n'
- '{name}: {prefix}limit: {value}'
- .format(name=self.__class__.__name__,
- query=self.query_limit,
- api=self.api_limit,
- limit=self.limit,
- new=new_limit,
- count=self._count,
- prefix=self.prefix,
- value=self.request[self.prefix + 'limit']))
- return prev_limit, new_limit
-
- def _get_resultdata(self):
- """Get resultdata and verify result."""
- resultdata = keys = self.data['query'][self.resultkey]
- if isinstance(resultdata, dict):
- keys = list(resultdata.keys())
- if 'results' in resultdata:
- resultdata = resultdata['results']
- elif 'pageids' in self.data['query']:
- # this ensures that page data will be iterated
- # in the same order as received from server
- resultdata = [resultdata[k]
- for k in self.data['query']['pageids']]
- else:
- resultdata = [resultdata[k]
- for k in sorted(resultdata.keys())]
- pywikibot.debug('{name} received {keys}; limit={limit}'
- .format(name=type(self).__name__, keys=keys,
- limit=self.limit))
- return resultdata
-
- def _extract_results(self, resultdata):
- """Extract results from resultdata."""
- for item in resultdata:
- result = self.result(item)
- if self._namespaces and not self._check_result_namespace(result):
- continue
-
- yield result
- if isinstance(item, dict) \
- and set(self.continuekey) & set(item.keys()):
- # if we need to count elements contained in items in
- # self.data["query"]["pages"], we want to count
- # item[self.continuekey] (e.g. 'revisions') and not
- # self.resultkey (i.e. 'pages')
- for key in set(self.continuekey) & set(item.keys()):
- self._count += len(item[key])
- # otherwise we proceed as usual
- else:
- self._count += 1
- # note: self.limit could be -1
- if self.limit and 0 < self.limit <= self._count:
- raise RuntimeError(
- 'QueryGenerator._extract_results reached the limit')
-
- def __iter__(self):
- """Submit request and iterate the response based on self.resultkey.
-
- Continues response as needed until limit (if any) is reached.
-
- """
- previous_result_had_data = True
- prev_limit = new_limit = None
-
- self._count = 0
- while True:
- prev_limit, new_limit = self._handle_query_limit(
- prev_limit, new_limit, previous_result_had_data)
- if not hasattr(self, 'data'):
- self.data = self.request.submit()
- if not self.data or not isinstance(self.data, dict):
- pywikibot.debug(
- '{}: stopped iteration because no dict retrieved from api.'
- .format(type(self).__name__))
- return
-
- if 'query' in self.data and self.resultkey in self.data['query']:
- resultdata = self._get_resultdata()
- if 'normalized' in self.data['query']:
- self.normalized = {
- item['to']: item['from']
- for item in self.data['query']['normalized']}
- else:
- self.normalized = {}
- try:
- yield from self._extract_results(resultdata)
- except RuntimeError:
- return
- # self.resultkey in data in last request.submit()
- previous_result_had_data = True
- else:
- if 'query' not in self.data:
- pywikibot.log("%s: 'query' not found in api response." %
- self.__class__.__name__)
- pywikibot.log(str(self.data))
- # if (query-)continue is present, self.resultkey might not have
- # been fetched yet
- if self.continue_name not in self.data:
- # No results.
- return
- # self.resultkey not in data in last request.submit()
- # only "(query-)continue" was retrieved.
- previous_result_had_data = False
- if self.modules[0] == 'random':
- # "random" module does not return "(query-)continue"
- # now we loop for a new random query
- del self.data # a new request is needed
- continue
- if self.continue_name not in self.data:
- return
- if self.continue_update():
- return
-
- del self.data # a new request with (query-)continue is needed
-
- def result(self, data):
- """Process result data as needed for particular subclass."""
- return data
-
-
-class PageGenerator(QueryGenerator):
-
- """Iterator for response to a request of type action=query&generator=foo.
-
- This class can be used for any of the query types that are listed in the
- API documentation as being able to be used as a generator. Instances of
- this class iterate Page objects.
-
- """
-
- def __init__(
- self,
- generator: str,
- g_content: bool = False,
- **kwargs
- ) -> None:
- """
- Initializer.
-
- Required and optional parameters are as for ``Request``, except that
- action=query is assumed and generator is required.
-
- :param generator: the "generator=" type from api.php
- :param g_content: if True, retrieve the contents of the current
- version of each Page (default False)
-
- """
- # If possible, use self.request after __init__ instead of appendParams
- def append_params(params, key, value) -> None:
- if key in params:
- params[key] += '|' + value
- else:
- params[key] = value
- kwargs = self._clean_kwargs(kwargs)
- parameters = kwargs['parameters']
- # get some basic information about every page generated
- append_params(parameters, 'prop', 'info|imageinfo|categoryinfo')
- if g_content:
- # retrieve the current revision
- append_params(parameters, 'prop', 'revisions')
- append_params(parameters, 'rvprop',
- 'ids|timestamp|flags|comment|user|content')
- if not ('inprop' in parameters
- and 'protection' in parameters['inprop']):
- append_params(parameters, 'inprop', 'protection')
- append_params(parameters, 'iiprop',
- 'timestamp|user|comment|url|size|sha1|metadata')
- append_params(parameters, 'iilimit', 'max') # T194233
- parameters['generator'] = generator
- super().__init__(**kwargs)
- self.resultkey = 'pages' # element to look for in result
- self.props = self.request['prop']
-
- def result(self, pagedata):
- """Convert page dict entry from api to Page object.
-
- This can be overridden in subclasses to return a different type
- of object.
-
- """
- p = pywikibot.Page(self.site, pagedata['title'], pagedata['ns'])
- ns = pagedata['ns']
- # Upcast to proper Page subclass.
- if ns == 2:
- p = pywikibot.User(p)
- elif ns == 6:
- p = pywikibot.FilePage(p)
- elif ns == 14:
- p = pywikibot.Category(p)
- update_page(p, pagedata, self.props)
- return p
-
-
-class PropertyGenerator(QueryGenerator):
-
- """Iterator for queries of type action=query&prop=foo.
-
- See the API documentation for types of page properties that can be
- queried.
-
- This iterator yields one or more dict object(s) corresponding
- to each "page" item(s) from the API response; the calling module has to
- decide what to do with the contents of the dict. There will be one
- dict for each page queried via a titles= or ids= parameter (which must
- be supplied when instantiating this class).
-
- """
-
- def __init__(self, prop: str, **kwargs) -> None:
- """
- Initializer.
-
- Required and optional parameters are as for ``Request``, except that
- action=query is assumed and prop is required.
-
- :param prop: the "prop=" type from api.php
- """
- kwargs = self._clean_kwargs(kwargs, prop=prop)
- super().__init__(**kwargs)
- self._props = frozenset(prop.split('|'))
- self.resultkey = 'pages'
-
- @property
- def props(self):
- """The requested property names."""
- return self._props
-
- def __iter__(self):
- """Yield results."""
- self._previous_dicts = {}
- yield from super().__iter__()
- yield from self._previous_dicts.values()
-
- def _extract_results(self, resultdata):
- """Yield completed page_data of consecutive API requests."""
- yield from self._fully_retrieved_data_dicts(resultdata)
- for data_dict in super()._extract_results(resultdata):
- if 'title' in data_dict:
- d = self._previous_dicts.setdefault(data_dict['title'],
- data_dict)
- if d is not data_dict:
- self._update_old_result_dict(d, data_dict)
- else:
- pywikibot.warn('Skipping result without title: '
- + str(data_dict))
-
- def _fully_retrieved_data_dicts(self, resultdata):
- """Yield items of self._previous_dicts that are not in resultdata."""
- resultdata_titles = {d['title'] for d in resultdata if 'title' in d}
- for prev_title, prev_dict in self._previous_dicts.copy().items():
- if prev_title not in resultdata_titles:
- yield prev_dict
- del self._previous_dicts[prev_title]
-
- @staticmethod
- def _update_old_result_dict(old_dict, new_dict) -> None:
- """Update old result dict with new_dict."""
- for k, v in new_dict.items():
- if k not in old_dict:
- old_dict[k] = v
- continue
- if isinstance(v, list):
- old_dict[k].extend(v)
- continue
- assert isinstance(v, (str, int)), (
- 'continued API result had an unexpected type: {}'.format(v))
-
-
-class ListGenerator(QueryGenerator):
-
- """Iterator for queries of type action=query&list=foo.
-
- See the API documentation for types of lists that can be queried. Lists
- include both site-wide information (such as 'allpages') and page-specific
- information (such as 'backlinks').
-
- This iterator yields a dict object for each member of the list returned
- by the API, with the format of the dict depending on the particular list
- command used. For those lists that contain page information, it may be
- easier to use the PageGenerator class instead, as that will convert the
- returned information into a Page object.
-
- """
-
- def __init__(self, listaction: str, **kwargs) -> None:
- """
- Initializer.
-
- Required and optional parameters are as for ``Request``, except that
- action=query is assumed and listaction is required.
-
- :param listaction: the "list=" type from api.php
- """
- kwargs = self._clean_kwargs(kwargs, list=listaction)
- super().__init__(**kwargs)
-
-
-class LogEntryListGenerator(ListGenerator):
-
- """
- Iterator for queries of list 'logevents'.
-
- Yields LogEntry objects instead of dicts.
- """
-
- def __init__(self, logtype=None, **kwargs) -> None:
- """Initializer."""
- super().__init__('logevents', **kwargs)
-
- from pywikibot import logentries
- self.entryFactory = logentries.LogEntryFactory(self.site, logtype)
-
- def result(self, pagedata):
- """Instantiate LogEntry from data from api."""
- return self.entryFactory.create(pagedata)
-
- def _check_result_namespace(self, result):
- """Return True if result.ns() is in self._namespaces."""
- return result.ns() in self._namespaces
-
-
class LoginManager(login.LoginManager):
"""Supply login_to_site method to use API interface."""
@@ -2319,170 +1520,3 @@
query.sort(key=lambda x: x[0].lower().endswith('token')
+ (x[0] == 'wpEditToken'))
return urlencode(query)
-
-
-def _update_pageid(page, pagedict: dict):
- """Update pageid."""
- if 'pageid' in pagedict:
- page._pageid = int(pagedict['pageid'])
- elif 'missing' in pagedict:
- page._pageid = 0 # Non-existent page
- else:
- # Something is wrong.
- if page.site.sametitle(page.title(), pagedict['title']) \
- and 'invalid' in pagedict:
- raise InvalidTitleError('{}: {}'
- .format(page, pagedict['invalidreason']))
- if int(pagedict['ns']) < 0:
- raise UnsupportedPageError(page)
- raise RuntimeError(
- "Page {} has neither 'pageid' nor 'missing' attribute"
- .format(pagedict['title']))
-
-
-def _update_contentmodel(page, pagedict: dict) -> None:
- """Update page content model."""
- page._contentmodel = pagedict.get('contentmodel') # can be None
-
- if (page._contentmodel
- and page._contentmodel == 'proofread-page'
- and 'proofread' in pagedict):
- page._quality = pagedict['proofread']['quality']
- page._quality_text = pagedict['proofread']['quality_text']
-
-
-def _update_protection(page, pagedict: dict) -> None:
- """Update page protection."""
- if 'restrictiontypes' in pagedict:
- page._applicable_protections = set(pagedict['restrictiontypes'])
- else:
- page._applicable_protections = None
- page._protection = {item['type']: (item['level'], item['expiry'])
- for item in pagedict['protection']}
-
-
-def _update_revisions(page, revisions) -> None:
- """Update page revisions."""
- for rev in revisions:
- revid = rev['revid']
- revision = pywikibot.page.Revision(**rev)
- # do not overwrite an existing Revision if there is no content
- if revid in page._revisions and revision.text is None:
- pass
- else:
- page._revisions[revid] = revision
-
-
-def _update_templates(page, templates) -> None:
- """Update page templates."""
- templ_pages = [pywikibot.Page(page.site, tl['title']) for tl in templates]
- if hasattr(page, '_templates'):
- page._templates.extend(templ_pages)
- else:
- page._templates = templ_pages
-
-
-def _update_langlinks(page, langlinks) -> None:
- """Update page langlinks."""
- links = [pywikibot.Link.langlinkUnsafe(link['lang'], link['*'],
- source=page.site)
- for link in langlinks]
-
- if hasattr(page, '_langlinks'):
- page._langlinks.extend(links)
- else:
- page._langlinks = links
-
-
-def _update_coordinates(page, coordinates) -> None:
- """Update page coordinates."""
- coords = []
- for co in coordinates:
- coord = pywikibot.Coordinate(lat=co['lat'],
- lon=co['lon'],
- typ=co.get('type', ''),
- name=co.get('name', ''),
- dim=int(co.get('dim', 0)) or None,
- globe=co['globe'], # See [[gerrit:67886]]
- primary='primary' in co
- )
- coords.append(coord)
- page._coords = coords
-
-
-def update_page(page, pagedict: dict, props=None):
- """Update attributes of Page object page, based on query data in pagedict.
-
- :param page: object to be updated
- :type page: pywikibot.page.Page
- :param pagedict: the contents of a "page" element of a query response
- :param props: the property names which resulted in pagedict. If a missing
- value in pagedict can indicate both 'false' and 'not present' the
- property which would make the value present must be in the props
- parameter.
- :type props: iterable of string
- :raises pywikibot.exceptions.InvalidTitleError: Page title is invalid
- :raises pywikibot.exceptions.UnsupportedPageError: Page with namespace < 0
- is not supported yet
- """
- _update_pageid(page, pagedict)
- _update_contentmodel(page, pagedict)
-
- props = props or []
- if 'info' in props:
- page._isredir = 'redirect' in pagedict
-
- if 'touched' in pagedict:
- page._timestamp = pagedict['touched']
-
- if 'protection' in pagedict:
- _update_protection(page, pagedict)
-
- if 'revisions' in pagedict:
- _update_revisions(page, pagedict['revisions'])
-
- if 'lastrevid' in pagedict:
- page.latest_revision_id = pagedict['lastrevid']
-
- if 'imageinfo' in pagedict:
- if not isinstance(page, pywikibot.FilePage):
- raise RuntimeError(
- '"imageinfo" found but {} is not a FilePage object'
- .format(page))
- page._load_file_revisions(pagedict['imageinfo'])
-
- if 'categoryinfo' in pagedict:
- page._catinfo = pagedict['categoryinfo']
-
- if 'templates' in pagedict:
- _update_templates(page, pagedict['templates'])
- elif 'templates' in props:
- page._templates = []
-
- if 'langlinks' in pagedict:
- _update_langlinks(page, pagedict['langlinks'])
- elif 'langlinks' in props:
- page._langlinks = []
-
- if 'coordinates' in pagedict:
- _update_coordinates(page, pagedict['coordinates'])
-
- if 'pageimage' in pagedict:
- page._pageimage = pywikibot.FilePage(page.site, pagedict['pageimage'])
-
- if 'pageprops' in pagedict:
- page._pageprops = pagedict['pageprops']
- elif 'pageprops' in props:
- page._pageprops = {}
-
- if 'preload' in pagedict:
- page._preloadedtext = pagedict['preload']
-
- if 'flowinfo' in pagedict:
- page._flowinfo = pagedict['flowinfo']['flow']
-
- if 'lintId' in pagedict:
- page._lintinfo = pagedict
- page._lintinfo.pop('pageid')
- page._lintinfo.pop('title')
- page._lintinfo.pop('ns')
diff --git a/pywikibot/data/api/_generators.py b/pywikibot/data/api/_generators.py
index acaf7ba..eedc9da 100644
--- a/pywikibot/data/api/_generators.py
+++ b/pywikibot/data/api/_generators.py
@@ -1,1341 +1,15 @@
-"""Interface to Mediawiki's api.php."""
+"""Objects representing API/Query generators."""
#
-# (C) Pywikibot team, 2007-2022
+# (C) Pywikibot team, 2008-2022
#
# Distributed under the terms of the MIT license.
#
-import datetime
-import hashlib
-import inspect
-import os
-import pickle
-import pprint
-import re
-import traceback
-from collections.abc import MutableMapping
-from email.generator import BytesGenerator
-from email.mime.multipart import MIMEMultipart as MIMEMultipartOrig
-from email.mime.nonmultipart import MIMENonMultipart
-from inspect import getfullargspec
-from io import BytesIO
-from typing import Any, Optional, Union
-from urllib.parse import unquote, urlencode
+from typing import Union
from warnings import warn
import pywikibot
-from pywikibot import config, login
-from pywikibot.backports import Callable, Dict, Match, Tuple, removeprefix
-from pywikibot.comms import http
-from pywikibot.data.api._paraminfo import ParamInfo
-from pywikibot.data.api._optionset import OptionSet
-from pywikibot.exceptions import (
- Error,
- FatalServerError,
- InvalidTitleError,
- MaxlagTimeoutError,
- NoUsernameError,
- Server414Error,
- Server504Error,
- SiteDefinitionError,
- TimeoutError,
- UnsupportedPageError,
-)
-from pywikibot.family import SubdomainFamily
-from pywikibot.login import LoginStatus
-from pywikibot.textlib import removeHTMLParts
-from pywikibot.tools import PYTHON_VERSION
-
-__all__ = (
- 'APIGenerator',
- 'CachedRequest',
- 'ListGenerator',
- 'LogEntryListGenerator',
- 'LoginManager',
- 'OptionSet',
- 'PageGenerator',
- 'ParamInfo',
- 'PropertyGenerator',
- 'QueryGenerator',
- 'Request',
- 'encode_url',
- 'update_page',
-)
-
-
-lagpattern = re.compile(
- r'Waiting for [\w.: ]+: (?P<lag>\d+(?:\.\d+)?) seconds? lagged')
-
-
-def _invalidate_superior_cookies(family) -> None:
- """
- Clear cookies for site's second level domain.
-
- get_login_token() will generate new cookies needed.
- This is a workaround for requests bug, see :phab:`T224712`
- and https://github.com/psf/requests/issues/5411
- for more details.
- """
- if isinstance(family, SubdomainFamily):
- for cookie in http.cookie_jar:
- if family.domain == cookie.domain:
- http.cookie_jar.clear(cookie.domain, cookie.path, cookie.name)
-
-
-# Bug: T113120, T228841
-# Subclassing necessary to fix bug of the email package in Python 3:
-# see https://bugs.python.org/issue19003
-# see https://bugs.python.org/issue18886
-# The following solution might be removed if the bug is fixed for
-# Python versions which are supported by PWB, probably with Python 3.5
-
-class CTEBinaryBytesGenerator(BytesGenerator):
-
- """Workaround for bug in python 3 email handling of CTE binary."""
-
- def __init__(self, *args, **kwargs) -> None:
- """Initializer."""
- super().__init__(*args, **kwargs)
- self._writeBody = self._write_body
-
- def _write_body(self, msg) -> None:
- if msg['content-transfer-encoding'] == 'binary':
- self._fp.write(msg.get_payload(decode=True))
- else:
- super()._handle_text(msg)
-
-
-class CTEBinaryMIMEMultipart(MIMEMultipartOrig):
-
- """Workaround for bug in python 3 email handling of CTE binary."""
-
- def as_bytes(self, unixfrom: bool = False, policy=None):
- """Return unmodified binary payload."""
- policy = self.policy if policy is None else policy
- fp = BytesIO()
- g = CTEBinaryBytesGenerator(fp, mangle_from_=False, policy=policy)
- g.flatten(self, unixfrom=unixfrom)
- return fp.getvalue()
-
-
-MIMEMultipart = CTEBinaryMIMEMultipart
-
-
-class Request(MutableMapping):
-
- """A request to a Site's api.php interface.
-
- Attributes of this object (except for the special parameters listed
- below) get passed as commands to api.php, and can be get or set
- using the dict interface. All attributes must be strings. Use an
- empty string for parameters that don't require a value. For example,
- Request(action="query", titles="Foo bar", prop="info", redirects="")
- corresponds to the API request
- "api.php?action=query&titles=Foo%20bar&prop=info&redirects"
-
- This is the lowest-level interface to the API, and can be used for any
- request that a particular site's API supports. See the API documentation
- (https://www.mediawiki.org/wiki/API) and site-specific settings for
- details on what parameters are accepted for each request type.
-
- Uploading files is a special case: to upload, the parameter "mime" must
- contain a dict, and the parameter "file" must be set equal to a valid
- filename on the local computer, _not_ to the content of the file.
-
- Returns a dict containing the JSON data returned by the wiki. Normally,
- one of the dict keys will be equal to the value of the 'action'
- parameter. Errors are caught and raise an APIError exception.
-
- Example:
-
- >>> r = Request(parameters={'action': 'query', 'meta': 'userinfo'})
- >>> # This is equivalent to
- >>> # https://{path}/api.php?action=query&meta=userinfo&format=json
- >>> # change a parameter
- >>> r['meta'] = "userinfo|siteinfo"
- >>> # add a new parameter
- >>> r['siprop'] = "namespaces"
- >>> # note that "uiprop" param gets added automatically
- >>> str(r.action)
- 'query'
- >>> sorted(str(key) for key in r._params.keys())
- ['action', 'meta', 'siprop']
- >>> [str(key) for key in r._params['action']]
- ['query']
- >>> [str(key) for key in r._params['meta']]
- ['userinfo', 'siteinfo']
- >>> [str(key) for key in r._params['siprop']]
- ['namespaces']
- >>> data = r.submit()
- >>> isinstance(data, dict)
- True
- >>> set(['query', 'batchcomplete', 'warnings']).issuperset(data.keys())
- True
- >>> 'query' in data
- True
- >>> sorted(str(key) for key in data['query'].keys())
- ['namespaces', 'userinfo']
-
- """
-
- # To make sure the default value of 'parameters' can be identified.
- _PARAM_DEFAULT = object()
-
- def __init__(self, site=None,
- mime: Optional[dict] = None,
- throttle: bool = True,
- max_retries: Optional[int] = None,
- retry_wait: Optional[int] = None,
- use_get: Optional[bool] = None,
- parameters=_PARAM_DEFAULT, **kwargs) -> None:
- """
- Create a new Request instance with the given parameters.
-
- The parameters for the request can be defined via either the
- 'parameters' parameter or the keyword arguments. The keyword arguments
- were the previous implementation but could cause problems when there
- are arguments to the API named the same as normal arguments to this
- class. So the second parameter 'parameters' was added which just
- contains all parameters. When a Request instance is created it must use
- either one of them and not both at the same time. To have backwards
- compatibility it adds a parameter named 'parameters' to kwargs when
- both parameters are set as that indicates an old call and 'parameters'
- was originally supplied as a keyword parameter.
-
- If undefined keyword arguments were given AND the 'parameters'
- parameter was supplied as a positional parameter it still assumes
- 'parameters' were part of the keyword arguments.
-
- If a class is using Request and is directly forwarding the parameters,
- :py:obj:`Request.clean_kwargs` can be used to automatically
- convert the old kwargs mode into the new parameter mode. This
- normalizes the arguments so that when the API parameters are
- modified the changes can always be applied to the 'parameters'
- parameter.
-
- :param site: The Site to which the request will be submitted. If not
- supplied, uses the user's configured default Site.
- :param mime: If not None, send in "multipart/form-data" format (default
- None). Parameters which should only be transferred via mime
- mode are defined via this parameter (even an empty dict means
- mime shall be used).
- :param max_retries: Maximum number of times to retry after
- errors, defaults to config.max_retries.
- :param retry_wait: Minimum time in seconds to wait after an
- error, defaults to config.retry_wait seconds (doubles each retry
- until config.retry_max seconds is reached).
- :param use_get: Use HTTP GET request if possible. If False it
- uses a POST request. If None, it'll try to determine via
- action=paraminfo if the action requires a POST.
- :param parameters: The parameters used for the request to the API.
- :type parameters: dict
- :param kwargs: The parameters used for the request to the API.
- """
- if site is None:
- self.site = pywikibot.Site()
- warn('Request() invoked without a site; setting to {}'
- .format(self.site), RuntimeWarning, 2)
- else:
- self.site = site
-
- self.mime = mime
- if isinstance(mime, bool):
- raise TypeError('mime param in api.Request() must not be boolean')
-
- self.throttle = throttle
- self.use_get = use_get
- if max_retries is None:
- self.max_retries = pywikibot.config.max_retries
- else:
- self.max_retries = max_retries
- self.current_retries = 0
- if retry_wait is None:
- self.retry_wait = pywikibot.config.retry_wait
- else:
- self.retry_wait = retry_wait
- # The only problem with that system is that it won't detect when
- # 'parameters' is actually the only parameter for the request as it
- # then assumes it's using the new mode (and the parameters are actually
- # in the parameter 'parameters' not that the parameter 'parameters' is
- # actually a parameter for the request). But that is invalid anyway as
- # it MUST have at least an action parameter for the request which would
- # be in kwargs if it's using the old mode.
- if kwargs:
- if parameters is not self._PARAM_DEFAULT:
- # 'parameters' AND kwargs is set. In that case think of
- # 'parameters' being an old kwarg which is now filled in an
- # actual parameter
- self._warn_both()
- kwargs['parameters'] = parameters
- # When parameters wasn't set it's likely that kwargs-mode was used
- self._warn_kwargs()
- parameters = kwargs
- elif parameters is self._PARAM_DEFAULT:
- parameters = {}
- self._params = {}
- if 'action' not in parameters:
- raise ValueError("'action' specification missing from Request.")
- self.action = parameters['action']
- self.update(parameters) # also convert all parameter values to lists
- self._warning_handler = None # type: Optional[Callable[[str, str], Union[Match[str], bool, None]]] # noqa: E501
- # Actions that imply database updates on the server, used for various
- # things like throttling or skipping actions when we're in simulation
- # mode
- self.write = self.action in {
- 'block', 'clearhasmsg', 'createaccount', 'delete', 'edit',
- 'emailuser', 'filerevert', 'flowthank', 'imagerotate', 'import',
- 'managetags', 'mergehistory', 'move', 'options', 'patrol',
- 'protect', 'purge', 'resetpassword', 'revisiondelete', 'rollback',
- 'setnotificationtimestamp', 'setpagelanguage', 'tag', 'thank',
- 'unblock', 'undelete', 'upload', 'userrights', 'watch',
- 'wbcreateclaim', 'wbcreateredirect', 'wbeditentity',
- 'wblinktitles', 'wbmergeitems', 'wbremoveclaims',
- 'wbremovequalifiers', 'wbremovereferences', 'wbsetaliases',
- 'wbsetclaim', 'wbsetclaimvalue', 'wbsetdescription', 'wbsetlabel',
- 'wbsetqualifier', 'wbsetreference', 'wbsetsitelink',
- 'wbladdform', 'wbleditformelements', 'wblmergelexemes',
- 'wblremoveform',
- }
- # Client side verification that the request is being performed
- # by a logged in user, and warn if it isn't a config username.
- if self.write:
- try:
- username = self.site.userinfo['name']
- except KeyError:
- raise Error('API write action attempted without user name')
-
- if 'anon' in self.site.userinfo:
- raise Error("API write action attempted as IP '{}'"
- .format(username))
-
- if not self.site.user() or self.site.username() != username:
- pywikibot.warning(
- 'API write action by unexpected username {} commenced.\n'
- 'userinfo: {!r}'.format(username, self.site.userinfo))
-
- # Make sure user is logged in
- if self.write:
- pywikibot.debug('Adding user assertion')
- self['assert'] = 'user'
-
- @classmethod
- def create_simple(cls, req_site, **kwargs):
- """Create a new instance using all args except site for the API."""
- # This ONLY support site so that any caller can be sure there will be
- # no conflict with PWB parameters
- # req_site is needed to avoid conflicts with possible site keyword in
- # kwarg until positional-only parameters are supported, see T262926
- # TODO: Use ParamInfo request to determine valid parameters
- if isinstance(kwargs.get('parameters'), dict):
- warn('The request contains already a "parameters" entry which is '
- 'a dict.')
- return cls(site=req_site, parameters=kwargs)
-
- @classmethod
- def _warn_both(cls) -> None:
- """Warn that kwargs mode was used but parameters was set too."""
- warn('Both kwargs and parameters are set in Request.__init__. It '
- 'assumes that "parameters" is actually a parameter of the '
- 'Request and is added to kwargs.', DeprecationWarning, 3)
-
- @classmethod
- def _warn_kwargs(cls) -> None:
- """Warn that kwargs was used instead of parameters."""
- warn('Instead of using kwargs from Request.__init__, parameters '
- 'for the request to the API should be added via the '
- '"parameters" parameter.', DeprecationWarning, 3)
-
- @classmethod
- def clean_kwargs(cls, kwargs: dict) -> dict:
- """
- Convert keyword arguments into new parameters mode.
-
- If there are no other arguments in kwargs apart from the used arguments
- by the class' initializer it'll just return kwargs and otherwise remove
- those which aren't in the initializer and put them in a dict which is
- added as a 'parameters' keyword. It will always create a shallow copy.
-
- :param kwargs: The original keyword arguments which is not modified.
- :return: The normalized keyword arguments.
- """
- if 'expiry' in kwargs and kwargs['expiry'] is None:
- del kwargs['expiry']
-
- args = set()
- for super_cls in inspect.getmro(cls):
- if not super_cls.__name__.endswith('Request'):
- break
- args |= set(getfullargspec(super_cls.__init__).args)
- else:
- raise ValueError('Request was not a super class of '
- '{!r}'.format(cls))
- args -= {'self'}
- old_kwargs = set(kwargs)
- # all kwargs defined above but not in args indicate 'kwargs' mode
- if old_kwargs - args:
- # Move all kwargs into parameters
- parameters = {name: value for name, value in kwargs.items()
- if name not in args or name == 'parameters'}
- if 'parameters' in parameters:
- cls._warn_both()
- # Copy only arguments and not the parameters
- kwargs = {name: value for name, value in kwargs.items()
- if name in args or name == 'self'}
- kwargs['parameters'] = parameters
- # Make sure that all arguments have remained
- assert(old_kwargs | {'parameters'}
- == set(kwargs) | set(kwargs['parameters']))
- assert(('parameters' in old_kwargs)
- is ('parameters' in kwargs['parameters']))
- cls._warn_kwargs()
- else:
- kwargs = dict(kwargs)
- kwargs.setdefault('parameters', {})
- return kwargs
-
- def _format_value(self, value):
- """
- Format the MediaWiki API request parameter.
-
- Converts from Python datatypes to MediaWiki API parameter values.
-
- Supports:
- * datetime.datetime (using strftime and ISO8601 format)
- * pywikibot.page.BasePage (using title (+namespace; -section))
-
- All other datatypes are converted to string.
- """
- if isinstance(value, datetime.datetime):
- return value.strftime(pywikibot.Timestamp.ISO8601Format)
- if isinstance(value, pywikibot.page.BasePage):
- if value.site != self.site:
- raise RuntimeError(
- 'value.site {!r} is different from Request.site {!r}'
- .format(value.site, self.site))
- return value.title(with_section=False)
- return str(value)
-
- def __getitem__(self, key):
- """Implement dict interface."""
- return self._params[key]
-
- def __setitem__(self, key: str, value) -> None:
- """Set MediaWiki API request parameter.
-
- :param value: param value(s)
- :type value: str in site encoding
- (string types may be a `|`-separated list)
- iterable, where items are converted to string
- with special handling for datetime.datetime to convert it to a
- string using the ISO 8601 format accepted by the MediaWiki API.
- """
- if isinstance(value, bytes):
- value = value.decode(self.site.encoding())
-
- if isinstance(value, str):
- value = value.split('|')
-
- if hasattr(value, 'api_iter'):
- self._params[key] = value
- else:
- try:
- iter(value)
- except TypeError:
- # convert any non-iterable value into a single-element list
- self._params[key] = [value]
- else:
- self._params[key] = list(value)
-
- def __delitem__(self, key) -> None:
- """Implement dict interface."""
- del self._params[key]
-
- def keys(self):
- """Implement dict interface."""
- return list(self._params.keys())
-
- def __contains__(self, key) -> bool:
- """Implement dict interface."""
- return key in self._params
-
- def __iter__(self):
- """Implement dict interface."""
- return iter(self._params)
-
- def __len__(self) -> int:
- """Implement dict interface."""
- return len(self._params)
-
- def iteritems(self):
- """Implement dict interface."""
- return iter(self._params.items())
-
- def items(self):
- """Return a list of tuples containing the parameters in any order."""
- return list(self._params.items())
-
- def _add_defaults(self):
- """
- Add default parameters to the API request.
-
- This method will only add them once.
- """
- if hasattr(self, '__defaulted'):
- return
-
- if self.mime is not None \
- and set(self._params.keys()) & set(self.mime.keys()):
- raise ValueError('The mime and params shall not share the '
- 'same keys.')
-
- if self.action == 'query':
- meta = self._params.get('meta', [])
- # Special logic for private wikis (T153903).
- # If the wiki requires login privileges to read articles, pywikibot
- # will be blocked from accessing the userinfo.
- # Work around this by requiring userinfo only if 'tokens' and
- # 'login' are not both set.
- typep = self._params.get('type', [])
- if not ('tokens' in meta and 'login' in typep):
- if 'userinfo' not in meta:
- meta = set(meta + ['userinfo'])
- self['meta'] = sorted(meta)
- uiprop = self._params.get('uiprop', [])
- uiprop = set(uiprop + ['blockinfo', 'hasmsg'])
- self['uiprop'] = sorted(uiprop)
- if 'prop' in self._params \
- and self.site.has_extension('ProofreadPage'):
- prop = set(self['prop'] + ['proofread'])
- self['prop'] = sorted(prop)
- # When neither 'continue' nor 'rawcontinue' is present and the
- # version number is at least 1.25wmf5 we add a dummy rawcontinue
- # parameter. Querying siteinfo is save as it adds 'continue'
- # except for 'tokens' (T284577)
- if ('tokens' not in meta and 'continue' not in self._params
- and self.site.mw_version >= '1.25wmf5'):
- self._params.setdefault('rawcontinue', [''])
- elif self.action == 'help' and self.site.mw_version > '1.24':
- self['wrap'] = ''
-
- if config.maxlag:
- self._params.setdefault('maxlag', [str(config.maxlag)])
- self._params.setdefault('format', ['json'])
- if self['format'] != ['json']:
- raise TypeError(
- "Query format '{}' cannot be parsed.".format(self['format']))
-
- self.__defaulted = True # skipcq: PTC-W0037
-
- def _encoded_items(self) -> Dict[str, Union[str, bytes]]:
- """
- Build a dict of params with minimal encoding needed for the site.
-
- This helper method only prepares params for serialisation or
- transmission, so it only encodes values which are not ASCII,
- requiring callers to consider how to handle ASCII vs other values,
- however the output is designed to enable __str__ and __repr__ to
- do the right thing in most circumstances.
-
- Servers which use an encoding that is not a superset of ASCII
- are not supported.
-
- :return: Parameters either in the site encoding, or ASCII strings
- """
- params = {}
- for key, values in self._params.items():
- try:
- iterator = values.api_iter()
- except AttributeError:
- if len(values) == 1:
- value = values[0]
- if value is True:
- values = ['']
- elif value is False or value is None:
- # False and None are not included in the http URI
- continue
- iterator = iter(values)
- value = '|'.join(self._format_value(value) for value in iterator)
- # If the value is encodable as ascii, do not encode it.
- # This means that any value which can be encoded as ascii
- # is presumed to be ascii, and servers using a site encoding
- # which is not a superset of ascii may be problematic.
- try:
- value.encode('ascii')
- except UnicodeError:
- try:
- value = value.encode(self.site.encoding())
- except Exception:
- pywikibot.error(
- "_encoded_items: '{}' could not be encoded as '{}':"
- ' {!r}'.format(key, self.site.encoding(), value))
- assert key.encode('ascii')
- assert isinstance(key, str)
- params[key] = value
- return params
-
- def _http_param_string(self):
- """
- Return the parameters as a HTTP URL query fragment.
-
- URL encodes the parameters provided by _encoded_items()
-
- .. note:: Not all parameters are sorted, therefore for two given
- CachedRequest objects with equal _params, the result of
- _http_param_string() is not necessarily equal.
- """
- return encode_url(self._encoded_items())
-
- def __str__(self) -> str:
- """Return a string representation."""
- return unquote(self.site.scriptpath()
- + '/api.php?'
- + self._http_param_string())
-
- def __repr__(self) -> str:
- """Return internal representation."""
- return '{}.{}<{}->{!r}>'.format(self.__class__.__module__,
- self.__class__.__name__,
- self.site, str(self))
-
- def _simulate(self, action):
- """Simulate action."""
- if action and config.simulate and (
- self.write or action in config.actions_to_block):
- pywikibot.output('<<black;yellow>>SIMULATION: {} action blocked.'
- '<<default>>'.format(action))
- # for more realistic simulation
- if config.simulate is not True:
- pywikibot.sleep(float(config.simulate))
- return {
- action: {'result': 'Success', 'nochange': ''},
-
- # wikibase results
- 'entity': {'lastrevid': -1},
- 'pageinfo': {'lastrevid': -1},
- 'reference': {'hash': -1},
- }
- return None
-
- def _is_wikibase_error_retryable(self, error):
- # dict of error message and current action.
- # Value is True if action type is to be ignored
- err_msg = {
- 'edit-already-exists': 'wbeditentity',
- 'actionthrottledtext': True, # T192912, T268645
- }
- messages = error.get('messages')
- message = None
- # bug T68619; after Wikibase breaking change 1ca9cee we have a
- # list of messages
- if isinstance(messages, list):
- for item in messages:
- message = item['name']
- action = err_msg.get(message)
- if action is True or action == self.action:
- return True
-
- return False
-
- if isinstance(messages, dict):
- try: # behaviour before gerrit 124323 breaking change
- message = messages['0']['name']
- except KeyError: # unsure the new output is always a list
- message = messages['name']
- action = err_msg.get(message)
- return action is True or action == self.action
-
- @staticmethod
- def _generate_mime_part(key, content, keytype=None, headers=None):
- if not keytype:
- try:
- content.encode('ascii')
- keytype = ('text', 'plain')
- except (UnicodeError, AttributeError):
- keytype = ('application', 'octet-stream')
- submsg = MIMENonMultipart(*keytype)
- content_headers = {'name': key}
- if headers:
- content_headers.update(headers)
- submsg.add_header('Content-disposition', 'form-data',
- **content_headers)
-
- if keytype != ('text', 'plain'):
- submsg['Content-Transfer-Encoding'] = 'binary'
-
- submsg.set_payload(content)
- return submsg
-
- def _use_get(self):
- """Verify whether 'get' is to be used."""
- if (not config.enable_GET_without_SSL
- and self.site.protocol() != 'https'
- or self.site.is_oauth_token_available()): # T108182 workaround
- use_get = False
- elif self.use_get is None:
- if self.action == 'query':
- # for queries check the query module
- modules = set()
- for mod_type_name in ('list', 'prop', 'generator'):
- modules.update(self._params.get(mod_type_name, []))
- else:
- modules = {self.action}
- if modules:
- self.site._paraminfo.fetch(modules)
- use_get = all('mustbeposted' not in self.site._paraminfo[mod]
- for mod in modules)
- else:
- # If modules is empty, just 'meta' was given, which doesn't
- # require POSTs, and is required for ParamInfo
- use_get = True
- else:
- use_get = self.use_get
- return use_get
-
- @classmethod
- def _build_mime_request(cls, params: dict,
- mime_params: dict) -> Tuple[dict, bytes]:
- """
- Construct a MIME multipart form post.
-
- :param params: HTTP request params
- :param mime_params: HTTP request parts which must be sent in the body
- :type mime_params: dict of (content, keytype, headers) # noqa: DAR103
- :return: HTTP request headers and body
- """
- # construct a MIME message containing all API key/values
- container = MIMEMultipart(_subtype='form-data')
- for key, value in params.items():
- submsg = cls._generate_mime_part(key, value)
- container.attach(submsg)
- for key, value in mime_params.items():
- submsg = cls._generate_mime_part(key, *value)
- container.attach(submsg)
-
- # strip the headers to get the HTTP message body
- body = container.as_bytes()
- marker = b'\n\n' # separates headers from body
- eoh = body.find(marker)
- body = body[eoh + len(marker):]
- # retrieve the headers from the MIME object
- headers = dict(container.items())
- return headers, body
-
- def _get_request_params(self, use_get, paramstring):
- """Get request parameters."""
- uri = self.site.apipath()
- if self.mime is not None:
- (headers, body) = Request._build_mime_request(
- self._encoded_items(), self.mime)
- use_get = False # MIME requests require HTTP POST
- else:
- headers = {'Content-Type': 'application/x-www-form-urlencoded'}
- if (not self.site.maximum_GET_length()
- or self.site.maximum_GET_length() < len(paramstring)):
- use_get = False
- if use_get:
- uri = '{}?{}'.format(uri, paramstring)
- body = None
- else:
- body = paramstring
-
- pywikibot.debug('API request to {} (uses get: {}):\n'
- 'Headers: {!r}\nURI: {!r}\nBody: {!r}'
- .format(self.site, use_get, headers, uri, body))
- return use_get, uri, body, headers
-
- def _http_request(self, use_get: bool, uri: str, data, headers,
- paramstring) -> tuple:
- """Get or post a http request with exception handling.
-
- :return: a tuple containing requests.Response object from
- http.request and use_get value
- """
- try:
- response = http.request(self.site, uri=uri,
- method='GET' if use_get else 'POST',
- data=data, headers=headers)
- except Server504Error:
- pywikibot.log('Caught HTTP 504 error; retrying')
- except Server414Error:
- if use_get:
- pywikibot.log('Caught HTTP 414 error; retrying')
- use_get = False
- else:
- pywikibot.warning('Caught HTTP 414 error, although not '
- 'using GET.')
- raise
- except (ConnectionError, FatalServerError):
- # This error is not going to be fixed by just waiting
- pywikibot.error(traceback.format_exc())
- raise
- # TODO: what other exceptions can occur here?
- except Exception:
- # for any other error on the http request, wait and retry
- pywikibot.error(traceback.format_exc())
- pywikibot.log('{}, {}'.format(uri, paramstring))
- else:
- return response, use_get
- self.wait()
- return None, use_get
-
- def _json_loads(self, response) -> Optional[dict]:
- """Return a dict from requests.Response.
-
- :param response: a requests.Response object
- :type response: requests.Response
- :return: a data dict
- :raises pywikibot.exceptions.APIError: unknown action found
- :raises pywikibot.exceptions.APIError: unknown query result type
- """
- try:
- result = response.json()
- except ValueError:
- # if the result isn't valid JSON, there may be a server
- # problem. Wait a few seconds and try again
- # Show 20 lines of bare text
- text = '\n'.join(removeHTMLParts(response.text).splitlines()[:20])
- msg = """\
-Non-JSON response received from server {site} for url
-{resp.url}
-The server may be down.
-Status code: {resp.status_code}
-
-The text message is:
-{text}
-""".format(site=self.site, resp=response, text=text)
-
- # Do not retry for AutoFamily but raise a SiteDefinitionError
- # Note: family.AutoFamily is a function to create that class
- if self.site.family.__class__.__name__ == 'AutoFamily':
- pywikibot.debug(msg)
- raise SiteDefinitionError('Invalid AutoFamily({!r})'
- .format(self.site.family.domain))
-
- pywikibot.warning(msg)
-
- # there might also be an overflow, so try a smaller limit
- for param in self._params:
- if param.endswith('limit'):
- # param values are stored a list of str
- value = self[param][0]
- if value.isdigit():
- self[param] = [str(int(value) // 2)]
- pywikibot.output('Set {} = {}'
- .format(param, self[param]))
- else:
- return result or {}
- self.wait()
- return None
-
- def _relogin(self, message: str = '') -> None:
- """Force re-login and inform user."""
- pywikibot.error('{}{}Forcing re-login.'.format(message,
- ' ' if message else ''))
- self.site._relogin()
-
- def _userinfo_query(self, result) -> bool:
- """Handle userinfo query."""
- if self.action == 'query' and 'userinfo' in result.get('query', ()):
- # if we get passed userinfo in the query result, we can confirm
- # that we are logged in as the correct user. If this is not the
- # case, force a re-login.
- username = result['query']['userinfo']['name']
- if (self.site.user() is not None and self.site.user() != username
- and self.site._loginstatus != LoginStatus.IN_PROGRESS):
- message = ("Logged in as '{actual}' instead of '{expected}'."
- .format(actual=username, expected=self.site.user()))
- self._relogin(message)
- return True
- return False
-
- def _handle_warnings(self, result: Dict[str, Any]) -> bool:
- """Handle warnings; return True to retry request, False to resume.
-
- .. versionchanged:: 7.2
- Return True to retry the current request and Falso to resume.
- """
- retry = False
- if 'warnings' not in result:
- return retry
-
- for mod, warning in result['warnings'].items():
- if mod == 'info':
- continue
- if '*' in warning:
- text = warning['*']
- elif 'html' in warning:
- # bug T51978
- text = warning['html']['*']
- else:
- pywikibot.warning('API warning ({}) of unknown format: {}'
- .format(mod, warning))
- continue
-
- # multiple warnings are in text separated by a newline
- for single_warning in text.splitlines():
- if (not callable(self._warning_handler)
- or not self._warning_handler(mod, single_warning)):
- handled = self._default_warning_handler(mod,
- single_warning)
- if handled is None:
- pywikibot.warning('API warning ({}): {}'
- .format(mod, single_warning))
- else:
- retry = retry or handled
- return retry
-
- def _default_warning_handler(self, mode: str, msg: str) -> Optional[bool]:
- """A default warning handler to handle specific warnings.
-
- Return True to retry the request, False to resume and None if
- the warning is not handled.
-
- .. versionadded:: 7.2
- """
- warnings = {
- 'purge': ("You've exceeded your rate limit. "
- 'Please wait some time and try again.',
- '_ratelimited', True),
- }
- warning, handler, retry = warnings.get(mode, (None, None, None))
- if handler and msg == warning:
- # Only show the first warning part
- pywikibot.warning(msg.split('.')[0] + '.')
- # call the handler
- getattr(self, handler)()
- return retry
- return None
-
- def _logged_in(self, code) -> bool:
- """Check whether user is logged in.
-
- Older wikis returned an error instead of a warning when the request
- asked for too many values. If we get this error, assume we are not
- logged in (we can't check this because the userinfo data is not
- present) and force a re-login
- """
- if code.endswith('limit'):
- message = 'Received API limit error.'
-
- # If the user assertion failed, we're probably logged out as well.
- elif code == 'assertuserfailed':
- message = 'User assertion failed.'
-
- # Lastly, the purge module requires a POST if used as anonymous user,
- # but we normally send a GET request. If the API tells us the request
- # has to be POSTed, we're probably logged out.
- elif code == 'mustbeposted' and self.action == 'purge':
- message = "Received unexpected 'mustbeposted' error."
-
- else:
- return True
-
- self._relogin(message)
- return False
-
- def _internal_api_error(self, code, error, result) -> bool:
- """Check for internal_api_error_ or readonly and retry.
-
- :raises pywikibot.exceptions.APIMWError: internal_api_error or readonly
- """
- iae = 'internal_api_error_'
- if not (code.startswith(iae) or code == 'readonly'):
- return False
-
- # T154011
- class_name = code if code == 'readonly' else removeprefix(code, iae)
-
- del error['code'] # is added via class_name
- e = pywikibot.exceptions.APIMWError(class_name, **error)
-
- # If the error key is in this table, it is probably a temporary
- # problem, so we will retry the edit.
- # TODO: T154011: 'ReadOnlyError' seems replaced by 'readonly'
- retry = class_name in ['DBConnectionError', # T64974
- 'DBQueryError', # T60158
- 'DBQueryTimeoutError', # T297708
- 'ReadOnlyError', # T61227
- 'readonly', # T154011
- ]
-
- pywikibot.error('Detected MediaWiki API exception {}{}'
- .format(e, '; retrying' if retry else '; raising'))
- param_repr = str(self._params)
- pywikibot.log('MediaWiki exception {} details:\n'
- ' query=\n{}\n'
- ' response=\n{}'
- .format(class_name,
- pprint.pformat(param_repr),
- result))
- if not retry:
- raise e
-
- self.wait()
- return True
-
- def _ratelimited(self) -> None:
- """Handle ratelimited warning."""
- ratelimits = self.site.userinfo['ratelimits']
- delay = None
-
- ratelimit = ratelimits.get(self.action, {})
- # find the lowest wait time for the given action
- for limit in ratelimit.values():
- seconds = limit['seconds']
- hits = limit['hits']
- delay = min(delay or seconds, seconds / hits)
-
- if not delay:
- pywikibot.warning(
- 'No rate limit found for action {}'.format(self.action))
- self.wait(delay)
-
- def _bad_token(self, code) -> bool:
- """Check for bad token."""
- if code != 'badtoken': # Other code not handled here
- return False
-
- if self.site._loginstatus == LoginStatus.IN_PROGRESS:
- pywikibot.log('Login status: {}'
- .format(self.site._loginstatus.name))
- return False
-
- user_tokens = self.site.tokens._tokens[self.site.user()]
- # all token values mapped to their type
- tokens = {token: t_type for t_type, token in user_tokens.items()}
- # determine which tokens are bad
- invalid_param = {name: tokens[param[0]]
- for name, param in self._params.items()
- if len(param) == 1 and param[0] in tokens}
- # doesn't care about the cache so can directly load them
- if invalid_param:
- pywikibot.log(
- 'Bad token error for {}. Tokens for "{}" used in request; '
- 'invalidated them.'
- .format(self.site.user(),
- '", "'.join(sorted(set(invalid_param.values())))))
- # invalidate superior wiki cookies (T224712)
- _invalidate_superior_cookies(self.site.family)
- # request new token(s) instead of invalid
- self.site.tokens.load_tokens(set(invalid_param.values()))
- # fix parameters; lets hope that it doesn't mistake actual
- # parameters as tokens
- for name, t_type in invalid_param.items():
- self[name] = self.site.tokens[t_type]
- return True
-
- # otherwise couldn't find any … weird there is nothing what
- # can be done here because it doesn't know which parameters
- # to fix
- pywikibot.log(
- 'Bad token error for {} but no parameter is using a '
- 'token. Current tokens: {}'
- .format(self.site.user(),
- ', '.join('{}: {}'.format(*e)
- for e in user_tokens.items())))
- return False
-
- def submit(self) -> dict:
- """
- Submit a query and parse the response.
-
- :return: a dict containing data retrieved from api.php
- """
- self._add_defaults()
- use_get = self._use_get()
- retries = 0
- while True:
- paramstring = self._http_param_string()
-
- simulate = self._simulate(self.action)
- if simulate:
- return simulate
-
- if self.throttle:
- self.site.throttle(write=self.write)
- else:
- pywikibot.log(
- "Submitting unthrottled action '{}'.".format(self.action))
-
- use_get, uri, body, headers = self._get_request_params(use_get,
- paramstring)
- response, use_get = self._http_request(use_get, uri, body, headers,
- paramstring)
- if response is None:
- continue
-
- result = self._json_loads(response)
- if result is None:
- continue
-
- if self._userinfo_query(result):
- continue
-
- if self._handle_warnings(result):
- continue
-
- if 'error' not in result:
- return result
-
- error = result['error'].copy()
- for key in result:
- if key in ('error', 'warnings'):
- continue
- assert key not in error
- assert isinstance(result[key], str), \
- 'Unexpected {}: {!r}'.format(key, result[key])
- error[key] = result[key]
-
- if '*' in result['error']:
- # help text returned
- result['error']['help'] = result['error'].pop('*')
- code = result['error'].setdefault('code', 'Unknown')
- info = result['error'].setdefault('info', None)
-
- if not self._logged_in(code):
- continue
-
- if code == 'maxlag':
- retries += 1
- if retries > max(5, pywikibot.config.max_retries):
- break
- pywikibot.log('Pausing due to database lag: ' + info)
-
- try:
- lag = result['error']['lag']
- except KeyError:
- lag = lagpattern.search(info)
- lag = float(lag.group('lag')) if lag else 0.0
-
- self.site.throttle.lag(lag * retries)
- continue
-
- if code == 'help' and self.action == 'help':
- # The help module returns an error result with the complete
- # API information. As this data was requested, return the
- # data instead of raising an exception.
- return {'help': {'mime': 'text/plain',
- 'help': result['error']['help']}}
-
- pywikibot.warning('API error {}: {}'.format(code, info))
- pywikibot.log(' headers=\n{}'.format(response.headers))
-
- if self._internal_api_error(code, error, result):
- continue
-
- # Phab. tickets T48535, T64126, T68494, T68619
- if code == 'failed-save' \
- and self._is_wikibase_error_retryable(result['error']):
- self.wait()
- continue
-
- if code == 'ratelimited':
- self._ratelimited()
- continue
-
- # If readapidenied is returned try to login
- if code == 'readapidenied' \
- and self.site._loginstatus in (LoginStatus.NOT_ATTEMPTED,
- LoginStatus.NOT_LOGGED_IN):
- self.site.login()
- continue
-
- if self._bad_token(code):
- continue
-
- if 'mwoauth-invalid-authorization' in code:
- if 'Nonce already used' in info:
- pywikibot.error(
- 'Retrying failed OAuth authentication for {}: {}'
- .format(self.site, info))
- continue
- raise NoUsernameError('Failed OAuth authentication for {}: {}'
- .format(self.site, info))
- if code == 'cirrussearch-too-busy-error': # T170647
- self.wait()
- continue
-
- if code in ('search-title-disabled', 'search-text-disabled'):
- prefix = 'gsr' if 'gsrsearch' in self._params else 'sr'
- del self._params[prefix + 'what']
- # use intitle: search instead
- if code == 'search-title-disabled' \
- and self.site.has_extension('CirrusSearch'):
- key = prefix + 'search'
- self._params[key] = ['intitle:' + search
- for search in self._params[key]]
- continue
-
- if code == 'urlshortener-blocked': # T244062
- # add additional informations to result['error']
- result['error']['current site'] = self.site
- if self.site.user():
- result['error']['current user'] = self.site.user()
- else: # not logged in; show the IP
- uinfo = self.site.userinfo
- result['error']['current user'] = uinfo['name']
-
- # raise error
- try:
- param_repr = str(self._params)
- pywikibot.log('API Error: query=\n{}'
- .format(pprint.pformat(param_repr)))
- pywikibot.log(' response=\n{}'.format(result))
-
- raise pywikibot.exceptions.APIError(**result['error'])
- except TypeError:
- raise RuntimeError(result)
-
- msg = 'Maximum retries attempted due to maxlag without success.'
- if os.environ.get('PYWIKIBOT_TESTS_RUNNING', '0') == '1':
- import unittest
- raise unittest.SkipTest(msg)
-
- raise MaxlagTimeoutError(msg)
-
- def wait(self, delay=None):
- """Determine how long to wait after a failed request."""
- self.current_retries += 1
- if self.current_retries > self.max_retries:
- raise TimeoutError('Maximum retries attempted without success.')
-
- # double the next wait, but do not exceed config.retry_max seconds
- delay = delay or self.retry_wait
- delay *= 2 ** (self.current_retries - 1)
- delay = min(delay, config.retry_max)
-
- pywikibot.warning('Waiting {:.1f} seconds before retrying.'
- .format(delay))
- pywikibot.sleep(delay)
-
-
-class CachedRequest(Request):
-
- """Cached request."""
-
- def __init__(self, expiry, *args, **kwargs) -> None:
- """Initialize a CachedRequest object.
-
- :param expiry: either a number of days or a datetime.timedelta object
- """
- assert expiry is not None
- super().__init__(*args, **kwargs)
- if not isinstance(expiry, datetime.timedelta):
- expiry = datetime.timedelta(expiry)
- self.expiry = min(expiry, datetime.timedelta(config.API_config_expiry))
- self._data = None
- self._cachetime = None
-
- @classmethod
- def create_simple(cls, req_site, **kwargs):
- """Unsupported as it requires at least two parameters."""
- raise NotImplementedError('CachedRequest cannot be created simply.')
-
- @classmethod
- def _get_cache_dir(cls) -> str:
- """
- Return the base directory path for cache entries.
-
- The directory will be created if it does not already exist.
-
- :return: base directory path for cache entries
- """
- path = os.path.join(config.base_dir,
- 'apicache-py{:d}'.format(PYTHON_VERSION[0]))
- cls._make_dir(path)
- cls._get_cache_dir = classmethod(lambda c: path) # cache the result
- return path
-
- @staticmethod
- def _make_dir(dir_name: str) -> str:
- """Create directory if it does not exist already.
-
- .. versionchanged:: 7.0
- Only `FileExistsError` is ignored but other OS exceptions can
- be still raised
-
- :param dir_name: directory path
- :return: unmodified directory name for test purpose
- """
- os.makedirs(dir_name, exist_ok=True)
- return dir_name
-
- def _uniquedescriptionstr(self) -> str:
- """Return unique description for the cache entry.
-
- If this is modified, please also update
- scripts/maintenance/cache.py to support
- the new key and all previous keys.
- """
- login_status = self.site._loginstatus
-
- if login_status >= LoginStatus.AS_USER:
- # This uses the format of Page.__repr__, without performing
- # config.console_encoding as done by Page.__repr__.
- # The returned value can't be encoded to anything other than
- # ascii otherwise it creates an exception when _create_file_name()
- # tries to encode it as utf-8.
- user_key = 'User(User:{})'.format(self.site.userinfo['name'])
- else:
- user_key = repr(LoginStatus(LoginStatus.NOT_LOGGED_IN))
-
- request_key = repr(sorted(self._encoded_items().items()))
- return '{!r}{}{}'.format(self.site, user_key, request_key)
-
- def _create_file_name(self) -> str:
- """Return a unique ascii identifier for the cache entry."""
- return hashlib.sha256(
- self._uniquedescriptionstr().encode('utf-8')
- ).hexdigest()
-
- def _cachefile_path(self):
- return os.path.join(CachedRequest._get_cache_dir(),
- self._create_file_name())
-
- def _expired(self, dt):
- return dt + self.expiry < datetime.datetime.utcnow()
-
- def _load_cache(self) -> bool:
- """Load cache entry for request, if available.
-
- :return: Whether the request was loaded from the cache
- """
- self._add_defaults()
- try:
- filename = self._cachefile_path()
- with open(filename, 'rb') as f:
- uniquedescr, self._data, self._cachetime = pickle.load(f)
- if uniquedescr != self._uniquedescriptionstr():
- raise RuntimeError('Expected unique description for the cache '
- 'entry is different from file entry.')
- if self._expired(self._cachetime):
- self._data = None
- return False
- pywikibot.debug('{}: cache hit ({}) for API request: {}'
- .format(self.__class__.__name__, filename,
- uniquedescr))
- return True
- except OSError:
- # file not found
- return False
- except Exception as e:
- pywikibot.output('Could not load cache: {!r}'.format(e))
- return False
-
- def _write_cache(self, data) -> None:
- """Write data to self._cachefile_path()."""
- data = (self._uniquedescriptionstr(), data, datetime.datetime.utcnow())
- with open(self._cachefile_path(), 'wb') as f:
- pickle.dump(data, f, protocol=config.pickle_protocol)
-
- def submit(self):
- """Submit cached request."""
- cached_available = self._load_cache()
- if not cached_available:
- self._data = super().submit()
- self._write_cache(self._data)
- else:
- self._handle_warnings(self._data)
- return self._data
+from pywikibot import config
+from pywikibot.exceptions import Error, InvalidTitleError, UnsupportedPageError
class _RequestWrapper:
@@ -2143,184 +817,6 @@
return result.ns() in self._namespaces
-class LoginManager(login.LoginManager):
-
- """Supply login_to_site method to use API interface."""
-
- # API login parameters mapping
- mapping = {
- 'user': ('lgname', 'username'),
- 'password': ('lgpassword', 'password'),
- 'ldap': ('lgdomain', 'domain'),
- 'token': ('lgtoken', 'logintoken'),
- 'result': ('result', 'status'),
- 'success': ('Success', 'PASS'),
- 'fail': ('Failed', 'FAIL'),
- 'reason': ('reason', 'message')
- }
-
- def keyword(self, key):
- """Get API keyword from mapping."""
- return self.mapping[key][self.action != 'login']
-
- def _login_parameters(self, *, botpassword: bool = False
- ) -> Dict[str, str]:
- """Return login parameters."""
- # Since MW 1.27 only for bot passwords.
- self.action = 'login'
- if not botpassword:
- # get token using meta=tokens if supported
- token = self.get_login_token()
- if token:
- # Standard login request since MW 1.27
- self.action = 'clientlogin'
-
- # prepare default login parameters
- parameters = {'action': self.action,
- self.keyword('user'): self.login_name,
- self.keyword('password'): self.password}
-
- if self.action == 'clientlogin':
- # clientlogin requires non-empty loginreturnurl
- parameters['loginreturnurl'] = 'https://example.com'
- parameters['rememberMe'] = '1'
- parameters['logintoken'] = token
-
- if self.site.family.ldapDomain:
- parameters[self.keyword('ldap')] = self.site.family.ldapDomain
-
- return parameters
-
- def login_to_site(self) -> None:
- """Login to the site.
-
- Note, this doesn't do anything with cookies. The http module
- takes care of all the cookie stuff. Throws exception on failure.
- """
- self.below_mw_1_27 = False
- if hasattr(self, '_waituntil') \
- and datetime.datetime.now() < self._waituntil:
- diff = self._waituntil - datetime.datetime.now()
- pywikibot.warning(
- 'Too many tries, waiting {} seconds before retrying.'
- .format(diff.seconds))
- pywikibot.sleep(diff.seconds)
-
- self.site._loginstatus = LoginStatus.IN_PROGRESS
-
- # Bot passwords username contains @,
- # otherwise @ is not allowed in usernames.
- # @ in bot password is deprecated,
- # but we don't want to break bots using it.
- parameters = self._login_parameters(
- botpassword='@' in self.login_name or '@' in self.password)
-
- # base login request
- login_request = self.site._request(use_get=False,
- parameters=parameters)
- while True:
- # try to login
- try:
- login_result = login_request.submit()
- except pywikibot.exceptions.APIError as e:
- login_result = {'error': e.__dict__}
-
- # clientlogin response can be clientlogin or error
- if self.action in login_result:
- response = login_result[self.action]
- result_key = self.keyword('result')
- elif 'error' in login_result:
- response = login_result['error']
- result_key = 'code'
- else:
- raise RuntimeError('Unexpected API login response key.')
-
- status = response[result_key]
- fail_reason = response.get(self.keyword('reason'), '')
- if status == self.keyword('success'):
- return
-
- if status in ('NeedToken', 'WrongToken', 'badtoken'):
- token = response.get('token')
- if token and self.below_mw_1_27:
- # fetched token using action=login
- login_request['lgtoken'] = token
- pywikibot.log('Received login token, proceed with login.')
- else:
- # if incorrect login token was used,
- # force relogin and generate fresh one
- pywikibot.error('Received incorrect login token. '
- 'Forcing re-login.')
- # invalidate superior wiki cookies (T224712)
- _invalidate_superior_cookies(self.site.family)
- login_request[
- self.keyword('token')] = self.get_login_token()
- continue
-
- # messagecode was introduced with 1.29.0-wmf.14
- # but older wikis are still supported
- login_throttled = response.get('messagecode') == 'login-throttled'
-
- if (status == 'Throttled' or status == self.keyword('fail')
- and (login_throttled or 'wait' in fail_reason)):
- wait = response.get('wait')
- if wait:
- delta = datetime.timedelta(seconds=int(wait))
- else:
- match = re.search(r'(\d+) (seconds|minutes)', fail_reason)
- if match:
- delta = datetime.timedelta(
- **{match.group(2): int(match.group(1))})
- else:
- delta = datetime.timedelta()
- self._waituntil = datetime.datetime.now() + delta
-
- break
-
- if 'error' in login_result:
- raise pywikibot.exceptions.APIError(**response)
-
- raise pywikibot.exceptions.APIError(code=status, info=fail_reason)
-
- def get_login_token(self) -> Optional[str]:
- """Fetch login token for MediaWiki 1.27+.
-
- :return: login token
- """
- login_token_request = self.site._request(
- use_get=False,
- parameters={'action': 'query', 'meta': 'tokens', 'type': 'login'},
- )
- login_token_result = login_token_request.submit()
- # check if we have to use old implementation of mw < 1.27
- if 'query' in login_token_result:
- return login_token_result['query']['tokens'].get('logintoken')
-
- self.below_mw_1_27 = True
- return None
-
-
-def encode_url(query) -> str:
- """Encode parameters to pass with a url.
-
- Reorder parameters so that token parameters go last and call wraps
- :py:obj:`urlencode`. Return an HTTP URL query fragment which
- complies with :api:`Edit#Parameters` (See the 'token' bullet.)
-
- :param query: keys and values to be uncoded for passing with a url
- :type query: mapping object or a sequence of two-element tuples
- :return: encoded parameters with token parameters at the end
- """
- if hasattr(query, 'items'):
- query = list(query.items())
-
- # parameters ending on 'token' should go last
- # wpEditToken should go very last
- query.sort(key=lambda x: x[0].lower().endswith('token')
- + (x[0] == 'wpEditToken'))
- return urlencode(query)
-
-
def _update_pageid(page, pagedict: dict):
"""Update pageid."""
if 'pageid' in pagedict:
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805804
To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: Id9e72cf003635d67703718f4bebc1096af55c4bb
Gerrit-Change-Number: 805804
Gerrit-PatchSet: 2
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged
Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805787 )
Change subject: [IMPR] detach api.OptionSet part 2 while keeping the history
......................................................................
[IMPR] detach api.OptionSet part 2 while keeping the history
Change-Id: I529945360b2d60975657f0f41765b7729a735527
---
R pywikibot/data/api/__init__.py
M pywikibot/data/api/_optionset.py
2 files changed, 4 insertions(+), 2,664 deletions(-)
Approvals:
jenkins-bot: Verified
Xqt: Verified; Looks good to me, approved
diff --git a/pywikibot/data/api/__init.py b/pywikibot/data/api/__init__.py
similarity index 92%
rename from pywikibot/data/api/__init.py
rename to pywikibot/data/api/__init__.py
index baf2006..acaf7ba 100644
--- a/pywikibot/data/api/__init.py
+++ b/pywikibot/data/api/__init__.py
@@ -27,6 +27,7 @@
from pywikibot.backports import Callable, Dict, Match, Tuple, removeprefix
from pywikibot.comms import http
from pywikibot.data.api._paraminfo import ParamInfo
+from pywikibot.data.api._optionset import OptionSet
from pywikibot.exceptions import (
Error,
FatalServerError,
@@ -119,188 +120,6 @@
MIMEMultipart = CTEBinaryMIMEMultipart
-class OptionSet(MutableMapping):
-
- """
- A class to store a set of options which can be either enabled or not.
-
- If it is instantiated with the associated site, module and parameter it
- will only allow valid names as options. If instantiated 'lazy loaded' it
- won't checks if the names are valid until the site has been set (which
- isn't required, but recommended). The site can only be set once if it's not
- None and after setting it, any site (even None) will fail.
- """
-
- def __init__(self, site=None,
- module: Optional[str] = None,
- param: Optional[str] = None,
- dict: Optional[dict] = None) -> None:
- """
- Initializer.
-
- If a site is given, the module and param must be given too.
-
- :param site: The associated site
- :type site: pywikibot.site.APISite or None
- :param module: The module name which is used by paraminfo. (Ignored
- when site is None)
- :param param: The parameter name inside the module. That parameter must
- have a 'type' entry. (Ignored when site is None)
- :param dict: The initializing dict which is used for
- :py:obj:`from_dict`
- """
- self._site_set = False
- self._enabled = set()
- self._disabled = set()
- self._set_site(site, module, param)
- if dict:
- self.from_dict(dict)
-
- def _set_site(self, site, module: str, param: str,
- clear_invalid: bool = False):
- """Set the site and valid names.
-
- As soon as the site has been not None, any subsequent calls will fail,
- unless there had been invalid names and a KeyError was thrown.
-
- :param site: The associated site
- :type site: pywikibot.site.APISite
- :param module: The module name which is used by paraminfo.
- :param param: The parameter name inside the module. That parameter must
- have a 'type' entry.
- :param clear_invalid: Instead of throwing a KeyError, invalid names are
- silently removed from the options (disabled by default).
- """
- if self._site_set:
- raise TypeError('The site cannot be set multiple times.')
- # If the entries written to this are valid, it will never be
- # overwritten
- self._valid_enable = set()
- self._valid_disable = set()
- if site is None:
- return
- for type_value in site._paraminfo.parameter(module, param)['type']:
- if type_value[0] == '!':
- self._valid_disable.add(type_value[1:])
- else:
- self._valid_enable.add(type_value)
- if clear_invalid:
- self._enabled &= self._valid_enable
- self._disabled &= self._valid_disable
- else:
- invalid_names = ((self._enabled - self._valid_enable)
- | (self._disabled - self._valid_disable))
- if invalid_names:
- raise KeyError('OptionSet already contains invalid name(s) '
- '"{}"'.format('", "'.join(invalid_names)))
- self._site_set = True
-
- def from_dict(self, dictionary):
- """
- Load options from the dict.
-
- The options are not cleared before. If changes have been made
- previously, but only the dict values should be applied it needs to be
- cleared first.
-
- :param dictionary:
- a dictionary containing for each entry either the value
- False, True or None. The names must be valid depending on whether
- they enable or disable the option. All names with the value None
- can be in either of the list.
- :type dictionary: dict (keys are strings, values are bool/None)
- """
- enabled = set()
- disabled = set()
- removed = set()
- for name, value in dictionary.items():
- if value is True:
- enabled.add(name)
- elif value is False:
- disabled.add(name)
- elif value is None:
- removed.add(name)
- else:
- raise ValueError('Dict contains invalid value "{}"'.format(
- value))
- invalid_names = (
- (enabled - self._valid_enable) | (disabled - self._valid_disable)
- | (removed - self._valid_enable - self._valid_disable)
- )
- if invalid_names and self._site_set:
- raise ValueError('Dict contains invalid name(s) "{}"'.format(
- '", "'.join(invalid_names)))
- self._enabled = enabled | (self._enabled - disabled - removed)
- self._disabled = disabled | (self._disabled - enabled - removed)
-
- def clear(self) -> None:
- """Clear all enabled and disabled options."""
- self._enabled.clear()
- self._disabled.clear()
-
- def __setitem__(self, name, value):
- """Set option to enabled, disabled or neither."""
- if value is True:
- if self._site_set and name not in self._valid_enable:
- raise KeyError('Invalid name "{}"'.format(name))
- self._enabled.add(name)
- self._disabled.discard(name)
- elif value is False:
- if self._site_set and name not in self._valid_disable:
- raise KeyError('Invalid name "{}"'.format(name))
- self._disabled.add(name)
- self._enabled.discard(name)
- elif value is None:
- if self._site_set and (name not in self._valid_enable
- or name not in self._valid_disable):
- raise KeyError('Invalid name "{}"'.format(name))
- self._enabled.discard(name)
- self._disabled.discard(name)
- else:
- raise ValueError('Invalid value "{}"'.format(value))
-
- def __getitem__(self, name) -> Optional[bool]:
- """
- Return whether the option is enabled.
-
- :return: If the name has been set it returns whether it is enabled.
- Otherwise it returns None. If the site has been set it raises a
- KeyError if the name is invalid. Otherwise it might return a value
- even though the name might be invalid.
- """
- if name in self._enabled:
- return True
- if name in self._disabled:
- return False
- if (self._site_set or name in self._valid_enable
- or name in self._valid_disable):
- return None
- raise KeyError('Invalid name "{}"'.format(name))
-
- def __delitem__(self, name) -> None:
- """Remove the item by setting it to None."""
- self[name] = None
-
- def __contains__(self, name) -> bool:
- """Return True if option has been set."""
- return name in self._enabled or name in self._disabled
-
- def __iter__(self):
- """Iterate over each enabled and disabled option."""
- yield from self._enabled
- yield from self._disabled
-
- def api_iter(self):
- """Iterate over each option as they appear in the URL."""
- yield from self._enabled
- for disabled in self._disabled:
- yield '!{}'.format(disabled)
-
- def __len__(self) -> int:
- """Return the number of enabled and disabled options."""
- return len(self._enabled) + len(self._disabled)
-
-
class Request(MutableMapping):
"""A request to a Site's api.php interface.
diff --git a/pywikibot/data/api/_optionset.py b/pywikibot/data/api/_optionset.py
index baf2006..1ca2262 100644
--- a/pywikibot/data/api/_optionset.py
+++ b/pywikibot/data/api/_optionset.py
@@ -1,122 +1,11 @@
-"""Interface to Mediawiki's api.php."""
+"""Object representing boolean API option."""
#
-# (C) Pywikibot team, 2007-2022
+# (C) Pywikibot team, 2015-2022
#
# Distributed under the terms of the MIT license.
#
-import datetime
-import hashlib
-import inspect
-import os
-import pickle
-import pprint
-import re
-import traceback
from collections.abc import MutableMapping
-from email.generator import BytesGenerator
-from email.mime.multipart import MIMEMultipart as MIMEMultipartOrig
-from email.mime.nonmultipart import MIMENonMultipart
-from inspect import getfullargspec
-from io import BytesIO
-from typing import Any, Optional, Union
-from urllib.parse import unquote, urlencode
-from warnings import warn
-
-import pywikibot
-from pywikibot import config, login
-from pywikibot.backports import Callable, Dict, Match, Tuple, removeprefix
-from pywikibot.comms import http
-from pywikibot.data.api._paraminfo import ParamInfo
-from pywikibot.exceptions import (
- Error,
- FatalServerError,
- InvalidTitleError,
- MaxlagTimeoutError,
- NoUsernameError,
- Server414Error,
- Server504Error,
- SiteDefinitionError,
- TimeoutError,
- UnsupportedPageError,
-)
-from pywikibot.family import SubdomainFamily
-from pywikibot.login import LoginStatus
-from pywikibot.textlib import removeHTMLParts
-from pywikibot.tools import PYTHON_VERSION
-
-__all__ = (
- 'APIGenerator',
- 'CachedRequest',
- 'ListGenerator',
- 'LogEntryListGenerator',
- 'LoginManager',
- 'OptionSet',
- 'PageGenerator',
- 'ParamInfo',
- 'PropertyGenerator',
- 'QueryGenerator',
- 'Request',
- 'encode_url',
- 'update_page',
-)
-
-
-lagpattern = re.compile(
- r'Waiting for [\w.: ]+: (?P<lag>\d+(?:\.\d+)?) seconds? lagged')
-
-
-def _invalidate_superior_cookies(family) -> None:
- """
- Clear cookies for site's second level domain.
-
- get_login_token() will generate new cookies needed.
- This is a workaround for requests bug, see :phab:`T224712`
- and https://github.com/psf/requests/issues/5411
- for more details.
- """
- if isinstance(family, SubdomainFamily):
- for cookie in http.cookie_jar:
- if family.domain == cookie.domain:
- http.cookie_jar.clear(cookie.domain, cookie.path, cookie.name)
-
-
-# Bug: T113120, T228841
-# Subclassing necessary to fix bug of the email package in Python 3:
-# see https://bugs.python.org/issue19003
-# see https://bugs.python.org/issue18886
-# The following solution might be removed if the bug is fixed for
-# Python versions which are supported by PWB, probably with Python 3.5
-
-class CTEBinaryBytesGenerator(BytesGenerator):
-
- """Workaround for bug in python 3 email handling of CTE binary."""
-
- def __init__(self, *args, **kwargs) -> None:
- """Initializer."""
- super().__init__(*args, **kwargs)
- self._writeBody = self._write_body
-
- def _write_body(self, msg) -> None:
- if msg['content-transfer-encoding'] == 'binary':
- self._fp.write(msg.get_payload(decode=True))
- else:
- super()._handle_text(msg)
-
-
-class CTEBinaryMIMEMultipart(MIMEMultipartOrig):
-
- """Workaround for bug in python 3 email handling of CTE binary."""
-
- def as_bytes(self, unixfrom: bool = False, policy=None):
- """Return unmodified binary payload."""
- policy = self.policy if policy is None else policy
- fp = BytesIO()
- g = CTEBinaryBytesGenerator(fp, mangle_from_=False, policy=policy)
- g.flatten(self, unixfrom=unixfrom)
- return fp.getvalue()
-
-
-MIMEMultipart = CTEBinaryMIMEMultipart
+from typing import Optional
class OptionSet(MutableMapping):
@@ -299,2371 +188,3 @@
def __len__(self) -> int:
"""Return the number of enabled and disabled options."""
return len(self._enabled) + len(self._disabled)
-
-
-class Request(MutableMapping):
-
- """A request to a Site's api.php interface.
-
- Attributes of this object (except for the special parameters listed
- below) get passed as commands to api.php, and can be get or set
- using the dict interface. All attributes must be strings. Use an
- empty string for parameters that don't require a value. For example,
- Request(action="query", titles="Foo bar", prop="info", redirects="")
- corresponds to the API request
- "api.php?action=query&titles=Foo%20bar&prop=info&redirects"
-
- This is the lowest-level interface to the API, and can be used for any
- request that a particular site's API supports. See the API documentation
- (https://www.mediawiki.org/wiki/API) and site-specific settings for
- details on what parameters are accepted for each request type.
-
- Uploading files is a special case: to upload, the parameter "mime" must
- contain a dict, and the parameter "file" must be set equal to a valid
- filename on the local computer, _not_ to the content of the file.
-
- Returns a dict containing the JSON data returned by the wiki. Normally,
- one of the dict keys will be equal to the value of the 'action'
- parameter. Errors are caught and raise an APIError exception.
-
- Example:
-
- >>> r = Request(parameters={'action': 'query', 'meta': 'userinfo'})
- >>> # This is equivalent to
- >>> # https://{path}/api.php?action=query&meta=userinfo&format=json
- >>> # change a parameter
- >>> r['meta'] = "userinfo|siteinfo"
- >>> # add a new parameter
- >>> r['siprop'] = "namespaces"
- >>> # note that "uiprop" param gets added automatically
- >>> str(r.action)
- 'query'
- >>> sorted(str(key) for key in r._params.keys())
- ['action', 'meta', 'siprop']
- >>> [str(key) for key in r._params['action']]
- ['query']
- >>> [str(key) for key in r._params['meta']]
- ['userinfo', 'siteinfo']
- >>> [str(key) for key in r._params['siprop']]
- ['namespaces']
- >>> data = r.submit()
- >>> isinstance(data, dict)
- True
- >>> set(['query', 'batchcomplete', 'warnings']).issuperset(data.keys())
- True
- >>> 'query' in data
- True
- >>> sorted(str(key) for key in data['query'].keys())
- ['namespaces', 'userinfo']
-
- """
-
- # To make sure the default value of 'parameters' can be identified.
- _PARAM_DEFAULT = object()
-
- def __init__(self, site=None,
- mime: Optional[dict] = None,
- throttle: bool = True,
- max_retries: Optional[int] = None,
- retry_wait: Optional[int] = None,
- use_get: Optional[bool] = None,
- parameters=_PARAM_DEFAULT, **kwargs) -> None:
- """
- Create a new Request instance with the given parameters.
-
- The parameters for the request can be defined via either the
- 'parameters' parameter or the keyword arguments. The keyword arguments
- were the previous implementation but could cause problems when there
- are arguments to the API named the same as normal arguments to this
- class. So the second parameter 'parameters' was added which just
- contains all parameters. When a Request instance is created it must use
- either one of them and not both at the same time. To have backwards
- compatibility it adds a parameter named 'parameters' to kwargs when
- both parameters are set as that indicates an old call and 'parameters'
- was originally supplied as a keyword parameter.
-
- If undefined keyword arguments were given AND the 'parameters'
- parameter was supplied as a positional parameter it still assumes
- 'parameters' were part of the keyword arguments.
-
- If a class is using Request and is directly forwarding the parameters,
- :py:obj:`Request.clean_kwargs` can be used to automatically
- convert the old kwargs mode into the new parameter mode. This
- normalizes the arguments so that when the API parameters are
- modified the changes can always be applied to the 'parameters'
- parameter.
-
- :param site: The Site to which the request will be submitted. If not
- supplied, uses the user's configured default Site.
- :param mime: If not None, send in "multipart/form-data" format (default
- None). Parameters which should only be transferred via mime
- mode are defined via this parameter (even an empty dict means
- mime shall be used).
- :param max_retries: Maximum number of times to retry after
- errors, defaults to config.max_retries.
- :param retry_wait: Minimum time in seconds to wait after an
- error, defaults to config.retry_wait seconds (doubles each retry
- until config.retry_max seconds is reached).
- :param use_get: Use HTTP GET request if possible. If False it
- uses a POST request. If None, it'll try to determine via
- action=paraminfo if the action requires a POST.
- :param parameters: The parameters used for the request to the API.
- :type parameters: dict
- :param kwargs: The parameters used for the request to the API.
- """
- if site is None:
- self.site = pywikibot.Site()
- warn('Request() invoked without a site; setting to {}'
- .format(self.site), RuntimeWarning, 2)
- else:
- self.site = site
-
- self.mime = mime
- if isinstance(mime, bool):
- raise TypeError('mime param in api.Request() must not be boolean')
-
- self.throttle = throttle
- self.use_get = use_get
- if max_retries is None:
- self.max_retries = pywikibot.config.max_retries
- else:
- self.max_retries = max_retries
- self.current_retries = 0
- if retry_wait is None:
- self.retry_wait = pywikibot.config.retry_wait
- else:
- self.retry_wait = retry_wait
- # The only problem with that system is that it won't detect when
- # 'parameters' is actually the only parameter for the request as it
- # then assumes it's using the new mode (and the parameters are actually
- # in the parameter 'parameters' not that the parameter 'parameters' is
- # actually a parameter for the request). But that is invalid anyway as
- # it MUST have at least an action parameter for the request which would
- # be in kwargs if it's using the old mode.
- if kwargs:
- if parameters is not self._PARAM_DEFAULT:
- # 'parameters' AND kwargs is set. In that case think of
- # 'parameters' being an old kwarg which is now filled in an
- # actual parameter
- self._warn_both()
- kwargs['parameters'] = parameters
- # When parameters wasn't set it's likely that kwargs-mode was used
- self._warn_kwargs()
- parameters = kwargs
- elif parameters is self._PARAM_DEFAULT:
- parameters = {}
- self._params = {}
- if 'action' not in parameters:
- raise ValueError("'action' specification missing from Request.")
- self.action = parameters['action']
- self.update(parameters) # also convert all parameter values to lists
- self._warning_handler = None # type: Optional[Callable[[str, str], Union[Match[str], bool, None]]] # noqa: E501
- # Actions that imply database updates on the server, used for various
- # things like throttling or skipping actions when we're in simulation
- # mode
- self.write = self.action in {
- 'block', 'clearhasmsg', 'createaccount', 'delete', 'edit',
- 'emailuser', 'filerevert', 'flowthank', 'imagerotate', 'import',
- 'managetags', 'mergehistory', 'move', 'options', 'patrol',
- 'protect', 'purge', 'resetpassword', 'revisiondelete', 'rollback',
- 'setnotificationtimestamp', 'setpagelanguage', 'tag', 'thank',
- 'unblock', 'undelete', 'upload', 'userrights', 'watch',
- 'wbcreateclaim', 'wbcreateredirect', 'wbeditentity',
- 'wblinktitles', 'wbmergeitems', 'wbremoveclaims',
- 'wbremovequalifiers', 'wbremovereferences', 'wbsetaliases',
- 'wbsetclaim', 'wbsetclaimvalue', 'wbsetdescription', 'wbsetlabel',
- 'wbsetqualifier', 'wbsetreference', 'wbsetsitelink',
- 'wbladdform', 'wbleditformelements', 'wblmergelexemes',
- 'wblremoveform',
- }
- # Client side verification that the request is being performed
- # by a logged in user, and warn if it isn't a config username.
- if self.write:
- try:
- username = self.site.userinfo['name']
- except KeyError:
- raise Error('API write action attempted without user name')
-
- if 'anon' in self.site.userinfo:
- raise Error("API write action attempted as IP '{}'"
- .format(username))
-
- if not self.site.user() or self.site.username() != username:
- pywikibot.warning(
- 'API write action by unexpected username {} commenced.\n'
- 'userinfo: {!r}'.format(username, self.site.userinfo))
-
- # Make sure user is logged in
- if self.write:
- pywikibot.debug('Adding user assertion')
- self['assert'] = 'user'
-
- @classmethod
- def create_simple(cls, req_site, **kwargs):
- """Create a new instance using all args except site for the API."""
- # This ONLY support site so that any caller can be sure there will be
- # no conflict with PWB parameters
- # req_site is needed to avoid conflicts with possible site keyword in
- # kwarg until positional-only parameters are supported, see T262926
- # TODO: Use ParamInfo request to determine valid parameters
- if isinstance(kwargs.get('parameters'), dict):
- warn('The request contains already a "parameters" entry which is '
- 'a dict.')
- return cls(site=req_site, parameters=kwargs)
-
- @classmethod
- def _warn_both(cls) -> None:
- """Warn that kwargs mode was used but parameters was set too."""
- warn('Both kwargs and parameters are set in Request.__init__. It '
- 'assumes that "parameters" is actually a parameter of the '
- 'Request and is added to kwargs.', DeprecationWarning, 3)
-
- @classmethod
- def _warn_kwargs(cls) -> None:
- """Warn that kwargs was used instead of parameters."""
- warn('Instead of using kwargs from Request.__init__, parameters '
- 'for the request to the API should be added via the '
- '"parameters" parameter.', DeprecationWarning, 3)
-
- @classmethod
- def clean_kwargs(cls, kwargs: dict) -> dict:
- """
- Convert keyword arguments into new parameters mode.
-
- If there are no other arguments in kwargs apart from the used arguments
- by the class' initializer it'll just return kwargs and otherwise remove
- those which aren't in the initializer and put them in a dict which is
- added as a 'parameters' keyword. It will always create a shallow copy.
-
- :param kwargs: The original keyword arguments which is not modified.
- :return: The normalized keyword arguments.
- """
- if 'expiry' in kwargs and kwargs['expiry'] is None:
- del kwargs['expiry']
-
- args = set()
- for super_cls in inspect.getmro(cls):
- if not super_cls.__name__.endswith('Request'):
- break
- args |= set(getfullargspec(super_cls.__init__).args)
- else:
- raise ValueError('Request was not a super class of '
- '{!r}'.format(cls))
- args -= {'self'}
- old_kwargs = set(kwargs)
- # all kwargs defined above but not in args indicate 'kwargs' mode
- if old_kwargs - args:
- # Move all kwargs into parameters
- parameters = {name: value for name, value in kwargs.items()
- if name not in args or name == 'parameters'}
- if 'parameters' in parameters:
- cls._warn_both()
- # Copy only arguments and not the parameters
- kwargs = {name: value for name, value in kwargs.items()
- if name in args or name == 'self'}
- kwargs['parameters'] = parameters
- # Make sure that all arguments have remained
- assert(old_kwargs | {'parameters'}
- == set(kwargs) | set(kwargs['parameters']))
- assert(('parameters' in old_kwargs)
- is ('parameters' in kwargs['parameters']))
- cls._warn_kwargs()
- else:
- kwargs = dict(kwargs)
- kwargs.setdefault('parameters', {})
- return kwargs
-
- def _format_value(self, value):
- """
- Format the MediaWiki API request parameter.
-
- Converts from Python datatypes to MediaWiki API parameter values.
-
- Supports:
- * datetime.datetime (using strftime and ISO8601 format)
- * pywikibot.page.BasePage (using title (+namespace; -section))
-
- All other datatypes are converted to string.
- """
- if isinstance(value, datetime.datetime):
- return value.strftime(pywikibot.Timestamp.ISO8601Format)
- if isinstance(value, pywikibot.page.BasePage):
- if value.site != self.site:
- raise RuntimeError(
- 'value.site {!r} is different from Request.site {!r}'
- .format(value.site, self.site))
- return value.title(with_section=False)
- return str(value)
-
- def __getitem__(self, key):
- """Implement dict interface."""
- return self._params[key]
-
- def __setitem__(self, key: str, value) -> None:
- """Set MediaWiki API request parameter.
-
- :param value: param value(s)
- :type value: str in site encoding
- (string types may be a `|`-separated list)
- iterable, where items are converted to string
- with special handling for datetime.datetime to convert it to a
- string using the ISO 8601 format accepted by the MediaWiki API.
- """
- if isinstance(value, bytes):
- value = value.decode(self.site.encoding())
-
- if isinstance(value, str):
- value = value.split('|')
-
- if hasattr(value, 'api_iter'):
- self._params[key] = value
- else:
- try:
- iter(value)
- except TypeError:
- # convert any non-iterable value into a single-element list
- self._params[key] = [value]
- else:
- self._params[key] = list(value)
-
- def __delitem__(self, key) -> None:
- """Implement dict interface."""
- del self._params[key]
-
- def keys(self):
- """Implement dict interface."""
- return list(self._params.keys())
-
- def __contains__(self, key) -> bool:
- """Implement dict interface."""
- return key in self._params
-
- def __iter__(self):
- """Implement dict interface."""
- return iter(self._params)
-
- def __len__(self) -> int:
- """Implement dict interface."""
- return len(self._params)
-
- def iteritems(self):
- """Implement dict interface."""
- return iter(self._params.items())
-
- def items(self):
- """Return a list of tuples containing the parameters in any order."""
- return list(self._params.items())
-
- def _add_defaults(self):
- """
- Add default parameters to the API request.
-
- This method will only add them once.
- """
- if hasattr(self, '__defaulted'):
- return
-
- if self.mime is not None \
- and set(self._params.keys()) & set(self.mime.keys()):
- raise ValueError('The mime and params shall not share the '
- 'same keys.')
-
- if self.action == 'query':
- meta = self._params.get('meta', [])
- # Special logic for private wikis (T153903).
- # If the wiki requires login privileges to read articles, pywikibot
- # will be blocked from accessing the userinfo.
- # Work around this by requiring userinfo only if 'tokens' and
- # 'login' are not both set.
- typep = self._params.get('type', [])
- if not ('tokens' in meta and 'login' in typep):
- if 'userinfo' not in meta:
- meta = set(meta + ['userinfo'])
- self['meta'] = sorted(meta)
- uiprop = self._params.get('uiprop', [])
- uiprop = set(uiprop + ['blockinfo', 'hasmsg'])
- self['uiprop'] = sorted(uiprop)
- if 'prop' in self._params \
- and self.site.has_extension('ProofreadPage'):
- prop = set(self['prop'] + ['proofread'])
- self['prop'] = sorted(prop)
- # When neither 'continue' nor 'rawcontinue' is present and the
- # version number is at least 1.25wmf5 we add a dummy rawcontinue
- # parameter. Querying siteinfo is save as it adds 'continue'
- # except for 'tokens' (T284577)
- if ('tokens' not in meta and 'continue' not in self._params
- and self.site.mw_version >= '1.25wmf5'):
- self._params.setdefault('rawcontinue', [''])
- elif self.action == 'help' and self.site.mw_version > '1.24':
- self['wrap'] = ''
-
- if config.maxlag:
- self._params.setdefault('maxlag', [str(config.maxlag)])
- self._params.setdefault('format', ['json'])
- if self['format'] != ['json']:
- raise TypeError(
- "Query format '{}' cannot be parsed.".format(self['format']))
-
- self.__defaulted = True # skipcq: PTC-W0037
-
- def _encoded_items(self) -> Dict[str, Union[str, bytes]]:
- """
- Build a dict of params with minimal encoding needed for the site.
-
- This helper method only prepares params for serialisation or
- transmission, so it only encodes values which are not ASCII,
- requiring callers to consider how to handle ASCII vs other values,
- however the output is designed to enable __str__ and __repr__ to
- do the right thing in most circumstances.
-
- Servers which use an encoding that is not a superset of ASCII
- are not supported.
-
- :return: Parameters either in the site encoding, or ASCII strings
- """
- params = {}
- for key, values in self._params.items():
- try:
- iterator = values.api_iter()
- except AttributeError:
- if len(values) == 1:
- value = values[0]
- if value is True:
- values = ['']
- elif value is False or value is None:
- # False and None are not included in the http URI
- continue
- iterator = iter(values)
- value = '|'.join(self._format_value(value) for value in iterator)
- # If the value is encodable as ascii, do not encode it.
- # This means that any value which can be encoded as ascii
- # is presumed to be ascii, and servers using a site encoding
- # which is not a superset of ascii may be problematic.
- try:
- value.encode('ascii')
- except UnicodeError:
- try:
- value = value.encode(self.site.encoding())
- except Exception:
- pywikibot.error(
- "_encoded_items: '{}' could not be encoded as '{}':"
- ' {!r}'.format(key, self.site.encoding(), value))
- assert key.encode('ascii')
- assert isinstance(key, str)
- params[key] = value
- return params
-
- def _http_param_string(self):
- """
- Return the parameters as a HTTP URL query fragment.
-
- URL encodes the parameters provided by _encoded_items()
-
- .. note:: Not all parameters are sorted, therefore for two given
- CachedRequest objects with equal _params, the result of
- _http_param_string() is not necessarily equal.
- """
- return encode_url(self._encoded_items())
-
- def __str__(self) -> str:
- """Return a string representation."""
- return unquote(self.site.scriptpath()
- + '/api.php?'
- + self._http_param_string())
-
- def __repr__(self) -> str:
- """Return internal representation."""
- return '{}.{}<{}->{!r}>'.format(self.__class__.__module__,
- self.__class__.__name__,
- self.site, str(self))
-
- def _simulate(self, action):
- """Simulate action."""
- if action and config.simulate and (
- self.write or action in config.actions_to_block):
- pywikibot.output('<<black;yellow>>SIMULATION: {} action blocked.'
- '<<default>>'.format(action))
- # for more realistic simulation
- if config.simulate is not True:
- pywikibot.sleep(float(config.simulate))
- return {
- action: {'result': 'Success', 'nochange': ''},
-
- # wikibase results
- 'entity': {'lastrevid': -1},
- 'pageinfo': {'lastrevid': -1},
- 'reference': {'hash': -1},
- }
- return None
-
- def _is_wikibase_error_retryable(self, error):
- # dict of error message and current action.
- # Value is True if action type is to be ignored
- err_msg = {
- 'edit-already-exists': 'wbeditentity',
- 'actionthrottledtext': True, # T192912, T268645
- }
- messages = error.get('messages')
- message = None
- # bug T68619; after Wikibase breaking change 1ca9cee we have a
- # list of messages
- if isinstance(messages, list):
- for item in messages:
- message = item['name']
- action = err_msg.get(message)
- if action is True or action == self.action:
- return True
-
- return False
-
- if isinstance(messages, dict):
- try: # behaviour before gerrit 124323 breaking change
- message = messages['0']['name']
- except KeyError: # unsure the new output is always a list
- message = messages['name']
- action = err_msg.get(message)
- return action is True or action == self.action
-
- @staticmethod
- def _generate_mime_part(key, content, keytype=None, headers=None):
- if not keytype:
- try:
- content.encode('ascii')
- keytype = ('text', 'plain')
- except (UnicodeError, AttributeError):
- keytype = ('application', 'octet-stream')
- submsg = MIMENonMultipart(*keytype)
- content_headers = {'name': key}
- if headers:
- content_headers.update(headers)
- submsg.add_header('Content-disposition', 'form-data',
- **content_headers)
-
- if keytype != ('text', 'plain'):
- submsg['Content-Transfer-Encoding'] = 'binary'
-
- submsg.set_payload(content)
- return submsg
-
- def _use_get(self):
- """Verify whether 'get' is to be used."""
- if (not config.enable_GET_without_SSL
- and self.site.protocol() != 'https'
- or self.site.is_oauth_token_available()): # T108182 workaround
- use_get = False
- elif self.use_get is None:
- if self.action == 'query':
- # for queries check the query module
- modules = set()
- for mod_type_name in ('list', 'prop', 'generator'):
- modules.update(self._params.get(mod_type_name, []))
- else:
- modules = {self.action}
- if modules:
- self.site._paraminfo.fetch(modules)
- use_get = all('mustbeposted' not in self.site._paraminfo[mod]
- for mod in modules)
- else:
- # If modules is empty, just 'meta' was given, which doesn't
- # require POSTs, and is required for ParamInfo
- use_get = True
- else:
- use_get = self.use_get
- return use_get
-
- @classmethod
- def _build_mime_request(cls, params: dict,
- mime_params: dict) -> Tuple[dict, bytes]:
- """
- Construct a MIME multipart form post.
-
- :param params: HTTP request params
- :param mime_params: HTTP request parts which must be sent in the body
- :type mime_params: dict of (content, keytype, headers) # noqa: DAR103
- :return: HTTP request headers and body
- """
- # construct a MIME message containing all API key/values
- container = MIMEMultipart(_subtype='form-data')
- for key, value in params.items():
- submsg = cls._generate_mime_part(key, value)
- container.attach(submsg)
- for key, value in mime_params.items():
- submsg = cls._generate_mime_part(key, *value)
- container.attach(submsg)
-
- # strip the headers to get the HTTP message body
- body = container.as_bytes()
- marker = b'\n\n' # separates headers from body
- eoh = body.find(marker)
- body = body[eoh + len(marker):]
- # retrieve the headers from the MIME object
- headers = dict(container.items())
- return headers, body
-
- def _get_request_params(self, use_get, paramstring):
- """Get request parameters."""
- uri = self.site.apipath()
- if self.mime is not None:
- (headers, body) = Request._build_mime_request(
- self._encoded_items(), self.mime)
- use_get = False # MIME requests require HTTP POST
- else:
- headers = {'Content-Type': 'application/x-www-form-urlencoded'}
- if (not self.site.maximum_GET_length()
- or self.site.maximum_GET_length() < len(paramstring)):
- use_get = False
- if use_get:
- uri = '{}?{}'.format(uri, paramstring)
- body = None
- else:
- body = paramstring
-
- pywikibot.debug('API request to {} (uses get: {}):\n'
- 'Headers: {!r}\nURI: {!r}\nBody: {!r}'
- .format(self.site, use_get, headers, uri, body))
- return use_get, uri, body, headers
-
- def _http_request(self, use_get: bool, uri: str, data, headers,
- paramstring) -> tuple:
- """Get or post a http request with exception handling.
-
- :return: a tuple containing requests.Response object from
- http.request and use_get value
- """
- try:
- response = http.request(self.site, uri=uri,
- method='GET' if use_get else 'POST',
- data=data, headers=headers)
- except Server504Error:
- pywikibot.log('Caught HTTP 504 error; retrying')
- except Server414Error:
- if use_get:
- pywikibot.log('Caught HTTP 414 error; retrying')
- use_get = False
- else:
- pywikibot.warning('Caught HTTP 414 error, although not '
- 'using GET.')
- raise
- except (ConnectionError, FatalServerError):
- # This error is not going to be fixed by just waiting
- pywikibot.error(traceback.format_exc())
- raise
- # TODO: what other exceptions can occur here?
- except Exception:
- # for any other error on the http request, wait and retry
- pywikibot.error(traceback.format_exc())
- pywikibot.log('{}, {}'.format(uri, paramstring))
- else:
- return response, use_get
- self.wait()
- return None, use_get
-
- def _json_loads(self, response) -> Optional[dict]:
- """Return a dict from requests.Response.
-
- :param response: a requests.Response object
- :type response: requests.Response
- :return: a data dict
- :raises pywikibot.exceptions.APIError: unknown action found
- :raises pywikibot.exceptions.APIError: unknown query result type
- """
- try:
- result = response.json()
- except ValueError:
- # if the result isn't valid JSON, there may be a server
- # problem. Wait a few seconds and try again
- # Show 20 lines of bare text
- text = '\n'.join(removeHTMLParts(response.text).splitlines()[:20])
- msg = """\
-Non-JSON response received from server {site} for url
-{resp.url}
-The server may be down.
-Status code: {resp.status_code}
-
-The text message is:
-{text}
-""".format(site=self.site, resp=response, text=text)
-
- # Do not retry for AutoFamily but raise a SiteDefinitionError
- # Note: family.AutoFamily is a function to create that class
- if self.site.family.__class__.__name__ == 'AutoFamily':
- pywikibot.debug(msg)
- raise SiteDefinitionError('Invalid AutoFamily({!r})'
- .format(self.site.family.domain))
-
- pywikibot.warning(msg)
-
- # there might also be an overflow, so try a smaller limit
- for param in self._params:
- if param.endswith('limit'):
- # param values are stored a list of str
- value = self[param][0]
- if value.isdigit():
- self[param] = [str(int(value) // 2)]
- pywikibot.output('Set {} = {}'
- .format(param, self[param]))
- else:
- return result or {}
- self.wait()
- return None
-
- def _relogin(self, message: str = '') -> None:
- """Force re-login and inform user."""
- pywikibot.error('{}{}Forcing re-login.'.format(message,
- ' ' if message else ''))
- self.site._relogin()
-
- def _userinfo_query(self, result) -> bool:
- """Handle userinfo query."""
- if self.action == 'query' and 'userinfo' in result.get('query', ()):
- # if we get passed userinfo in the query result, we can confirm
- # that we are logged in as the correct user. If this is not the
- # case, force a re-login.
- username = result['query']['userinfo']['name']
- if (self.site.user() is not None and self.site.user() != username
- and self.site._loginstatus != LoginStatus.IN_PROGRESS):
- message = ("Logged in as '{actual}' instead of '{expected}'."
- .format(actual=username, expected=self.site.user()))
- self._relogin(message)
- return True
- return False
-
- def _handle_warnings(self, result: Dict[str, Any]) -> bool:
- """Handle warnings; return True to retry request, False to resume.
-
- .. versionchanged:: 7.2
- Return True to retry the current request and Falso to resume.
- """
- retry = False
- if 'warnings' not in result:
- return retry
-
- for mod, warning in result['warnings'].items():
- if mod == 'info':
- continue
- if '*' in warning:
- text = warning['*']
- elif 'html' in warning:
- # bug T51978
- text = warning['html']['*']
- else:
- pywikibot.warning('API warning ({}) of unknown format: {}'
- .format(mod, warning))
- continue
-
- # multiple warnings are in text separated by a newline
- for single_warning in text.splitlines():
- if (not callable(self._warning_handler)
- or not self._warning_handler(mod, single_warning)):
- handled = self._default_warning_handler(mod,
- single_warning)
- if handled is None:
- pywikibot.warning('API warning ({}): {}'
- .format(mod, single_warning))
- else:
- retry = retry or handled
- return retry
-
- def _default_warning_handler(self, mode: str, msg: str) -> Optional[bool]:
- """A default warning handler to handle specific warnings.
-
- Return True to retry the request, False to resume and None if
- the warning is not handled.
-
- .. versionadded:: 7.2
- """
- warnings = {
- 'purge': ("You've exceeded your rate limit. "
- 'Please wait some time and try again.',
- '_ratelimited', True),
- }
- warning, handler, retry = warnings.get(mode, (None, None, None))
- if handler and msg == warning:
- # Only show the first warning part
- pywikibot.warning(msg.split('.')[0] + '.')
- # call the handler
- getattr(self, handler)()
- return retry
- return None
-
- def _logged_in(self, code) -> bool:
- """Check whether user is logged in.
-
- Older wikis returned an error instead of a warning when the request
- asked for too many values. If we get this error, assume we are not
- logged in (we can't check this because the userinfo data is not
- present) and force a re-login
- """
- if code.endswith('limit'):
- message = 'Received API limit error.'
-
- # If the user assertion failed, we're probably logged out as well.
- elif code == 'assertuserfailed':
- message = 'User assertion failed.'
-
- # Lastly, the purge module requires a POST if used as anonymous user,
- # but we normally send a GET request. If the API tells us the request
- # has to be POSTed, we're probably logged out.
- elif code == 'mustbeposted' and self.action == 'purge':
- message = "Received unexpected 'mustbeposted' error."
-
- else:
- return True
-
- self._relogin(message)
- return False
-
- def _internal_api_error(self, code, error, result) -> bool:
- """Check for internal_api_error_ or readonly and retry.
-
- :raises pywikibot.exceptions.APIMWError: internal_api_error or readonly
- """
- iae = 'internal_api_error_'
- if not (code.startswith(iae) or code == 'readonly'):
- return False
-
- # T154011
- class_name = code if code == 'readonly' else removeprefix(code, iae)
-
- del error['code'] # is added via class_name
- e = pywikibot.exceptions.APIMWError(class_name, **error)
-
- # If the error key is in this table, it is probably a temporary
- # problem, so we will retry the edit.
- # TODO: T154011: 'ReadOnlyError' seems replaced by 'readonly'
- retry = class_name in ['DBConnectionError', # T64974
- 'DBQueryError', # T60158
- 'DBQueryTimeoutError', # T297708
- 'ReadOnlyError', # T61227
- 'readonly', # T154011
- ]
-
- pywikibot.error('Detected MediaWiki API exception {}{}'
- .format(e, '; retrying' if retry else '; raising'))
- param_repr = str(self._params)
- pywikibot.log('MediaWiki exception {} details:\n'
- ' query=\n{}\n'
- ' response=\n{}'
- .format(class_name,
- pprint.pformat(param_repr),
- result))
- if not retry:
- raise e
-
- self.wait()
- return True
-
- def _ratelimited(self) -> None:
- """Handle ratelimited warning."""
- ratelimits = self.site.userinfo['ratelimits']
- delay = None
-
- ratelimit = ratelimits.get(self.action, {})
- # find the lowest wait time for the given action
- for limit in ratelimit.values():
- seconds = limit['seconds']
- hits = limit['hits']
- delay = min(delay or seconds, seconds / hits)
-
- if not delay:
- pywikibot.warning(
- 'No rate limit found for action {}'.format(self.action))
- self.wait(delay)
-
- def _bad_token(self, code) -> bool:
- """Check for bad token."""
- if code != 'badtoken': # Other code not handled here
- return False
-
- if self.site._loginstatus == LoginStatus.IN_PROGRESS:
- pywikibot.log('Login status: {}'
- .format(self.site._loginstatus.name))
- return False
-
- user_tokens = self.site.tokens._tokens[self.site.user()]
- # all token values mapped to their type
- tokens = {token: t_type for t_type, token in user_tokens.items()}
- # determine which tokens are bad
- invalid_param = {name: tokens[param[0]]
- for name, param in self._params.items()
- if len(param) == 1 and param[0] in tokens}
- # doesn't care about the cache so can directly load them
- if invalid_param:
- pywikibot.log(
- 'Bad token error for {}. Tokens for "{}" used in request; '
- 'invalidated them.'
- .format(self.site.user(),
- '", "'.join(sorted(set(invalid_param.values())))))
- # invalidate superior wiki cookies (T224712)
- _invalidate_superior_cookies(self.site.family)
- # request new token(s) instead of invalid
- self.site.tokens.load_tokens(set(invalid_param.values()))
- # fix parameters; lets hope that it doesn't mistake actual
- # parameters as tokens
- for name, t_type in invalid_param.items():
- self[name] = self.site.tokens[t_type]
- return True
-
- # otherwise couldn't find any … weird there is nothing what
- # can be done here because it doesn't know which parameters
- # to fix
- pywikibot.log(
- 'Bad token error for {} but no parameter is using a '
- 'token. Current tokens: {}'
- .format(self.site.user(),
- ', '.join('{}: {}'.format(*e)
- for e in user_tokens.items())))
- return False
-
- def submit(self) -> dict:
- """
- Submit a query and parse the response.
-
- :return: a dict containing data retrieved from api.php
- """
- self._add_defaults()
- use_get = self._use_get()
- retries = 0
- while True:
- paramstring = self._http_param_string()
-
- simulate = self._simulate(self.action)
- if simulate:
- return simulate
-
- if self.throttle:
- self.site.throttle(write=self.write)
- else:
- pywikibot.log(
- "Submitting unthrottled action '{}'.".format(self.action))
-
- use_get, uri, body, headers = self._get_request_params(use_get,
- paramstring)
- response, use_get = self._http_request(use_get, uri, body, headers,
- paramstring)
- if response is None:
- continue
-
- result = self._json_loads(response)
- if result is None:
- continue
-
- if self._userinfo_query(result):
- continue
-
- if self._handle_warnings(result):
- continue
-
- if 'error' not in result:
- return result
-
- error = result['error'].copy()
- for key in result:
- if key in ('error', 'warnings'):
- continue
- assert key not in error
- assert isinstance(result[key], str), \
- 'Unexpected {}: {!r}'.format(key, result[key])
- error[key] = result[key]
-
- if '*' in result['error']:
- # help text returned
- result['error']['help'] = result['error'].pop('*')
- code = result['error'].setdefault('code', 'Unknown')
- info = result['error'].setdefault('info', None)
-
- if not self._logged_in(code):
- continue
-
- if code == 'maxlag':
- retries += 1
- if retries > max(5, pywikibot.config.max_retries):
- break
- pywikibot.log('Pausing due to database lag: ' + info)
-
- try:
- lag = result['error']['lag']
- except KeyError:
- lag = lagpattern.search(info)
- lag = float(lag.group('lag')) if lag else 0.0
-
- self.site.throttle.lag(lag * retries)
- continue
-
- if code == 'help' and self.action == 'help':
- # The help module returns an error result with the complete
- # API information. As this data was requested, return the
- # data instead of raising an exception.
- return {'help': {'mime': 'text/plain',
- 'help': result['error']['help']}}
-
- pywikibot.warning('API error {}: {}'.format(code, info))
- pywikibot.log(' headers=\n{}'.format(response.headers))
-
- if self._internal_api_error(code, error, result):
- continue
-
- # Phab. tickets T48535, T64126, T68494, T68619
- if code == 'failed-save' \
- and self._is_wikibase_error_retryable(result['error']):
- self.wait()
- continue
-
- if code == 'ratelimited':
- self._ratelimited()
- continue
-
- # If readapidenied is returned try to login
- if code == 'readapidenied' \
- and self.site._loginstatus in (LoginStatus.NOT_ATTEMPTED,
- LoginStatus.NOT_LOGGED_IN):
- self.site.login()
- continue
-
- if self._bad_token(code):
- continue
-
- if 'mwoauth-invalid-authorization' in code:
- if 'Nonce already used' in info:
- pywikibot.error(
- 'Retrying failed OAuth authentication for {}: {}'
- .format(self.site, info))
- continue
- raise NoUsernameError('Failed OAuth authentication for {}: {}'
- .format(self.site, info))
- if code == 'cirrussearch-too-busy-error': # T170647
- self.wait()
- continue
-
- if code in ('search-title-disabled', 'search-text-disabled'):
- prefix = 'gsr' if 'gsrsearch' in self._params else 'sr'
- del self._params[prefix + 'what']
- # use intitle: search instead
- if code == 'search-title-disabled' \
- and self.site.has_extension('CirrusSearch'):
- key = prefix + 'search'
- self._params[key] = ['intitle:' + search
- for search in self._params[key]]
- continue
-
- if code == 'urlshortener-blocked': # T244062
- # add additional informations to result['error']
- result['error']['current site'] = self.site
- if self.site.user():
- result['error']['current user'] = self.site.user()
- else: # not logged in; show the IP
- uinfo = self.site.userinfo
- result['error']['current user'] = uinfo['name']
-
- # raise error
- try:
- param_repr = str(self._params)
- pywikibot.log('API Error: query=\n{}'
- .format(pprint.pformat(param_repr)))
- pywikibot.log(' response=\n{}'.format(result))
-
- raise pywikibot.exceptions.APIError(**result['error'])
- except TypeError:
- raise RuntimeError(result)
-
- msg = 'Maximum retries attempted due to maxlag without success.'
- if os.environ.get('PYWIKIBOT_TESTS_RUNNING', '0') == '1':
- import unittest
- raise unittest.SkipTest(msg)
-
- raise MaxlagTimeoutError(msg)
-
- def wait(self, delay=None):
- """Determine how long to wait after a failed request."""
- self.current_retries += 1
- if self.current_retries > self.max_retries:
- raise TimeoutError('Maximum retries attempted without success.')
-
- # double the next wait, but do not exceed config.retry_max seconds
- delay = delay or self.retry_wait
- delay *= 2 ** (self.current_retries - 1)
- delay = min(delay, config.retry_max)
-
- pywikibot.warning('Waiting {:.1f} seconds before retrying.'
- .format(delay))
- pywikibot.sleep(delay)
-
-
-class CachedRequest(Request):
-
- """Cached request."""
-
- def __init__(self, expiry, *args, **kwargs) -> None:
- """Initialize a CachedRequest object.
-
- :param expiry: either a number of days or a datetime.timedelta object
- """
- assert expiry is not None
- super().__init__(*args, **kwargs)
- if not isinstance(expiry, datetime.timedelta):
- expiry = datetime.timedelta(expiry)
- self.expiry = min(expiry, datetime.timedelta(config.API_config_expiry))
- self._data = None
- self._cachetime = None
-
- @classmethod
- def create_simple(cls, req_site, **kwargs):
- """Unsupported as it requires at least two parameters."""
- raise NotImplementedError('CachedRequest cannot be created simply.')
-
- @classmethod
- def _get_cache_dir(cls) -> str:
- """
- Return the base directory path for cache entries.
-
- The directory will be created if it does not already exist.
-
- :return: base directory path for cache entries
- """
- path = os.path.join(config.base_dir,
- 'apicache-py{:d}'.format(PYTHON_VERSION[0]))
- cls._make_dir(path)
- cls._get_cache_dir = classmethod(lambda c: path) # cache the result
- return path
-
- @staticmethod
- def _make_dir(dir_name: str) -> str:
- """Create directory if it does not exist already.
-
- .. versionchanged:: 7.0
- Only `FileExistsError` is ignored but other OS exceptions can
- be still raised
-
- :param dir_name: directory path
- :return: unmodified directory name for test purpose
- """
- os.makedirs(dir_name, exist_ok=True)
- return dir_name
-
- def _uniquedescriptionstr(self) -> str:
- """Return unique description for the cache entry.
-
- If this is modified, please also update
- scripts/maintenance/cache.py to support
- the new key and all previous keys.
- """
- login_status = self.site._loginstatus
-
- if login_status >= LoginStatus.AS_USER:
- # This uses the format of Page.__repr__, without performing
- # config.console_encoding as done by Page.__repr__.
- # The returned value can't be encoded to anything other than
- # ascii otherwise it creates an exception when _create_file_name()
- # tries to encode it as utf-8.
- user_key = 'User(User:{})'.format(self.site.userinfo['name'])
- else:
- user_key = repr(LoginStatus(LoginStatus.NOT_LOGGED_IN))
-
- request_key = repr(sorted(self._encoded_items().items()))
- return '{!r}{}{}'.format(self.site, user_key, request_key)
-
- def _create_file_name(self) -> str:
- """Return a unique ascii identifier for the cache entry."""
- return hashlib.sha256(
- self._uniquedescriptionstr().encode('utf-8')
- ).hexdigest()
-
- def _cachefile_path(self):
- return os.path.join(CachedRequest._get_cache_dir(),
- self._create_file_name())
-
- def _expired(self, dt):
- return dt + self.expiry < datetime.datetime.utcnow()
-
- def _load_cache(self) -> bool:
- """Load cache entry for request, if available.
-
- :return: Whether the request was loaded from the cache
- """
- self._add_defaults()
- try:
- filename = self._cachefile_path()
- with open(filename, 'rb') as f:
- uniquedescr, self._data, self._cachetime = pickle.load(f)
- if uniquedescr != self._uniquedescriptionstr():
- raise RuntimeError('Expected unique description for the cache '
- 'entry is different from file entry.')
- if self._expired(self._cachetime):
- self._data = None
- return False
- pywikibot.debug('{}: cache hit ({}) for API request: {}'
- .format(self.__class__.__name__, filename,
- uniquedescr))
- return True
- except OSError:
- # file not found
- return False
- except Exception as e:
- pywikibot.output('Could not load cache: {!r}'.format(e))
- return False
-
- def _write_cache(self, data) -> None:
- """Write data to self._cachefile_path()."""
- data = (self._uniquedescriptionstr(), data, datetime.datetime.utcnow())
- with open(self._cachefile_path(), 'wb') as f:
- pickle.dump(data, f, protocol=config.pickle_protocol)
-
- def submit(self):
- """Submit cached request."""
- cached_available = self._load_cache()
- if not cached_available:
- self._data = super().submit()
- self._write_cache(self._data)
- else:
- self._handle_warnings(self._data)
- return self._data
-
-
-class _RequestWrapper:
-
- """A wrapper class to handle the usage of the ``parameters`` parameter."""
-
- def _clean_kwargs(self, kwargs, **mw_api_args):
- """Clean kwargs, define site and request class."""
- if 'site' not in kwargs:
- warn('{} invoked without a site'.format(self.__class__.__name__),
- RuntimeWarning, 3)
- kwargs['site'] = pywikibot.Site()
- assert(not hasattr(self, 'site') or self.site == kwargs['site'])
- self.site = kwargs['site']
- self.request_class = kwargs['site']._request_class(kwargs)
- kwargs = self.request_class.clean_kwargs(kwargs)
- kwargs['parameters'].update(mw_api_args)
- return kwargs
-
- def set_maximum_items(self, value: Union[int, str, None]) -> None:
- raise NotImplementedError
-
-
-class APIGenerator(_RequestWrapper):
-
- """
- Iterator that handle API responses containing lists.
-
- The iterator will iterate each item in the query response and use the
- continue request parameter to retrieve the next portion of items
- automatically. If the limit attribute is set, the iterator will stop
- after iterating that many values.
- """
-
- def __init__(
- self,
- action: str,
- continue_name: str = 'continue',
- limit_name: str = 'limit',
- data_name: str = 'data',
- **kwargs
- ) -> None:
- """
- Initialize an APIGenerator object.
-
- kwargs are used to create a Request object; see that object's
- documentation for values.
-
- :param action: API action name.
- :param continue_name: Name of the continue API parameter.
- :param limit_name: Name of the limit API parameter.
- :param data_name: Name of the data in API response.
- """
- kwargs = self._clean_kwargs(kwargs, action=action)
-
- self.continue_name = continue_name
- self.limit_name = limit_name
- self.data_name = data_name
-
- if config.step > 0:
- self.query_increment = config.step
- else:
- self.query_increment = None
- self.limit = None
- self.starting_offset = kwargs['parameters'].pop(self.continue_name, 0)
- self.request = self.request_class(**kwargs)
- self.request[self.limit_name] = self.query_increment
-
- def set_query_increment(self, value: int) -> None:
- """
- Set the maximum number of items to be retrieved per API query.
-
- If not called, the default is config.step.
-
- :param value: The value of maximum number of items to be retrieved
- per API request to set.
- """
- self.query_increment = int(value)
- self.request[self.limit_name] = self.query_increment
- pywikibot.debug('{}: Set query_increment to {}.'
- .format(type(self).__name__, self.query_increment))
-
- def set_maximum_items(self, value: Union[int, str, None]) -> None:
- """
- Set the maximum number of items to be retrieved from the wiki.
-
- If not called, most queries will continue as long as there is
- more data to be retrieved from the API.
-
- :param value: The value of maximum number of items to be retrieved
- in total to set. Ignores None value.
- """
- if value is not None and int(value) > 0:
- self.limit = int(value)
- if self.query_increment and self.limit < self.query_increment:
- self.request[self.limit_name] = self.limit
- pywikibot.debug('{}: Set request item limit to {}'
- .format(type(self).__name__, self.limit))
- pywikibot.debug('{}: Set limit (maximum_items) to {}.'
- .format(type(self).__name__, self.limit))
-
- def __iter__(self):
- """
- Submit request and iterate the response.
-
- Continues response as needed until limit (if defined) is reached.
- """
- offset = self.starting_offset
- n = 0
- while True:
- self.request[self.continue_name] = offset
- pywikibot.debug('{}: Request: {}'
- .format(type(self).__name__, self.request))
- data = self.request.submit()
-
- n_items = len(data[self.data_name])
- pywikibot.debug('{}: Retrieved {} items'
- .format(type(self).__name__, n_items))
- if n_items > 0:
- for item in data[self.data_name]:
- yield item
- n += 1
- if self.limit is not None and n >= self.limit:
- pywikibot.debug('{}: Stopped iterating due to '
- 'exceeding item limit.'
- .format(type(self).__name__))
- return
- offset += n_items
- else:
- pywikibot.debug('{}: Stopped iterating due to empty list in '
- 'response.'.format(type(self).__name__))
- break
-
-
-class QueryGenerator(_RequestWrapper):
-
- """
- Base class for iterators that handle responses to API action=query.
-
- By default, the iterator will iterate each item in the query response,
- and use the (query-)continue element, if present, to continue iterating as
- long as the wiki returns additional values. However, if the iterator's
- limit attribute is set to a positive int, the iterator will stop after
- iterating that many values. If limit is negative, the limit parameter
- will not be passed to the API at all.
-
- Most common query types are more efficiently handled by subclasses, but
- this class can be used directly for custom queries and miscellaneous
- types (such as "meta=...") that don't return the usual list of pages or
- links. See the API documentation for specific query options.
-
- """
-
- # Should results be filtered during iteration according to set_namespace?
- # Used if the API module does not support multiple namespaces.
- # Override in subclasses by defining a function that returns True if
- # the result's namespace is in self._namespaces.
- _check_result_namespace = NotImplemented
-
- # Set of allowed namespaces will be assigned to _namespaces during
- # set_namespace call. Only to be used by _check_result_namespace.
- _namespaces = None
-
- def __init__(self, **kwargs) -> None:
- """
- Initialize a QueryGenerator object.
-
- kwargs are used to create a Request object; see that object's
- documentation for values. 'action'='query' is assumed.
-
- """
- if not hasattr(self, 'site'):
- kwargs = self._clean_kwargs(kwargs) # hasn't been called yet
- parameters = kwargs['parameters']
- if 'action' in parameters and parameters['action'] != 'query':
- raise Error("{}: 'action' must be 'query', not {}"
- .format(self.__class__.__name__, kwargs['action']))
- parameters['action'] = 'query'
- # make sure request type is valid, and get limit key if any
- for modtype in ('generator', 'list', 'prop', 'meta'):
- if modtype in parameters:
- self.modules = parameters[modtype].split('|')
- break
- else:
- raise Error('{}: No query module name found in arguments.'
- .format(self.__class__.__name__))
-
- parameters['indexpageids'] = True # always ask for list of pageids
- self.continue_name = 'continue'
- self.continue_update = self._continue
- # Explicitly enable the simplified continuation
- parameters['continue'] = True
- self.request = self.request_class(**kwargs)
-
- self.site._paraminfo.fetch('query+' + mod for mod in self.modules)
-
- limited_modules = {mod for mod in self.modules
- if self.site._paraminfo.parameter('query+' + mod,
- 'limit')}
-
- if not limited_modules:
- self.limited_module = None
- elif len(limited_modules) == 1:
- self.limited_module = limited_modules.pop()
- else:
- # Select the first limited module in the request.
- # Query will continue as needed until limit (if any) for this
- # module is reached.
- for module in self.modules:
- if module in limited_modules:
- self.limited_module = module
- limited_modules.remove(module)
- break
- pywikibot.log('{}: multiple requested query modules support limits'
- "; using the first such module '{}' of {!r}"
- .format(self.__class__.__name__, self.limited_module,
- self.modules))
-
- # Set limits for all remaining limited modules to max value.
- # Default values will only cause more requests and make the query
- # slower.
- for module in limited_modules:
- param = self.site._paraminfo.parameter('query+' + module,
- 'limit')
- prefix = self.site._paraminfo['query+' + module]['prefix']
- if self.site.logged_in() \
- and self.site.has_right('apihighlimits'):
- self.request[prefix + 'limit'] = int(param['highmax'])
- else:
- self.request[prefix + 'limit'] = int(param['max'])
-
- if config.step > 0:
- self.api_limit = config.step
- else:
- self.api_limit = None
-
- if self.limited_module:
- self.prefix = self.site._paraminfo['query+'
- + self.limited_module]['prefix']
- self._update_limit()
-
- if self.api_limit is not None and 'generator' in parameters:
- self.prefix = 'g' + self.prefix
-
- self.limit = None
- self.query_limit = self.api_limit
- if 'generator' in parameters:
- # name of the "query" subelement key to look for when iterating
- self.resultkey = 'pages'
- else:
- self.resultkey = self.modules[0]
-
- # usually the (query-)continue key is the same as the querymodule,
- # but not always
- # API can return more than one query-continue key, if multiple
- # properties are requested by the query, e.g.
- # "query-continue":{
- # "langlinks":{"llcontinue":"12188973|pt"},
- # "templates":{"tlcontinue":"310820|828|Namespace_detect"}}
- # self.continuekey is a list
- self.continuekey = self.modules
- self._add_slots()
-
- def _add_slots(self) -> None:
- """Add slots to params if the site supports multi-content revisions.
-
- On MW 1.32+ the following query parameters require slots to be given
- when content or contentmodel is requested.
-
- * prop=revisions
- * prop=deletedrevisions or
- * list=allrevisions
- * list=alldeletedrevisions
-
- More info:
- https://lists.wikimedia.org/hyperkitty/list/mediawiki-api-announce@lists.wi…
- """
- if self.site.mw_version < '1.32':
- return
- request = self.request
- # If using any deprecated_params, do not add slots. Usage of
- # these parameters together with slots is forbidden and the user will
- # get an API warning anyway.
- props = request.get('prop')
- if props:
- if 'revisions' in props:
- deprecated_params = {
- 'rvexpandtemplates', 'rvparse', 'rvdiffto', 'rvdifftotext',
- 'rvdifftotextpst', 'rvcontentformat', 'parsetree'}
- if not set(request) & deprecated_params:
- request['rvslots'] = '*'
- if 'deletedrevisions' in props:
- deprecated_params = {
- 'drvexpandtemplates', 'drvparse', 'drvdiffto',
- 'drvdifftotext', 'drvdifftotextpst', 'drvcontentformat',
- 'parsetree'}
- if not set(request) & deprecated_params:
- request['drvslots'] = '*'
- lists = request.get('list')
- if lists:
- if 'allrevisions' in lists:
- deprecated_params = {
- 'arvexpandtemplates', 'arvparse', 'arvdiffto',
- 'arvdifftotext', 'arvdifftotextpst', 'arvcontentformat',
- 'parsetree'}
- if not set(request) & deprecated_params:
- request['arvslots'] = '*'
- if 'alldeletedrevisions' in lists:
- deprecated_params = {
- 'adrexpandtemplates', 'adrparse', 'adrdiffto',
- 'adrdifftotext', 'adrdifftotextpst', 'adrcontentformat',
- 'parsetree'}
- if not set(request) & deprecated_params:
- request['adrslots'] = '*'
-
- def set_query_increment(self, value) -> None:
- """Set the maximum number of items to be retrieved per API query.
-
- If not called, the default is to ask for "max" items and let the
- API decide how many to send.
- """
- limit = int(value)
-
- # don't update if limit is greater than maximum allowed by API
- if self.api_limit is None:
- self.query_limit = limit
- else:
- self.query_limit = min(self.api_limit, limit)
- pywikibot.debug('{}: Set query_limit to {}.'
- .format(type(self).__name__, self.query_limit))
-
- def set_maximum_items(self, value: Union[int, str, None]) -> None:
- """Set the maximum number of items to be retrieved from the wiki.
-
- If not called, most queries will continue as long as there is
- more data to be retrieved from the API.
-
- If set to -1 (or any negative value), the "limit" parameter will be
- omitted from the request. For some request types (such as
- prop=revisions), this is necessary to signal that only current
- revision is to be returned.
-
- :param value: The value of maximum number of items to be retrieved
- in total to set. Ignores None value.
- """
- if value is not None:
- self.limit = int(value)
-
- def _update_limit(self) -> None:
- """Set query limit for self.module based on api response."""
- param = self.site._paraminfo.parameter('query+' + self.limited_module,
- 'limit')
- if self.site.logged_in() and self.site.has_right('apihighlimits'):
- limit = int(param['highmax'])
- else:
- limit = int(param['max'])
- if self.api_limit is None or limit < self.api_limit:
- self.api_limit = limit
- pywikibot.debug('{}: Set query_limit to {}.'
- .format(type(self).__name__, self.api_limit))
-
- def support_namespace(self) -> bool:
- """Check if namespace is a supported parameter on this query.
-
- Note: this function will be removed when self.set_namespace() will
- throw TypeError() instead of just giving a warning.
- See T196619.
-
- :return: True if yes, False otherwise
- """
- assert self.limited_module # some modules do not have a prefix
- return bool(
- self.site._paraminfo.parameter('query+' + self.limited_module,
- 'namespace'))
-
- def set_namespace(self, namespaces):
- """Set a namespace filter on this query.
-
- :param namespaces: namespace identifiers to limit query results
- :type namespaces: iterable of str or Namespace key, or a single
- instance of those types. May be a '|' separated list of
- namespace identifiers. An empty iterator clears any
- namespace restriction.
- :raises KeyError: a namespace identifier was not resolved
- """
- # TODO: T196619
- # :raises TypeError: module does not support a namespace parameter
- # or a namespace identifier has an inappropriate
- # type such as NoneType or bool, or more than one namespace
- # if the API module does not support multiple namespaces
- assert self.limited_module # some modules do not have a prefix
- param = self.site._paraminfo.parameter('query+' + self.limited_module,
- 'namespace')
- if not param:
- pywikibot.warning('{} module does not support a namespace '
- 'parameter'.format(self.limited_module))
- warn('set_namespace() will be modified to raise TypeError '
- 'when namespace parameter is not supported. '
- 'It will be a Breaking Change, please update your code '
- 'ASAP, due date July, 31st 2019.', FutureWarning, 2)
-
- # TODO: T196619
- # raise TypeError('{} module does not support a namespace '
- # 'parameter'.format(self.limited_module))
-
- return False
-
- if isinstance(namespaces, str):
- namespaces = namespaces.split('|')
-
- # Use Namespace id (int) here; Request will cast int to str
- namespaces = [ns.id for ns in
- self.site.namespaces.resolve(namespaces)]
-
- if 'multi' not in param and len(namespaces) != 1:
- if self._check_result_namespace is NotImplemented:
- raise TypeError('{} module does not support multiple '
- 'namespaces'.format(self.limited_module))
- self._namespaces = set(namespaces)
- namespaces = None
-
- if namespaces:
- self.request[self.prefix + 'namespace'] = namespaces
- elif self.prefix + 'namespace' in self.request:
- del self.request[self.prefix + 'namespace']
-
- return None
-
- def _query_continue(self) -> bool:
- if all(key not in self.data[self.continue_name]
- for key in self.continuekey):
- pywikibot.log(
- "Missing '{}' key(s) in ['{}'] value."
- .format(self.continuekey, self.continue_name))
- return True
-
- for query_continue_pair in self.data['query-continue'].values():
- self._add_continues(query_continue_pair)
- return False # a new request with query-continue is needed
-
- def _continue(self) -> bool:
- self._add_continues(self.data['continue'])
- return False # a new request with continue is needed
-
- def _add_continues(self, continue_pair) -> None:
- for key, value in continue_pair.items():
- # query-continue can return ints (continue too?)
- if isinstance(value, int):
- value = str(value)
- self.request[key] = value
-
- def _handle_query_limit(self, prev_limit, new_limit, had_data):
- """Handle query limit."""
- if self.query_limit is None or self.limited_module is None:
- return prev_limit, new_limit
-
- prev_limit = new_limit
- if self.limit is None:
- new_limit = self.query_limit
- elif self.limit > 0:
- if had_data:
- # self.resultkey in data in last request.submit()
- new_limit = min(self.query_limit, self.limit - self._count)
- else:
- # only "(query-)continue" returned. See Bug T74209.
- # increase new_limit to advance faster until new
- # useful data are found again.
- new_limit = min(new_limit * 2, self.query_limit)
- else:
- new_limit = None
-
- if new_limit and 'rvprop' in self.request \
- and 'content' in self.request['rvprop']:
- # queries that retrieve page content have lower limits
- # Note: although API allows up to 500 pages for content
- # queries, these sometimes result in server-side errors
- # so use 250 as a safer limit
- new_limit = min(new_limit, self.api_limit // 10, 250)
-
- if new_limit is not None:
- self.request[self.prefix + 'limit'] = str(new_limit)
-
- if prev_limit != new_limit:
- pywikibot.debug(
- '{name}: query_limit: {query}, api_limit: {api}, '
- 'limit: {limit}, new_limit: {new}, count: {count}\n'
- '{name}: {prefix}limit: {value}'
- .format(name=self.__class__.__name__,
- query=self.query_limit,
- api=self.api_limit,
- limit=self.limit,
- new=new_limit,
- count=self._count,
- prefix=self.prefix,
- value=self.request[self.prefix + 'limit']))
- return prev_limit, new_limit
-
- def _get_resultdata(self):
- """Get resultdata and verify result."""
- resultdata = keys = self.data['query'][self.resultkey]
- if isinstance(resultdata, dict):
- keys = list(resultdata.keys())
- if 'results' in resultdata:
- resultdata = resultdata['results']
- elif 'pageids' in self.data['query']:
- # this ensures that page data will be iterated
- # in the same order as received from server
- resultdata = [resultdata[k]
- for k in self.data['query']['pageids']]
- else:
- resultdata = [resultdata[k]
- for k in sorted(resultdata.keys())]
- pywikibot.debug('{name} received {keys}; limit={limit}'
- .format(name=type(self).__name__, keys=keys,
- limit=self.limit))
- return resultdata
-
- def _extract_results(self, resultdata):
- """Extract results from resultdata."""
- for item in resultdata:
- result = self.result(item)
- if self._namespaces and not self._check_result_namespace(result):
- continue
-
- yield result
- if isinstance(item, dict) \
- and set(self.continuekey) & set(item.keys()):
- # if we need to count elements contained in items in
- # self.data["query"]["pages"], we want to count
- # item[self.continuekey] (e.g. 'revisions') and not
- # self.resultkey (i.e. 'pages')
- for key in set(self.continuekey) & set(item.keys()):
- self._count += len(item[key])
- # otherwise we proceed as usual
- else:
- self._count += 1
- # note: self.limit could be -1
- if self.limit and 0 < self.limit <= self._count:
- raise RuntimeError(
- 'QueryGenerator._extract_results reached the limit')
-
- def __iter__(self):
- """Submit request and iterate the response based on self.resultkey.
-
- Continues response as needed until limit (if any) is reached.
-
- """
- previous_result_had_data = True
- prev_limit = new_limit = None
-
- self._count = 0
- while True:
- prev_limit, new_limit = self._handle_query_limit(
- prev_limit, new_limit, previous_result_had_data)
- if not hasattr(self, 'data'):
- self.data = self.request.submit()
- if not self.data or not isinstance(self.data, dict):
- pywikibot.debug(
- '{}: stopped iteration because no dict retrieved from api.'
- .format(type(self).__name__))
- return
-
- if 'query' in self.data and self.resultkey in self.data['query']:
- resultdata = self._get_resultdata()
- if 'normalized' in self.data['query']:
- self.normalized = {
- item['to']: item['from']
- for item in self.data['query']['normalized']}
- else:
- self.normalized = {}
- try:
- yield from self._extract_results(resultdata)
- except RuntimeError:
- return
- # self.resultkey in data in last request.submit()
- previous_result_had_data = True
- else:
- if 'query' not in self.data:
- pywikibot.log("%s: 'query' not found in api response." %
- self.__class__.__name__)
- pywikibot.log(str(self.data))
- # if (query-)continue is present, self.resultkey might not have
- # been fetched yet
- if self.continue_name not in self.data:
- # No results.
- return
- # self.resultkey not in data in last request.submit()
- # only "(query-)continue" was retrieved.
- previous_result_had_data = False
- if self.modules[0] == 'random':
- # "random" module does not return "(query-)continue"
- # now we loop for a new random query
- del self.data # a new request is needed
- continue
- if self.continue_name not in self.data:
- return
- if self.continue_update():
- return
-
- del self.data # a new request with (query-)continue is needed
-
- def result(self, data):
- """Process result data as needed for particular subclass."""
- return data
-
-
-class PageGenerator(QueryGenerator):
-
- """Iterator for response to a request of type action=query&generator=foo.
-
- This class can be used for any of the query types that are listed in the
- API documentation as being able to be used as a generator. Instances of
- this class iterate Page objects.
-
- """
-
- def __init__(
- self,
- generator: str,
- g_content: bool = False,
- **kwargs
- ) -> None:
- """
- Initializer.
-
- Required and optional parameters are as for ``Request``, except that
- action=query is assumed and generator is required.
-
- :param generator: the "generator=" type from api.php
- :param g_content: if True, retrieve the contents of the current
- version of each Page (default False)
-
- """
- # If possible, use self.request after __init__ instead of appendParams
- def append_params(params, key, value) -> None:
- if key in params:
- params[key] += '|' + value
- else:
- params[key] = value
- kwargs = self._clean_kwargs(kwargs)
- parameters = kwargs['parameters']
- # get some basic information about every page generated
- append_params(parameters, 'prop', 'info|imageinfo|categoryinfo')
- if g_content:
- # retrieve the current revision
- append_params(parameters, 'prop', 'revisions')
- append_params(parameters, 'rvprop',
- 'ids|timestamp|flags|comment|user|content')
- if not ('inprop' in parameters
- and 'protection' in parameters['inprop']):
- append_params(parameters, 'inprop', 'protection')
- append_params(parameters, 'iiprop',
- 'timestamp|user|comment|url|size|sha1|metadata')
- append_params(parameters, 'iilimit', 'max') # T194233
- parameters['generator'] = generator
- super().__init__(**kwargs)
- self.resultkey = 'pages' # element to look for in result
- self.props = self.request['prop']
-
- def result(self, pagedata):
- """Convert page dict entry from api to Page object.
-
- This can be overridden in subclasses to return a different type
- of object.
-
- """
- p = pywikibot.Page(self.site, pagedata['title'], pagedata['ns'])
- ns = pagedata['ns']
- # Upcast to proper Page subclass.
- if ns == 2:
- p = pywikibot.User(p)
- elif ns == 6:
- p = pywikibot.FilePage(p)
- elif ns == 14:
- p = pywikibot.Category(p)
- update_page(p, pagedata, self.props)
- return p
-
-
-class PropertyGenerator(QueryGenerator):
-
- """Iterator for queries of type action=query&prop=foo.
-
- See the API documentation for types of page properties that can be
- queried.
-
- This iterator yields one or more dict object(s) corresponding
- to each "page" item(s) from the API response; the calling module has to
- decide what to do with the contents of the dict. There will be one
- dict for each page queried via a titles= or ids= parameter (which must
- be supplied when instantiating this class).
-
- """
-
- def __init__(self, prop: str, **kwargs) -> None:
- """
- Initializer.
-
- Required and optional parameters are as for ``Request``, except that
- action=query is assumed and prop is required.
-
- :param prop: the "prop=" type from api.php
- """
- kwargs = self._clean_kwargs(kwargs, prop=prop)
- super().__init__(**kwargs)
- self._props = frozenset(prop.split('|'))
- self.resultkey = 'pages'
-
- @property
- def props(self):
- """The requested property names."""
- return self._props
-
- def __iter__(self):
- """Yield results."""
- self._previous_dicts = {}
- yield from super().__iter__()
- yield from self._previous_dicts.values()
-
- def _extract_results(self, resultdata):
- """Yield completed page_data of consecutive API requests."""
- yield from self._fully_retrieved_data_dicts(resultdata)
- for data_dict in super()._extract_results(resultdata):
- if 'title' in data_dict:
- d = self._previous_dicts.setdefault(data_dict['title'],
- data_dict)
- if d is not data_dict:
- self._update_old_result_dict(d, data_dict)
- else:
- pywikibot.warn('Skipping result without title: '
- + str(data_dict))
-
- def _fully_retrieved_data_dicts(self, resultdata):
- """Yield items of self._previous_dicts that are not in resultdata."""
- resultdata_titles = {d['title'] for d in resultdata if 'title' in d}
- for prev_title, prev_dict in self._previous_dicts.copy().items():
- if prev_title not in resultdata_titles:
- yield prev_dict
- del self._previous_dicts[prev_title]
-
- @staticmethod
- def _update_old_result_dict(old_dict, new_dict) -> None:
- """Update old result dict with new_dict."""
- for k, v in new_dict.items():
- if k not in old_dict:
- old_dict[k] = v
- continue
- if isinstance(v, list):
- old_dict[k].extend(v)
- continue
- assert isinstance(v, (str, int)), (
- 'continued API result had an unexpected type: {}'.format(v))
-
-
-class ListGenerator(QueryGenerator):
-
- """Iterator for queries of type action=query&list=foo.
-
- See the API documentation for types of lists that can be queried. Lists
- include both site-wide information (such as 'allpages') and page-specific
- information (such as 'backlinks').
-
- This iterator yields a dict object for each member of the list returned
- by the API, with the format of the dict depending on the particular list
- command used. For those lists that contain page information, it may be
- easier to use the PageGenerator class instead, as that will convert the
- returned information into a Page object.
-
- """
-
- def __init__(self, listaction: str, **kwargs) -> None:
- """
- Initializer.
-
- Required and optional parameters are as for ``Request``, except that
- action=query is assumed and listaction is required.
-
- :param listaction: the "list=" type from api.php
- """
- kwargs = self._clean_kwargs(kwargs, list=listaction)
- super().__init__(**kwargs)
-
-
-class LogEntryListGenerator(ListGenerator):
-
- """
- Iterator for queries of list 'logevents'.
-
- Yields LogEntry objects instead of dicts.
- """
-
- def __init__(self, logtype=None, **kwargs) -> None:
- """Initializer."""
- super().__init__('logevents', **kwargs)
-
- from pywikibot import logentries
- self.entryFactory = logentries.LogEntryFactory(self.site, logtype)
-
- def result(self, pagedata):
- """Instantiate LogEntry from data from api."""
- return self.entryFactory.create(pagedata)
-
- def _check_result_namespace(self, result):
- """Return True if result.ns() is in self._namespaces."""
- return result.ns() in self._namespaces
-
-
-class LoginManager(login.LoginManager):
-
- """Supply login_to_site method to use API interface."""
-
- # API login parameters mapping
- mapping = {
- 'user': ('lgname', 'username'),
- 'password': ('lgpassword', 'password'),
- 'ldap': ('lgdomain', 'domain'),
- 'token': ('lgtoken', 'logintoken'),
- 'result': ('result', 'status'),
- 'success': ('Success', 'PASS'),
- 'fail': ('Failed', 'FAIL'),
- 'reason': ('reason', 'message')
- }
-
- def keyword(self, key):
- """Get API keyword from mapping."""
- return self.mapping[key][self.action != 'login']
-
- def _login_parameters(self, *, botpassword: bool = False
- ) -> Dict[str, str]:
- """Return login parameters."""
- # Since MW 1.27 only for bot passwords.
- self.action = 'login'
- if not botpassword:
- # get token using meta=tokens if supported
- token = self.get_login_token()
- if token:
- # Standard login request since MW 1.27
- self.action = 'clientlogin'
-
- # prepare default login parameters
- parameters = {'action': self.action,
- self.keyword('user'): self.login_name,
- self.keyword('password'): self.password}
-
- if self.action == 'clientlogin':
- # clientlogin requires non-empty loginreturnurl
- parameters['loginreturnurl'] = 'https://example.com'
- parameters['rememberMe'] = '1'
- parameters['logintoken'] = token
-
- if self.site.family.ldapDomain:
- parameters[self.keyword('ldap')] = self.site.family.ldapDomain
-
- return parameters
-
- def login_to_site(self) -> None:
- """Login to the site.
-
- Note, this doesn't do anything with cookies. The http module
- takes care of all the cookie stuff. Throws exception on failure.
- """
- self.below_mw_1_27 = False
- if hasattr(self, '_waituntil') \
- and datetime.datetime.now() < self._waituntil:
- diff = self._waituntil - datetime.datetime.now()
- pywikibot.warning(
- 'Too many tries, waiting {} seconds before retrying.'
- .format(diff.seconds))
- pywikibot.sleep(diff.seconds)
-
- self.site._loginstatus = LoginStatus.IN_PROGRESS
-
- # Bot passwords username contains @,
- # otherwise @ is not allowed in usernames.
- # @ in bot password is deprecated,
- # but we don't want to break bots using it.
- parameters = self._login_parameters(
- botpassword='@' in self.login_name or '@' in self.password)
-
- # base login request
- login_request = self.site._request(use_get=False,
- parameters=parameters)
- while True:
- # try to login
- try:
- login_result = login_request.submit()
- except pywikibot.exceptions.APIError as e:
- login_result = {'error': e.__dict__}
-
- # clientlogin response can be clientlogin or error
- if self.action in login_result:
- response = login_result[self.action]
- result_key = self.keyword('result')
- elif 'error' in login_result:
- response = login_result['error']
- result_key = 'code'
- else:
- raise RuntimeError('Unexpected API login response key.')
-
- status = response[result_key]
- fail_reason = response.get(self.keyword('reason'), '')
- if status == self.keyword('success'):
- return
-
- if status in ('NeedToken', 'WrongToken', 'badtoken'):
- token = response.get('token')
- if token and self.below_mw_1_27:
- # fetched token using action=login
- login_request['lgtoken'] = token
- pywikibot.log('Received login token, proceed with login.')
- else:
- # if incorrect login token was used,
- # force relogin and generate fresh one
- pywikibot.error('Received incorrect login token. '
- 'Forcing re-login.')
- # invalidate superior wiki cookies (T224712)
- _invalidate_superior_cookies(self.site.family)
- login_request[
- self.keyword('token')] = self.get_login_token()
- continue
-
- # messagecode was introduced with 1.29.0-wmf.14
- # but older wikis are still supported
- login_throttled = response.get('messagecode') == 'login-throttled'
-
- if (status == 'Throttled' or status == self.keyword('fail')
- and (login_throttled or 'wait' in fail_reason)):
- wait = response.get('wait')
- if wait:
- delta = datetime.timedelta(seconds=int(wait))
- else:
- match = re.search(r'(\d+) (seconds|minutes)', fail_reason)
- if match:
- delta = datetime.timedelta(
- **{match.group(2): int(match.group(1))})
- else:
- delta = datetime.timedelta()
- self._waituntil = datetime.datetime.now() + delta
-
- break
-
- if 'error' in login_result:
- raise pywikibot.exceptions.APIError(**response)
-
- raise pywikibot.exceptions.APIError(code=status, info=fail_reason)
-
- def get_login_token(self) -> Optional[str]:
- """Fetch login token for MediaWiki 1.27+.
-
- :return: login token
- """
- login_token_request = self.site._request(
- use_get=False,
- parameters={'action': 'query', 'meta': 'tokens', 'type': 'login'},
- )
- login_token_result = login_token_request.submit()
- # check if we have to use old implementation of mw < 1.27
- if 'query' in login_token_result:
- return login_token_result['query']['tokens'].get('logintoken')
-
- self.below_mw_1_27 = True
- return None
-
-
-def encode_url(query) -> str:
- """Encode parameters to pass with a url.
-
- Reorder parameters so that token parameters go last and call wraps
- :py:obj:`urlencode`. Return an HTTP URL query fragment which
- complies with :api:`Edit#Parameters` (See the 'token' bullet.)
-
- :param query: keys and values to be uncoded for passing with a url
- :type query: mapping object or a sequence of two-element tuples
- :return: encoded parameters with token parameters at the end
- """
- if hasattr(query, 'items'):
- query = list(query.items())
-
- # parameters ending on 'token' should go last
- # wpEditToken should go very last
- query.sort(key=lambda x: x[0].lower().endswith('token')
- + (x[0] == 'wpEditToken'))
- return urlencode(query)
-
-
-def _update_pageid(page, pagedict: dict):
- """Update pageid."""
- if 'pageid' in pagedict:
- page._pageid = int(pagedict['pageid'])
- elif 'missing' in pagedict:
- page._pageid = 0 # Non-existent page
- else:
- # Something is wrong.
- if page.site.sametitle(page.title(), pagedict['title']) \
- and 'invalid' in pagedict:
- raise InvalidTitleError('{}: {}'
- .format(page, pagedict['invalidreason']))
- if int(pagedict['ns']) < 0:
- raise UnsupportedPageError(page)
- raise RuntimeError(
- "Page {} has neither 'pageid' nor 'missing' attribute"
- .format(pagedict['title']))
-
-
-def _update_contentmodel(page, pagedict: dict) -> None:
- """Update page content model."""
- page._contentmodel = pagedict.get('contentmodel') # can be None
-
- if (page._contentmodel
- and page._contentmodel == 'proofread-page'
- and 'proofread' in pagedict):
- page._quality = pagedict['proofread']['quality']
- page._quality_text = pagedict['proofread']['quality_text']
-
-
-def _update_protection(page, pagedict: dict) -> None:
- """Update page protection."""
- if 'restrictiontypes' in pagedict:
- page._applicable_protections = set(pagedict['restrictiontypes'])
- else:
- page._applicable_protections = None
- page._protection = {item['type']: (item['level'], item['expiry'])
- for item in pagedict['protection']}
-
-
-def _update_revisions(page, revisions) -> None:
- """Update page revisions."""
- for rev in revisions:
- revid = rev['revid']
- revision = pywikibot.page.Revision(**rev)
- # do not overwrite an existing Revision if there is no content
- if revid in page._revisions and revision.text is None:
- pass
- else:
- page._revisions[revid] = revision
-
-
-def _update_templates(page, templates) -> None:
- """Update page templates."""
- templ_pages = [pywikibot.Page(page.site, tl['title']) for tl in templates]
- if hasattr(page, '_templates'):
- page._templates.extend(templ_pages)
- else:
- page._templates = templ_pages
-
-
-def _update_langlinks(page, langlinks) -> None:
- """Update page langlinks."""
- links = [pywikibot.Link.langlinkUnsafe(link['lang'], link['*'],
- source=page.site)
- for link in langlinks]
-
- if hasattr(page, '_langlinks'):
- page._langlinks.extend(links)
- else:
- page._langlinks = links
-
-
-def _update_coordinates(page, coordinates) -> None:
- """Update page coordinates."""
- coords = []
- for co in coordinates:
- coord = pywikibot.Coordinate(lat=co['lat'],
- lon=co['lon'],
- typ=co.get('type', ''),
- name=co.get('name', ''),
- dim=int(co.get('dim', 0)) or None,
- globe=co['globe'], # See [[gerrit:67886]]
- primary='primary' in co
- )
- coords.append(coord)
- page._coords = coords
-
-
-def update_page(page, pagedict: dict, props=None):
- """Update attributes of Page object page, based on query data in pagedict.
-
- :param page: object to be updated
- :type page: pywikibot.page.Page
- :param pagedict: the contents of a "page" element of a query response
- :param props: the property names which resulted in pagedict. If a missing
- value in pagedict can indicate both 'false' and 'not present' the
- property which would make the value present must be in the props
- parameter.
- :type props: iterable of string
- :raises pywikibot.exceptions.InvalidTitleError: Page title is invalid
- :raises pywikibot.exceptions.UnsupportedPageError: Page with namespace < 0
- is not supported yet
- """
- _update_pageid(page, pagedict)
- _update_contentmodel(page, pagedict)
-
- props = props or []
- if 'info' in props:
- page._isredir = 'redirect' in pagedict
-
- if 'touched' in pagedict:
- page._timestamp = pagedict['touched']
-
- if 'protection' in pagedict:
- _update_protection(page, pagedict)
-
- if 'revisions' in pagedict:
- _update_revisions(page, pagedict['revisions'])
-
- if 'lastrevid' in pagedict:
- page.latest_revision_id = pagedict['lastrevid']
-
- if 'imageinfo' in pagedict:
- if not isinstance(page, pywikibot.FilePage):
- raise RuntimeError(
- '"imageinfo" found but {} is not a FilePage object'
- .format(page))
- page._load_file_revisions(pagedict['imageinfo'])
-
- if 'categoryinfo' in pagedict:
- page._catinfo = pagedict['categoryinfo']
-
- if 'templates' in pagedict:
- _update_templates(page, pagedict['templates'])
- elif 'templates' in props:
- page._templates = []
-
- if 'langlinks' in pagedict:
- _update_langlinks(page, pagedict['langlinks'])
- elif 'langlinks' in props:
- page._langlinks = []
-
- if 'coordinates' in pagedict:
- _update_coordinates(page, pagedict['coordinates'])
-
- if 'pageimage' in pagedict:
- page._pageimage = pywikibot.FilePage(page.site, pagedict['pageimage'])
-
- if 'pageprops' in pagedict:
- page._pageprops = pagedict['pageprops']
- elif 'pageprops' in props:
- page._pageprops = {}
-
- if 'preload' in pagedict:
- page._preloadedtext = pagedict['preload']
-
- if 'flowinfo' in pagedict:
- page._flowinfo = pagedict['flowinfo']['flow']
-
- if 'lintId' in pagedict:
- page._lintinfo = pagedict
- page._lintinfo.pop('pageid')
- page._lintinfo.pop('title')
- page._lintinfo.pop('ns')
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805787
To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I529945360b2d60975657f0f41765b7729a735527
Gerrit-Change-Number: 805787
Gerrit-PatchSet: 2
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged
Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805404 )
Change subject: [IMPR] Move api.ParamInfo to _paraminfo.py
......................................................................
[IMPR] Move api.ParamInfo to _paraminfo.py
Part 2:
- rename __init.py to __init__py
- remove ParamInfo in __init__.py
- remove all code except ParamInfo in _paraminfo.py
Change-Id: I194bf8c1f9472ab9e8927b6df3047a816369df01
---
M pywikibot/CONTENT.rst
R pywikibot/data/api/__init__.py
M pywikibot/data/api/_paraminfo.py
3 files changed, 30 insertions(+), 3,222 deletions(-)
Approvals:
Xqt: Verified; Looks good to me, approved
diff --git a/pywikibot/CONTENT.rst b/pywikibot/CONTENT.rst
index 318c2e9..6b9f18f 100644
--- a/pywikibot/CONTENT.rst
+++ b/pywikibot/CONTENT.rst
@@ -90,9 +90,11 @@
| data | Module providing layers of data access to wiki |
+============================+======================================================+
| api.py | Interface Module to MediaWiki's api |
- | +-------------+----------------------------------------+
- | | __init__.py | Interface to MediaWiki's api.php |
- +----------------------------+-------------+----------------------------------------+
+ | +--------------+---------------------------------------+
+ | | __init__.py | Interface to MediaWiki's api.php |
+ | +--------------+---------------------------------------+
+ | | paraminfo.py | API parameter information data object |
+ +----------------------------+--------------+---------------------------------------+
| mysql.py | Miscellaneous helper functions for mysql queries |
+----------------------------+------------------------------------------------------+
| sparql.py | Objects representing SPARQL query API |
diff --git a/pywikibot/data/api/__init.py b/pywikibot/data/api/__init__.py
similarity index 82%
rename from pywikibot/data/api/__init.py
rename to pywikibot/data/api/__init__.py
index ab01827..baf2006 100644
--- a/pywikibot/data/api/__init.py
+++ b/pywikibot/data/api/__init__.py
@@ -12,7 +12,7 @@
import pprint
import re
import traceback
-from collections.abc import Container, MutableMapping, Sized
+from collections.abc import MutableMapping
from email.generator import BytesGenerator
from email.mime.multipart import MIMEMultipart as MIMEMultipartOrig
from email.mime.nonmultipart import MIMENonMultipart
@@ -26,6 +26,7 @@
from pywikibot import config, login
from pywikibot.backports import Callable, Dict, Match, Tuple, removeprefix
from pywikibot.comms import http
+from pywikibot.data.api._paraminfo import ParamInfo
from pywikibot.exceptions import (
Error,
FatalServerError,
@@ -41,7 +42,23 @@
from pywikibot.family import SubdomainFamily
from pywikibot.login import LoginStatus
from pywikibot.textlib import removeHTMLParts
-from pywikibot.tools import PYTHON_VERSION, itergroup
+from pywikibot.tools import PYTHON_VERSION
+
+__all__ = (
+ 'APIGenerator',
+ 'CachedRequest',
+ 'ListGenerator',
+ 'LogEntryListGenerator',
+ 'LoginManager',
+ 'OptionSet',
+ 'PageGenerator',
+ 'ParamInfo',
+ 'PropertyGenerator',
+ 'QueryGenerator',
+ 'Request',
+ 'encode_url',
+ 'update_page',
+)
lagpattern = re.compile(
@@ -102,578 +119,6 @@
MIMEMultipart = CTEBinaryMIMEMultipart
-class ParamInfo(Sized, Container):
-
- """
- API parameter information data object.
-
- Provides cache aware fetching of parameter information.
-
- It does not support the format modules.
- """
-
- paraminfo_keys = frozenset(['modules', 'querymodules', 'formatmodules',
- 'mainmodule', 'pagesetmodule'])
-
- root_modules = frozenset(['main', 'pageset'])
-
- init_modules = frozenset(['main', 'paraminfo'])
-
- def __init__(
- self,
- site,
- preloaded_modules=None,
- modules_only_mode=None
- ) -> None:
- """
- Initializer.
-
- :param preloaded_modules: API modules to preload
- :type preloaded_modules: set of string
- :param modules_only_mode: use the 'modules' only syntax for API request
- :type modules_only_mode: bool or None to only use default, which True
- if the site is 1.25wmf4+
- """
- self.site = site
-
- # Keys are module names, values are the raw responses from the server.
- self._paraminfo = {}
-
- # Cached data.
- self._prefixes = {}
- self._prefix_map = {}
- self._with_limits = None
-
- self._action_modules = frozenset() # top level modules
- self._modules = {} # filled in _init() (and enlarged in fetch)
- self._limit = None
-
- self.preloaded_modules = self.init_modules
- if preloaded_modules:
- self.preloaded_modules |= set(preloaded_modules)
-
- self.modules_only_mode = modules_only_mode
- if self.modules_only_mode:
- self.paraminfo_keys = frozenset(['modules'])
-
- def _add_submodules(self, name, modules) -> None:
- """Add the modules to the internal cache or check if equal."""
- # The current implementation here doesn't support submodules inside of
- # submodules, because that would require to fetch all modules when only
- # the names of them were requested
- assert '+' not in name
- modules = frozenset(modules)
- if name == 'main':
- # The main module behaves differently as it has no prefix
- if self._action_modules:
- assert modules == self._action_modules
- else:
- self._action_modules = modules
- elif name in self._modules:
- assert modules == self._modules[name]
- else:
- self._modules[name] = modules
-
- def _init(self):
- assert ('query' in self._modules) is ('main' in self._paraminfo)
- if 'query' in self._modules:
- return
- mw_ver = self.site.mw_version
-
- # The paraminfo api deprecated the old request syntax of
- # querymodules='info'; to avoid warnings sites with 1.25wmf4+
- # must only use 'modules' parameter.
- if self.modules_only_mode is None:
- self.modules_only_mode = mw_ver >= '1.25wmf4'
- if self.modules_only_mode:
- self.paraminfo_keys = frozenset(['modules'])
-
- # Assume that by v1.26, it will be desirable to prefetch 'query'
- if mw_ver > '1.26':
- self.preloaded_modules |= {'query'}
-
- self._fetch(self.preloaded_modules)
-
- main_modules_param = self.parameter('main', 'action')
- assert main_modules_param
- assert 'type' in main_modules_param
- assert isinstance(main_modules_param['type'], list)
- assert self._action_modules == set(main_modules_param['type'])
-
- # While deprecated with warning in 1.25, paraminfo param 'querymodules'
- # provides a list of all query modules. This will likely be removed
- # from the API in the future, in which case the fallback is the use
- # the same data available in the paraminfo for query.
- query_modules_param = self.parameter('paraminfo', 'querymodules')
-
- if 'limit' not in query_modules_param:
- raise RuntimeError('"limit" not found in query modules')
- self._limit = query_modules_param['limit']
-
- if query_modules_param and 'type' in query_modules_param:
- # 'type' is the list of modules
- self._add_submodules('query', query_modules_param['type'])
-
- if 'query' not in self._modules:
- assert 'query' not in self._paraminfo
- self._fetch({'query'})
- assert 'query' in self._modules
-
- def _emulate_pageset(self) -> None:
- """Emulate the pageset module, which existed until MW 1.24."""
- # pageset isn't a module in the new system, so it is emulated, with
- # the paraminfo from the query module.
- assert 'query' in self._paraminfo
-
- self._paraminfo['pageset'] = {
- 'name': 'pageset',
- 'path': 'pageset',
- 'classname': 'ApiPageSet',
- 'prefix': '',
- 'readrights': '',
- 'helpurls': [],
- 'parameters': self._paraminfo['query']['parameters']
- }
-
- @staticmethod
- def _modules_to_set(modules) -> set:
- """Return modules as a set.
-
- :type modules: iterable or str
- """
- if isinstance(modules, str):
- return set(modules.split('|'))
- return set(modules)
-
- def fetch(self, modules) -> None:
- """
- Fetch paraminfo for multiple modules.
-
- No exception is raised when paraminfo for a module does not exist.
- Use __getitem__ to cause an exception if a module does not exist.
-
- :param modules: API modules to load
- :type modules: iterable or str
- """
- if 'main' not in self._paraminfo:
- # The first request should be 'paraminfo', so that
- # query modules can be prefixed with 'query+'
- self._init()
-
- modules = self._modules_to_set(modules)
-
- if self._action_modules:
- # The query module may be added before the action modules have been
- if 'query' in self._modules:
- # It does fetch() while initializing, and this method can't be
- # called before it's initialized.
- modules = self._normalize_modules(modules)
- else:
- # We do know the valid action modules and require a subset
- assert not modules - self._action_modules - self.root_modules
-
- self._fetch(modules)
-
- def _fetch(self, modules: Union[set, frozenset]) -> None:
- """
- Fetch paraminfo for multiple modules without initializing beforehand.
-
- :param modules: API modules to load and which haven't been loaded yet.
- """
- def module_generator():
- """A generator yielding batches of modules."""
- i = itergroup(sorted(modules), self._limit)
- for batch in i:
- for failed_module in failed_modules:
- yield [failed_module]
- del failed_modules[:]
- yield batch
-
- modules = modules - set(self._paraminfo.keys())
- if not modules:
- return
-
- assert 'query' in self._modules or 'paraminfo' not in self._paraminfo
-
- # If something went wrong in a batch it can add each module to the
- # batch and the generator will on the next iteration yield each module
- # separately
- failed_modules = []
-
- # This can be further optimised, by grouping them in more stable
- # subsets, which are unlikely to change. i.e. first request core
- # modules which have been a stable part of the API for a long time.
- # Also detecting extension based modules may help.
- # Also, when self.modules_only_mode is disabled, both modules and
- # querymodules may each be filled with self._limit items, doubling the
- # number of modules that may be processed in a single batch.
- for module_batch in module_generator():
- if self.modules_only_mode and 'pageset' in module_batch:
- pywikibot.debug('paraminfo fetch: removed pageset')
- module_batch.remove('pageset')
- # If this occurred during initialisation,
- # also record it in the preloaded_modules.
- # (at least so tests know an extra load was intentional)
- if 'query' not in self._paraminfo:
- pywikibot.debug('paraminfo batch: added query')
- module_batch.append('query')
- self.preloaded_modules |= {'query'}
-
- params = {
- 'action': 'paraminfo',
- }
-
- if self.modules_only_mode:
- params['modules'] = module_batch
- else:
- params['modules'] = [mod for mod in module_batch
- if not mod.startswith('query+')
- and mod not in self.root_modules]
- params['querymodules'] = [mod[6:] for mod in module_batch
- if mod.startswith('query+')]
-
- for mod in set(module_batch) & self.root_modules:
- params[mod + 'module'] = 1
-
- # Request need ParamInfo to determine use_get
- request = self.site._request(expiry=config.API_config_expiry,
- use_get=True,
- parameters=params)
- result = request.submit()
-
- normalized_result = self.normalize_paraminfo(result)
- for path in list(normalized_result):
- if normalized_result[path] is False:
- del normalized_result[path]
-
- # Sometimes the name/path of the module is not actually the name
- # which was requested, so we need to manually determine which
- # (wrongly named) module uses which actual name. See also T105478
- missing_modules = [m for m in module_batch
- if m not in normalized_result]
- if len(missing_modules) == 1 and len(normalized_result) == 1:
- # Okay it's possible to recover
- normalized_result = next(iter(normalized_result.values()))
- pywikibot.warning('The module "{0[name]}" ("{0[path]}") '
- 'was returned as path even though "{1}" '
- 'was requested'.format(normalized_result,
- missing_modules[0]))
- normalized_result['path'] = missing_modules[0]
- normalized_result['name'] = missing_modules[0].rsplit('+')[0]
- normalized_result = {missing_modules[0]: normalized_result}
- elif len(module_batch) > 1 and missing_modules:
- # Rerequest the missing ones separately
- pywikibot.log('Inconsistency in batch "{}"; rerequest '
- 'separately'.format(missing_modules))
- failed_modules.extend(missing_modules)
-
- # Remove all modules which weren't requested, we can't be sure that
- # they are valid
- for path in list(normalized_result):
- if path not in module_batch:
- del normalized_result[path]
-
- self._paraminfo.update(normalized_result)
- for mod in normalized_result.values():
- self._generate_submodules(mod['path'])
-
- if 'pageset' in modules and 'pageset' not in self._paraminfo:
- self._emulate_pageset()
-
- def _generate_submodules(self, module) -> None:
- """Check and generate submodules for the given module."""
- parameters = self._paraminfo[module].get('parameters', [])
- submodules = set()
- # Advanced submodule into added to MW API in df80f1ea
- if self.site.mw_version >= '1.26wmf9':
- # This is supplying submodules even if they aren't submodules
- # of the given module so skip those
- for param in parameters:
- if module == 'main' and param['name'] == 'format' \
- or 'submodules' not in param:
- continue
-
- for submodule in param['submodules'].values():
- if '+' in submodule:
- parent, child = submodule.rsplit('+', 1)
- else:
- parent, child = 'main', submodule
- if parent == module:
- submodules.add(child)
- else:
- # Boolean submodule info added to MW API in afa153ae
- if self.site.mw_version < '1.24wmf18':
- if module == 'main':
- params = {'action'}
- elif module == 'query':
- params = {'prop', 'list', 'meta'}
- else:
- params = set()
- for param in parameters:
- if param['name'] in params:
- param['submodules'] = ''
-
- for param in parameters:
- # Do not add format modules
- if 'submodules' in param \
- and (module != 'main' or param['name'] != 'format'):
- submodules |= set(param['type'])
-
- if submodules:
- self._add_submodules(module, submodules)
- if module == 'query':
- # Previously also modules from generator were used as query
- # modules, but verify that those are just a subset of the
- # prop/list/meta modules. There is no sanity check as this
- # needs to be revisited if query has no generator parameter
- for param in parameters:
- if param['name'] == 'generator':
- break
- else:
- param = {}
- assert param['name'] == 'generator' \
- and submodules >= set(param['type'])
-
- def _normalize_modules(self, modules) -> set:
- """Add query+ to any query module name not also in action modules."""
- # Users will supply the wrong type, and expect it to work.
- modules = self._modules_to_set(modules)
-
- assert self._action_modules
-
- return {'query+' + mod
- if '+' not in mod and mod in self.query_modules
- and mod not in self._action_modules
- else mod
- for mod in modules}
-
- def normalize_modules(self, modules) -> set:
- """
- Convert the modules into module paths.
-
- Add query+ to any query module name not also in action modules.
-
- :return: The modules converted into a module paths
- """
- self._init()
- return self._normalize_modules(modules)
-
- @classmethod
- def normalize_paraminfo(cls, data):
- """
- Convert both old and new API JSON into a new-ish data structure.
-
- For duplicate paths, the value will be False.
- """
- result_data = {}
- for paraminfo_key, modules_data in data['paraminfo'].items():
- if not modules_data:
- continue
-
- if paraminfo_key[:-len('module')] in cls.root_modules:
- modules_data = [modules_data]
- elif not paraminfo_key.endswith('modules'):
- continue
-
- for mod_data in modules_data:
- if 'missing' in mod_data:
- continue
-
- name = mod_data.get('name')
- php_class = mod_data.get('classname')
-
- if not name and php_class:
- if php_class == 'ApiMain':
- name = 'main'
- elif php_class == 'ApiPageSet':
- name = 'pageset'
- else:
- pywikibot.warning('Unknown paraminfo module "{}"'
- .format(php_class))
- name = '<unknown>:' + php_class
-
- mod_data['name'] = name
-
- if 'path' not in mod_data:
- # query modules often contain 'ApiQuery' and have a suffix.
- # 'ApiQuery' alone is the action 'query'
- if ('querytype' in mod_data
- or php_class and len(php_class) > 8
- and 'ApiQuery' in php_class):
- mod_data['path'] = 'query+' + name
- else:
- mod_data['path'] = name
-
- path = mod_data['path']
-
- if path in result_data:
- # Only warn first time
- if result_data[path] is not False:
- pywikibot.warning('Path "{}" is ambiguous.'
- .format(path))
- else:
- pywikibot.log('Found another path "{}"'.format(path))
- result_data[path] = False
- else:
- result_data[path] = mod_data
-
- return result_data
-
- def __getitem__(self, key):
- """
- Return a paraminfo module for the module path, caching it.
-
- Use the module path, such as 'query+x', to obtain the paraminfo for
- submodule 'x' in the query module.
-
- If the key does not include a '+' and is not present in the top level
- of the API, it will fallback to looking for the key 'query+x'.
- """
- self.fetch({key})
- if key in self._paraminfo:
- return self._paraminfo[key]
- if '+' not in key:
- return self._paraminfo['query+' + key]
- raise KeyError(key)
-
- def __contains__(self, key) -> bool:
- """Return whether the key is valid."""
- try:
- self[key]
- return True
- except KeyError:
- return False
-
- def __len__(self) -> int:
- """Return number of cached modules."""
- return len(self._paraminfo)
-
- def parameter(
- self,
- module: str,
- param_name: str
- ) -> Optional[Dict[str, Any]]:
- """
- Get details about one modules parameter.
-
- Returns None if the parameter does not exist.
-
- :param module: API module name
- :param param_name: parameter name in the module
- :return: metadata that describes how the parameter may be used
- """
- # TODO: the 'description' field of each parameter is not in the default
- # output of v1.25, and can't removed from previous API versions.
- # There should be an option to remove this verbose data from the cached
- # version, for earlier versions of the API, and/or extract any useful
- # data and discard the entire received paraminfo structure. There are
- # also params which are common to many modules, such as those provided
- # by the ApiPageSet php class: titles, pageids, redirects, etc.
- try:
- module = self[module]
- except KeyError:
- raise ValueError("paraminfo for '{}' not loaded".format(module))
-
- try:
- params = module['parameters']
- except KeyError:
- pywikibot.warning("module '{}' has no parameters".format(module))
- return None
-
- param_data = [param for param in params
- if param['name'] == param_name]
-
- if not param_data:
- return None
-
- if len(param_data) != 1:
- raise RuntimeError(
- 'parameter data length is eiter empty or not unique.\n{}'
- .format(param_data))
- return param_data[0]
-
- @property
- def module_paths(self):
- """Set of all modules using their paths."""
- return self._module_set(True)
-
- # As soon as modules() is removed, module_paths and _module_set can be
- # combined, so don't add any code between these two methods.
- def _module_set(self, path):
- # Load the submodules of all action modules available
- self.fetch(self.action_modules)
- modules = set(self.action_modules)
- for parent_module in self._modules:
- submodules = self.submodules(parent_module, path)
- assert not submodules & modules or not path
- modules |= submodules
- return modules
-
- @property
- def action_modules(self):
- """Set of all action modules."""
- self._init()
- return self._action_modules
-
- @property
- def query_modules(self):
- """Set of all query module names without query+ path prefix."""
- return self.submodules('query')
-
- def submodules(self, name: str, path: bool = False) -> set:
- """
- Set of all submodules.
-
- :param name: The name of the parent module.
- :param path: Whether the path and not the name is returned.
- :return: The names or paths of the submodules.
- """
- if name not in self._modules:
- self.fetch([name])
- submodules = self._modules[name]
- if path:
- submodules = self._prefix_submodules(submodules, name)
- return submodules
-
- @staticmethod
- def _prefix_submodules(modules, prefix):
- """Prefix submodules with path."""
- return {'{}+{}'.format(prefix, mod) for mod in modules}
-
- @property
- def prefix_map(self):
- """
- Mapping of module to its prefix for all modules with a prefix.
-
- This loads paraminfo for all modules.
- """
- if not self._prefix_map:
- self._prefix_map = {module: prefix
- for module, prefix
- in self.attributes('prefix').items()
- if prefix}
- return self._prefix_map.copy()
-
- def attributes(self, attribute: str, modules: Optional[set] = None):
- """
- Mapping of modules with an attribute to the attribute value.
-
- It will include all modules which have that attribute set, also if that
- attribute is empty or set to False.
-
- :param attribute: attribute name
- :param modules: modules to include. If None (default), it'll load all
- modules including all submodules using the paths.
- :rtype: dict using modules as keys
- """
- if modules is None:
- modules = self.module_paths
- self.fetch(modules)
-
- return {mod: self[mod][attribute]
- for mod in modules if attribute in self[mod]}
-
-
class OptionSet(MutableMapping):
"""
diff --git a/pywikibot/data/api/_paraminfo.py b/pywikibot/data/api/_paraminfo.py
index ab01827..a884383 100644
--- a/pywikibot/data/api/_paraminfo.py
+++ b/pywikibot/data/api/_paraminfo.py
@@ -1,105 +1,16 @@
-"""Interface to Mediawiki's api.php."""
+"""Object representing API parameter information."""
#
-# (C) Pywikibot team, 2007-2022
+# (C) Pywikibot team, 2014-2022
#
# Distributed under the terms of the MIT license.
#
-import datetime
-import hashlib
-import inspect
-import os
-import pickle
-import pprint
-import re
-import traceback
-from collections.abc import Container, MutableMapping, Sized
-from email.generator import BytesGenerator
-from email.mime.multipart import MIMEMultipart as MIMEMultipartOrig
-from email.mime.nonmultipart import MIMENonMultipart
-from inspect import getfullargspec
-from io import BytesIO
+from collections.abc import Container, Sized
from typing import Any, Optional, Union
-from urllib.parse import unquote, urlencode
-from warnings import warn
import pywikibot
-from pywikibot import config, login
-from pywikibot.backports import Callable, Dict, Match, Tuple, removeprefix
-from pywikibot.comms import http
-from pywikibot.exceptions import (
- Error,
- FatalServerError,
- InvalidTitleError,
- MaxlagTimeoutError,
- NoUsernameError,
- Server414Error,
- Server504Error,
- SiteDefinitionError,
- TimeoutError,
- UnsupportedPageError,
-)
-from pywikibot.family import SubdomainFamily
-from pywikibot.login import LoginStatus
-from pywikibot.textlib import removeHTMLParts
-from pywikibot.tools import PYTHON_VERSION, itergroup
-
-
-lagpattern = re.compile(
- r'Waiting for [\w.: ]+: (?P<lag>\d+(?:\.\d+)?) seconds? lagged')
-
-
-def _invalidate_superior_cookies(family) -> None:
- """
- Clear cookies for site's second level domain.
-
- get_login_token() will generate new cookies needed.
- This is a workaround for requests bug, see :phab:`T224712`
- and https://github.com/psf/requests/issues/5411
- for more details.
- """
- if isinstance(family, SubdomainFamily):
- for cookie in http.cookie_jar:
- if family.domain == cookie.domain:
- http.cookie_jar.clear(cookie.domain, cookie.path, cookie.name)
-
-
-# Bug: T113120, T228841
-# Subclassing necessary to fix bug of the email package in Python 3:
-# see https://bugs.python.org/issue19003
-# see https://bugs.python.org/issue18886
-# The following solution might be removed if the bug is fixed for
-# Python versions which are supported by PWB, probably with Python 3.5
-
-class CTEBinaryBytesGenerator(BytesGenerator):
-
- """Workaround for bug in python 3 email handling of CTE binary."""
-
- def __init__(self, *args, **kwargs) -> None:
- """Initializer."""
- super().__init__(*args, **kwargs)
- self._writeBody = self._write_body
-
- def _write_body(self, msg) -> None:
- if msg['content-transfer-encoding'] == 'binary':
- self._fp.write(msg.get_payload(decode=True))
- else:
- super()._handle_text(msg)
-
-
-class CTEBinaryMIMEMultipart(MIMEMultipartOrig):
-
- """Workaround for bug in python 3 email handling of CTE binary."""
-
- def as_bytes(self, unixfrom: bool = False, policy=None):
- """Return unmodified binary payload."""
- policy = self.policy if policy is None else policy
- fp = BytesIO()
- g = CTEBinaryBytesGenerator(fp, mangle_from_=False, policy=policy)
- g.flatten(self, unixfrom=unixfrom)
- return fp.getvalue()
-
-
-MIMEMultipart = CTEBinaryMIMEMultipart
+from pywikibot import config
+from pywikibot.backports import Dict
+from pywikibot.tools import itergroup
class ParamInfo(Sized, Container):
@@ -672,2553 +583,3 @@
return {mod: self[mod][attribute]
for mod in modules if attribute in self[mod]}
-
-
-class OptionSet(MutableMapping):
-
- """
- A class to store a set of options which can be either enabled or not.
-
- If it is instantiated with the associated site, module and parameter it
- will only allow valid names as options. If instantiated 'lazy loaded' it
- won't checks if the names are valid until the site has been set (which
- isn't required, but recommended). The site can only be set once if it's not
- None and after setting it, any site (even None) will fail.
- """
-
- def __init__(self, site=None,
- module: Optional[str] = None,
- param: Optional[str] = None,
- dict: Optional[dict] = None) -> None:
- """
- Initializer.
-
- If a site is given, the module and param must be given too.
-
- :param site: The associated site
- :type site: pywikibot.site.APISite or None
- :param module: The module name which is used by paraminfo. (Ignored
- when site is None)
- :param param: The parameter name inside the module. That parameter must
- have a 'type' entry. (Ignored when site is None)
- :param dict: The initializing dict which is used for
- :py:obj:`from_dict`
- """
- self._site_set = False
- self._enabled = set()
- self._disabled = set()
- self._set_site(site, module, param)
- if dict:
- self.from_dict(dict)
-
- def _set_site(self, site, module: str, param: str,
- clear_invalid: bool = False):
- """Set the site and valid names.
-
- As soon as the site has been not None, any subsequent calls will fail,
- unless there had been invalid names and a KeyError was thrown.
-
- :param site: The associated site
- :type site: pywikibot.site.APISite
- :param module: The module name which is used by paraminfo.
- :param param: The parameter name inside the module. That parameter must
- have a 'type' entry.
- :param clear_invalid: Instead of throwing a KeyError, invalid names are
- silently removed from the options (disabled by default).
- """
- if self._site_set:
- raise TypeError('The site cannot be set multiple times.')
- # If the entries written to this are valid, it will never be
- # overwritten
- self._valid_enable = set()
- self._valid_disable = set()
- if site is None:
- return
- for type_value in site._paraminfo.parameter(module, param)['type']:
- if type_value[0] == '!':
- self._valid_disable.add(type_value[1:])
- else:
- self._valid_enable.add(type_value)
- if clear_invalid:
- self._enabled &= self._valid_enable
- self._disabled &= self._valid_disable
- else:
- invalid_names = ((self._enabled - self._valid_enable)
- | (self._disabled - self._valid_disable))
- if invalid_names:
- raise KeyError('OptionSet already contains invalid name(s) '
- '"{}"'.format('", "'.join(invalid_names)))
- self._site_set = True
-
- def from_dict(self, dictionary):
- """
- Load options from the dict.
-
- The options are not cleared before. If changes have been made
- previously, but only the dict values should be applied it needs to be
- cleared first.
-
- :param dictionary:
- a dictionary containing for each entry either the value
- False, True or None. The names must be valid depending on whether
- they enable or disable the option. All names with the value None
- can be in either of the list.
- :type dictionary: dict (keys are strings, values are bool/None)
- """
- enabled = set()
- disabled = set()
- removed = set()
- for name, value in dictionary.items():
- if value is True:
- enabled.add(name)
- elif value is False:
- disabled.add(name)
- elif value is None:
- removed.add(name)
- else:
- raise ValueError('Dict contains invalid value "{}"'.format(
- value))
- invalid_names = (
- (enabled - self._valid_enable) | (disabled - self._valid_disable)
- | (removed - self._valid_enable - self._valid_disable)
- )
- if invalid_names and self._site_set:
- raise ValueError('Dict contains invalid name(s) "{}"'.format(
- '", "'.join(invalid_names)))
- self._enabled = enabled | (self._enabled - disabled - removed)
- self._disabled = disabled | (self._disabled - enabled - removed)
-
- def clear(self) -> None:
- """Clear all enabled and disabled options."""
- self._enabled.clear()
- self._disabled.clear()
-
- def __setitem__(self, name, value):
- """Set option to enabled, disabled or neither."""
- if value is True:
- if self._site_set and name not in self._valid_enable:
- raise KeyError('Invalid name "{}"'.format(name))
- self._enabled.add(name)
- self._disabled.discard(name)
- elif value is False:
- if self._site_set and name not in self._valid_disable:
- raise KeyError('Invalid name "{}"'.format(name))
- self._disabled.add(name)
- self._enabled.discard(name)
- elif value is None:
- if self._site_set and (name not in self._valid_enable
- or name not in self._valid_disable):
- raise KeyError('Invalid name "{}"'.format(name))
- self._enabled.discard(name)
- self._disabled.discard(name)
- else:
- raise ValueError('Invalid value "{}"'.format(value))
-
- def __getitem__(self, name) -> Optional[bool]:
- """
- Return whether the option is enabled.
-
- :return: If the name has been set it returns whether it is enabled.
- Otherwise it returns None. If the site has been set it raises a
- KeyError if the name is invalid. Otherwise it might return a value
- even though the name might be invalid.
- """
- if name in self._enabled:
- return True
- if name in self._disabled:
- return False
- if (self._site_set or name in self._valid_enable
- or name in self._valid_disable):
- return None
- raise KeyError('Invalid name "{}"'.format(name))
-
- def __delitem__(self, name) -> None:
- """Remove the item by setting it to None."""
- self[name] = None
-
- def __contains__(self, name) -> bool:
- """Return True if option has been set."""
- return name in self._enabled or name in self._disabled
-
- def __iter__(self):
- """Iterate over each enabled and disabled option."""
- yield from self._enabled
- yield from self._disabled
-
- def api_iter(self):
- """Iterate over each option as they appear in the URL."""
- yield from self._enabled
- for disabled in self._disabled:
- yield '!{}'.format(disabled)
-
- def __len__(self) -> int:
- """Return the number of enabled and disabled options."""
- return len(self._enabled) + len(self._disabled)
-
-
-class Request(MutableMapping):
-
- """A request to a Site's api.php interface.
-
- Attributes of this object (except for the special parameters listed
- below) get passed as commands to api.php, and can be get or set
- using the dict interface. All attributes must be strings. Use an
- empty string for parameters that don't require a value. For example,
- Request(action="query", titles="Foo bar", prop="info", redirects="")
- corresponds to the API request
- "api.php?action=query&titles=Foo%20bar&prop=info&redirects"
-
- This is the lowest-level interface to the API, and can be used for any
- request that a particular site's API supports. See the API documentation
- (https://www.mediawiki.org/wiki/API) and site-specific settings for
- details on what parameters are accepted for each request type.
-
- Uploading files is a special case: to upload, the parameter "mime" must
- contain a dict, and the parameter "file" must be set equal to a valid
- filename on the local computer, _not_ to the content of the file.
-
- Returns a dict containing the JSON data returned by the wiki. Normally,
- one of the dict keys will be equal to the value of the 'action'
- parameter. Errors are caught and raise an APIError exception.
-
- Example:
-
- >>> r = Request(parameters={'action': 'query', 'meta': 'userinfo'})
- >>> # This is equivalent to
- >>> # https://{path}/api.php?action=query&meta=userinfo&format=json
- >>> # change a parameter
- >>> r['meta'] = "userinfo|siteinfo"
- >>> # add a new parameter
- >>> r['siprop'] = "namespaces"
- >>> # note that "uiprop" param gets added automatically
- >>> str(r.action)
- 'query'
- >>> sorted(str(key) for key in r._params.keys())
- ['action', 'meta', 'siprop']
- >>> [str(key) for key in r._params['action']]
- ['query']
- >>> [str(key) for key in r._params['meta']]
- ['userinfo', 'siteinfo']
- >>> [str(key) for key in r._params['siprop']]
- ['namespaces']
- >>> data = r.submit()
- >>> isinstance(data, dict)
- True
- >>> set(['query', 'batchcomplete', 'warnings']).issuperset(data.keys())
- True
- >>> 'query' in data
- True
- >>> sorted(str(key) for key in data['query'].keys())
- ['namespaces', 'userinfo']
-
- """
-
- # To make sure the default value of 'parameters' can be identified.
- _PARAM_DEFAULT = object()
-
- def __init__(self, site=None,
- mime: Optional[dict] = None,
- throttle: bool = True,
- max_retries: Optional[int] = None,
- retry_wait: Optional[int] = None,
- use_get: Optional[bool] = None,
- parameters=_PARAM_DEFAULT, **kwargs) -> None:
- """
- Create a new Request instance with the given parameters.
-
- The parameters for the request can be defined via either the
- 'parameters' parameter or the keyword arguments. The keyword arguments
- were the previous implementation but could cause problems when there
- are arguments to the API named the same as normal arguments to this
- class. So the second parameter 'parameters' was added which just
- contains all parameters. When a Request instance is created it must use
- either one of them and not both at the same time. To have backwards
- compatibility it adds a parameter named 'parameters' to kwargs when
- both parameters are set as that indicates an old call and 'parameters'
- was originally supplied as a keyword parameter.
-
- If undefined keyword arguments were given AND the 'parameters'
- parameter was supplied as a positional parameter it still assumes
- 'parameters' were part of the keyword arguments.
-
- If a class is using Request and is directly forwarding the parameters,
- :py:obj:`Request.clean_kwargs` can be used to automatically
- convert the old kwargs mode into the new parameter mode. This
- normalizes the arguments so that when the API parameters are
- modified the changes can always be applied to the 'parameters'
- parameter.
-
- :param site: The Site to which the request will be submitted. If not
- supplied, uses the user's configured default Site.
- :param mime: If not None, send in "multipart/form-data" format (default
- None). Parameters which should only be transferred via mime
- mode are defined via this parameter (even an empty dict means
- mime shall be used).
- :param max_retries: Maximum number of times to retry after
- errors, defaults to config.max_retries.
- :param retry_wait: Minimum time in seconds to wait after an
- error, defaults to config.retry_wait seconds (doubles each retry
- until config.retry_max seconds is reached).
- :param use_get: Use HTTP GET request if possible. If False it
- uses a POST request. If None, it'll try to determine via
- action=paraminfo if the action requires a POST.
- :param parameters: The parameters used for the request to the API.
- :type parameters: dict
- :param kwargs: The parameters used for the request to the API.
- """
- if site is None:
- self.site = pywikibot.Site()
- warn('Request() invoked without a site; setting to {}'
- .format(self.site), RuntimeWarning, 2)
- else:
- self.site = site
-
- self.mime = mime
- if isinstance(mime, bool):
- raise TypeError('mime param in api.Request() must not be boolean')
-
- self.throttle = throttle
- self.use_get = use_get
- if max_retries is None:
- self.max_retries = pywikibot.config.max_retries
- else:
- self.max_retries = max_retries
- self.current_retries = 0
- if retry_wait is None:
- self.retry_wait = pywikibot.config.retry_wait
- else:
- self.retry_wait = retry_wait
- # The only problem with that system is that it won't detect when
- # 'parameters' is actually the only parameter for the request as it
- # then assumes it's using the new mode (and the parameters are actually
- # in the parameter 'parameters' not that the parameter 'parameters' is
- # actually a parameter for the request). But that is invalid anyway as
- # it MUST have at least an action parameter for the request which would
- # be in kwargs if it's using the old mode.
- if kwargs:
- if parameters is not self._PARAM_DEFAULT:
- # 'parameters' AND kwargs is set. In that case think of
- # 'parameters' being an old kwarg which is now filled in an
- # actual parameter
- self._warn_both()
- kwargs['parameters'] = parameters
- # When parameters wasn't set it's likely that kwargs-mode was used
- self._warn_kwargs()
- parameters = kwargs
- elif parameters is self._PARAM_DEFAULT:
- parameters = {}
- self._params = {}
- if 'action' not in parameters:
- raise ValueError("'action' specification missing from Request.")
- self.action = parameters['action']
- self.update(parameters) # also convert all parameter values to lists
- self._warning_handler = None # type: Optional[Callable[[str, str], Union[Match[str], bool, None]]] # noqa: E501
- # Actions that imply database updates on the server, used for various
- # things like throttling or skipping actions when we're in simulation
- # mode
- self.write = self.action in {
- 'block', 'clearhasmsg', 'createaccount', 'delete', 'edit',
- 'emailuser', 'filerevert', 'flowthank', 'imagerotate', 'import',
- 'managetags', 'mergehistory', 'move', 'options', 'patrol',
- 'protect', 'purge', 'resetpassword', 'revisiondelete', 'rollback',
- 'setnotificationtimestamp', 'setpagelanguage', 'tag', 'thank',
- 'unblock', 'undelete', 'upload', 'userrights', 'watch',
- 'wbcreateclaim', 'wbcreateredirect', 'wbeditentity',
- 'wblinktitles', 'wbmergeitems', 'wbremoveclaims',
- 'wbremovequalifiers', 'wbremovereferences', 'wbsetaliases',
- 'wbsetclaim', 'wbsetclaimvalue', 'wbsetdescription', 'wbsetlabel',
- 'wbsetqualifier', 'wbsetreference', 'wbsetsitelink',
- 'wbladdform', 'wbleditformelements', 'wblmergelexemes',
- 'wblremoveform',
- }
- # Client side verification that the request is being performed
- # by a logged in user, and warn if it isn't a config username.
- if self.write:
- try:
- username = self.site.userinfo['name']
- except KeyError:
- raise Error('API write action attempted without user name')
-
- if 'anon' in self.site.userinfo:
- raise Error("API write action attempted as IP '{}'"
- .format(username))
-
- if not self.site.user() or self.site.username() != username:
- pywikibot.warning(
- 'API write action by unexpected username {} commenced.\n'
- 'userinfo: {!r}'.format(username, self.site.userinfo))
-
- # Make sure user is logged in
- if self.write:
- pywikibot.debug('Adding user assertion')
- self['assert'] = 'user'
-
- @classmethod
- def create_simple(cls, req_site, **kwargs):
- """Create a new instance using all args except site for the API."""
- # This ONLY support site so that any caller can be sure there will be
- # no conflict with PWB parameters
- # req_site is needed to avoid conflicts with possible site keyword in
- # kwarg until positional-only parameters are supported, see T262926
- # TODO: Use ParamInfo request to determine valid parameters
- if isinstance(kwargs.get('parameters'), dict):
- warn('The request contains already a "parameters" entry which is '
- 'a dict.')
- return cls(site=req_site, parameters=kwargs)
-
- @classmethod
- def _warn_both(cls) -> None:
- """Warn that kwargs mode was used but parameters was set too."""
- warn('Both kwargs and parameters are set in Request.__init__. It '
- 'assumes that "parameters" is actually a parameter of the '
- 'Request and is added to kwargs.', DeprecationWarning, 3)
-
- @classmethod
- def _warn_kwargs(cls) -> None:
- """Warn that kwargs was used instead of parameters."""
- warn('Instead of using kwargs from Request.__init__, parameters '
- 'for the request to the API should be added via the '
- '"parameters" parameter.', DeprecationWarning, 3)
-
- @classmethod
- def clean_kwargs(cls, kwargs: dict) -> dict:
- """
- Convert keyword arguments into new parameters mode.
-
- If there are no other arguments in kwargs apart from the used arguments
- by the class' initializer it'll just return kwargs and otherwise remove
- those which aren't in the initializer and put them in a dict which is
- added as a 'parameters' keyword. It will always create a shallow copy.
-
- :param kwargs: The original keyword arguments which is not modified.
- :return: The normalized keyword arguments.
- """
- if 'expiry' in kwargs and kwargs['expiry'] is None:
- del kwargs['expiry']
-
- args = set()
- for super_cls in inspect.getmro(cls):
- if not super_cls.__name__.endswith('Request'):
- break
- args |= set(getfullargspec(super_cls.__init__).args)
- else:
- raise ValueError('Request was not a super class of '
- '{!r}'.format(cls))
- args -= {'self'}
- old_kwargs = set(kwargs)
- # all kwargs defined above but not in args indicate 'kwargs' mode
- if old_kwargs - args:
- # Move all kwargs into parameters
- parameters = {name: value for name, value in kwargs.items()
- if name not in args or name == 'parameters'}
- if 'parameters' in parameters:
- cls._warn_both()
- # Copy only arguments and not the parameters
- kwargs = {name: value for name, value in kwargs.items()
- if name in args or name == 'self'}
- kwargs['parameters'] = parameters
- # Make sure that all arguments have remained
- assert(old_kwargs | {'parameters'}
- == set(kwargs) | set(kwargs['parameters']))
- assert(('parameters' in old_kwargs)
- is ('parameters' in kwargs['parameters']))
- cls._warn_kwargs()
- else:
- kwargs = dict(kwargs)
- kwargs.setdefault('parameters', {})
- return kwargs
-
- def _format_value(self, value):
- """
- Format the MediaWiki API request parameter.
-
- Converts from Python datatypes to MediaWiki API parameter values.
-
- Supports:
- * datetime.datetime (using strftime and ISO8601 format)
- * pywikibot.page.BasePage (using title (+namespace; -section))
-
- All other datatypes are converted to string.
- """
- if isinstance(value, datetime.datetime):
- return value.strftime(pywikibot.Timestamp.ISO8601Format)
- if isinstance(value, pywikibot.page.BasePage):
- if value.site != self.site:
- raise RuntimeError(
- 'value.site {!r} is different from Request.site {!r}'
- .format(value.site, self.site))
- return value.title(with_section=False)
- return str(value)
-
- def __getitem__(self, key):
- """Implement dict interface."""
- return self._params[key]
-
- def __setitem__(self, key: str, value) -> None:
- """Set MediaWiki API request parameter.
-
- :param value: param value(s)
- :type value: str in site encoding
- (string types may be a `|`-separated list)
- iterable, where items are converted to string
- with special handling for datetime.datetime to convert it to a
- string using the ISO 8601 format accepted by the MediaWiki API.
- """
- if isinstance(value, bytes):
- value = value.decode(self.site.encoding())
-
- if isinstance(value, str):
- value = value.split('|')
-
- if hasattr(value, 'api_iter'):
- self._params[key] = value
- else:
- try:
- iter(value)
- except TypeError:
- # convert any non-iterable value into a single-element list
- self._params[key] = [value]
- else:
- self._params[key] = list(value)
-
- def __delitem__(self, key) -> None:
- """Implement dict interface."""
- del self._params[key]
-
- def keys(self):
- """Implement dict interface."""
- return list(self._params.keys())
-
- def __contains__(self, key) -> bool:
- """Implement dict interface."""
- return key in self._params
-
- def __iter__(self):
- """Implement dict interface."""
- return iter(self._params)
-
- def __len__(self) -> int:
- """Implement dict interface."""
- return len(self._params)
-
- def iteritems(self):
- """Implement dict interface."""
- return iter(self._params.items())
-
- def items(self):
- """Return a list of tuples containing the parameters in any order."""
- return list(self._params.items())
-
- def _add_defaults(self):
- """
- Add default parameters to the API request.
-
- This method will only add them once.
- """
- if hasattr(self, '__defaulted'):
- return
-
- if self.mime is not None \
- and set(self._params.keys()) & set(self.mime.keys()):
- raise ValueError('The mime and params shall not share the '
- 'same keys.')
-
- if self.action == 'query':
- meta = self._params.get('meta', [])
- # Special logic for private wikis (T153903).
- # If the wiki requires login privileges to read articles, pywikibot
- # will be blocked from accessing the userinfo.
- # Work around this by requiring userinfo only if 'tokens' and
- # 'login' are not both set.
- typep = self._params.get('type', [])
- if not ('tokens' in meta and 'login' in typep):
- if 'userinfo' not in meta:
- meta = set(meta + ['userinfo'])
- self['meta'] = sorted(meta)
- uiprop = self._params.get('uiprop', [])
- uiprop = set(uiprop + ['blockinfo', 'hasmsg'])
- self['uiprop'] = sorted(uiprop)
- if 'prop' in self._params \
- and self.site.has_extension('ProofreadPage'):
- prop = set(self['prop'] + ['proofread'])
- self['prop'] = sorted(prop)
- # When neither 'continue' nor 'rawcontinue' is present and the
- # version number is at least 1.25wmf5 we add a dummy rawcontinue
- # parameter. Querying siteinfo is save as it adds 'continue'
- # except for 'tokens' (T284577)
- if ('tokens' not in meta and 'continue' not in self._params
- and self.site.mw_version >= '1.25wmf5'):
- self._params.setdefault('rawcontinue', [''])
- elif self.action == 'help' and self.site.mw_version > '1.24':
- self['wrap'] = ''
-
- if config.maxlag:
- self._params.setdefault('maxlag', [str(config.maxlag)])
- self._params.setdefault('format', ['json'])
- if self['format'] != ['json']:
- raise TypeError(
- "Query format '{}' cannot be parsed.".format(self['format']))
-
- self.__defaulted = True # skipcq: PTC-W0037
-
- def _encoded_items(self) -> Dict[str, Union[str, bytes]]:
- """
- Build a dict of params with minimal encoding needed for the site.
-
- This helper method only prepares params for serialisation or
- transmission, so it only encodes values which are not ASCII,
- requiring callers to consider how to handle ASCII vs other values,
- however the output is designed to enable __str__ and __repr__ to
- do the right thing in most circumstances.
-
- Servers which use an encoding that is not a superset of ASCII
- are not supported.
-
- :return: Parameters either in the site encoding, or ASCII strings
- """
- params = {}
- for key, values in self._params.items():
- try:
- iterator = values.api_iter()
- except AttributeError:
- if len(values) == 1:
- value = values[0]
- if value is True:
- values = ['']
- elif value is False or value is None:
- # False and None are not included in the http URI
- continue
- iterator = iter(values)
- value = '|'.join(self._format_value(value) for value in iterator)
- # If the value is encodable as ascii, do not encode it.
- # This means that any value which can be encoded as ascii
- # is presumed to be ascii, and servers using a site encoding
- # which is not a superset of ascii may be problematic.
- try:
- value.encode('ascii')
- except UnicodeError:
- try:
- value = value.encode(self.site.encoding())
- except Exception:
- pywikibot.error(
- "_encoded_items: '{}' could not be encoded as '{}':"
- ' {!r}'.format(key, self.site.encoding(), value))
- assert key.encode('ascii')
- assert isinstance(key, str)
- params[key] = value
- return params
-
- def _http_param_string(self):
- """
- Return the parameters as a HTTP URL query fragment.
-
- URL encodes the parameters provided by _encoded_items()
-
- .. note:: Not all parameters are sorted, therefore for two given
- CachedRequest objects with equal _params, the result of
- _http_param_string() is not necessarily equal.
- """
- return encode_url(self._encoded_items())
-
- def __str__(self) -> str:
- """Return a string representation."""
- return unquote(self.site.scriptpath()
- + '/api.php?'
- + self._http_param_string())
-
- def __repr__(self) -> str:
- """Return internal representation."""
- return '{}.{}<{}->{!r}>'.format(self.__class__.__module__,
- self.__class__.__name__,
- self.site, str(self))
-
- def _simulate(self, action):
- """Simulate action."""
- if action and config.simulate and (
- self.write or action in config.actions_to_block):
- pywikibot.output('<<black;yellow>>SIMULATION: {} action blocked.'
- '<<default>>'.format(action))
- # for more realistic simulation
- if config.simulate is not True:
- pywikibot.sleep(float(config.simulate))
- return {
- action: {'result': 'Success', 'nochange': ''},
-
- # wikibase results
- 'entity': {'lastrevid': -1},
- 'pageinfo': {'lastrevid': -1},
- 'reference': {'hash': -1},
- }
- return None
-
- def _is_wikibase_error_retryable(self, error):
- # dict of error message and current action.
- # Value is True if action type is to be ignored
- err_msg = {
- 'edit-already-exists': 'wbeditentity',
- 'actionthrottledtext': True, # T192912, T268645
- }
- messages = error.get('messages')
- message = None
- # bug T68619; after Wikibase breaking change 1ca9cee we have a
- # list of messages
- if isinstance(messages, list):
- for item in messages:
- message = item['name']
- action = err_msg.get(message)
- if action is True or action == self.action:
- return True
-
- return False
-
- if isinstance(messages, dict):
- try: # behaviour before gerrit 124323 breaking change
- message = messages['0']['name']
- except KeyError: # unsure the new output is always a list
- message = messages['name']
- action = err_msg.get(message)
- return action is True or action == self.action
-
- @staticmethod
- def _generate_mime_part(key, content, keytype=None, headers=None):
- if not keytype:
- try:
- content.encode('ascii')
- keytype = ('text', 'plain')
- except (UnicodeError, AttributeError):
- keytype = ('application', 'octet-stream')
- submsg = MIMENonMultipart(*keytype)
- content_headers = {'name': key}
- if headers:
- content_headers.update(headers)
- submsg.add_header('Content-disposition', 'form-data',
- **content_headers)
-
- if keytype != ('text', 'plain'):
- submsg['Content-Transfer-Encoding'] = 'binary'
-
- submsg.set_payload(content)
- return submsg
-
- def _use_get(self):
- """Verify whether 'get' is to be used."""
- if (not config.enable_GET_without_SSL
- and self.site.protocol() != 'https'
- or self.site.is_oauth_token_available()): # T108182 workaround
- use_get = False
- elif self.use_get is None:
- if self.action == 'query':
- # for queries check the query module
- modules = set()
- for mod_type_name in ('list', 'prop', 'generator'):
- modules.update(self._params.get(mod_type_name, []))
- else:
- modules = {self.action}
- if modules:
- self.site._paraminfo.fetch(modules)
- use_get = all('mustbeposted' not in self.site._paraminfo[mod]
- for mod in modules)
- else:
- # If modules is empty, just 'meta' was given, which doesn't
- # require POSTs, and is required for ParamInfo
- use_get = True
- else:
- use_get = self.use_get
- return use_get
-
- @classmethod
- def _build_mime_request(cls, params: dict,
- mime_params: dict) -> Tuple[dict, bytes]:
- """
- Construct a MIME multipart form post.
-
- :param params: HTTP request params
- :param mime_params: HTTP request parts which must be sent in the body
- :type mime_params: dict of (content, keytype, headers) # noqa: DAR103
- :return: HTTP request headers and body
- """
- # construct a MIME message containing all API key/values
- container = MIMEMultipart(_subtype='form-data')
- for key, value in params.items():
- submsg = cls._generate_mime_part(key, value)
- container.attach(submsg)
- for key, value in mime_params.items():
- submsg = cls._generate_mime_part(key, *value)
- container.attach(submsg)
-
- # strip the headers to get the HTTP message body
- body = container.as_bytes()
- marker = b'\n\n' # separates headers from body
- eoh = body.find(marker)
- body = body[eoh + len(marker):]
- # retrieve the headers from the MIME object
- headers = dict(container.items())
- return headers, body
-
- def _get_request_params(self, use_get, paramstring):
- """Get request parameters."""
- uri = self.site.apipath()
- if self.mime is not None:
- (headers, body) = Request._build_mime_request(
- self._encoded_items(), self.mime)
- use_get = False # MIME requests require HTTP POST
- else:
- headers = {'Content-Type': 'application/x-www-form-urlencoded'}
- if (not self.site.maximum_GET_length()
- or self.site.maximum_GET_length() < len(paramstring)):
- use_get = False
- if use_get:
- uri = '{}?{}'.format(uri, paramstring)
- body = None
- else:
- body = paramstring
-
- pywikibot.debug('API request to {} (uses get: {}):\n'
- 'Headers: {!r}\nURI: {!r}\nBody: {!r}'
- .format(self.site, use_get, headers, uri, body))
- return use_get, uri, body, headers
-
- def _http_request(self, use_get: bool, uri: str, data, headers,
- paramstring) -> tuple:
- """Get or post a http request with exception handling.
-
- :return: a tuple containing requests.Response object from
- http.request and use_get value
- """
- try:
- response = http.request(self.site, uri=uri,
- method='GET' if use_get else 'POST',
- data=data, headers=headers)
- except Server504Error:
- pywikibot.log('Caught HTTP 504 error; retrying')
- except Server414Error:
- if use_get:
- pywikibot.log('Caught HTTP 414 error; retrying')
- use_get = False
- else:
- pywikibot.warning('Caught HTTP 414 error, although not '
- 'using GET.')
- raise
- except (ConnectionError, FatalServerError):
- # This error is not going to be fixed by just waiting
- pywikibot.error(traceback.format_exc())
- raise
- # TODO: what other exceptions can occur here?
- except Exception:
- # for any other error on the http request, wait and retry
- pywikibot.error(traceback.format_exc())
- pywikibot.log('{}, {}'.format(uri, paramstring))
- else:
- return response, use_get
- self.wait()
- return None, use_get
-
- def _json_loads(self, response) -> Optional[dict]:
- """Return a dict from requests.Response.
-
- :param response: a requests.Response object
- :type response: requests.Response
- :return: a data dict
- :raises pywikibot.exceptions.APIError: unknown action found
- :raises pywikibot.exceptions.APIError: unknown query result type
- """
- try:
- result = response.json()
- except ValueError:
- # if the result isn't valid JSON, there may be a server
- # problem. Wait a few seconds and try again
- # Show 20 lines of bare text
- text = '\n'.join(removeHTMLParts(response.text).splitlines()[:20])
- msg = """\
-Non-JSON response received from server {site} for url
-{resp.url}
-The server may be down.
-Status code: {resp.status_code}
-
-The text message is:
-{text}
-""".format(site=self.site, resp=response, text=text)
-
- # Do not retry for AutoFamily but raise a SiteDefinitionError
- # Note: family.AutoFamily is a function to create that class
- if self.site.family.__class__.__name__ == 'AutoFamily':
- pywikibot.debug(msg)
- raise SiteDefinitionError('Invalid AutoFamily({!r})'
- .format(self.site.family.domain))
-
- pywikibot.warning(msg)
-
- # there might also be an overflow, so try a smaller limit
- for param in self._params:
- if param.endswith('limit'):
- # param values are stored a list of str
- value = self[param][0]
- if value.isdigit():
- self[param] = [str(int(value) // 2)]
- pywikibot.output('Set {} = {}'
- .format(param, self[param]))
- else:
- return result or {}
- self.wait()
- return None
-
- def _relogin(self, message: str = '') -> None:
- """Force re-login and inform user."""
- pywikibot.error('{}{}Forcing re-login.'.format(message,
- ' ' if message else ''))
- self.site._relogin()
-
- def _userinfo_query(self, result) -> bool:
- """Handle userinfo query."""
- if self.action == 'query' and 'userinfo' in result.get('query', ()):
- # if we get passed userinfo in the query result, we can confirm
- # that we are logged in as the correct user. If this is not the
- # case, force a re-login.
- username = result['query']['userinfo']['name']
- if (self.site.user() is not None and self.site.user() != username
- and self.site._loginstatus != LoginStatus.IN_PROGRESS):
- message = ("Logged in as '{actual}' instead of '{expected}'."
- .format(actual=username, expected=self.site.user()))
- self._relogin(message)
- return True
- return False
-
- def _handle_warnings(self, result: Dict[str, Any]) -> bool:
- """Handle warnings; return True to retry request, False to resume.
-
- .. versionchanged:: 7.2
- Return True to retry the current request and Falso to resume.
- """
- retry = False
- if 'warnings' not in result:
- return retry
-
- for mod, warning in result['warnings'].items():
- if mod == 'info':
- continue
- if '*' in warning:
- text = warning['*']
- elif 'html' in warning:
- # bug T51978
- text = warning['html']['*']
- else:
- pywikibot.warning('API warning ({}) of unknown format: {}'
- .format(mod, warning))
- continue
-
- # multiple warnings are in text separated by a newline
- for single_warning in text.splitlines():
- if (not callable(self._warning_handler)
- or not self._warning_handler(mod, single_warning)):
- handled = self._default_warning_handler(mod,
- single_warning)
- if handled is None:
- pywikibot.warning('API warning ({}): {}'
- .format(mod, single_warning))
- else:
- retry = retry or handled
- return retry
-
- def _default_warning_handler(self, mode: str, msg: str) -> Optional[bool]:
- """A default warning handler to handle specific warnings.
-
- Return True to retry the request, False to resume and None if
- the warning is not handled.
-
- .. versionadded:: 7.2
- """
- warnings = {
- 'purge': ("You've exceeded your rate limit. "
- 'Please wait some time and try again.',
- '_ratelimited', True),
- }
- warning, handler, retry = warnings.get(mode, (None, None, None))
- if handler and msg == warning:
- # Only show the first warning part
- pywikibot.warning(msg.split('.')[0] + '.')
- # call the handler
- getattr(self, handler)()
- return retry
- return None
-
- def _logged_in(self, code) -> bool:
- """Check whether user is logged in.
-
- Older wikis returned an error instead of a warning when the request
- asked for too many values. If we get this error, assume we are not
- logged in (we can't check this because the userinfo data is not
- present) and force a re-login
- """
- if code.endswith('limit'):
- message = 'Received API limit error.'
-
- # If the user assertion failed, we're probably logged out as well.
- elif code == 'assertuserfailed':
- message = 'User assertion failed.'
-
- # Lastly, the purge module requires a POST if used as anonymous user,
- # but we normally send a GET request. If the API tells us the request
- # has to be POSTed, we're probably logged out.
- elif code == 'mustbeposted' and self.action == 'purge':
- message = "Received unexpected 'mustbeposted' error."
-
- else:
- return True
-
- self._relogin(message)
- return False
-
- def _internal_api_error(self, code, error, result) -> bool:
- """Check for internal_api_error_ or readonly and retry.
-
- :raises pywikibot.exceptions.APIMWError: internal_api_error or readonly
- """
- iae = 'internal_api_error_'
- if not (code.startswith(iae) or code == 'readonly'):
- return False
-
- # T154011
- class_name = code if code == 'readonly' else removeprefix(code, iae)
-
- del error['code'] # is added via class_name
- e = pywikibot.exceptions.APIMWError(class_name, **error)
-
- # If the error key is in this table, it is probably a temporary
- # problem, so we will retry the edit.
- # TODO: T154011: 'ReadOnlyError' seems replaced by 'readonly'
- retry = class_name in ['DBConnectionError', # T64974
- 'DBQueryError', # T60158
- 'DBQueryTimeoutError', # T297708
- 'ReadOnlyError', # T61227
- 'readonly', # T154011
- ]
-
- pywikibot.error('Detected MediaWiki API exception {}{}'
- .format(e, '; retrying' if retry else '; raising'))
- param_repr = str(self._params)
- pywikibot.log('MediaWiki exception {} details:\n'
- ' query=\n{}\n'
- ' response=\n{}'
- .format(class_name,
- pprint.pformat(param_repr),
- result))
- if not retry:
- raise e
-
- self.wait()
- return True
-
- def _ratelimited(self) -> None:
- """Handle ratelimited warning."""
- ratelimits = self.site.userinfo['ratelimits']
- delay = None
-
- ratelimit = ratelimits.get(self.action, {})
- # find the lowest wait time for the given action
- for limit in ratelimit.values():
- seconds = limit['seconds']
- hits = limit['hits']
- delay = min(delay or seconds, seconds / hits)
-
- if not delay:
- pywikibot.warning(
- 'No rate limit found for action {}'.format(self.action))
- self.wait(delay)
-
- def _bad_token(self, code) -> bool:
- """Check for bad token."""
- if code != 'badtoken': # Other code not handled here
- return False
-
- if self.site._loginstatus == LoginStatus.IN_PROGRESS:
- pywikibot.log('Login status: {}'
- .format(self.site._loginstatus.name))
- return False
-
- user_tokens = self.site.tokens._tokens[self.site.user()]
- # all token values mapped to their type
- tokens = {token: t_type for t_type, token in user_tokens.items()}
- # determine which tokens are bad
- invalid_param = {name: tokens[param[0]]
- for name, param in self._params.items()
- if len(param) == 1 and param[0] in tokens}
- # doesn't care about the cache so can directly load them
- if invalid_param:
- pywikibot.log(
- 'Bad token error for {}. Tokens for "{}" used in request; '
- 'invalidated them.'
- .format(self.site.user(),
- '", "'.join(sorted(set(invalid_param.values())))))
- # invalidate superior wiki cookies (T224712)
- _invalidate_superior_cookies(self.site.family)
- # request new token(s) instead of invalid
- self.site.tokens.load_tokens(set(invalid_param.values()))
- # fix parameters; lets hope that it doesn't mistake actual
- # parameters as tokens
- for name, t_type in invalid_param.items():
- self[name] = self.site.tokens[t_type]
- return True
-
- # otherwise couldn't find any … weird there is nothing what
- # can be done here because it doesn't know which parameters
- # to fix
- pywikibot.log(
- 'Bad token error for {} but no parameter is using a '
- 'token. Current tokens: {}'
- .format(self.site.user(),
- ', '.join('{}: {}'.format(*e)
- for e in user_tokens.items())))
- return False
-
- def submit(self) -> dict:
- """
- Submit a query and parse the response.
-
- :return: a dict containing data retrieved from api.php
- """
- self._add_defaults()
- use_get = self._use_get()
- retries = 0
- while True:
- paramstring = self._http_param_string()
-
- simulate = self._simulate(self.action)
- if simulate:
- return simulate
-
- if self.throttle:
- self.site.throttle(write=self.write)
- else:
- pywikibot.log(
- "Submitting unthrottled action '{}'.".format(self.action))
-
- use_get, uri, body, headers = self._get_request_params(use_get,
- paramstring)
- response, use_get = self._http_request(use_get, uri, body, headers,
- paramstring)
- if response is None:
- continue
-
- result = self._json_loads(response)
- if result is None:
- continue
-
- if self._userinfo_query(result):
- continue
-
- if self._handle_warnings(result):
- continue
-
- if 'error' not in result:
- return result
-
- error = result['error'].copy()
- for key in result:
- if key in ('error', 'warnings'):
- continue
- assert key not in error
- assert isinstance(result[key], str), \
- 'Unexpected {}: {!r}'.format(key, result[key])
- error[key] = result[key]
-
- if '*' in result['error']:
- # help text returned
- result['error']['help'] = result['error'].pop('*')
- code = result['error'].setdefault('code', 'Unknown')
- info = result['error'].setdefault('info', None)
-
- if not self._logged_in(code):
- continue
-
- if code == 'maxlag':
- retries += 1
- if retries > max(5, pywikibot.config.max_retries):
- break
- pywikibot.log('Pausing due to database lag: ' + info)
-
- try:
- lag = result['error']['lag']
- except KeyError:
- lag = lagpattern.search(info)
- lag = float(lag.group('lag')) if lag else 0.0
-
- self.site.throttle.lag(lag * retries)
- continue
-
- if code == 'help' and self.action == 'help':
- # The help module returns an error result with the complete
- # API information. As this data was requested, return the
- # data instead of raising an exception.
- return {'help': {'mime': 'text/plain',
- 'help': result['error']['help']}}
-
- pywikibot.warning('API error {}: {}'.format(code, info))
- pywikibot.log(' headers=\n{}'.format(response.headers))
-
- if self._internal_api_error(code, error, result):
- continue
-
- # Phab. tickets T48535, T64126, T68494, T68619
- if code == 'failed-save' \
- and self._is_wikibase_error_retryable(result['error']):
- self.wait()
- continue
-
- if code == 'ratelimited':
- self._ratelimited()
- continue
-
- # If readapidenied is returned try to login
- if code == 'readapidenied' \
- and self.site._loginstatus in (LoginStatus.NOT_ATTEMPTED,
- LoginStatus.NOT_LOGGED_IN):
- self.site.login()
- continue
-
- if self._bad_token(code):
- continue
-
- if 'mwoauth-invalid-authorization' in code:
- if 'Nonce already used' in info:
- pywikibot.error(
- 'Retrying failed OAuth authentication for {}: {}'
- .format(self.site, info))
- continue
- raise NoUsernameError('Failed OAuth authentication for {}: {}'
- .format(self.site, info))
- if code == 'cirrussearch-too-busy-error': # T170647
- self.wait()
- continue
-
- if code in ('search-title-disabled', 'search-text-disabled'):
- prefix = 'gsr' if 'gsrsearch' in self._params else 'sr'
- del self._params[prefix + 'what']
- # use intitle: search instead
- if code == 'search-title-disabled' \
- and self.site.has_extension('CirrusSearch'):
- key = prefix + 'search'
- self._params[key] = ['intitle:' + search
- for search in self._params[key]]
- continue
-
- if code == 'urlshortener-blocked': # T244062
- # add additional informations to result['error']
- result['error']['current site'] = self.site
- if self.site.user():
- result['error']['current user'] = self.site.user()
- else: # not logged in; show the IP
- uinfo = self.site.userinfo
- result['error']['current user'] = uinfo['name']
-
- # raise error
- try:
- param_repr = str(self._params)
- pywikibot.log('API Error: query=\n{}'
- .format(pprint.pformat(param_repr)))
- pywikibot.log(' response=\n{}'.format(result))
-
- raise pywikibot.exceptions.APIError(**result['error'])
- except TypeError:
- raise RuntimeError(result)
-
- msg = 'Maximum retries attempted due to maxlag without success.'
- if os.environ.get('PYWIKIBOT_TESTS_RUNNING', '0') == '1':
- import unittest
- raise unittest.SkipTest(msg)
-
- raise MaxlagTimeoutError(msg)
-
- def wait(self, delay=None):
- """Determine how long to wait after a failed request."""
- self.current_retries += 1
- if self.current_retries > self.max_retries:
- raise TimeoutError('Maximum retries attempted without success.')
-
- # double the next wait, but do not exceed config.retry_max seconds
- delay = delay or self.retry_wait
- delay *= 2 ** (self.current_retries - 1)
- delay = min(delay, config.retry_max)
-
- pywikibot.warning('Waiting {:.1f} seconds before retrying.'
- .format(delay))
- pywikibot.sleep(delay)
-
-
-class CachedRequest(Request):
-
- """Cached request."""
-
- def __init__(self, expiry, *args, **kwargs) -> None:
- """Initialize a CachedRequest object.
-
- :param expiry: either a number of days or a datetime.timedelta object
- """
- assert expiry is not None
- super().__init__(*args, **kwargs)
- if not isinstance(expiry, datetime.timedelta):
- expiry = datetime.timedelta(expiry)
- self.expiry = min(expiry, datetime.timedelta(config.API_config_expiry))
- self._data = None
- self._cachetime = None
-
- @classmethod
- def create_simple(cls, req_site, **kwargs):
- """Unsupported as it requires at least two parameters."""
- raise NotImplementedError('CachedRequest cannot be created simply.')
-
- @classmethod
- def _get_cache_dir(cls) -> str:
- """
- Return the base directory path for cache entries.
-
- The directory will be created if it does not already exist.
-
- :return: base directory path for cache entries
- """
- path = os.path.join(config.base_dir,
- 'apicache-py{:d}'.format(PYTHON_VERSION[0]))
- cls._make_dir(path)
- cls._get_cache_dir = classmethod(lambda c: path) # cache the result
- return path
-
- @staticmethod
- def _make_dir(dir_name: str) -> str:
- """Create directory if it does not exist already.
-
- .. versionchanged:: 7.0
- Only `FileExistsError` is ignored but other OS exceptions can
- be still raised
-
- :param dir_name: directory path
- :return: unmodified directory name for test purpose
- """
- os.makedirs(dir_name, exist_ok=True)
- return dir_name
-
- def _uniquedescriptionstr(self) -> str:
- """Return unique description for the cache entry.
-
- If this is modified, please also update
- scripts/maintenance/cache.py to support
- the new key and all previous keys.
- """
- login_status = self.site._loginstatus
-
- if login_status >= LoginStatus.AS_USER:
- # This uses the format of Page.__repr__, without performing
- # config.console_encoding as done by Page.__repr__.
- # The returned value can't be encoded to anything other than
- # ascii otherwise it creates an exception when _create_file_name()
- # tries to encode it as utf-8.
- user_key = 'User(User:{})'.format(self.site.userinfo['name'])
- else:
- user_key = repr(LoginStatus(LoginStatus.NOT_LOGGED_IN))
-
- request_key = repr(sorted(self._encoded_items().items()))
- return '{!r}{}{}'.format(self.site, user_key, request_key)
-
- def _create_file_name(self) -> str:
- """Return a unique ascii identifier for the cache entry."""
- return hashlib.sha256(
- self._uniquedescriptionstr().encode('utf-8')
- ).hexdigest()
-
- def _cachefile_path(self):
- return os.path.join(CachedRequest._get_cache_dir(),
- self._create_file_name())
-
- def _expired(self, dt):
- return dt + self.expiry < datetime.datetime.utcnow()
-
- def _load_cache(self) -> bool:
- """Load cache entry for request, if available.
-
- :return: Whether the request was loaded from the cache
- """
- self._add_defaults()
- try:
- filename = self._cachefile_path()
- with open(filename, 'rb') as f:
- uniquedescr, self._data, self._cachetime = pickle.load(f)
- if uniquedescr != self._uniquedescriptionstr():
- raise RuntimeError('Expected unique description for the cache '
- 'entry is different from file entry.')
- if self._expired(self._cachetime):
- self._data = None
- return False
- pywikibot.debug('{}: cache hit ({}) for API request: {}'
- .format(self.__class__.__name__, filename,
- uniquedescr))
- return True
- except OSError:
- # file not found
- return False
- except Exception as e:
- pywikibot.output('Could not load cache: {!r}'.format(e))
- return False
-
- def _write_cache(self, data) -> None:
- """Write data to self._cachefile_path()."""
- data = (self._uniquedescriptionstr(), data, datetime.datetime.utcnow())
- with open(self._cachefile_path(), 'wb') as f:
- pickle.dump(data, f, protocol=config.pickle_protocol)
-
- def submit(self):
- """Submit cached request."""
- cached_available = self._load_cache()
- if not cached_available:
- self._data = super().submit()
- self._write_cache(self._data)
- else:
- self._handle_warnings(self._data)
- return self._data
-
-
-class _RequestWrapper:
-
- """A wrapper class to handle the usage of the ``parameters`` parameter."""
-
- def _clean_kwargs(self, kwargs, **mw_api_args):
- """Clean kwargs, define site and request class."""
- if 'site' not in kwargs:
- warn('{} invoked without a site'.format(self.__class__.__name__),
- RuntimeWarning, 3)
- kwargs['site'] = pywikibot.Site()
- assert(not hasattr(self, 'site') or self.site == kwargs['site'])
- self.site = kwargs['site']
- self.request_class = kwargs['site']._request_class(kwargs)
- kwargs = self.request_class.clean_kwargs(kwargs)
- kwargs['parameters'].update(mw_api_args)
- return kwargs
-
- def set_maximum_items(self, value: Union[int, str, None]) -> None:
- raise NotImplementedError
-
-
-class APIGenerator(_RequestWrapper):
-
- """
- Iterator that handle API responses containing lists.
-
- The iterator will iterate each item in the query response and use the
- continue request parameter to retrieve the next portion of items
- automatically. If the limit attribute is set, the iterator will stop
- after iterating that many values.
- """
-
- def __init__(
- self,
- action: str,
- continue_name: str = 'continue',
- limit_name: str = 'limit',
- data_name: str = 'data',
- **kwargs
- ) -> None:
- """
- Initialize an APIGenerator object.
-
- kwargs are used to create a Request object; see that object's
- documentation for values.
-
- :param action: API action name.
- :param continue_name: Name of the continue API parameter.
- :param limit_name: Name of the limit API parameter.
- :param data_name: Name of the data in API response.
- """
- kwargs = self._clean_kwargs(kwargs, action=action)
-
- self.continue_name = continue_name
- self.limit_name = limit_name
- self.data_name = data_name
-
- if config.step > 0:
- self.query_increment = config.step
- else:
- self.query_increment = None
- self.limit = None
- self.starting_offset = kwargs['parameters'].pop(self.continue_name, 0)
- self.request = self.request_class(**kwargs)
- self.request[self.limit_name] = self.query_increment
-
- def set_query_increment(self, value: int) -> None:
- """
- Set the maximum number of items to be retrieved per API query.
-
- If not called, the default is config.step.
-
- :param value: The value of maximum number of items to be retrieved
- per API request to set.
- """
- self.query_increment = int(value)
- self.request[self.limit_name] = self.query_increment
- pywikibot.debug('{}: Set query_increment to {}.'
- .format(type(self).__name__, self.query_increment))
-
- def set_maximum_items(self, value: Union[int, str, None]) -> None:
- """
- Set the maximum number of items to be retrieved from the wiki.
-
- If not called, most queries will continue as long as there is
- more data to be retrieved from the API.
-
- :param value: The value of maximum number of items to be retrieved
- in total to set. Ignores None value.
- """
- if value is not None and int(value) > 0:
- self.limit = int(value)
- if self.query_increment and self.limit < self.query_increment:
- self.request[self.limit_name] = self.limit
- pywikibot.debug('{}: Set request item limit to {}'
- .format(type(self).__name__, self.limit))
- pywikibot.debug('{}: Set limit (maximum_items) to {}.'
- .format(type(self).__name__, self.limit))
-
- def __iter__(self):
- """
- Submit request and iterate the response.
-
- Continues response as needed until limit (if defined) is reached.
- """
- offset = self.starting_offset
- n = 0
- while True:
- self.request[self.continue_name] = offset
- pywikibot.debug('{}: Request: {}'
- .format(type(self).__name__, self.request))
- data = self.request.submit()
-
- n_items = len(data[self.data_name])
- pywikibot.debug('{}: Retrieved {} items'
- .format(type(self).__name__, n_items))
- if n_items > 0:
- for item in data[self.data_name]:
- yield item
- n += 1
- if self.limit is not None and n >= self.limit:
- pywikibot.debug('{}: Stopped iterating due to '
- 'exceeding item limit.'
- .format(type(self).__name__))
- return
- offset += n_items
- else:
- pywikibot.debug('{}: Stopped iterating due to empty list in '
- 'response.'.format(type(self).__name__))
- break
-
-
-class QueryGenerator(_RequestWrapper):
-
- """
- Base class for iterators that handle responses to API action=query.
-
- By default, the iterator will iterate each item in the query response,
- and use the (query-)continue element, if present, to continue iterating as
- long as the wiki returns additional values. However, if the iterator's
- limit attribute is set to a positive int, the iterator will stop after
- iterating that many values. If limit is negative, the limit parameter
- will not be passed to the API at all.
-
- Most common query types are more efficiently handled by subclasses, but
- this class can be used directly for custom queries and miscellaneous
- types (such as "meta=...") that don't return the usual list of pages or
- links. See the API documentation for specific query options.
-
- """
-
- # Should results be filtered during iteration according to set_namespace?
- # Used if the API module does not support multiple namespaces.
- # Override in subclasses by defining a function that returns True if
- # the result's namespace is in self._namespaces.
- _check_result_namespace = NotImplemented
-
- # Set of allowed namespaces will be assigned to _namespaces during
- # set_namespace call. Only to be used by _check_result_namespace.
- _namespaces = None
-
- def __init__(self, **kwargs) -> None:
- """
- Initialize a QueryGenerator object.
-
- kwargs are used to create a Request object; see that object's
- documentation for values. 'action'='query' is assumed.
-
- """
- if not hasattr(self, 'site'):
- kwargs = self._clean_kwargs(kwargs) # hasn't been called yet
- parameters = kwargs['parameters']
- if 'action' in parameters and parameters['action'] != 'query':
- raise Error("{}: 'action' must be 'query', not {}"
- .format(self.__class__.__name__, kwargs['action']))
- parameters['action'] = 'query'
- # make sure request type is valid, and get limit key if any
- for modtype in ('generator', 'list', 'prop', 'meta'):
- if modtype in parameters:
- self.modules = parameters[modtype].split('|')
- break
- else:
- raise Error('{}: No query module name found in arguments.'
- .format(self.__class__.__name__))
-
- parameters['indexpageids'] = True # always ask for list of pageids
- self.continue_name = 'continue'
- self.continue_update = self._continue
- # Explicitly enable the simplified continuation
- parameters['continue'] = True
- self.request = self.request_class(**kwargs)
-
- self.site._paraminfo.fetch('query+' + mod for mod in self.modules)
-
- limited_modules = {mod for mod in self.modules
- if self.site._paraminfo.parameter('query+' + mod,
- 'limit')}
-
- if not limited_modules:
- self.limited_module = None
- elif len(limited_modules) == 1:
- self.limited_module = limited_modules.pop()
- else:
- # Select the first limited module in the request.
- # Query will continue as needed until limit (if any) for this
- # module is reached.
- for module in self.modules:
- if module in limited_modules:
- self.limited_module = module
- limited_modules.remove(module)
- break
- pywikibot.log('{}: multiple requested query modules support limits'
- "; using the first such module '{}' of {!r}"
- .format(self.__class__.__name__, self.limited_module,
- self.modules))
-
- # Set limits for all remaining limited modules to max value.
- # Default values will only cause more requests and make the query
- # slower.
- for module in limited_modules:
- param = self.site._paraminfo.parameter('query+' + module,
- 'limit')
- prefix = self.site._paraminfo['query+' + module]['prefix']
- if self.site.logged_in() \
- and self.site.has_right('apihighlimits'):
- self.request[prefix + 'limit'] = int(param['highmax'])
- else:
- self.request[prefix + 'limit'] = int(param['max'])
-
- if config.step > 0:
- self.api_limit = config.step
- else:
- self.api_limit = None
-
- if self.limited_module:
- self.prefix = self.site._paraminfo['query+'
- + self.limited_module]['prefix']
- self._update_limit()
-
- if self.api_limit is not None and 'generator' in parameters:
- self.prefix = 'g' + self.prefix
-
- self.limit = None
- self.query_limit = self.api_limit
- if 'generator' in parameters:
- # name of the "query" subelement key to look for when iterating
- self.resultkey = 'pages'
- else:
- self.resultkey = self.modules[0]
-
- # usually the (query-)continue key is the same as the querymodule,
- # but not always
- # API can return more than one query-continue key, if multiple
- # properties are requested by the query, e.g.
- # "query-continue":{
- # "langlinks":{"llcontinue":"12188973|pt"},
- # "templates":{"tlcontinue":"310820|828|Namespace_detect"}}
- # self.continuekey is a list
- self.continuekey = self.modules
- self._add_slots()
-
- def _add_slots(self) -> None:
- """Add slots to params if the site supports multi-content revisions.
-
- On MW 1.32+ the following query parameters require slots to be given
- when content or contentmodel is requested.
-
- * prop=revisions
- * prop=deletedrevisions or
- * list=allrevisions
- * list=alldeletedrevisions
-
- More info:
- https://lists.wikimedia.org/hyperkitty/list/mediawiki-api-announce@lists.wi…
- """
- if self.site.mw_version < '1.32':
- return
- request = self.request
- # If using any deprecated_params, do not add slots. Usage of
- # these parameters together with slots is forbidden and the user will
- # get an API warning anyway.
- props = request.get('prop')
- if props:
- if 'revisions' in props:
- deprecated_params = {
- 'rvexpandtemplates', 'rvparse', 'rvdiffto', 'rvdifftotext',
- 'rvdifftotextpst', 'rvcontentformat', 'parsetree'}
- if not set(request) & deprecated_params:
- request['rvslots'] = '*'
- if 'deletedrevisions' in props:
- deprecated_params = {
- 'drvexpandtemplates', 'drvparse', 'drvdiffto',
- 'drvdifftotext', 'drvdifftotextpst', 'drvcontentformat',
- 'parsetree'}
- if not set(request) & deprecated_params:
- request['drvslots'] = '*'
- lists = request.get('list')
- if lists:
- if 'allrevisions' in lists:
- deprecated_params = {
- 'arvexpandtemplates', 'arvparse', 'arvdiffto',
- 'arvdifftotext', 'arvdifftotextpst', 'arvcontentformat',
- 'parsetree'}
- if not set(request) & deprecated_params:
- request['arvslots'] = '*'
- if 'alldeletedrevisions' in lists:
- deprecated_params = {
- 'adrexpandtemplates', 'adrparse', 'adrdiffto',
- 'adrdifftotext', 'adrdifftotextpst', 'adrcontentformat',
- 'parsetree'}
- if not set(request) & deprecated_params:
- request['adrslots'] = '*'
-
- def set_query_increment(self, value) -> None:
- """Set the maximum number of items to be retrieved per API query.
-
- If not called, the default is to ask for "max" items and let the
- API decide how many to send.
- """
- limit = int(value)
-
- # don't update if limit is greater than maximum allowed by API
- if self.api_limit is None:
- self.query_limit = limit
- else:
- self.query_limit = min(self.api_limit, limit)
- pywikibot.debug('{}: Set query_limit to {}.'
- .format(type(self).__name__, self.query_limit))
-
- def set_maximum_items(self, value: Union[int, str, None]) -> None:
- """Set the maximum number of items to be retrieved from the wiki.
-
- If not called, most queries will continue as long as there is
- more data to be retrieved from the API.
-
- If set to -1 (or any negative value), the "limit" parameter will be
- omitted from the request. For some request types (such as
- prop=revisions), this is necessary to signal that only current
- revision is to be returned.
-
- :param value: The value of maximum number of items to be retrieved
- in total to set. Ignores None value.
- """
- if value is not None:
- self.limit = int(value)
-
- def _update_limit(self) -> None:
- """Set query limit for self.module based on api response."""
- param = self.site._paraminfo.parameter('query+' + self.limited_module,
- 'limit')
- if self.site.logged_in() and self.site.has_right('apihighlimits'):
- limit = int(param['highmax'])
- else:
- limit = int(param['max'])
- if self.api_limit is None or limit < self.api_limit:
- self.api_limit = limit
- pywikibot.debug('{}: Set query_limit to {}.'
- .format(type(self).__name__, self.api_limit))
-
- def support_namespace(self) -> bool:
- """Check if namespace is a supported parameter on this query.
-
- Note: this function will be removed when self.set_namespace() will
- throw TypeError() instead of just giving a warning.
- See T196619.
-
- :return: True if yes, False otherwise
- """
- assert self.limited_module # some modules do not have a prefix
- return bool(
- self.site._paraminfo.parameter('query+' + self.limited_module,
- 'namespace'))
-
- def set_namespace(self, namespaces):
- """Set a namespace filter on this query.
-
- :param namespaces: namespace identifiers to limit query results
- :type namespaces: iterable of str or Namespace key, or a single
- instance of those types. May be a '|' separated list of
- namespace identifiers. An empty iterator clears any
- namespace restriction.
- :raises KeyError: a namespace identifier was not resolved
- """
- # TODO: T196619
- # :raises TypeError: module does not support a namespace parameter
- # or a namespace identifier has an inappropriate
- # type such as NoneType or bool, or more than one namespace
- # if the API module does not support multiple namespaces
- assert self.limited_module # some modules do not have a prefix
- param = self.site._paraminfo.parameter('query+' + self.limited_module,
- 'namespace')
- if not param:
- pywikibot.warning('{} module does not support a namespace '
- 'parameter'.format(self.limited_module))
- warn('set_namespace() will be modified to raise TypeError '
- 'when namespace parameter is not supported. '
- 'It will be a Breaking Change, please update your code '
- 'ASAP, due date July, 31st 2019.', FutureWarning, 2)
-
- # TODO: T196619
- # raise TypeError('{} module does not support a namespace '
- # 'parameter'.format(self.limited_module))
-
- return False
-
- if isinstance(namespaces, str):
- namespaces = namespaces.split('|')
-
- # Use Namespace id (int) here; Request will cast int to str
- namespaces = [ns.id for ns in
- self.site.namespaces.resolve(namespaces)]
-
- if 'multi' not in param and len(namespaces) != 1:
- if self._check_result_namespace is NotImplemented:
- raise TypeError('{} module does not support multiple '
- 'namespaces'.format(self.limited_module))
- self._namespaces = set(namespaces)
- namespaces = None
-
- if namespaces:
- self.request[self.prefix + 'namespace'] = namespaces
- elif self.prefix + 'namespace' in self.request:
- del self.request[self.prefix + 'namespace']
-
- return None
-
- def _query_continue(self) -> bool:
- if all(key not in self.data[self.continue_name]
- for key in self.continuekey):
- pywikibot.log(
- "Missing '{}' key(s) in ['{}'] value."
- .format(self.continuekey, self.continue_name))
- return True
-
- for query_continue_pair in self.data['query-continue'].values():
- self._add_continues(query_continue_pair)
- return False # a new request with query-continue is needed
-
- def _continue(self) -> bool:
- self._add_continues(self.data['continue'])
- return False # a new request with continue is needed
-
- def _add_continues(self, continue_pair) -> None:
- for key, value in continue_pair.items():
- # query-continue can return ints (continue too?)
- if isinstance(value, int):
- value = str(value)
- self.request[key] = value
-
- def _handle_query_limit(self, prev_limit, new_limit, had_data):
- """Handle query limit."""
- if self.query_limit is None or self.limited_module is None:
- return prev_limit, new_limit
-
- prev_limit = new_limit
- if self.limit is None:
- new_limit = self.query_limit
- elif self.limit > 0:
- if had_data:
- # self.resultkey in data in last request.submit()
- new_limit = min(self.query_limit, self.limit - self._count)
- else:
- # only "(query-)continue" returned. See Bug T74209.
- # increase new_limit to advance faster until new
- # useful data are found again.
- new_limit = min(new_limit * 2, self.query_limit)
- else:
- new_limit = None
-
- if new_limit and 'rvprop' in self.request \
- and 'content' in self.request['rvprop']:
- # queries that retrieve page content have lower limits
- # Note: although API allows up to 500 pages for content
- # queries, these sometimes result in server-side errors
- # so use 250 as a safer limit
- new_limit = min(new_limit, self.api_limit // 10, 250)
-
- if new_limit is not None:
- self.request[self.prefix + 'limit'] = str(new_limit)
-
- if prev_limit != new_limit:
- pywikibot.debug(
- '{name}: query_limit: {query}, api_limit: {api}, '
- 'limit: {limit}, new_limit: {new}, count: {count}\n'
- '{name}: {prefix}limit: {value}'
- .format(name=self.__class__.__name__,
- query=self.query_limit,
- api=self.api_limit,
- limit=self.limit,
- new=new_limit,
- count=self._count,
- prefix=self.prefix,
- value=self.request[self.prefix + 'limit']))
- return prev_limit, new_limit
-
- def _get_resultdata(self):
- """Get resultdata and verify result."""
- resultdata = keys = self.data['query'][self.resultkey]
- if isinstance(resultdata, dict):
- keys = list(resultdata.keys())
- if 'results' in resultdata:
- resultdata = resultdata['results']
- elif 'pageids' in self.data['query']:
- # this ensures that page data will be iterated
- # in the same order as received from server
- resultdata = [resultdata[k]
- for k in self.data['query']['pageids']]
- else:
- resultdata = [resultdata[k]
- for k in sorted(resultdata.keys())]
- pywikibot.debug('{name} received {keys}; limit={limit}'
- .format(name=type(self).__name__, keys=keys,
- limit=self.limit))
- return resultdata
-
- def _extract_results(self, resultdata):
- """Extract results from resultdata."""
- for item in resultdata:
- result = self.result(item)
- if self._namespaces and not self._check_result_namespace(result):
- continue
-
- yield result
- if isinstance(item, dict) \
- and set(self.continuekey) & set(item.keys()):
- # if we need to count elements contained in items in
- # self.data["query"]["pages"], we want to count
- # item[self.continuekey] (e.g. 'revisions') and not
- # self.resultkey (i.e. 'pages')
- for key in set(self.continuekey) & set(item.keys()):
- self._count += len(item[key])
- # otherwise we proceed as usual
- else:
- self._count += 1
- # note: self.limit could be -1
- if self.limit and 0 < self.limit <= self._count:
- raise RuntimeError(
- 'QueryGenerator._extract_results reached the limit')
-
- def __iter__(self):
- """Submit request and iterate the response based on self.resultkey.
-
- Continues response as needed until limit (if any) is reached.
-
- """
- previous_result_had_data = True
- prev_limit = new_limit = None
-
- self._count = 0
- while True:
- prev_limit, new_limit = self._handle_query_limit(
- prev_limit, new_limit, previous_result_had_data)
- if not hasattr(self, 'data'):
- self.data = self.request.submit()
- if not self.data or not isinstance(self.data, dict):
- pywikibot.debug(
- '{}: stopped iteration because no dict retrieved from api.'
- .format(type(self).__name__))
- return
-
- if 'query' in self.data and self.resultkey in self.data['query']:
- resultdata = self._get_resultdata()
- if 'normalized' in self.data['query']:
- self.normalized = {
- item['to']: item['from']
- for item in self.data['query']['normalized']}
- else:
- self.normalized = {}
- try:
- yield from self._extract_results(resultdata)
- except RuntimeError:
- return
- # self.resultkey in data in last request.submit()
- previous_result_had_data = True
- else:
- if 'query' not in self.data:
- pywikibot.log("%s: 'query' not found in api response." %
- self.__class__.__name__)
- pywikibot.log(str(self.data))
- # if (query-)continue is present, self.resultkey might not have
- # been fetched yet
- if self.continue_name not in self.data:
- # No results.
- return
- # self.resultkey not in data in last request.submit()
- # only "(query-)continue" was retrieved.
- previous_result_had_data = False
- if self.modules[0] == 'random':
- # "random" module does not return "(query-)continue"
- # now we loop for a new random query
- del self.data # a new request is needed
- continue
- if self.continue_name not in self.data:
- return
- if self.continue_update():
- return
-
- del self.data # a new request with (query-)continue is needed
-
- def result(self, data):
- """Process result data as needed for particular subclass."""
- return data
-
-
-class PageGenerator(QueryGenerator):
-
- """Iterator for response to a request of type action=query&generator=foo.
-
- This class can be used for any of the query types that are listed in the
- API documentation as being able to be used as a generator. Instances of
- this class iterate Page objects.
-
- """
-
- def __init__(
- self,
- generator: str,
- g_content: bool = False,
- **kwargs
- ) -> None:
- """
- Initializer.
-
- Required and optional parameters are as for ``Request``, except that
- action=query is assumed and generator is required.
-
- :param generator: the "generator=" type from api.php
- :param g_content: if True, retrieve the contents of the current
- version of each Page (default False)
-
- """
- # If possible, use self.request after __init__ instead of appendParams
- def append_params(params, key, value) -> None:
- if key in params:
- params[key] += '|' + value
- else:
- params[key] = value
- kwargs = self._clean_kwargs(kwargs)
- parameters = kwargs['parameters']
- # get some basic information about every page generated
- append_params(parameters, 'prop', 'info|imageinfo|categoryinfo')
- if g_content:
- # retrieve the current revision
- append_params(parameters, 'prop', 'revisions')
- append_params(parameters, 'rvprop',
- 'ids|timestamp|flags|comment|user|content')
- if not ('inprop' in parameters
- and 'protection' in parameters['inprop']):
- append_params(parameters, 'inprop', 'protection')
- append_params(parameters, 'iiprop',
- 'timestamp|user|comment|url|size|sha1|metadata')
- append_params(parameters, 'iilimit', 'max') # T194233
- parameters['generator'] = generator
- super().__init__(**kwargs)
- self.resultkey = 'pages' # element to look for in result
- self.props = self.request['prop']
-
- def result(self, pagedata):
- """Convert page dict entry from api to Page object.
-
- This can be overridden in subclasses to return a different type
- of object.
-
- """
- p = pywikibot.Page(self.site, pagedata['title'], pagedata['ns'])
- ns = pagedata['ns']
- # Upcast to proper Page subclass.
- if ns == 2:
- p = pywikibot.User(p)
- elif ns == 6:
- p = pywikibot.FilePage(p)
- elif ns == 14:
- p = pywikibot.Category(p)
- update_page(p, pagedata, self.props)
- return p
-
-
-class PropertyGenerator(QueryGenerator):
-
- """Iterator for queries of type action=query&prop=foo.
-
- See the API documentation for types of page properties that can be
- queried.
-
- This iterator yields one or more dict object(s) corresponding
- to each "page" item(s) from the API response; the calling module has to
- decide what to do with the contents of the dict. There will be one
- dict for each page queried via a titles= or ids= parameter (which must
- be supplied when instantiating this class).
-
- """
-
- def __init__(self, prop: str, **kwargs) -> None:
- """
- Initializer.
-
- Required and optional parameters are as for ``Request``, except that
- action=query is assumed and prop is required.
-
- :param prop: the "prop=" type from api.php
- """
- kwargs = self._clean_kwargs(kwargs, prop=prop)
- super().__init__(**kwargs)
- self._props = frozenset(prop.split('|'))
- self.resultkey = 'pages'
-
- @property
- def props(self):
- """The requested property names."""
- return self._props
-
- def __iter__(self):
- """Yield results."""
- self._previous_dicts = {}
- yield from super().__iter__()
- yield from self._previous_dicts.values()
-
- def _extract_results(self, resultdata):
- """Yield completed page_data of consecutive API requests."""
- yield from self._fully_retrieved_data_dicts(resultdata)
- for data_dict in super()._extract_results(resultdata):
- if 'title' in data_dict:
- d = self._previous_dicts.setdefault(data_dict['title'],
- data_dict)
- if d is not data_dict:
- self._update_old_result_dict(d, data_dict)
- else:
- pywikibot.warn('Skipping result without title: '
- + str(data_dict))
-
- def _fully_retrieved_data_dicts(self, resultdata):
- """Yield items of self._previous_dicts that are not in resultdata."""
- resultdata_titles = {d['title'] for d in resultdata if 'title' in d}
- for prev_title, prev_dict in self._previous_dicts.copy().items():
- if prev_title not in resultdata_titles:
- yield prev_dict
- del self._previous_dicts[prev_title]
-
- @staticmethod
- def _update_old_result_dict(old_dict, new_dict) -> None:
- """Update old result dict with new_dict."""
- for k, v in new_dict.items():
- if k not in old_dict:
- old_dict[k] = v
- continue
- if isinstance(v, list):
- old_dict[k].extend(v)
- continue
- assert isinstance(v, (str, int)), (
- 'continued API result had an unexpected type: {}'.format(v))
-
-
-class ListGenerator(QueryGenerator):
-
- """Iterator for queries of type action=query&list=foo.
-
- See the API documentation for types of lists that can be queried. Lists
- include both site-wide information (such as 'allpages') and page-specific
- information (such as 'backlinks').
-
- This iterator yields a dict object for each member of the list returned
- by the API, with the format of the dict depending on the particular list
- command used. For those lists that contain page information, it may be
- easier to use the PageGenerator class instead, as that will convert the
- returned information into a Page object.
-
- """
-
- def __init__(self, listaction: str, **kwargs) -> None:
- """
- Initializer.
-
- Required and optional parameters are as for ``Request``, except that
- action=query is assumed and listaction is required.
-
- :param listaction: the "list=" type from api.php
- """
- kwargs = self._clean_kwargs(kwargs, list=listaction)
- super().__init__(**kwargs)
-
-
-class LogEntryListGenerator(ListGenerator):
-
- """
- Iterator for queries of list 'logevents'.
-
- Yields LogEntry objects instead of dicts.
- """
-
- def __init__(self, logtype=None, **kwargs) -> None:
- """Initializer."""
- super().__init__('logevents', **kwargs)
-
- from pywikibot import logentries
- self.entryFactory = logentries.LogEntryFactory(self.site, logtype)
-
- def result(self, pagedata):
- """Instantiate LogEntry from data from api."""
- return self.entryFactory.create(pagedata)
-
- def _check_result_namespace(self, result):
- """Return True if result.ns() is in self._namespaces."""
- return result.ns() in self._namespaces
-
-
-class LoginManager(login.LoginManager):
-
- """Supply login_to_site method to use API interface."""
-
- # API login parameters mapping
- mapping = {
- 'user': ('lgname', 'username'),
- 'password': ('lgpassword', 'password'),
- 'ldap': ('lgdomain', 'domain'),
- 'token': ('lgtoken', 'logintoken'),
- 'result': ('result', 'status'),
- 'success': ('Success', 'PASS'),
- 'fail': ('Failed', 'FAIL'),
- 'reason': ('reason', 'message')
- }
-
- def keyword(self, key):
- """Get API keyword from mapping."""
- return self.mapping[key][self.action != 'login']
-
- def _login_parameters(self, *, botpassword: bool = False
- ) -> Dict[str, str]:
- """Return login parameters."""
- # Since MW 1.27 only for bot passwords.
- self.action = 'login'
- if not botpassword:
- # get token using meta=tokens if supported
- token = self.get_login_token()
- if token:
- # Standard login request since MW 1.27
- self.action = 'clientlogin'
-
- # prepare default login parameters
- parameters = {'action': self.action,
- self.keyword('user'): self.login_name,
- self.keyword('password'): self.password}
-
- if self.action == 'clientlogin':
- # clientlogin requires non-empty loginreturnurl
- parameters['loginreturnurl'] = 'https://example.com'
- parameters['rememberMe'] = '1'
- parameters['logintoken'] = token
-
- if self.site.family.ldapDomain:
- parameters[self.keyword('ldap')] = self.site.family.ldapDomain
-
- return parameters
-
- def login_to_site(self) -> None:
- """Login to the site.
-
- Note, this doesn't do anything with cookies. The http module
- takes care of all the cookie stuff. Throws exception on failure.
- """
- self.below_mw_1_27 = False
- if hasattr(self, '_waituntil') \
- and datetime.datetime.now() < self._waituntil:
- diff = self._waituntil - datetime.datetime.now()
- pywikibot.warning(
- 'Too many tries, waiting {} seconds before retrying.'
- .format(diff.seconds))
- pywikibot.sleep(diff.seconds)
-
- self.site._loginstatus = LoginStatus.IN_PROGRESS
-
- # Bot passwords username contains @,
- # otherwise @ is not allowed in usernames.
- # @ in bot password is deprecated,
- # but we don't want to break bots using it.
- parameters = self._login_parameters(
- botpassword='@' in self.login_name or '@' in self.password)
-
- # base login request
- login_request = self.site._request(use_get=False,
- parameters=parameters)
- while True:
- # try to login
- try:
- login_result = login_request.submit()
- except pywikibot.exceptions.APIError as e:
- login_result = {'error': e.__dict__}
-
- # clientlogin response can be clientlogin or error
- if self.action in login_result:
- response = login_result[self.action]
- result_key = self.keyword('result')
- elif 'error' in login_result:
- response = login_result['error']
- result_key = 'code'
- else:
- raise RuntimeError('Unexpected API login response key.')
-
- status = response[result_key]
- fail_reason = response.get(self.keyword('reason'), '')
- if status == self.keyword('success'):
- return
-
- if status in ('NeedToken', 'WrongToken', 'badtoken'):
- token = response.get('token')
- if token and self.below_mw_1_27:
- # fetched token using action=login
- login_request['lgtoken'] = token
- pywikibot.log('Received login token, proceed with login.')
- else:
- # if incorrect login token was used,
- # force relogin and generate fresh one
- pywikibot.error('Received incorrect login token. '
- 'Forcing re-login.')
- # invalidate superior wiki cookies (T224712)
- _invalidate_superior_cookies(self.site.family)
- login_request[
- self.keyword('token')] = self.get_login_token()
- continue
-
- # messagecode was introduced with 1.29.0-wmf.14
- # but older wikis are still supported
- login_throttled = response.get('messagecode') == 'login-throttled'
-
- if (status == 'Throttled' or status == self.keyword('fail')
- and (login_throttled or 'wait' in fail_reason)):
- wait = response.get('wait')
- if wait:
- delta = datetime.timedelta(seconds=int(wait))
- else:
- match = re.search(r'(\d+) (seconds|minutes)', fail_reason)
- if match:
- delta = datetime.timedelta(
- **{match.group(2): int(match.group(1))})
- else:
- delta = datetime.timedelta()
- self._waituntil = datetime.datetime.now() + delta
-
- break
-
- if 'error' in login_result:
- raise pywikibot.exceptions.APIError(**response)
-
- raise pywikibot.exceptions.APIError(code=status, info=fail_reason)
-
- def get_login_token(self) -> Optional[str]:
- """Fetch login token for MediaWiki 1.27+.
-
- :return: login token
- """
- login_token_request = self.site._request(
- use_get=False,
- parameters={'action': 'query', 'meta': 'tokens', 'type': 'login'},
- )
- login_token_result = login_token_request.submit()
- # check if we have to use old implementation of mw < 1.27
- if 'query' in login_token_result:
- return login_token_result['query']['tokens'].get('logintoken')
-
- self.below_mw_1_27 = True
- return None
-
-
-def encode_url(query) -> str:
- """Encode parameters to pass with a url.
-
- Reorder parameters so that token parameters go last and call wraps
- :py:obj:`urlencode`. Return an HTTP URL query fragment which
- complies with :api:`Edit#Parameters` (See the 'token' bullet.)
-
- :param query: keys and values to be uncoded for passing with a url
- :type query: mapping object or a sequence of two-element tuples
- :return: encoded parameters with token parameters at the end
- """
- if hasattr(query, 'items'):
- query = list(query.items())
-
- # parameters ending on 'token' should go last
- # wpEditToken should go very last
- query.sort(key=lambda x: x[0].lower().endswith('token')
- + (x[0] == 'wpEditToken'))
- return urlencode(query)
-
-
-def _update_pageid(page, pagedict: dict):
- """Update pageid."""
- if 'pageid' in pagedict:
- page._pageid = int(pagedict['pageid'])
- elif 'missing' in pagedict:
- page._pageid = 0 # Non-existent page
- else:
- # Something is wrong.
- if page.site.sametitle(page.title(), pagedict['title']) \
- and 'invalid' in pagedict:
- raise InvalidTitleError('{}: {}'
- .format(page, pagedict['invalidreason']))
- if int(pagedict['ns']) < 0:
- raise UnsupportedPageError(page)
- raise RuntimeError(
- "Page {} has neither 'pageid' nor 'missing' attribute"
- .format(pagedict['title']))
-
-
-def _update_contentmodel(page, pagedict: dict) -> None:
- """Update page content model."""
- page._contentmodel = pagedict.get('contentmodel') # can be None
-
- if (page._contentmodel
- and page._contentmodel == 'proofread-page'
- and 'proofread' in pagedict):
- page._quality = pagedict['proofread']['quality']
- page._quality_text = pagedict['proofread']['quality_text']
-
-
-def _update_protection(page, pagedict: dict) -> None:
- """Update page protection."""
- if 'restrictiontypes' in pagedict:
- page._applicable_protections = set(pagedict['restrictiontypes'])
- else:
- page._applicable_protections = None
- page._protection = {item['type']: (item['level'], item['expiry'])
- for item in pagedict['protection']}
-
-
-def _update_revisions(page, revisions) -> None:
- """Update page revisions."""
- for rev in revisions:
- revid = rev['revid']
- revision = pywikibot.page.Revision(**rev)
- # do not overwrite an existing Revision if there is no content
- if revid in page._revisions and revision.text is None:
- pass
- else:
- page._revisions[revid] = revision
-
-
-def _update_templates(page, templates) -> None:
- """Update page templates."""
- templ_pages = [pywikibot.Page(page.site, tl['title']) for tl in templates]
- if hasattr(page, '_templates'):
- page._templates.extend(templ_pages)
- else:
- page._templates = templ_pages
-
-
-def _update_langlinks(page, langlinks) -> None:
- """Update page langlinks."""
- links = [pywikibot.Link.langlinkUnsafe(link['lang'], link['*'],
- source=page.site)
- for link in langlinks]
-
- if hasattr(page, '_langlinks'):
- page._langlinks.extend(links)
- else:
- page._langlinks = links
-
-
-def _update_coordinates(page, coordinates) -> None:
- """Update page coordinates."""
- coords = []
- for co in coordinates:
- coord = pywikibot.Coordinate(lat=co['lat'],
- lon=co['lon'],
- typ=co.get('type', ''),
- name=co.get('name', ''),
- dim=int(co.get('dim', 0)) or None,
- globe=co['globe'], # See [[gerrit:67886]]
- primary='primary' in co
- )
- coords.append(coord)
- page._coords = coords
-
-
-def update_page(page, pagedict: dict, props=None):
- """Update attributes of Page object page, based on query data in pagedict.
-
- :param page: object to be updated
- :type page: pywikibot.page.Page
- :param pagedict: the contents of a "page" element of a query response
- :param props: the property names which resulted in pagedict. If a missing
- value in pagedict can indicate both 'false' and 'not present' the
- property which would make the value present must be in the props
- parameter.
- :type props: iterable of string
- :raises pywikibot.exceptions.InvalidTitleError: Page title is invalid
- :raises pywikibot.exceptions.UnsupportedPageError: Page with namespace < 0
- is not supported yet
- """
- _update_pageid(page, pagedict)
- _update_contentmodel(page, pagedict)
-
- props = props or []
- if 'info' in props:
- page._isredir = 'redirect' in pagedict
-
- if 'touched' in pagedict:
- page._timestamp = pagedict['touched']
-
- if 'protection' in pagedict:
- _update_protection(page, pagedict)
-
- if 'revisions' in pagedict:
- _update_revisions(page, pagedict['revisions'])
-
- if 'lastrevid' in pagedict:
- page.latest_revision_id = pagedict['lastrevid']
-
- if 'imageinfo' in pagedict:
- if not isinstance(page, pywikibot.FilePage):
- raise RuntimeError(
- '"imageinfo" found but {} is not a FilePage object'
- .format(page))
- page._load_file_revisions(pagedict['imageinfo'])
-
- if 'categoryinfo' in pagedict:
- page._catinfo = pagedict['categoryinfo']
-
- if 'templates' in pagedict:
- _update_templates(page, pagedict['templates'])
- elif 'templates' in props:
- page._templates = []
-
- if 'langlinks' in pagedict:
- _update_langlinks(page, pagedict['langlinks'])
- elif 'langlinks' in props:
- page._langlinks = []
-
- if 'coordinates' in pagedict:
- _update_coordinates(page, pagedict['coordinates'])
-
- if 'pageimage' in pagedict:
- page._pageimage = pywikibot.FilePage(page.site, pagedict['pageimage'])
-
- if 'pageprops' in pagedict:
- page._pageprops = pagedict['pageprops']
- elif 'pageprops' in props:
- page._pageprops = {}
-
- if 'preload' in pagedict:
- page._preloadedtext = pagedict['preload']
-
- if 'flowinfo' in pagedict:
- page._flowinfo = pagedict['flowinfo']['flow']
-
- if 'lintId' in pagedict:
- page._lintinfo = pagedict
- page._lintinfo.pop('pageid')
- page._lintinfo.pop('title')
- page._lintinfo.pop('ns')
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805404
To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I194bf8c1f9472ab9e8927b6df3047a816369df01
Gerrit-Change-Number: 805404
Gerrit-PatchSet: 3
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged
Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805403 )
Change subject: [IMPR] Move api.ParamInfo to _paraminfo.py
......................................................................
[IMPR] Move api.ParamInfo to _paraminfo.py
Part 1:
- rename __init__.py to __init.py
- copy __init.py to _paraminfo.py to keep version history unchanged
Change-Id: I35a25281e55f11c80e791c83d7a7f6b6a489bef5
---
R pywikibot/data/api/__init.py
C pywikibot/data/api/_paraminfo.py
2 files changed, 0 insertions(+), 0 deletions(-)
Approvals:
Xqt: Verified; Looks good to me, approved
diff --git a/pywikibot/data/api/__init__.py b/pywikibot/data/api/__init.py
similarity index 100%
rename from pywikibot/data/api/__init__.py
rename to pywikibot/data/api/__init.py
diff --git a/pywikibot/data/api/__init__.py b/pywikibot/data/api/_paraminfo.py
similarity index 100%
copy from pywikibot/data/api/__init__.py
copy to pywikibot/data/api/_paraminfo.py
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/805403
To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I35a25281e55f11c80e791c83d7a7f6b6a489bef5
Gerrit-Change-Number: 805403
Gerrit-PatchSet: 1
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged