Xqt submitted this change.
[doc] Update references
Change-Id: I344a84cab6bc3860812016486b81863814e76197
---
M HISTORY.rst
M ROADMAP.rst
M docs/api_ref/index.rst
M docs/api_ref/pywikibot.rst
M docs/faq.rst
M docs/library_usage.rst
M docs/licenses.rst
M pywikibot/bot.py
M pywikibot/bot_choice.py
M pywikibot/comms/eventstreams.py
M pywikibot/data/api/_generators.py
M pywikibot/data/memento.py
M pywikibot/page/__init__.py
M pywikibot/page/_pages.py
M pywikibot/pagegenerators/_generators.py
M pywikibot/site/_apisite.py
M pywikibot/site/_extensions.py
M pywikibot/site/_siteinfo.py
M pywikibot/userinterfaces/__init__.py
M pywikibot/userinterfaces/terminal_interface_base.py
M scripts/archivebot.py
M scripts/basic.py
M scripts/blockpageschecker.py
M scripts/category_redirect.py
M scripts/change_pagelang.py
M scripts/clean_sandbox.py
M scripts/commonscat.py
M scripts/coordinate_import.py
M scripts/delinker.py
M scripts/djvutext.py
M scripts/download_dump.py
M scripts/harvest_template.py
M scripts/interwikidata.py
M scripts/nowcommons.py
M scripts/protect.py
M scripts/reflinks.py
M scripts/unusedfiles.py
M tests/utils.py
38 files changed, 82 insertions(+), 82 deletions(-)
diff --git a/HISTORY.rst b/HISTORY.rst
index 4954881..3f64ec3 100644
--- a/HISTORY.rst
+++ b/HISTORY.rst
@@ -13,9 +13,9 @@
around wbparsevalue was added (:phab:`T112140`, :phab:`T312755`)
* L10N updates
* Fix cp encodings in :func:`get_charset_from_content_type()
- <pywikibot.comms.http.get_charset_from_content_type>` (:phab:`T312230`)
+ <comms.http.get_charset_from_content_type>` (:phab:`T312230`)
* New :mod:`pywikibot.time` module with new functions in addition to `Timestamp`
-* :meth:`Page.revisions()<pywikibot.page.BasePage.revisions>` supports more formats/types for
+* :meth:`Page.revisions()<page.BasePage.revisions>` supports more formats/types for
starttime and endtime parameters, in addition to those allowed by
:meth:`Timestamp.fromISOformat()<pywikibot.Timestamp.fromISOformat>`.
* New :meth:`Timestamp.set_timestamp()<pywikibot.Timestamp.set_timestamp>` method
@@ -24,7 +24,7 @@
* Handle asynchronous page_put_queue after KeyboardInterrupt in Python 3.9+ (:phab:`T311076`)
* No longer expect a specific namespace alias in cosmetic_changes
:meth:`translateAndCapitalizeNamespaces
- <pywikibot.cosmetic_changes.CosmeticChangesToolkit.translateAndCapitalizeNamespaces>`
+ <cosmetic_changes.CosmeticChangesToolkit.translateAndCapitalizeNamespaces>`
7.4.0
@@ -32,9 +32,9 @@
*26 June 2022*
* Provide Built Distribution with Pywikibot (:pep:`427`)
-* Update `WRITE_ACTIONS` in used by :class:`api.Request<pywikibot.data.api.Request>`
-* Move :func:`get_closest_memento_url<pywikibot.data.memento.get_closest_memento_url>` from weblinkchecker script to memento module.
-* Add :mod:`memento module<pywikibot.data.memento>` to fix memento_client package (:phab:`T185561`)
+* Update `WRITE_ACTIONS` in used by :class:`api.Request<data.api.Request>`
+* Move :func:`get_closest_memento_url<data.memento.get_closest_memento_url>` from weblinkchecker script to memento module.
+* Add :mod:`memento module<data.memento>` to fix memento_client package (:phab:`T185561`)
* L10N and i18n updates
* Fix Flow board topic continuation when iterating in reverse (:phab:`T138323`)
* Add Avestan transliteration
@@ -42,7 +42,7 @@
* Show an APIError if PetScanPageGenerator.query() fails (:phab:`T309538`)
* `login.py` is now a utiliy script even for site-package installation (:phab:`T309290`)
* `preload_sites.py` is now a utiliy script even for site-package installation (:phab:`T308912`)
-* :attr:`generator_completed<pywikibot.bot.BaseBot.generator_completed>` became a public attribute
+* :attr:`generator_completed<bot.BaseBot.generator_completed>` became a public attribute
* Return gracefully from pwb.find_alternates if folder in user_script_paths does not exist (:phab:`T308910`)
@@ -176,7 +176,7 @@
* Upload: Retry upload if 'copyuploadbaddomain' API error occurs (:phab:`T294825`)
* Update invisible characters from unicodedata 14.0.0
* Add support for Wikimedia OCR engine with proofreadpage
-* Rewrite :func:`pywikibot.tools.itertools.intersect_generators` which makes it running up to 10'000 times faster. (:phab:`T85623`, :phab:`T293276`)
+* Rewrite :func:`tools.itertools.intersect_generators` which makes it running up to 10'000 times faster. (:phab:`T85623`, :phab:`T293276`)
* The cached output functionality from compat release was re-implemented (:phab:`T151727`, :phab:`T73646`, :phab:`T74942`, :phab:`T132135`, :phab:`T144698`, :phab:`T196039`, :phab:`T280466`)
* L10N updates
* Adjust groupsize within pagegenerators.PreloadingGenerator (:phab:`T291770`)
@@ -249,7 +249,7 @@
* pywikibot.__release__ was removed in favour of pywikibot.__version__
* TextfilePageGenerator was replaced by TextIOPageGenerator
* PreloadingItemGenerator was replaced by PreloadingEntityGenerator
-* DuplicateFilterPageGenerator was replaced by :func:`pywikibot.tools.itertools.filter_unique`
+* DuplicateFilterPageGenerator was replaced by :func:`tools.itertools.filter_unique`
* ItemPage.concept_url method was replaced by ItemPage.concept_uri
* Outdated parameter names has been dropped
* Deprecated pywikibot.Error exception were removed in favour of pywikibot.exceptions.Error classes (:phab:`T280227`)
@@ -681,7 +681,7 @@
* version.get_module_version() is deprecated and gives no meaningfull result
* Fix version.get_module_filename() and update log lines (:phab:`T264235`)
* Re-enable printing log header (:phab:`T264235`)
-* Fix result of :func:`pywikibot.tools.itertools.intersect_generators` (:phab:`T263947`)
+* Fix result of :func:`tools.itertools.intersect_generators` (:phab:`T263947`)
* Only show _GLOBAL_HELP options if explicitly wanted
* Deprecated Family.version() methods were removed
* Unused parameters of page methods like forceReload, insite, throttle, step was removed
diff --git a/ROADMAP.rst b/ROADMAP.rst
index 0b58951..29b9155 100644
--- a/ROADMAP.rst
+++ b/ROADMAP.rst
@@ -1,26 +1,26 @@
Current release 7.6.0
^^^^^^^^^^^^^^^^^^^^^
-* Make :func:`GoogleSearchPageGenerator<pywikibot.pagegenerators.GoogleSearchPageGenerator>`
- and :func:`PetScanPageGenerator<pywikibot.pagegenerators.PetScanPageGenerator>` a restartable
+* Make :func:`GoogleSearchPageGenerator<pagegenerators.GoogleSearchPageGenerator>`
+ and :func:`PetScanPageGenerator<pagegenerators.PetScanPageGenerator>` a restartable
Generator (:phab:`T313681`, :phab:`T313683`)
-* Provide a :class:`collections.GeneratorWrapper<pywikibot.tools.collections.GeneratorWrapper>`
+* Provide a :class:`collections.GeneratorWrapper<tools.collections.GeneratorWrapper>`
class to start/restart a generator (:phab:`T301318`, :phab:`T312654`, :phab:`T312883`)
-* tools' itertools functions were moved to :mod:`pywikibot.tools.itertools` submodule
-* tools' collections classes were moved to :mod:`pywikibot.tools.collections` submodule
+* tools' itertools functions were moved to :mod:`tools.itertools` submodule
+* tools' collections classes were moved to :mod:`tools.collections` submodule
* Set successful login status for the OAuth case (:phab:`T313571`)
Deprecations
^^^^^^^^^^^^
-* 7.6.0: :mod:`pywikibot.tools.collections` datatypes should no longer imported from :mod:`pywikibot.tools`
+* 7.6.0: :mod:`tools.collections` datatypes should no longer imported from :mod:`pywikibot.tools`
* 7.5.0: :mod:`pywikibot.textlib`.tzoneFixedOffset class will be removed in favour of :class:`pywikibot.time.TZoneFixedOffset`
* 7.4.0: `FilePage.usingPages()` was renamed to :meth:`using_pages()<pywikibot.FilePage.using_pages>`
* 7.2.0: ``tb`` parameter of :func:`exception()<pywikibot.exception>` function was renamed to ``exc_info``
* 7.2.0: XMLDumpOldPageGenerator is deprecated in favour of a `content` parameter of `XMLDumpPageGenerator` (:phab:`T306134`)
-* 7.2.0: RedirectPageBot and NoRedirectPageBot bot classes are deprecated in favour of :attr:`use_redirects<pywikibot.bot.BaseBot.use_redirects>` attribute
-* 7.2.0: :func:`tools.formatter.color_format<pywikibot.tools.formatter.color_format>` is deprecated and will be removed
+* 7.2.0: RedirectPageBot and NoRedirectPageBot bot classes are deprecated in favour of :attr:`use_redirects<bot.BaseBot.use_redirects>` attribute
+* 7.2.0: :func:`tools.formatter.color_format<tools.formatter.color_format>` is deprecated and will be removed
* 7.1.0: Unused `get_redirect` parameter of Page.getOldVersion() will be removed
* 7.1.0: APISite._simple_request() will be removed in favour of APISite.simple_request()
* 7.0.0: User.isBlocked() method is renamed to is_blocked for consistency
@@ -30,8 +30,8 @@
* 7.0.0: Values of APISite.allpages() parameter filterredir other than True, False and None are deprecated
* 6.5.0: OutputOption.output() method will be removed in favour of OutputOption.out property
* 6.5.0: Infinite rotating file handler with logfilecount of -1 is deprecated
-* 6.4.0: 'allow_duplicates' parameter of :func:`pywikibot.tools.itertools.intersect_generators` as positional argument is deprecated, use keyword argument instead
-* 6.4.0: 'iterables' of :func:`pywikibot.tools.itertools.intersect_generators` given as a list or tuple is deprecated, either use consecutive iterables or use '*' to unpack
+* 6.4.0: 'allow_duplicates' parameter of :func:`tools.itertools.intersect_generators` as positional argument is deprecated, use keyword argument instead
+* 6.4.0: 'iterables' of :func:`tools.itertools.intersect_generators` given as a list or tuple is deprecated, either use consecutive iterables or use '*' to unpack
* 6.2.0: outputter of OutputProxyOption without out property is deprecated
* 6.2.0: ContextOption.output_range() and HighlightContextOption.output_range() are deprecated
* 6.2.0: Error messages with '%' style is deprecated in favour for str.format() style
diff --git a/docs/api_ref/index.rst b/docs/api_ref/index.rst
index f280c72..7196738 100644
--- a/docs/api_ref/index.rst
+++ b/docs/api_ref/index.rst
@@ -10,7 +10,7 @@
wiki.
The :class:`pywikibot.Site` object then calls the MediaWiki API using the
-functions provided by :mod:`pywikibot.data.api`. This layer then uses :func:`pywikibot.comms.http.request`
+functions provided by :mod:`data.api`. This layer then uses :func:`comms.http.request`
to do the actual HTTP request.
Contents
diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst
index e0e7617..fc8e54b 100644
--- a/docs/api_ref/pywikibot.rst
+++ b/docs/api_ref/pywikibot.rst
@@ -143,7 +143,7 @@
.. automodule:: throttle
-.. :module:: time
+.. module:: time
:mod:`time` module
------------------
diff --git a/docs/faq.rst b/docs/faq.rst
index 91773da..f0530b7 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -5,19 +5,19 @@
can run :py:mod:`preload_sites <pywikibot.scripts.preload_sites>` script
to preload site info quickly.
2. If you need the content, use :py:mod:`PreloadingGenerator
- <pywikibot.pagegenerators.PreloadingGenerator>` with page generators,
- :py:mod:`EntityGenerator <pywikibot.pagegenerators.EntityGenerator>`
+ <pagegenerators.PreloadingGenerator>` with page generators,
+ :py:mod:`EntityGenerator <pagegenerators.EntityGenerator>`
for wikibase entities and :py:mod:`DequePreloadingGenerator
- <pywikibot.pagegenerators.DequePreloadingGenerator>` for a
- :py:mod:`DequeGenerator <pywikibot.tools.collections.DequeGenerator>`.
+ <pagegenerators.DequePreloadingGenerator>` for a
+ :py:mod:`DequeGenerator <tools.collections.DequeGenerator>`.
3. If you use :py:mod:`GeneratorFactory
- <pywikibot.pagegenerators.GeneratorFactory>` with your bot and use its
+ <pagegenerators.GeneratorFactory>` with your bot and use its
:py:mod:`getCombinedGenerator
- <pywikibot.pagegenerators.GeneratorFactory.getCombinedGenerator>` method
+ <pagegenerators.GeneratorFactory.getCombinedGenerator>` method
you can set ``preload=True`` to preload page content. This is an alternate
to the ``PreloadingGenerator`` function mentioned above.
4. Use :py:mod:`MySQLPageGenerator
- <pywikibot.pagegenerators.MySQLPageGenerator >` if direct DB access is
+ <pagegenerators.MySQLPageGenerator >` if direct DB access is
available and appropriate. See also: :manpage:`MySQL`
**The bot cannot delete pages**
diff --git a/docs/library_usage.rst b/docs/library_usage.rst
index 6aae756..c75d413 100644
--- a/docs/library_usage.rst
+++ b/docs/library_usage.rst
@@ -49,32 +49,32 @@
:1-3: Import necessary framework code parts:
:mod:`pywikibot`, :mod:`pywikibot.pagegenerators`,
- :class:`pywikibot.bot.ExistingPageBot`.
+ :class:`bot.ExistingPageBot`.
:5: The bot is derived from
- :class:`ExistingPageBot<pywikibot.bot.ExistingPageBot>`.
+ :class:`ExistingPageBot<bot.ExistingPageBot>`.
All pages from generator which does not exists are skipped.
:7: Every Bot has an *always* option which autoconfirms any changes if
set to True. To expand all available options of a bot and set the
default values of them, use
- :attr:`update_options<pywikibot.bot.BaseBot.update_options>`
+ :attr:`update_options<bot.BaseBot.update_options>`
attribute or update
- :attr:`available_options<pywikibot.bot.BaseBot.available_options>`
+ :attr:`available_options<bot.BaseBot.available_options>`
like it is shown in :ref:`BasicBot<Basic script>` below.
:12: All changes for each page are made in this
- :meth:`treat_page<pywikibot.bot.CurrentPageBot.treat_page>` method.
-:14: :attr:`current_page<pywikibot.bot.BaseBot.current_page>` is the current
+ :meth:`treat_page<bot.CurrentPageBot.treat_page>` method.
+:14: :attr:`current_page<bot.BaseBot.current_page>` is the current
:class:`pywikibot.Page` object from
- :attr:`generator<pywikibot.bot.BaseBot.generator>`.
+ :attr:`generator<bot.BaseBot.generator>`.
:15: All bot options which are passed to the bot class when
instantiating it are accessable via
- :class:`opt attribute<pywikibot.bot.OptionHandler>`. ``opt.always``,
+ :class:`opt attribute<bot.OptionHandler>`. ``opt.always``,
``opt.text`` and ``opt.summary`` are all available options for this
bot class.
:16: Save the changes to the live wiki with
- :meth:`put_current<pywikibot.bot.CurrentPageBot.put_current>`.
+ :meth:`put_current<bot.CurrentPageBot.put_current>`.
:18: Parse command line options inside this function.
:20: A dict which holds all options for the bot.
-:21: :py:obj:`pywikibot.pagegenerators.GeneratorFactory` supports
+:21: :py:obj:`pagegenerators.GeneratorFactory` supports
generators and filter options.
:23: Pywikibot provides :ref:`global options<Global Options>` like site
specification or a *simulate* switch to prevent live wiki changes.
@@ -83,7 +83,7 @@
:ref:`filter options<Filter Options>` of
:mod:`pywikibot.pagegenerators` are parsed here using
:meth:`GeneratorFactory.handle_args()
- <pywikibot.pagegenerators.GeneratorFactory.handle_args>`.
+ <pagegenerators.GeneratorFactory.handle_args>`.
:25: Local options which are are available for the current bot are
parsed in this loop.
:29: Create the bot passing keyword only parameters and run it.
diff --git a/docs/licenses.rst b/docs/licenses.rst
index f07112a..86c44e8 100644
--- a/docs/licenses.rst
+++ b/docs/licenses.rst
@@ -7,7 +7,7 @@
:ref:`MIT license`; translations by translators and manual pages on
mediawiki.org are available under the `CC-BY-SA 3.0`_ license. The
Pywikibot logo is Public domain but it includes material that may be
-protected as a trademark. Parts of :mod:`memento<pywikibot.data.memento>`
+protected as a trademark. Parts of :mod:`memento<data.memento>`
module is licenced under the `BSD`_ open source software license. You
may obtain a copy of the License at
http://mementoweb.github.io/SiteStory/license.html.
diff --git a/pywikibot/bot.py b/pywikibot/bot.py
index 97948ea..9720398 100644
--- a/pywikibot/bot.py
+++ b/pywikibot/bot.py
@@ -1219,7 +1219,7 @@
implemented by subclasses.
Each item processed by :meth:`treat` must be a
- :class:`pywikibot.page.BasePage` type. Use :meth:`init_page` to
+ :class:`page.BasePage` type. Use :meth:`init_page` to
upcast the type. To enable other types, set
:attr:`BaseBot.treat_page_type` to an appropriate type; your bot
should derive from :class:`BaseBot` in that case and handle site
@@ -1606,7 +1606,7 @@
"""Process one page (abstract method).
:param page: Object to be processed, usually a
- :class:`pywikibot.page.BasePage`. For other page types the
+ :class:`page.BasePage`. For other page types the
:attr:`treat_page_type` must be set.
"""
raise NotImplementedError('Method {}.treat() not implemented.'
@@ -1953,7 +1953,7 @@
A class which automatically defines ``summary`` for ``put_current``.
The class must defined a ``summary_key`` string which contains the
- i18n key for :py:obj:`pywikibot.i18n.twtranslate`. It can also
+ i18n key for :py:obj:`i18n.twtranslate`. It can also
override the ``summary_parameters`` property to specify any
parameters for the translated message.
"""
diff --git a/pywikibot/bot_choice.py b/pywikibot/bot_choice.py
index 6e13acf..2dbbdc8 100644
--- a/pywikibot/bot_choice.py
+++ b/pywikibot/bot_choice.py
@@ -105,7 +105,7 @@
.. note:: OutputOption must have an :py:obj:`out` property which
returns a string for
:py:meth:`userinterface output()
- <pywikibot.userinterfaces._interface_base.ABUIC.output>`
+ <userinterfaces._interface_base.ABUIC.output>`
method.
"""
@@ -126,7 +126,7 @@
"""String to be used when selected before or after the question.
.. note:: This method is used by :meth:`ui.input_choice
- <pywikibot.userinterfaces._interface_base.ABUIC.input_choice>`
+ <userinterfaces._interface_base.ABUIC.input_choice>`
instead of deprecated :meth:`output`.
.. versionadded:: 6.2
diff --git a/pywikibot/comms/eventstreams.py b/pywikibot/comms/eventstreams.py
index eed7350..21f591b 100644
--- a/pywikibot/comms/eventstreams.py
+++ b/pywikibot/comms/eventstreams.py
@@ -106,7 +106,7 @@
>>> del stream
.. versionchanged:: 7.6
- subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper`
+ subclassed from :class:`tools.collections.GeneratorWrapper`
"""
def __init__(self, **kwargs) -> None:
diff --git a/pywikibot/data/api/_generators.py b/pywikibot/data/api/_generators.py
index 312cd13..f4802f0 100644
--- a/pywikibot/data/api/_generators.py
+++ b/pywikibot/data/api/_generators.py
@@ -3,7 +3,7 @@
.. versionchanged:: 7.6
All Objects were changed from Iterable object to a Generator object.
They are subclassed from
- :class:`pywikibot.tools.collections.GeneratorWrapper`
+ :class:`tools.collections.GeneratorWrapper`
"""
#
# (C) Pywikibot team, 2008-2022
@@ -73,7 +73,7 @@
after iterating that many values.
.. versionchanged:: 7.6
- subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper`
+ subclassed from :class:`tools.collections.GeneratorWrapper`
"""
def __init__(
@@ -199,7 +199,7 @@
options.
.. versionchanged:: 7.6
- subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper`
+ subclassed from :class:`tools.collections.GeneratorWrapper`
"""
# Should results be filtered during iteration according to set_namespace?
diff --git a/pywikibot/data/memento.py b/pywikibot/data/memento.py
index f295356..55d3cfc 100644
--- a/pywikibot/data/memento.py
+++ b/pywikibot/data/memento.py
@@ -45,7 +45,7 @@
>>> mc = MementoClient()
>>> dt = mc.convert_to_datetime("Sun, 01 Apr 2010 12:00:00 GMT")
- >>> mi = mc.get_memento_info("http://www.bbc.com/", dt, timeout=40)
+ >>> mi = mc.get_memento_info("http://www.bbc.com/", dt, timeout=60)
>>> mi['original_uri']
'http://www.bbc.com/'
>>> mi['timegate_uri']
diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py
index 7434b8f..502e923 100644
--- a/pywikibot/page/__init__.py
+++ b/pywikibot/page/__init__.py
@@ -67,7 +67,7 @@
Uses the first encoding that doesn't cause an error.
.. deprecated:: 6.2
- Use :func:`pywikibot.tools.chars.url2string` instead.
+ Use :func:`tools.chars.url2string` instead.
:param title: URL-encoded character data to convert
:param encodings: Encodings to attempt to use during conversion.
diff --git a/pywikibot/page/_pages.py b/pywikibot/page/_pages.py
index b5ebb4a..51fb874 100644
--- a/pywikibot/page/_pages.py
+++ b/pywikibot/page/_pages.py
@@ -2164,7 +2164,7 @@
"""Extract templates and parameters.
This method is using
- :func:`pywikibot.textlib.extract_templates_and_params`.
+ :func:`textlib.extract_templates_and_params`.
Disabled parts and whitespace are stripped, except for
whitespace in anonymous positional arguments.
diff --git a/pywikibot/pagegenerators/_generators.py b/pywikibot/pagegenerators/_generators.py
index 5a92a8c..9ea56df 100644
--- a/pywikibot/pagegenerators/_generators.py
+++ b/pywikibot/pagegenerators/_generators.py
@@ -305,7 +305,7 @@
) -> Iterable['pywikibot.page.Page']:
"""Yield all pages linked from a specific page.
- See :py:obj:`pywikibot.page.BasePage.linkedPages` for details.
+ See :py:obj:`page.BasePage.linkedPages` for details.
:param linkingPage: the page that links to the pages we want
:param total: the total number of pages to iterate
@@ -795,7 +795,7 @@
generator prints a warning for each query.
.. versionchanged:: 7.6
- subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper`
+ subclassed from :class:`tools.collections.GeneratorWrapper`
"""
def __init__(self, query: Optional[str] = None,
@@ -1106,7 +1106,7 @@
.. seealso:: https://petscan.wmflabs.org/
.. versionadded:: 3.0
.. versionchanged:: 7.6
- subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper`
+ subclassed from :class:`tools.collections.GeneratorWrapper`
"""
def __init__(self, categories: Sequence[str],
diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py
index 8a6332f..de85f4a 100644
--- a/pywikibot/site/_apisite.py
+++ b/pywikibot/site/_apisite.py
@@ -1549,7 +1549,7 @@
.. seealso::
- :api:`Parse`
- - :meth:`pywikibot.page.BasePage.get_parsed_page`.
+ - :meth:`page.BasePage.get_parsed_page`.
"""
req = self.simple_request(action='parse', page=page)
data = req.submit()
diff --git a/pywikibot/site/_extensions.py b/pywikibot/site/_extensions.py
index 220db27..cafa212 100644
--- a/pywikibot/site/_extensions.py
+++ b/pywikibot/site/_extensions.py
@@ -746,7 +746,7 @@
- https://www.mediawiki.org/wiki/Extension:TextExtracts
- - :meth:`pywikibot.page.BasePage.extract`.
+ - :meth:`page.BasePage.extract`.
"""
if not page.exists():
raise NoPageError(page)
diff --git a/pywikibot/site/_siteinfo.py b/pywikibot/site/_siteinfo.py
index 5b00854..b973adc 100644
--- a/pywikibot/site/_siteinfo.py
+++ b/pywikibot/site/_siteinfo.py
@@ -77,11 +77,11 @@
- 'semiprotectedlevels': 'autoconfirmed'
- 'levels': '' (everybody), 'autoconfirmed', 'sysop'
- 'types': 'create', 'edit', 'move', 'upload'
- Otherwise it returns :py:obj:`pywikibot.tools.EMPTY_DEFAULT`.
+ Otherwise it returns :py:obj:`tools.EMPTY_DEFAULT`.
:param key: The property name
:return: The default value
- :rtype: dict or :py:obj:`pywikibot.tools.EmptyDefault`
+ :rtype: dict or :py:obj:`tools.EmptyDefault`
"""
if key == 'restrictions':
# implemented in b73b5883d486db0e9278ef16733551f28d9e096d
diff --git a/pywikibot/userinterfaces/__init__.py b/pywikibot/userinterfaces/__init__.py
index fa9afbd..5c20a19 100644
--- a/pywikibot/userinterfaces/__init__.py
+++ b/pywikibot/userinterfaces/__init__.py
@@ -4,7 +4,7 @@
which takes the root logger as its only argument, and which adds to that
logger whatever handlers and formatters are needed to process output and
display it to the user. The default
-(:mod:`terminal<pywikibot.userinterfaces.terminal_interface_base>`)
+(:mod:`terminal<userinterfaces.terminal_interface_base>`)
interface sends level :const:`STDOUT` to `sys.stdout` (as all interfaces
should) and sends all other levels to `sys.stderr`; levels
:const:`WARNING` and above are labeled with the level name.
@@ -12,5 +12,5 @@
UserInterface objects must also define methods `input()`,
`input_choice()`, `input_list_choice()`, `output()` and `editText()`,
all of which are documented in the abstract class
-:class:`pywikibot.userinterfaces._interface_base.ABUIC`.
+:class:`userinterfaces._interface_base.ABUIC`.
"""
diff --git a/pywikibot/userinterfaces/terminal_interface_base.py b/pywikibot/userinterfaces/terminal_interface_base.py
index d160084..91f3c11 100644
--- a/pywikibot/userinterfaces/terminal_interface_base.py
+++ b/pywikibot/userinterfaces/terminal_interface_base.py
@@ -61,7 +61,7 @@
.. versionchanged:: 6.2:
subclassed from
- :py:obj:`pywikibot.userinterfaces._interface_base.ABUIC`
+ :py:obj:`userinterfaces._interface_base.ABUIC`
"""
split_col_pat = re.compile(r'(\w+);?(\w+)?')
diff --git a/scripts/archivebot.py b/scripts/archivebot.py
index 33394aa..d981637 100755
--- a/scripts/archivebot.py
+++ b/scripts/archivebot.py
@@ -68,7 +68,7 @@
Alternatively you may use localized digits. This is only available for a
few site languages. Refer :attr:`NON_LATIN_DIGITS
-<pywikibot.userinterfaces.transliteration.NON_LATIN_DIGITS>` whether
+<userinterfaces.transliteration.NON_LATIN_DIGITS>` whether
there is a localized one:
%(localcounter)s the current value of the counter
diff --git a/scripts/basic.py b/scripts/basic.py
index 30d5433..451bb31 100755
--- a/scripts/basic.py
+++ b/scripts/basic.py
@@ -23,7 +23,7 @@
-summary: Set the action summary message for the edit.
This sample script is a
-:py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All settings can be
+:py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All settings can be
made either by giving option with the command line or with a settings file
which is scripts.ini by default. If you don't want the default values you can
add any option you want to change to that settings file below the [basic]
diff --git a/scripts/blockpageschecker.py b/scripts/blockpageschecker.py
index cd677e8..60e7419 100755
--- a/scripts/blockpageschecker.py
+++ b/scripts/blockpageschecker.py
@@ -19,7 +19,7 @@
-moveprotected Same as -protectedpages, for moveprotected pages
-This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`.
+This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`.
The following options can be set within a settings file which is scripts.ini
by default::
diff --git a/scripts/category_redirect.py b/scripts/category_redirect.py
index d0ce5b7..7af3042 100755
--- a/scripts/category_redirect.py
+++ b/scripts/category_redirect.py
@@ -26,7 +26,7 @@
python pwb.py category_redirect [options]
.. note:: This script is a
- :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options
+ :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options
can be set within a settings file which is scripts.ini by default.
"""
#
diff --git a/scripts/change_pagelang.py b/scripts/change_pagelang.py
index a8aec48..7946203 100755
--- a/scripts/change_pagelang.py
+++ b/scripts/change_pagelang.py
@@ -17,7 +17,7 @@
the one set in -setlang (keep the current language).
.. note:: This script is a
- :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options
+ :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options
can be set within a settings file which is scripts.ini by default.
"""
#
diff --git a/scripts/clean_sandbox.py b/scripts/clean_sandbox.py
index a6b199a..c8f59ce 100755
--- a/scripts/clean_sandbox.py
+++ b/scripts/clean_sandbox.py
@@ -23,7 +23,7 @@
-summary Summary of the edit made by bot. Overrides the default
from i18n.
-This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`.
+This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`.
All local parameters can be given inside a scripts.ini file. Options
passed to the script are priorized over options read from ini file.
diff --git a/scripts/commonscat.py b/scripts/commonscat.py
index ad8392f..2145865 100755
--- a/scripts/commonscat.py
+++ b/scripts/commonscat.py
@@ -12,7 +12,7 @@
-checkcurrent Work on all category pages that use the primary commonscat
template.
-This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`.
+This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`.
The following options can be set within a settings file which is scripts.ini
by default::
diff --git a/scripts/coordinate_import.py b/scripts/coordinate_import.py
index 08f843e..4e6b77d 100755
--- a/scripts/coordinate_import.py
+++ b/scripts/coordinate_import.py
@@ -37,7 +37,7 @@
-create Create items for pages without one.
.. note:: This script is a
- :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options
+ :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options
can be set within a settings file which is scripts.ini by default.
¶ms;
diff --git a/scripts/delinker.py b/scripts/delinker.py
index 507e56e..872f144 100644
--- a/scripts/delinker.py
+++ b/scripts/delinker.py
@@ -20,7 +20,7 @@
the next script call starts there if no `-since` is given.
.. note:: This sample script is a
- :class:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All
+ :class:`ConfigParserBot <bot.ConfigParserBot>`. All
settings can be made either by giving option with the command line or
with a settings file which is scripts.ini by default. If you don't
want the default values you can add any option you want to change to
diff --git a/scripts/djvutext.py b/scripts/djvutext.py
index 8e3ca18..4c85336 100755
--- a/scripts/djvutext.py
+++ b/scripts/djvutext.py
@@ -20,7 +20,7 @@
A -> just page A
-B -> pages 1 until B
-This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`.
+This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`.
The following options can be set within a settings file which is scripts.ini
by default:
diff --git a/scripts/download_dump.py b/scripts/download_dump.py
index abe740c..009a62f 100755
--- a/scripts/download_dump.py
+++ b/scripts/download_dump.py
@@ -12,7 +12,7 @@
formatted as YYYYMMDD.
.. note:: This script is a
- :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options
+ :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options
can be set within a settings file which is scripts.ini by default.
"""
#
diff --git a/scripts/harvest_template.py b/scripts/harvest_template.py
index 48f6dc9..b85f714 100755
--- a/scripts/harvest_template.py
+++ b/scripts/harvest_template.py
@@ -91,7 +91,7 @@
-multi
.. note:: This script is a
- :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options
+ :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options
can be set within a settings file which is scripts.ini by default.
.. versionadded:: 7.5
the -inverse option.
diff --git a/scripts/interwikidata.py b/scripts/interwikidata.py
index fc068b4..dfeebf1 100755
--- a/scripts/interwikidata.py
+++ b/scripts/interwikidata.py
@@ -25,7 +25,7 @@
-summary: Use your own edit summary for cleaning the page.
.. note:: This script is a
- :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options
+ :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options
can be set within a settings file which is scripts.ini by default.
"""
diff --git a/scripts/nowcommons.py b/scripts/nowcommons.py
index a395ad5..90b9154 100755
--- a/scripts/nowcommons.py
+++ b/scripts/nowcommons.py
@@ -39,7 +39,7 @@
python pwb.py nowcommons -replaceonly -replaceloose -replacealways -replace
.. note:: This script is a
- :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options
+ :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options
can be set within a settings file which is scripts.ini by default.
"""
#
diff --git a/scripts/protect.py b/scripts/protect.py
index a2f13d4..23f995a 100755
--- a/scripts/protect.py
+++ b/scripts/protect.py
@@ -24,7 +24,7 @@
parameters -unprotect or -default are used, only the last occurrence
is applied.
-This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`.
+This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`.
The following options can be set within a settings file which is scripts.ini
by default::
diff --git a/scripts/reflinks.py b/scripts/reflinks.py
index 377b456..51c0951 100755
--- a/scripts/reflinks.py
+++ b/scripts/reflinks.py
@@ -23,7 +23,7 @@
-xmlstart Page to start with when using an XML dump
-This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`.
+This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`.
The following options can be set within a settings file which is scripts.ini
by default::
diff --git a/scripts/unusedfiles.py b/scripts/unusedfiles.py
index 4512329..c1a7584 100755
--- a/scripts/unusedfiles.py
+++ b/scripts/unusedfiles.py
@@ -9,7 +9,7 @@
If not used, all pages are used.
-always Don't be asked every time.
-This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`.
+This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`.
The following options can be set within a settings file which is scripts.ini
by default::
diff --git a/tests/utils.py b/tests/utils.py
index cd32dbe..805ea62 100644
--- a/tests/utils.py
+++ b/tests/utils.py
@@ -209,7 +209,7 @@
class DryParamInfo(dict):
- """Dummy class to use instead of :py:obj:`pywikibot.data.api.ParamInfo`."""
+ """Dummy class to use instead of :py:obj:`data.api.ParamInfo`."""
def __init__(self, *args, **kwargs):
"""Initializer."""
@@ -284,7 +284,7 @@
class DryRequest(CachedRequest):
- """Dummy class to use instead of :py:obj:`pywikibot.data.api.Request`."""
+ """Dummy class to use instead of :py:obj:`data.api.Request`."""
def __init__(self, *args, **kwargs):
"""Initializer."""
To view, visit change 819055. To unsubscribe, or for help writing mail filters, visit settings.