Pywikibot-commits August 2022

pywikibot-commits@lists.wikimedia.org

1 participants
60 discussions

[Gerrit] ...core[master]: [doc] Additional badges
by Xqt (Code Review) 26 Aug '22

26 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826800 ) Change subject: [doc] Additional badges ...................................................................... [doc] Additional badges Change-Id: Ice6952641d5ed8f00c8f77bcf6743d4cc646b6c9 --- M README.rst 1 file changed, 10 insertions(+), 0 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/README.rst b/README.rst index c2220cb..90f9fbd 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,9 @@ .. image:: https://img.shields.io/pypi/pyversions/pywikibot.svg :alt: Python :target: https://www.python.org/downloads/ +.. image:: https://img.shields.io/github/languages/top/wikimedia/pywikibot + :alt: Top language + :target: https://www.python.org/downloads/ .. image:: https://img.shields.io/pypi/v/pywikibot.svg :alt: Pywikibot release :target: https://pypi.org/project/pywikibot/ @@ -22,6 +25,13 @@ .. image:: https://static.pepy.tech/personalized-badge/pywikibot?period=month&units=in… :alt: Monthly downloads :target: https://pepy.tech/project/pywikibot +.. image:: https://img.shields.io/pypi/wheel/pywikibot + :alt: wheel +.. image:: https://img.shields.io/tokei/lines/github/wikimedia/pywikibot + :alt: Lines of Code +.. image:: https://img.shields.io/github/last-commit/wikimedia/pywikibot + :alt: Last commit + Pywikibot ========= -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826800 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: Ice6952641d5ed8f00c8f77bcf6743d4cc646b6c9 Gerrit-Change-Number: 826800 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [doc] Use Python 3.6 to create Sphinx documentation
by Xqt (Code Review) 26 Aug '22

26 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826789 ) Change subject: [doc] Use Python 3.6 to create Sphinx documentation ...................................................................... [doc] Use Python 3.6 to create Sphinx documentation Use Python 3.6 instead of 3.7 because backports implemetations are incorporated for older Pythons only. Change-Id: Ie6748c65ce61fc9e4903781f85647bcb71e8847e --- M docs/requirements-py3.txt M tox.ini 2 files changed, 3 insertions(+), 3 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/docs/requirements-py3.txt b/docs/requirements-py3.txt index 9da69c9..53d9a1f 100644 --- a/docs/requirements-py3.txt +++ b/docs/requirements-py3.txt @@ -1,4 +1,5 @@ # This is a PIP requirements file for building Sphinx documentation of pywikibot # requirements.txt is also needed -sphinx >= 5.1.1 \ No newline at end of file +sphinx >= 5.1.1 +rstcheck >=3.5.0 \ No newline at end of file diff --git a/tox.ini b/tox.ini index 0cbdd79..ecf4bfc 100644 --- a/tox.ini +++ b/tox.ini @@ -82,11 +82,10 @@ commands = sphinx-build -M html ./docs ./docs/_build rstcheck --recursive --report warning --ignore-roles phab . -basepython = python3.7 +basepython = python3.6 deps = -rrequirements.txt -rdocs/requirements-py3.txt - rstcheck >=4.0.0,< 6.0.0 [flake8] # The following are intentionally ignored, possibly pending consensus -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826789 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: Ie6748c65ce61fc9e4903781f85647bcb71e8847e Gerrit-Change-Number: 826789 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [tests] Ignore some tests for create_isbn_edition.py
by Xqt (Code Review) 25 Aug '22

25 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826649 ) Change subject: [tests] Ignore some tests for create_isbn_edition.py ...................................................................... [tests] Ignore some tests for create_isbn_edition.py Change-Id: Ia114e57323aaf2cacf0a6fa0044066ab9bf0ca20 --- M tests/script_tests.py M tox.ini 2 files changed, 2 insertions(+), 2 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/tests/script_tests.py b/tests/script_tests.py index 0c38a52..94d0b80 100755 --- a/tests/script_tests.py +++ b/tests/script_tests.py @@ -374,7 +374,7 @@ # Here come scripts requiring and missing dependencies, that haven't been # fixed to output -help in that case. _expected_failures = {'version'} - _allowed_failures = ['create_isbn_edition.py'] + _allowed_failures = ['create_isbn_edition'] _arguments = '-help' _results = None diff --git a/tox.ini b/tox.ini index 2225165..0cbdd79 100644 --- a/tox.ini +++ b/tox.ini @@ -165,7 +165,7 @@ scripts/clean_sandbox.py: N816 scripts/commonscat.py: N802, N806, N816 scripts/cosmetic_changes.py: N816 - scripts/create_isbn_edition.py: E501, T201 + scripts/create_isbn_edition.py: C901, D100, E402, E501, F405, T201 scripts/dataextend.py: C901, D101, D102, E126, E127, E131, E501 scripts/harvest_template.py: N802, N816 scripts/interwiki.py: N802, N803, N806, N816 -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826649 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: Ia114e57323aaf2cacf0a6fa0044066ab9bf0ca20 Gerrit-Change-Number: 826649 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [tests] Ignore some tests for create_isbn_edition.py
by Xqt (Code Review) 25 Aug '22

25 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826648 ) Change subject: [tests] Ignore some tests for create_isbn_edition.py ...................................................................... [tests] Ignore some tests for create_isbn_edition.py Change-Id: I3e78a8228619f9862884607012f46d9f11fff9b1 --- M tests/script_tests.py M tox.ini 2 files changed, 2 insertions(+), 1 deletion(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/tests/script_tests.py b/tests/script_tests.py index e45d1e5..0c38a52 100755 --- a/tests/script_tests.py +++ b/tests/script_tests.py @@ -374,7 +374,7 @@ # Here come scripts requiring and missing dependencies, that haven't been # fixed to output -help in that case. _expected_failures = {'version'} - _allowed_failures = [] + _allowed_failures = ['create_isbn_edition.py'] _arguments = '-help' _results = None diff --git a/tox.ini b/tox.ini index 96e72f8..2225165 100644 --- a/tox.ini +++ b/tox.ini @@ -165,6 +165,7 @@ scripts/clean_sandbox.py: N816 scripts/commonscat.py: N802, N806, N816 scripts/cosmetic_changes.py: N816 + scripts/create_isbn_edition.py: E501, T201 scripts/dataextend.py: C901, D101, D102, E126, E127, E131, E501 scripts/harvest_template.py: N802, N816 scripts/interwiki.py: N802, N803, N806, N816 -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826648 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: I3e78a8228619f9862884607012f46d9f11fff9b1 Gerrit-Change-Number: 826648 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [doc] Fiy hyphen in backports
by Xqt (Code Review) 25 Aug '22

25 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826602 ) Change subject: [doc] Fiy hyphen in backports ...................................................................... [doc] Fiy hyphen in backports Change-Id: I7abb06b733c9a8d9ca08454e2ef1ae4228841cc8 --- M docs/api_ref/x_backports.rst 1 file changed, 2 insertions(+), 2 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/docs/api_ref/x_backports.rst b/docs/api_ref/x_backports.rst index 6c72988..ba67f44 100644 --- a/docs/api_ref/x_backports.rst +++ b/docs/api_ref/x_backports.rst @@ -1,5 +1,5 @@ -:mod:`backports` - Python Backports ------------------------------------ +:mod:`backports` --- Python Backports +------------------------------------- .. automodule:: backports :synopsis: This module contains backports to support older Python versions -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826602 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: I7abb06b733c9a8d9ca08454e2ef1ae4228841cc8 Gerrit-Change-Number: 826602 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [doc] Reorder and split Pywikibot API Reference
by Xqt (Code Review) 25 Aug '22

25 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826598 ) Change subject: [doc] Reorder and split Pywikibot API Reference ...................................................................... [doc] Reorder and split Pywikibot API Reference - Reorder and split Pywikibot API Reference to be more clearer - Increase left navigation bar - Rewrite pge._decorators, otherwise Sphinx hides the content and shows wrong parameters Change-Id: Icaac8e9504e34f1b05be43a427aae0a5e47f1d57 --- M docs/_static/css/pywikibot.css A docs/api_ref/bot.rst A docs/api_ref/bot_choice.rst A docs/api_ref/cosmetic_changes.rst A docs/api_ref/daemonize.rst A docs/api_ref/date.rst A docs/api_ref/date_time.rst A docs/api_ref/diff.rst A docs/api_ref/echo.rst A docs/api_ref/editor.rst A docs/api_ref/exceptions.rst A docs/api_ref/family.rst A docs/api_ref/fixes.rst A docs/api_ref/flow.rst A docs/api_ref/i18n.rst M docs/api_ref/index.rst A docs/api_ref/iw_interwiki_graph.rst A docs/api_ref/iw_titletranslate.rst A docs/api_ref/logentries.rst A docs/api_ref/logging.rst A docs/api_ref/login.rst A docs/api_ref/proofreadpage.rst M docs/api_ref/pywikibot.comms.rst M docs/api_ref/pywikibot.config.rst M docs/api_ref/pywikibot.data.rst M docs/api_ref/pywikibot.families.rst M docs/api_ref/pywikibot.page.rst M docs/api_ref/pywikibot.pagegenerators.rst M docs/api_ref/pywikibot.rst M docs/api_ref/pywikibot.site.rst M docs/api_ref/pywikibot.specialbots.rst M docs/api_ref/pywikibot.tools.rst M docs/api_ref/pywikibot.userinterfaces.rst A docs/api_ref/reader.rst A docs/api_ref/site_detect.rst A docs/api_ref/textlib.rst A docs/api_ref/throttle.rst A docs/api_ref/version.rst A docs/api_ref/x_backports.rst M pywikibot/page/_decorators.py 40 files changed, 339 insertions(+), 362 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/docs/_static/css/pywikibot.css b/docs/_static/css/pywikibot.css index ea2ac64..56e8d93 100644 --- a/docs/_static/css/pywikibot.css +++ b/docs/_static/css/pywikibot.css @@ -34,4 +34,10 @@ } code.xref:hover { color: #900; +} +div.sphinxsidebar { + width: 250px +} +div.bodywrapper { + margin: 0 0 0 250px; } \ No newline at end of file diff --git a/docs/api_ref/bot.rst b/docs/api_ref/bot.rst new file mode 100644 index 0000000..12c5f10 --- /dev/null +++ b/docs/api_ref/bot.rst @@ -0,0 +1,6 @@ +:mod:`bot` --- Classes for Building Bots +---------------------------------------- + +.. automodule:: bot + :synopsis: User-interface related functions for building bots + :member-order: bysource diff --git a/docs/api_ref/bot_choice.rst b/docs/api_ref/bot_choice.rst new file mode 100644 index 0000000..652b57f --- /dev/null +++ b/docs/api_ref/bot_choice.rst @@ -0,0 +1,5 @@ +:mod:`bot\_choice` --- UI Options and Choices +--------------------------------------------- + +.. automodule:: bot_choice + :synopsis: Options and Choices for :func:`pywikibot.input_choice` diff --git a/docs/api_ref/cosmetic_changes.rst b/docs/api_ref/cosmetic_changes.rst new file mode 100644 index 0000000..9f25a8d --- /dev/null +++ b/docs/api_ref/cosmetic_changes.rst @@ -0,0 +1,5 @@ +:mod:`cosmetic\_changes` --- Cosmetic Changes of Wikitext +--------------------------------------------------------- + +.. automodule:: cosmetic_changes + :synopsis: This module can do slight modifications to tidy a wiki page's source code diff --git a/docs/api_ref/daemonize.rst b/docs/api_ref/daemonize.rst new file mode 100644 index 0000000..af1b7c5 --- /dev/null +++ b/docs/api_ref/daemonize.rst @@ -0,0 +1,5 @@ +:mod:`daemonize` --- Daemonize Current Process (Unix only) +---------------------------------------------------------- + +.. automodule:: daemonize + :synopsis: Module to daemonize the current process on Unix. diff --git a/docs/api_ref/date.rst b/docs/api_ref/date.rst new file mode 100644 index 0000000..2ecacf4 --- /dev/null +++ b/docs/api_ref/date.rst @@ -0,0 +1,5 @@ +:mod:`date` --- Date Classes and Functions +------------------------------------------ + +.. automodule:: date + :synopsis: Date data and manipulation module diff --git a/docs/api_ref/date_time.rst b/docs/api_ref/date_time.rst new file mode 100644 index 0000000..84832a0 --- /dev/null +++ b/docs/api_ref/date_time.rst @@ -0,0 +1,4 @@ +:mod:`time` --- Time Classes and Functions +------------------------------------------ + +.. automodule:: pywikibot.time diff --git a/docs/api_ref/diff.rst b/docs/api_ref/diff.rst new file mode 100644 index 0000000..c6f5641 --- /dev/null +++ b/docs/api_ref/diff.rst @@ -0,0 +1,5 @@ +:mod:`diff` --- Helpers for computing deltas +-------------------------------------------- + +.. automodule:: diff + :synopsis: Diff module diff --git a/docs/api_ref/echo.rst b/docs/api_ref/echo.rst new file mode 100644 index 0000000..30201b4 --- /dev/null +++ b/docs/api_ref/echo.rst @@ -0,0 +1,5 @@ +:mod:`echo` --- Echo Extension Classes and functions +---------------------------------------------------- + +.. automodule:: echo + :synopsis: Classes and functions for working with the Echo extension diff --git a/docs/api_ref/editor.rst b/docs/api_ref/editor.rst new file mode 100644 index 0000000..d2df798 --- /dev/null +++ b/docs/api_ref/editor.rst @@ -0,0 +1,5 @@ +:mod:`editor` --- Text editor class +----------------------------------- + +.. automodule:: editor + :synopsis: Text editor class for your favourite editor diff --git a/docs/api_ref/exceptions.rst b/docs/api_ref/exceptions.rst new file mode 100644 index 0000000..7e37052 --- /dev/null +++ b/docs/api_ref/exceptions.rst @@ -0,0 +1,5 @@ +:mod:`exceptions` --- Exceptions and Warning Classes +---------------------------------------------------- + +.. automodule:: exceptions + :synopsis: Pywikibot exceptions and warning classes diff --git a/docs/api_ref/family.rst b/docs/api_ref/family.rst new file mode 100644 index 0000000..316feb1 --- /dev/null +++ b/docs/api_ref/family.rst @@ -0,0 +1,5 @@ +:mod:`family` --- MediaWiki families +------------------------------------ + +.. automodule:: family + :synopsis: Objects representing MediaWiki families diff --git a/docs/api_ref/fixes.rst b/docs/api_ref/fixes.rst new file mode 100644 index 0000000..657e5ba --- /dev/null +++ b/docs/api_ref/fixes.rst @@ -0,0 +1,5 @@ +:mod:`fixes` --- standard fixes for replace.py script +----------------------------------------------------- + +.. automodule:: fixes + :synopsis: File containing all standard fixes diff --git a/docs/api_ref/flow.rst b/docs/api_ref/flow.rst new file mode 100644 index 0000000..a3f16dd --- /dev/null +++ b/docs/api_ref/flow.rst @@ -0,0 +1,5 @@ +:mod:`flow` --- Flow Entities +----------------------------- + +.. automodule:: flow + :synopsis: Objects representing Flow entities, like boards, topics, and posts diff --git a/docs/api_ref/i18n.rst b/docs/api_ref/i18n.rst new file mode 100644 index 0000000..d717537 --- /dev/null +++ b/docs/api_ref/i18n.rst @@ -0,0 +1,11 @@ +:mod:`i18n` --- i18n Support +---------------------------- + +.. automodule:: i18n + :synopsis: Various i18n functions + +:mod:`plural` --- i18n Plural rules +----------------------------------- + +.. automodule:: plural + :synopsis: Module containing plural rules of various languages \ No newline at end of file diff --git a/docs/api_ref/index.rst b/docs/api_ref/index.rst index 7196738..c6bb0df 100644 --- a/docs/api_ref/index.rst +++ b/docs/api_ref/index.rst @@ -13,10 +13,31 @@ functions provided by :mod:`data.api`. This layer then uses :func:`comms.http.request` to do the actual HTTP request. -Contents -======== +Table of Contents +================= .. toctree:: :glob: + :maxdepth: 2 + pywikibot + pywikibot.config + pywikibot.page + proofreadpage + pywikibot.pagegenerators + pywikibot.site + login + logentries + family + pywikibot.families + pywikibot.data + pywikibot.comms + exceptions + textlib + cosmetic_changes + bot + pywikibot.specialbots + bot_choice + pywikibot.userinterfaces + logging * diff --git a/docs/api_ref/iw_interwiki_graph.rst b/docs/api_ref/iw_interwiki_graph.rst new file mode 100644 index 0000000..4682f47 --- /dev/null +++ b/docs/api_ref/iw_interwiki_graph.rst @@ -0,0 +1,5 @@ +:mod:`interwiki\_graph` --- Graphviz Drawing for Interwiki +---------------------------------------------------------- + +.. automodule:: interwiki_graph + :synopsis: Module with the Graphviz drawing calls diff --git a/docs/api_ref/iw_titletranslate.rst b/docs/api_ref/iw_titletranslate.rst new file mode 100644 index 0000000..b7faab7 --- /dev/null +++ b/docs/api_ref/iw_titletranslate.rst @@ -0,0 +1,5 @@ +:mod:`titletranslate` --- Interwiki Title Translator +---------------------------------------------------- + +.. automodule:: titletranslate + :synopsis: Title translate module diff --git a/docs/api_ref/logentries.rst b/docs/api_ref/logentries.rst new file mode 100644 index 0000000..279f91b --- /dev/null +++ b/docs/api_ref/logentries.rst @@ -0,0 +1,5 @@ +:mod:`logentries` module +------------------------ + +.. automodule:: logentries + :synopsis: Objects representing Mediawiki log entries diff --git a/docs/api_ref/logging.rst b/docs/api_ref/logging.rst new file mode 100644 index 0000000..ee96efd --- /dev/null +++ b/docs/api_ref/logging.rst @@ -0,0 +1,8 @@ +.. module:: logging + :synopsis: User output/logging functions + +:mod:`logging` --- Logging Functions +------------------------------------ + +.. automodule:: pywikibot.logging + :member-order: bysource diff --git a/docs/api_ref/login.rst b/docs/api_ref/login.rst new file mode 100644 index 0000000..d0150ed --- /dev/null +++ b/docs/api_ref/login.rst @@ -0,0 +1,5 @@ +:mod:`login` module +------------------- + +.. automodule:: login + :synopsis: Library to log the bot in to a wiki account diff --git a/docs/api_ref/proofreadpage.rst b/docs/api_ref/proofreadpage.rst new file mode 100644 index 0000000..e477ea5 --- /dev/null +++ b/docs/api_ref/proofreadpage.rst @@ -0,0 +1,5 @@ +:mod:`proofreadpage` --- ProofreadPage Extension +------------------------------------------------ + +.. automodule:: proofreadpage + :synopsis: Objects used with ProofreadPage Extension diff --git a/docs/api_ref/pywikibot.comms.rst b/docs/api_ref/pywikibot.comms.rst index 16f2c32..566c41f 100644 --- a/docs/api_ref/pywikibot.comms.rst +++ b/docs/api_ref/pywikibot.comms.rst @@ -1,20 +1,18 @@ -:mod:`comms` package -==================== +:mod:`comms` --- Communication layer +==================================== .. automodule:: comms :synopsis: Communication layer -Submodules ----------- -:mod:`comms.eventstreams` module --------------------------------- +:mod:`comms.eventstreams` --- Server-Sent Events Client +------------------------------------------------------- .. automodule:: comms.eventstreams :synopsis: Server-Sent Events client -:mod:`comms.http` module ------------------------- +:mod:`comms.http` --- HTTP access interface +------------------------------------------- .. automodule:: comms.http :synopsis: Basic HTTP access interface diff --git a/docs/api_ref/pywikibot.config.rst b/docs/api_ref/pywikibot.config.rst index 2197a12..ca1fdd8 100644 --- a/docs/api_ref/pywikibot.config.rst +++ b/docs/api_ref/pywikibot.config.rst @@ -1,5 +1,5 @@ -:mod:`config` module --------------------- +:mod:`config` --- Pywikibot Config File +--------------------------------------- API reference ^^^^^^^^^^^^^ diff --git a/docs/api_ref/pywikibot.data.rst b/docs/api_ref/pywikibot.data.rst index 7eb2c10..1bfc4bb 100644 --- a/docs/api_ref/pywikibot.data.rst +++ b/docs/api_ref/pywikibot.data.rst @@ -1,38 +1,35 @@ -:mod:`data` package -=================== +:mod:`data` --- Data Exchange +============================= .. automodule:: data - :synopsis: + :synopsis: Data Exchange -Submodules ----------- - -:mod:`data.api` module ----------------------- +:mod:`data.api` --- MediaWiki API Requests +------------------------------------------ .. automodule:: data.api :synopsis: Module providing several layers of data access to the wiki -:mod:`data.memento` module --------------------------- +:mod:`data.memento` --- Memento Requests +---------------------------------------- .. automodule:: data.memento :synopsis: Fix ups for memento-client package version 0.6.1 -:mod:`data.mysql` module ------------------------- +:mod:`data.mysql` --- Mysql Requests +------------------------------------ .. automodule:: data.mysql :synopsis: Miscellaneous helper functions for mysql queries -:mod:`data.sparql` module -------------------------- +:mod:`data.sparql` --- SPARQL requests +-------------------------------------- .. automodule:: data.sparql :synopsis: SPARQL Query interface -:mod:`data.wikistats` module ----------------------------- +:mod:`data.wikistats` --- WikiStats requests +-------------------------------------------- .. automodule:: data.wikistats :synopsis: Objects representing WikiStats API diff --git a/docs/api_ref/pywikibot.families.rst b/docs/api_ref/pywikibot.families.rst index 8a8245f..a4ae622 100644 --- a/docs/api_ref/pywikibot.families.rst +++ b/docs/api_ref/pywikibot.families.rst @@ -1,170 +1,167 @@ -:mod:`families` package -======================= +:mod:`families` --- Family Config Files +======================================= .. automodule:: families :synopsis: Families package -Submodules ----------- - -:mod:`families.commons\_family` module --------------------------------------- +:mod:`families.commons\_family` --- Commons +------------------------------------------- .. automodule:: families.commons_family :synopsis: Family module for Wikimedia Commons -:mod:`families.foundation\_family` module ------------------------------------------ +:mod:`families.foundation\_family` --- Foundation Wiki +------------------------------------------------------ .. automodule:: families.foundation_family - :synopsis: Family module for Foundation wiki + :synopsis: Family module for Foundation Wiki -:mod:`families.i18n\_family` module ------------------------------------ +:mod:`families.i18n\_family` --- Translate Wiki +----------------------------------------------- .. automodule:: families.i18n_family :synopsis: Family module for Translate Wiki -:mod:`families.incubator\_family` module ----------------------------------------- +:mod:`families.incubator\_family` --- Incubator +----------------------------------------------- .. automodule:: families.incubator_family :synopsis: Family module for Incubator Wiki -:mod:`families.lingualibre\_family` module ------------------------------------------- +:mod:`families.lingualibre\_family` --- Lingua Libre +---------------------------------------------------- .. automodule:: families.lingualibre_family :synopsis: Family module for Lingua Libre -:mod:`families.mediawiki\_family` module ----------------------------------------- +:mod:`families.mediawiki\_family` --- MediaWiki +----------------------------------------------- .. automodule:: families.mediawiki_family - :synopsis: Family module for MediaWiki wiki + :synopsis: Family module for MediaWiki Wiki -:mod:`families.meta\_family` module ------------------------------------ +:mod:`families.meta\_family` --- Meta +------------------------------------- .. automodule:: families.meta_family :synopsis: Family module for Meta Wiki -:mod:`families.omegawiki\_family` module ----------------------------------------- +:mod:`families.omegawiki\_family` --- Omega +------------------------------------------- .. automodule:: families.omegawiki_family :synopsis: Family module for Omega Wiki -:mod:`families.osm\_family` module ----------------------------------- +:mod:`families.osm\_family` --- OpenStreetMap +--------------------------------------------- .. automodule:: families.osm_family - :synopsis: Family module for OpenStreetMap wiki + :synopsis: Family module for OpenStreetMap Wiki -:mod:`families.outreach\_family` module ---------------------------------------- +:mod:`families.outreach\_family` --- Outreach +--------------------------------------------- .. automodule:: families.outreach_family - :synopsis: Family module for Wikimedia outreach wiki + :synopsis: Family module for Wikimedia Outreach Wiki -:mod:`families.species\_family` module --------------------------------------- +:mod:`families.species\_family` --- Species +------------------------------------------- .. automodule:: families.species_family - :synopsis: Family module for Wikimedia species wiki + :synopsis: Family module for Wikimedia Species Wiki -:mod:`families.vikidia\_family` module --------------------------------------- +:mod:`families.vikidia\_family` --- Vikidia +------------------------------------------- .. automodule:: families.vikidia_family - :synopsis: Family module for Vikidia + :synopsis: Family module for Vikidia Wiki -:mod:`families.wikibooks\_family` module ----------------------------------------- +:mod:`families.wikibooks\_family` --- Wikibooks +----------------------------------------------- .. automodule:: families.wikibooks_family :synopsis: Family module for Wikibooks -:mod:`families.wikidata\_family` module ---------------------------------------- +:mod:`families.wikidata\_family` --- Wikidata +--------------------------------------------- .. automodule:: families.wikidata_family :synopsis: Family module for Wikidata -:mod:`families.wikihow\_family` module --------------------------------------- +:mod:`families.wikihow\_family` --- Wikihow +------------------------------------------- .. automodule:: families.wikihow_family - :synopsis: Family module for Wikihow wiki + :synopsis: Family module for Wikihow Wiki -:mod:`families.wikimania\_family` module ----------------------------------------- +:mod:`families.wikimania\_family` --- Wikimania +----------------------------------------------- .. automodule:: families.wikimania_family - :synopsis: Family module for Wikimania wikis + :synopsis: Family module for Wikimania Wikis -:mod:`families.wikimediachapter\_family` module ------------------------------------------------ +:mod:`families.wikimediachapter\_family` --- Wikimedia Chapter +-------------------------------------------------------------- .. automodule:: families.wikimediachapter_family :synopsis: Family module for Wikimedia chapter, thematic organisation and WUG wikis -:mod:`families.wikinews\_family` module ---------------------------------------- +:mod:`families.wikinews\_family` --- Wikinews +--------------------------------------------- .. automodule:: families.wikinews_family :synopsis: Family module for Wikinews -:mod:`families.wikipedia\_family` module ----------------------------------------- +:mod:`families.wikipedia\_family` --- Wikipedia +----------------------------------------------- .. automodule:: families.wikipedia_family :synopsis: Family module for Wikipedia -:mod:`families.wikiquote\_family` module ----------------------------------------- +:mod:`families.wikiquote\_family` --- Wikiquote +----------------------------------------------- .. automodule:: families.wikiquote_family :synopsis: Family module for Wikiquote -:mod:`families.wikisource\_family` module ------------------------------------------ +:mod:`families.wikisource\_family` --- Wikisource +------------------------------------------------- .. automodule:: families.wikisource_family - :synopsis:Family module for Wikisource + :synopsis: Family module for Wikisource -:mod:`families.wikisopore\_family` module ------------------------------------------ +:mod:`families.wikisopore\_family` --- Wikispore +------------------------------------------------ .. automodule:: families.wikispore_family :synopsis: Family module for Wikispore -:mod:`families.wikitech\_family` module ---------------------------------------- +:mod:`families.wikitech\_family` --- Wikitech +--------------------------------------------- .. automodule:: families.wikitech_family :synopsis: Family module for Wikitech -:mod:`families.wikiversity\_family` module ------------------------------------------- +:mod:`families.wikiversity\_family` --- Wikiversity +--------------------------------------------------- .. automodule:: families.wikiversity_family :synopsis: Family module for Wikiversity -:mod:`families.wikivoyage\_family` module ------------------------------------------ +:mod:`families.wikivoyage\_family`--- Wikivoyage +------------------------------------------------ .. automodule:: families.wikivoyage_family :synopsis: Family module for Wikivoyage -:mod:`families.wiktionary\_family` module ------------------------------------------ +:mod:`families.wiktionary\_family` --- Wiktionary +------------------------------------------------- .. automodule:: families.wiktionary_family :synopsis: Family module for Wiktionary -:mod:`families.wowwiki\_family` module --------------------------------------- +:mod:`families.wowwiki\_family` --- Fandom WOW +---------------------------------------------- .. automodule:: families.wowwiki_family - :synopsis: Family module for WOW wiki + :synopsis: Family module for Fandom WOW Wiki diff --git a/docs/api_ref/pywikibot.page.rst b/docs/api_ref/pywikibot.page.rst index 18e7eb7..d451b9c 100644 --- a/docs/api_ref/pywikibot.page.rst +++ b/docs/api_ref/pywikibot.page.rst @@ -1,5 +1,5 @@ -:mod:`page` package -=================== +:mod:`page` --- MediaWiki Pages +=============================== .. automodule:: page :synopsis: Interface of various types of MediaWiki pages @@ -7,20 +7,21 @@ Submodules ---------- -:mod:`page.\_collections` module --------------------------------- +:mod:`page.\_collections` Wikibase Entity Structures +---------------------------------------------------- -.. automodule:: page._collections +.. automodule:: pywikibot.page._collections :synopsis: Structures holding data for Wikibase entities -:mod:`page.\_decorators` module -------------------------------- +:mod:`page.\_decorators` --- Page Decorators +-------------------------------------------- .. automodule:: page._decorators :synopsis: Decorators for Page objects + :private-members: -:mod:`page.\_revision` module ------------------------------ +:mod:`page.\_revision` --- Page Revision +---------------------------------------- .. automodule:: page._revision :synopsis: Object representing page revision diff --git a/docs/api_ref/pywikibot.pagegenerators.rst b/docs/api_ref/pywikibot.pagegenerators.rst index 72aef9c..3a8fcd5 100644 --- a/docs/api_ref/pywikibot.pagegenerators.rst +++ b/docs/api_ref/pywikibot.pagegenerators.rst @@ -1,23 +1,23 @@ -:mod:`pagegenerators` package -============================= +:mod:`pagegenerators` --- Page Generators +========================================= .. automodule:: pagegenerators :synopsis: This module offers a wide variety of page generators -:mod:`pagegenerators.\_factory` module --------------------------------------- +:mod:`pagegenerators.\_factory` --- Pagegenerators Options Handler +------------------------------------------------------------------ .. automodule:: pagegenerators._factory :synopsis: GeneratorFactory module wich handles pagegenerators options -:mod:`pagegenerators.\_filters` module --------------------------------------- +:mod:`pagegenerators.\_filters` --- Filter Funtions +--------------------------------------------------- .. automodule:: pagegenerators._filters :synopsis: Page filter generators provided by the pagegenerators module -:mod:`pagegenerators.\_generators` module ------------------------------------------ +:mod:`pagegenerators.\_generators` --- Generator Functions +---------------------------------------------------------- .. automodule:: pagegenerators._generators :synopsis: Page filter generators provided by the pagegenerators module diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index 53aebe5..3ae62f5 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -1,192 +1,4 @@ -pywikibot package -================= +:mod:`pywikibot` --- Base Classes and Functions +=============================================== .. automodule:: pywikibot - -Pywikibot Subpackages ---------------------- - -.. toctree:: - - pywikibot.comms - pywikibot.data - pywikibot.families - pywikibot.page - pywikibot.pagegenerators - pywikibot.site - pywikibot.specialbots - pywikibot.tools - pywikibot.userinterfaces - -Submodules ----------- - -:mod:`backports` module ------------------------ - -.. automodule:: backports - :synopsis: This module contains backports to support older Python versions - -:mod:`bot` module ------------------ - -.. automodule:: bot - :synopsis: User-interface related functions for building bots - :member-order: bysource - -:mod:`bot\_choice` module -------------------------- - -.. automodule:: bot_choice - :synopsis: Options and Choices for :func:`pywikibot.input_choice` - -.. include:: pywikibot.config.rst - -:mod:`cosmetic\_changes` module -------------------------------- - -.. automodule:: cosmetic_changes - :synopsis: This module can do slight modifications to tidy a wiki page's source code - -:mod:`daemonize` module ------------------------ - -.. automodule:: daemonize - :synopsis: Module to daemonize the current process on Unix. - -:mod:`date` module ------------------- - -.. automodule:: date - :synopsis: Date data and manipulation module - -:mod:`diff` module ------------------- - -.. automodule:: diff - :synopsis: Diff module - -:mod:`echo` module ------------------- - -.. automodule:: echo - :synopsis: Classes and functions for working with the Echo extension - -:mod:`editor` module --------------------- - -.. automodule:: editor - :synopsis: Text editor class for your favourite editor - -:mod:`exceptions` module ------------------------- - -.. automodule:: exceptions - :synopsis: Pywikibot exceptions and warning classes - -:mod:`family` module --------------------- - -.. automodule:: family - :synopsis: Objects representing MediaWiki families - -:mod:`fixes` module -------------------- - -.. automodule:: fixes - :synopsis: File containing all standard fixes - -:mod:`flow` module ------------------- - -.. automodule:: flow - :synopsis: Objects representing Flow entities, like boards, topics, and posts - -:mod:`i18n` module ------------------- - -.. automodule:: i18n - :synopsis: Various i18n functions - -:mod:`interwiki\_graph` module ------------------------------- - -.. automodule:: interwiki_graph - :synopsis: Module with the Graphviz drawing calls - -:mod:`logentries` module ------------------------- - -.. automodule:: logentries - :synopsis: Objects representing Mediawiki log entries - -.. module:: logging - :synopsis: User output/logging functions - -:mod:`logging` module ---------------------- - -.. automodule:: pywikibot.logging - :member-order: bysource - -:mod:`login` module -------------------- - -.. automodule:: login - :synopsis: Library to log the bot in to a wiki account - -:mod:`plural` module --------------------- - -.. automodule:: plural - :synopsis: Module containing plural rules of various languages - -:mod:`proofreadpage` module ---------------------------- - -.. automodule:: proofreadpage - :synopsis: Objects used with ProofreadPage Extension - -:mod:`site\_detect` module --------------------------- - -.. automodule:: site_detect - :synopsis: Classes for detecting a MediaWiki site - -:mod:`textlib` module ---------------------- - -.. automodule:: textlib - :synopsis: Functions for manipulating wiki-text - -:mod:`throttle` module ----------------------- - -.. automodule:: throttle - :synopsis: Mechanics to slow down wiki read and/or write rate - -.. module:: time - :synopsis: Time handling module - -:mod:`time` module ------------------- - -.. automodule:: pywikibot.time - -:mod:`titletranslate` module ----------------------------- - -.. automodule:: titletranslate - :synopsis: Title translate module - -:mod:`version` module ---------------------- - -.. automodule:: version - :synopsis: Module to determine the pywikibot version (tag, revision and date) - -:mod:`xmlreader` module ------------------------ - -.. automodule:: xmlreader - :synopsis: XML reading module diff --git a/docs/api_ref/pywikibot.site.rst b/docs/api_ref/pywikibot.site.rst index 77093b3..046348e 100644 --- a/docs/api_ref/pywikibot.site.rst +++ b/docs/api_ref/pywikibot.site.rst @@ -1,5 +1,5 @@ -:mod:`site` package -=================== +:mod:`site` --- MediaWiki sites +=============================== .. py:module:: site :synopsis: Library module representing MediaWiki sites (wikis) @@ -8,8 +8,8 @@ :no-members: :noindex: -:mod:`BaseSite<pywikibot.site._basesite>` package -------------------------------------------------- +:mod:`BaseSite<pywikibot.site._basesite>` --- Base Class for Sites +------------------------------------------------------------------ .. py:module:: site._basesite :synopsis: Objects with site methods independent of the communication interface @@ -19,8 +19,8 @@ .. py:module:: site._apisite :synopsis: Objects representing API interface to MediaWiki site -:mod:`APISite<pywikibot.site.\_apisite>` Package ------------------------------------------------- +:mod:`APISite<pywikibot.site.\_apisite>` --- API Interface for Sites +-------------------------------------------------------------------- .. automodule:: pywikibot.site._apisite @@ -30,48 +30,48 @@ .. automodule:: pywikibot.site._generators :synopsis: Objects representing API generators to MediaWiki site -:mod:`DataSite<pywikibot.site.\_datasite>` Package --------------------------------------------------- +:mod:`DataSite<pywikibot.site.\_datasite>` --- API Interface for Wikibase +------------------------------------------------------------------------- .. py:module:: site._datasite :synopsis: Objects representing API interface to Wikibase site .. automodule:: pywikibot.site._datasite -:mod:`Obsolete Sites<pywikibot.site._obsoletesites>` Package ------------------------------------------------------------- +:mod:`Obsolete Sites<pywikibot.site._obsoletesites>` --- Outdated Sites +----------------------------------------------------------------------- .. py:module:: site._obsoletesites :synopsis: Objects representing obsolete MediaWiki sites .. automodule:: pywikibot.site._obsoletesites -:mod:`Siteinfo<pywikibot.site._siteinfo>` Package -------------------------------------------------- +:mod:`Siteinfo<pywikibot.site._siteinfo>` --- Site Info Container +----------------------------------------------------------------- .. py:module:: site._siteinfo :synopsis: Objects representing site info data contents .. automodule:: pywikibot.site._siteinfo -:mod:`Namespace<pywikibot.site._namespace>` Package ---------------------------------------------------- +:mod:`Namespace<pywikibot.site._namespace>` --- Namespace Object +---------------------------------------------------------------- .. py:module:: site._namespace :synopsis: Objects representing Namespaces of MediaWiki site .. automodule:: pywikibot.site._namespace -:mod:`TokenWallet<pywikibot.site._tokenwallet>` Package -------------------------------------------------------- +:mod:`TokenWallet<pywikibot.site._tokenwallet>` --- Token Wallet +---------------------------------------------------------------- .. py:module:: site._tokenwallet :synopsis: Objects representing api tokens .. automodule:: pywikibot.site._tokenwallet -:mod:`Uploader<pywikibot.site._upload>` Package ------------------------------------------------ +:mod:`Uploader<pywikibot.site._upload>` --- Uploader Interface +-------------------------------------------------------------- .. py:module:: site._upload :synopsis: Objects representing API upload to MediaWiki site diff --git a/docs/api_ref/pywikibot.specialbots.rst b/docs/api_ref/pywikibot.specialbots.rst index ee34884..7a91759 100644 --- a/docs/api_ref/pywikibot.specialbots.rst +++ b/docs/api_ref/pywikibot.specialbots.rst @@ -1,5 +1,5 @@ -:mod:`specialbots` package -========================== +:mod:`specialbots` --- Special Reusable Bots +============================================ .. automodule:: specialbots :synopsis: Module containing special bots reusable by scripts \ No newline at end of file diff --git a/docs/api_ref/pywikibot.tools.rst b/docs/api_ref/pywikibot.tools.rst index 5b46ea8..8ed647e 100644 --- a/docs/api_ref/pywikibot.tools.rst +++ b/docs/api_ref/pywikibot.tools.rst @@ -1,47 +1,47 @@ -:mod:`tools` package -==================== +:mod:`tools` --- Miscellaneous Helper Functions +=============================================== .. automodule:: tools :synopsis: Miscellaneous helper functions (not wiki-dependent) -:mod:`tools.chars` module -------------------------- +:mod:`tools.chars` --- Character Based Helper Functions +------------------------------------------------------- .. automodule:: tools.chars :synopsis: Character based helper functions (not wiki-dependent) -:mod:`tools.collections` module -------------------------------- +:mod:`tools.collections` --- Container datatypes +------------------------------------------------ .. automodule:: tools.collections :synopsis: Collections datatypes -:mod:`tools.deprecate` module ------------------------------ +:mod:`tools.deprecate` --- Deprecating Decorators and Classes +------------------------------------------------------------- .. automodule:: tools._deprecate :synopsis: Module providing deprecation decorators -:mod:`tools.djvu` module ------------------------- +:mod:`tools.djvu` --- DJVU files wrapper +---------------------------------------- .. automodule:: tools.djvu :synopsis: Wrapper around djvulibre to access djvu files properties and content -:mod:`tools.formatter` module ------------------------------ +:mod:`tools.formatter` --- Formatting Related Functions and Classes +------------------------------------------------------------------- .. automodule:: tools.formatter :synopsis: Module containing various formatting related utilities -:mod:`tools.itertools` module ------------------------------ +:mod:`tools.itertools` --- Iterators for Efficient Looping +---------------------------------------------------------- .. automodule:: tools.itertools :synopsis: Iterator functions -:mod:`tools.\_logging` module ------------------------------ +:mod:`tools.\_logging` --- logging.Formatter Subclass +----------------------------------------------------- .. automodule:: tools._logging :synopsis: Logging tools diff --git a/docs/api_ref/pywikibot.userinterfaces.rst b/docs/api_ref/pywikibot.userinterfaces.rst index bf08f20..bb1240b 100644 --- a/docs/api_ref/pywikibot.userinterfaces.rst +++ b/docs/api_ref/pywikibot.userinterfaces.rst @@ -1,59 +1,59 @@ -:mod:`userinterfaces` package -============================= +:mod:`userinterfaces` --- User interfaces +========================================= .. automodule:: userinterfaces :synopsis: User interfaces module -:mod:`\_interface\_base` module -------------------------------- +:mod:`\_interface\_base` --- Abstract User Interface +---------------------------------------------------- .. automodule:: userinterfaces._interface_base :synopsis: Abstract base user interface module -:mod:`terminal\_interface` module ---------------------------------- +:mod:`terminal\_interface` module --- Terminal User Interface +------------------------------------------------------------- .. automodule:: userinterfaces.terminal_interface :synopsis: Platform independent terminal interface module -:mod:`terminal\_interface\_base` module ---------------------------------------- +:mod:`terminal\_interface\_base` --- Base Terminal Interface +------------------------------------------------------------- .. automodule:: userinterfaces.terminal_interface_base :synopsis: Base for terminal user interfaces -:mod:`terminal\_interface\_unix` module ---------------------------------------- +:mod:`terminal\_interface\_unix` --- Unix Terminal Interface +------------------------------------------------------------ .. automodule:: userinterfaces.terminal_interface_unix :synopsis: User interface for Unix terminals -:mod:`terminal\_interface\_win32` module ----------------------------------------- +:mod:`terminal\_interface\_win32` ---- Windows Terminal Interface +----------------------------------------------------------------- .. automodule:: userinterfaces.terminal_interface_win32 :synopsis: User interface for Win32 terminals -:mod:`buffer\_interface` module -------------------------------- +:mod:`buffer\_interface` --- Buffer Interface +--------------------------------------------- .. automodule:: userinterfaces.buffer_interface :synopsis: Non-interactive interface that stores output -:mod:`gui` module ------------------ +:mod:`gui` --- Graphical User Interface +--------------------------------------- .. automodule:: userinterfaces.gui :synopsis: A window with a textfield where the user can edit -:mod:`transliteration` module ------------------------------ +:mod:`transliteration` --- Transliteration +------------------------------------------ .. automodule:: userinterfaces.transliteration :synopsis: Module to transliterate text -:mod:`win32\_unicode` module ----------------------------- +:mod:`win32\_unicode` --- Unicode Interface for Python 3.5 +---------------------------------------------------------- .. automodule:: userinterfaces.win32_unicode :synopsis: Unicode support for stdout, stderr and argv with Python 3.5. diff --git a/docs/api_ref/reader.rst b/docs/api_ref/reader.rst new file mode 100644 index 0000000..83e2d16 --- /dev/null +++ b/docs/api_ref/reader.rst @@ -0,0 +1,5 @@ +:mod:`xmlreader` --- XML Reader +------------------------------- + +.. automodule:: xmlreader + :synopsis: XML reading module diff --git a/docs/api_ref/site_detect.rst b/docs/api_ref/site_detect.rst new file mode 100644 index 0000000..bd08507 --- /dev/null +++ b/docs/api_ref/site_detect.rst @@ -0,0 +1,5 @@ +:mod:`site\_detect` --- Classes for Detecting MediaWiki Sites +------------------------------------------------------------- + +.. automodule:: site_detect + :synopsis: Classes for detecting a MediaWiki site diff --git a/docs/api_ref/textlib.rst b/docs/api_ref/textlib.rst new file mode 100644 index 0000000..d1708ac --- /dev/null +++ b/docs/api_ref/textlib.rst @@ -0,0 +1,5 @@ +:mod:`textlib` --- Changing Wikitext +------------------------------------ + +.. automodule:: textlib + :synopsis: Functions for manipulating wiki-text diff --git a/docs/api_ref/throttle.rst b/docs/api_ref/throttle.rst new file mode 100644 index 0000000..71eda40 --- /dev/null +++ b/docs/api_ref/throttle.rst @@ -0,0 +1,5 @@ +:mod:`throttle` --- Slow Down Wiki I/O +-------------------------------------- + +.. automodule:: throttle + :synopsis: Mechanics to slow down wiki read and/or write rate diff --git a/docs/api_ref/version.rst b/docs/api_ref/version.rst new file mode 100644 index 0000000..58e7b9d --- /dev/null +++ b/docs/api_ref/version.rst @@ -0,0 +1,5 @@ +:mod:`version` --- Determine Pywikibot Version +---------------------------------------------- + +.. automodule:: version + :synopsis: Module to determine the pywikibot version (tag, revision and date) diff --git a/docs/api_ref/x_backports.rst b/docs/api_ref/x_backports.rst new file mode 100644 index 0000000..6c72988 --- /dev/null +++ b/docs/api_ref/x_backports.rst @@ -0,0 +1,5 @@ +:mod:`backports` - Python Backports +----------------------------------- + +.. automodule:: backports + :synopsis: This module contains backports to support older Python versions diff --git a/pywikibot/page/_decorators.py b/pywikibot/page/_decorators.py index ae20bb0..bf6722b 100644 --- a/pywikibot/page/_decorators.py +++ b/pywikibot/page/_decorators.py @@ -14,8 +14,8 @@ from pywikibot.tools import add_full_name, manage_wrapping -@add_full_name -def allow_asynchronous(func): +# decorating this function leads sphinx to hide it +def _allow_asynchronous(func): """ Decorator to make it possible to run a BasePage method asynchronously. @@ -23,6 +23,8 @@ Optionally, you can also provide kwarg callback, which, if provided, is a callable that gets the page as the first and a possible exception that occurred during saving in the second thread or None as the second argument. + + :meta public: """ def handle(func, self, *args, **kwargs): do_async = kwargs.pop('asynchronous', False) @@ -55,3 +57,7 @@ manage_wrapping(wrapper, func) return wrapper + + +#: `_allow_asynchronous` decorated with :func:`tools.add_full_name` +allow_asynchronous = add_full_name(_allow_asynchronous) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/826598 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: Icaac8e9504e34f1b05be43a427aae0a5e47f1d57 Gerrit-Change-Number: 826598 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [L10N] Update languages_by_size
by jenkins-bot (Code Review) 23 Aug '22

23 Aug '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/825691 ) Change subject: [L10N] Update languages_by_size ...................................................................... [L10N] Update languages_by_size Change-Id: Iad8ab76bebfa403a0c6b111af9b701a005f83267 --- M pywikibot/families/wikibooks_family.py M pywikibot/families/wikipedia_family.py M pywikibot/families/wikiquote_family.py M pywikibot/families/wiktionary_family.py 4 files changed, 17 insertions(+), 17 deletions(-) Approvals: Meno25: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/families/wikibooks_family.py b/pywikibot/families/wikibooks_family.py index bf28930..059d624 100644 --- a/pywikibot/families/wikibooks_family.py +++ b/pywikibot/families/wikibooks_family.py @@ -31,7 +31,7 @@ languages_by_size = [ 'en', 'hu', 'de', 'vi', 'fr', 'it', 'ja', 'pt', 'es', 'nl', 'pl', 'id', 'he', 'fi', 'zh', 'sq', 'az', 'fa', 'ru', 'ca', 'eu', 'th', 'da', 'ko', - 'ba', 'sv', 'gl', 'cs', 'hi', 'sr', 'uk', 'hr', 'no', 'tr', 'sa', 'ar', + 'ba', 'sv', 'gl', 'cs', 'sr', 'hi', 'uk', 'hr', 'no', 'tr', 'sa', 'ar', 'ta', 'eo', 'sk', 'is', 'bn', 'ro', 'si', 'bg', 'ms', 'ka', 'mk', 'tt', 'lt', 'el', 'li', 'sl', 'tl', 'ur', 'km', 'la', 'mr', 'kk', 'te', 'et', 'be', 'ia', 'ml', 'oc', 'hy', 'ne', 'pa', 'cv', 'tg', 'ku', 'fy', 'af', diff --git a/pywikibot/families/wikipedia_family.py b/pywikibot/families/wikipedia_family.py index 8938e08..b931d2c 100644 --- a/pywikibot/families/wikipedia_family.py +++ b/pywikibot/families/wikipedia_family.py @@ -35,28 +35,28 @@ 'zh-yue', 'lv', 'tg', 'af', 'my', 'mg', 'bs', 'oc', 'sq', 'mr', 'nds', 'ky', 'ml', 'be-tarask', 'te', 'sw', 'br', 'new', 'jv', 'vec', 'ht', 'pms', 'pnb', 'su', 'lb', 'ba', 'lld', 'ga', 'szl', 'lmo', 'is', 'ku', - 'cv', 'fy', 'vo', 'tl', 'ckb', 'wuu', 'an', 'sco', 'diq', 'pa', 'yo', - 'io', 'ne', 'gu', 'als', 'kn', 'bar', 'scn', 'bpy', 'avk', 'ia', 'qu', - 'mn', 'nv', 'crh', 'xmf', 'si', 'ha', 'bat-smg', 'os', 'frr', 'gd', - 'or', 'cdo', 'ps', 'bug', 'yi', 'ilo', 'sd', 'ban', 'am', 'nap', 'sah', + 'cv', 'fy', 'tl', 'ckb', 'wuu', 'an', 'vo', 'sco', 'diq', 'pa', 'io', + 'ne', 'yo', 'gu', 'als', 'kn', 'bar', 'scn', 'bpy', 'avk', 'ia', 'qu', + 'mn', 'nv', 'crh', 'xmf', 'si', 'ha', 'bat-smg', 'os', 'frr', 'or', + 'gd', 'ps', 'cdo', 'bug', 'yi', 'ilo', 'ban', 'sd', 'am', 'nap', 'sah', 'hsb', 'fo', 'map-bms', 'li', 'mai', 'mzn', 'gor', 'eml', 'ace', 'bcl', 'sa', 'shn', 'wa', 'zh-classical', 'ie', 'lij', 'as', 'zu', 'mhr', - 'mrj', 'hif', 'hyw', 'mni', 'km', 'hak', 'roa-tara', 'ig', 'pam', + 'mrj', 'hif', 'hyw', 'mni', 'km', 'ig', 'hak', 'roa-tara', 'pam', 'nso', 'sn', 'so', 'rue', 'bh', 'se', 'myv', 'vls', 'nds-nl', 'mi', 'sat', 'sc', 'nah', 'vep', 'gan', 'kab', 'glk', 'tk', 'fiu-vro', 'co', - 'bo', 'ab', 'ary', 'gv', 'frp', 'kw', 'kv', 'csb', 'pcd', 'ug', 'skr', - 'udm', 'zea', 'ay', 'gn', 'tum', 'nrm', 'mt', 'bjn', 'smn', 'lez', + 'bo', 'ab', 'gv', 'ary', 'frp', 'kw', 'kv', 'csb', 'pcd', 'ug', 'udm', + 'skr', 'tum', 'zea', 'ay', 'gn', 'nrm', 'mt', 'bjn', 'smn', 'lez', 'lfn', 'stq', 'lo', 'olo', 'mwl', 'fur', 'rm', 'ang', 'lad', 'gom', 'koi', 'ext', 'tyv', 'dsb', 'rw', 'dty', 'ln', 'av', 'cbk-zam', 'dv', 'ksh', 'gag', 'bxr', 'pfl', 'pap', 'pag', 'pi', 'haw', 'awa', 'tay', - 'tw', 'inh', 'krc', 'xal', 'szy', 'za', 'dag', 'kaa', 'pdc', 'mdf', + 'tw', 'inh', 'krc', 'dag', 'xal', 'szy', 'za', 'mdf', 'kaa', 'pdc', 'atj', 'to', 'arc', 'tcy', 'kbp', 'jam', 'na', 'wo', 'kbd', 'nia', - 'nov', 'ki', 'tet', 'lg', 'bi', 'mnw', 'tpi', 'nqo', 'jbo', 'roa-rup', + 'nov', 'ki', 'tet', 'mnw', 'lg', 'bi', 'tpi', 'nqo', 'jbo', 'roa-rup', 'fj', 'lbe', 'kg', 'xh', 'ty', 'ks', 'cu', 'shi', 'srn', 'trv', 'om', 'sm', 'guw', 'gcr', 'alt', 'chr', 'ltg', 'ny', 'pih', 'got', 'mad', 'st', 'ami', 'blk', 'tn', 'bm', 've', 'rmy', 'ts', 'chy', 'rn', 'iu', 'ak', 'ss', 'ch', 'ff', 'pnt', 'kcg', 'ady', 'ik', 'ee', 'sg', 'din', - 'pwn', 'kl', 'ti', 'dz', 'cr', 'pcm', + 'pwn', 'kl', 'pcm', 'ti', 'dz', 'cr', ] # Sites we want to edit but not count as real languages diff --git a/pywikibot/families/wikiquote_family.py b/pywikibot/families/wikiquote_family.py index 2af135f..01feb57 100644 --- a/pywikibot/families/wikiquote_family.py +++ b/pywikibot/families/wikiquote_family.py @@ -29,7 +29,7 @@ languages_by_size = [ 'it', 'en', 'pl', 'ru', 'cs', 'et', 'pt', 'fa', 'uk', 'de', 'fr', 'he', 'es', 'eo', 'tr', 'sk', 'bs', 'ca', 'az', 'fi', 'sl', 'zh', 'lt', 'ar', - 'bg', 'hy', 'hr', 'el', 'su', 'nn', 'id', 'sr', 'sv', 'li', 'hu', 'ko', + 'bg', 'hy', 'hr', 'el', 'su', 'nn', 'sr', 'id', 'sv', 'li', 'hu', 'ko', 'nl', 'sah', 'ja', 'la', 'ta', 'gl', 'gu', 'ur', 'be', 'te', 'vi', 'cy', 'no', 'ml', 'sq', 'hi', 'kn', 'eu', 'ro', 'ku', 'uz', 'ka', 'da', 'sa', 'is', 'br', 'mr', 'af', 'th', 'wo', 'ky', diff --git a/pywikibot/families/wiktionary_family.py b/pywikibot/families/wiktionary_family.py index 2f6ae1a..c7e32a1 100644 --- a/pywikibot/families/wiktionary_family.py +++ b/pywikibot/families/wiktionary_family.py @@ -34,14 +34,14 @@ 'jv', 'az', 'eu', 'uk', 'br', 'ast', 'is', 'da', 'lo', 'simple', 'bn', 'la', 'hr', 'sg', 'fj', 'tg', 'sk', 'ky', 'bg', 'wa', 'shn', 'ur', 'mnw', 'ps', 'cy', 'vo', 'om', 'he', 'sl', 'af', 'zh-min-nan', 'scn', - 'tl', 'lmo', 'pa', 'sw', 'fy', 'nn', 'ms', 'ka', 'lv', 'min', 'sq', + 'lmo', 'tl', 'pa', 'sw', 'fy', 'ms', 'nn', 'ka', 'lv', 'min', 'sq', 'nds', 'lb', 'co', 'mn', 'pnb', 'bs', 'nah', 'yue', 'sa', 'kk', 'km', 'diq', 'vec', 'be', 'tk', 'mk', 'nia', 'sm', 'hsb', 'ks', 'shy', 'su', 'gd', 'ga', 'bcl', 'mr', 'gom', 'an', 'wo', 'mni', 'ia', 'ang', 'mt', - 'sd', 'fo', 'tt', 'gn', 'ie', 'so', 'csb', 'ug', 'si', 'st', 'roa-rup', - 'mi', 'tpi', 'hif', 'kl', 'ha', 'zu', 'ay', 'jbo', 'yi', 'ln', 'gu', - 'na', 'gv', 'kw', 'am', 'ne', 'rw', 'ts', 'qu', 'ss', 'iu', 'chr', - 'dv', 'ti', 'tn', 'bjn', 'guw', + 'sd', 'fo', 'tt', 'gn', 'ie', 'so', 'csb', 'ug', 'mi', 'si', 'st', + 'roa-rup', 'tpi', 'hif', 'kl', 'ha', 'zu', 'bjn', 'ay', 'jbo', 'yi', + 'ln', 'gu', 'na', 'gv', 'kw', 'guw', 'am', 'ne', 'rw', 'ts', 'qu', + 'ss', 'iu', 'chr', 'dv', 'ti', 'tn', ] category_redirect_templates = { -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/825691 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: Iad8ab76bebfa403a0c6b111af9b701a005f83267 Gerrit-Change-Number: 825691 Gerrit-PatchSet: 2 Gerrit-Owner: Meno25 <meno25mail(a)gmail.com> Gerrit-Reviewer: Meno25 <meno25mail(a)gmail.com> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [IMPR] use subprocess.check_call instead of run
by jenkins-bot (Code Review) 22 Aug '22

22 Aug '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/825366 ) Change subject: [IMPR] use subprocess.check_call instead of run ...................................................................... [IMPR] use subprocess.check_call instead of run Also set shell=True because we have a string as command line Change-Id: Iadd06abafa9706b9ffac4c82a6079b412719c283 --- M make_dist.py 1 file changed, 7 insertions(+), 7 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/make_dist.py b/make_dist.py index b975f47..a285a7f 100644 --- a/make_dist.py +++ b/make_dist.py @@ -43,8 +43,8 @@ # Distributed under the terms of the MIT license. # import shutil -import subprocess import sys +from subprocess import check_call from pathlib import Path from pywikibot import __version__, error, info, input_yn, warning @@ -140,8 +140,8 @@ local, remote, clear, upgrade, nodist = handle_args() if upgrade: - subprocess.run('python -m pip install --upgrade pip') - subprocess.run('pip install --upgrade setuptools wheel twine ') + check_call('python -m pip install --upgrade pip', shell=True) + check_call('pip install --upgrade setuptools wheel twine ', shell=True) if clear: clear_old_dist() @@ -159,13 +159,13 @@ cleanup() if local: - subprocess.run('pip uninstall pywikibot -y') - subprocess.run( - 'pip install --no-index --pre --find-links=dist pywikibot') + check_call('pip uninstall pywikibot -y', shell=True) + check_call('pip install --no-index --pre --find-links=dist pywikibot', + shell=True) if remote and input_yn( '<<lightblue>>Upload dist to pypi', automatic_quit=False): - subprocess.run('twine upload dist/*') + check_call('twine upload dist/*', shell=True) if __name__ == '__main__': -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/825366 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: Iadd06abafa9706b9ffac4c82a6079b412719c283 Gerrit-Change-Number: 825366 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [flake8] Use flake8 >= 5.0.2 with Python 3.8
by Xqt (Code Review) 22 Aug '22

22 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/825362 ) Change subject: [flake8] Use flake8 >= 5.0.2 with Python 3.8 ...................................................................... [flake8] Use flake8 >= 5.0.2 with Python 3.8 Change-Id: I7059a626f6ea3fd03a6d65bf572344ff12ef4485 --- M dev-requirements.txt M setup.py 2 files changed, 2 insertions(+), 2 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/dev-requirements.txt b/dev-requirements.txt index 107391b..7cb8ea1 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -21,7 +21,7 @@ pydocstyle>=4.0.0 flake8==3.9.2; python_version < "3.6" -flake8>=5.0.0; python_version >= "3.6" +flake8>=5.0.2; python_version >= "3.6" flake8-docstrings>=0.2.6 flake8-isort;python_version>="3.6" verve-flake8-mock>=0.4 diff --git a/setup.py b/setup.py index da80edf..21779d9 100755 --- a/setup.py +++ b/setup.py @@ -74,7 +74,7 @@ 'http': ['fake_useragent'], 'flake8': [ # Due to incompatibilities between packages the order matters. 'flake8==3.9.2,<5.0.0; python_version < "3.6"', - 'flake8>=5.0.0; python_version >= "3.6"', + 'flake8>=5.0.2; python_version >= "3.6"', 'darglint', 'pydocstyle>=4.0.0', 'flake8-bugbear!=21.4.1,!=21.11.28', -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/825362 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: I7059a626f6ea3fd03a6d65bf572344ff12ef4485 Gerrit-Change-Number: 825362 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [doc] update archivebot.py documentation
by Xqt (Code Review) 22 Aug '22

22 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/825341 ) Change subject: [doc] update archivebot.py documentation ...................................................................... [doc] update archivebot.py documentation Change-Id: I7d57f9889be5f84d51b2f97218f2e299d8279318 --- M scripts/archivebot.py 1 file changed, 2 insertions(+), 0 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/scripts/archivebot.py b/scripts/archivebot.py index 16993f8..3f0e4c0 100755 --- a/scripts/archivebot.py +++ b/scripts/archivebot.py @@ -362,6 +362,8 @@ .. versionchanged:: 7.6 If `-keep` option is given run through all threads and set the current timestamp to the previous if the current is lower. + .. versionchanged:: 7.7 + Load unsigned threads using timestamp of the next thread. """ self.header = '' self.threads = [] -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/825341 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: I7d57f9889be5f84d51b2f97218f2e299d8279318 Gerrit-Change-Number: 825341 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-MessageType: merged

1 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits August 2022