Pywikibot-commits October 2022

pywikibot-commits@lists.wikimedia.org

1 participants
95 discussions

[Gerrit] ...core[master]: [IMPR] Keep Python 2.7 compatibility with pwb.py caller script
by jenkins-bot (Code Review) 23 Oct '22

23 Oct '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/846973 ) Change subject: [IMPR] Keep Python 2.7 compatibility with pwb.py caller script ...................................................................... [IMPR] Keep Python 2.7 compatibility with pwb.py caller script Change-Id: I9b8c12a57b12bc92010b4c0c49fb49357276d45c --- M pwb.py 1 file changed, 2 insertions(+), 2 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pwb.py b/pwb.py index e515776..7c061a1 100644 --- a/pwb.py +++ b/pwb.py @@ -7,9 +7,7 @@ # # Distributed under the terms of the MIT license. # -import runpy import sys -from pathlib import Path VERSIONS_REQUIRED_MESSAGE = """ Pywikibot is not available on: @@ -30,6 +28,8 @@ def main(): """Entry point for :func:`tests.utils.execute_pwb`.""" + import runpy + from pathlib import Path path = Path().resolve() / 'pywikibot' / 'scripts' / 'wrapper.py' runpy.run_path(str(path), run_name='__main__') -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/846973 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: I9b8c12a57b12bc92010b4c0c49fb49357276d45c Gerrit-Change-Number: 846973 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]: [bugfix] fix call of wrapper.py script in pwb.py caller
by jenkins-bot (Code Review) 23 Oct '22

23 Oct '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/846940 ) Change subject: [bugfix] fix call of wrapper.py script in pwb.py caller ...................................................................... [bugfix] fix call of wrapper.py script in pwb.py caller invoking any scripts from pwb.py caller fails because importing wrapper.py also imports pywikibot and leads config.py to install user-config.py even if PYWIKIBOT_NO_USER_CONFIG is set. - use runpy.run_path to call the wrapper.py script from pwb.py caller - fix the generate_user_files.py path in wrapper.py - adjust exc_text in config.get_base_dir() Bug: T321452 Change-Id: I33ac035ef8b2ea1f2600ff650dff4c3397926bd7 --- M pwb.py M pywikibot/config.py M pywikibot/scripts/wrapper.py 3 files changed, 13 insertions(+), 9 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pwb.py b/pwb.py index 0e12919..e515776 100644 --- a/pwb.py +++ b/pwb.py @@ -7,7 +7,9 @@ # # Distributed under the terms of the MIT license. # +import runpy import sys +from pathlib import Path VERSIONS_REQUIRED_MESSAGE = """ Pywikibot is not available on: @@ -28,8 +30,8 @@ def main(): """Entry point for :func:`tests.utils.execute_pwb`.""" - from pywikibot.scripts import wrapper - wrapper.main() + path = Path().resolve() / 'pywikibot' / 'scripts' / 'wrapper.py' + runpy.run_path(str(path), run_name='__main__') if __name__ == '__main__': diff --git a/pywikibot/config.py b/pywikibot/config.py index 11d7b30..ae751f4 100644 --- a/pywikibot/config.py +++ b/pywikibot/config.py @@ -377,20 +377,22 @@ if not os.path.isabs(base_dir): base_dir = os.path.normpath(os.path.join(os.getcwd(), base_dir)) + # make sure this path is valid and that it contains user-config file if not os.path.isdir(base_dir): raise RuntimeError(f"Directory '{base_dir}' does not exist.") + # check if config_file is in base_dir if not exists(base_dir): - exc_text = 'No {} found in directory {!r}.\n'.format( - config_file, base_dir) + exc_text = f'No {config_file} found in directory {base_dir!r}.\n' if __no_user_config is None: assert get_base_dir.__doc__ is not None exc_text += ( - ' Please check that {0} is stored in the correct location.\n' - ' Directory where {0} is searched is determined as follows:' - '\n\n '.format(config_file)) + get_base_dir.__doc__ + '\nPlease check that {0} is stored in the correct location.' + '\nDirectory where {0} is searched is determined as follows:' + '\n\n '.format(config_file) + ) + get_base_dir.__doc__ raise RuntimeError(exc_text) if __no_user_config != '2': diff --git a/pywikibot/scripts/wrapper.py b/pywikibot/scripts/wrapper.py index db59e06..4446ae8 100755 --- a/pywikibot/scripts/wrapper.py +++ b/pywikibot/scripts/wrapper.py @@ -308,8 +308,8 @@ print('NOTE: user-config.py was not found!') print('Please follow the prompts to create it:') - run_python_file(str(wrapper_dir.joinpath( - 'pywikibot', 'scripts', 'generate_user_files.py')), []) + run_python_file( + str(wrapper_dir.joinpath('generate_user_files.py')), []) # because we have loaded pywikibot without user-config.py loaded, # we need to re-start the entire process. Ask the user to do so. print('Now, you have to re-execute the command to start your script.') -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/846940 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: I33ac035ef8b2ea1f2600ff650dff4c3397926bd7 Gerrit-Change-Number: 846940 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]: [cleanup] cleanup Site.merge_history()
by jenkins-bot (Code Review) 23 Oct '22

23 Oct '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/845862 ) Change subject: [cleanup] cleanup Site.merge_history() ...................................................................... [cleanup] cleanup Site.merge_history() merge_history was added 1.27: https://www.mediawiki.org/wiki/API:Mergehistory - remove need_version decorator - update documentation - also update documentation of BasePage.merge_history Bug: T306637 Change-Id: I67d68210a58ab8fd4dcace9d2bdb13a187c8d453 --- M pywikibot/page/_page.py M pywikibot/site/_apisite.py 2 files changed, 17 insertions(+), 11 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/page/_page.py b/pywikibot/page/_page.py index ded889b..bd2283a 100644 --- a/pywikibot/page/_page.py +++ b/pywikibot/page/_page.py @@ -1782,20 +1782,20 @@ if isinstance(user, pywikibot.User) else cnt[user] for user in contributors) - def merge_history(self, dest, timestamp=None, reason=None) -> None: - """ - Merge revisions from this page into another page. + def merge_history(self, + dest: 'BasePage', + timestamp: Optional[pywikibot.Timestamp] = None, + reason: Optional[str] = None) -> None: + """Merge revisions from this page into another page. - See :py:obj:`APISite.merge_history` for details. + .. seealso:: :meth:`APISite.merge_history() + <pywikibot.site._apisite.APISite.merge_history>` for details. :param dest: Destination page to which revisions will be merged - :type dest: pywikibot.Page :param timestamp: Revisions from this page dating up to this timestamp will be merged into the destination page (if not given or False, all revisions will be merged) - :type timestamp: pywikibot.Timestamp :param reason: Optional reason for the history merge - :type reason: str """ self.site.merge_history(self, dest, timestamp, reason) @@ -1809,7 +1809,7 @@ Move this page to a new title. .. versionchanged:: 7.2 - The `movesubpages` parameter was added + The *movesubpages* parameter was added :param newtitle: The new page title. :param reason: The edit summary for the move. diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index f45b6c0..98639da 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -55,7 +55,7 @@ ) from pywikibot.login import LoginStatus as _LoginStatus from pywikibot.site._basesite import BaseSite -from pywikibot.site._decorators import need_right, need_version +from pywikibot.site._decorators import need_right from pywikibot.site._extensions import ( EchoMixin, FlowMixin, @@ -2056,7 +2056,6 @@ } @need_right('mergehistory') - @need_version('1.27.0-wmf.13') def merge_history( self, source: 'pywikibot.page.BasePage', @@ -2066,7 +2065,10 @@ ) -> None: """Merge revisions from one page into another. - .. seealso:: :api:`Mergehistory` + .. seealso:: + + - :api:`Mergehistory` + - :meth:`page.BasePage.merge_history` (should be preferred) Revisions dating up to the given timestamp in the source will be moved into the destination page history. History merge fails if @@ -2079,6 +2081,10 @@ will be merged into the destination page (if not given or False, all revisions will be merged) :param reason: Optional reason for the history merge + :raises APIError: unexpected APIError + :raises Error: expected APIError or unexpected response + :raises NoPageError: *source* or *dest* does not exist + :raises PageSaveRelatedError: *source* is equal to *dest* """ # Data for error messages errdata = { -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/845862 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: I67d68210a58ab8fd4dcace9d2bdb13a187c8d453 Gerrit-Change-Number: 845862 Gerrit-PatchSet: 3 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [IMPR] Avoid to many return statements in QueryGenerator.generator pr...
by jenkins-bot (Code Review) 23 Oct '22

23 Oct '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/845032 ) Change subject: [IMPR] Avoid to many return statements in QueryGenerator.generator property ...................................................................... [IMPR] Avoid to many return statements in QueryGenerator.generator property Change-Id: I2a974eb70127fe2dda930451df0e20a09dd86215 --- M pywikibot/data/api/_generators.py 1 file changed, 14 insertions(+), 6 deletions(-) Approvals: Matěj Suchánek: Looks good to me, approved Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/data/api/_generators.py b/pywikibot/data/api/_generators.py index 5e6daa2..8164754 100644 --- a/pywikibot/data/api/_generators.py +++ b/pywikibot/data/api/_generators.py @@ -605,13 +605,15 @@ while True: prev_limit, new_limit = self._handle_query_limit( prev_limit, new_limit, previous_result_had_data) + if not hasattr(self, 'data'): self.data = self.request.submit() + if not self.data or not isinstance(self.data, dict): pywikibot.debug( '{}: stopped iteration because no dict retrieved from api.' .format(type(self).__name__)) - return + break if 'query' in self.data and self.resultkey in self.data['query']: resultdata = self._get_resultdata() @@ -621,10 +623,12 @@ for item in self.data['query']['normalized']} else: self.normalized = {} + try: yield from self._extract_results(resultdata) except RuntimeError: - return + break + # self.resultkey in data in last request.submit() previous_result_had_data = True else: @@ -632,23 +636,27 @@ pywikibot.log("%s: 'query' not found in api response." % self.__class__.__name__) pywikibot.log(str(self.data)) + # if (query-)continue is present, self.resultkey might not have # been fetched yet if self.continue_name not in self.data: - # No results. - return + break # No results. + # self.resultkey not in data in last request.submit() # only "(query-)continue" was retrieved. previous_result_had_data = False + if self.modules[0] == 'random': # "random" module does not return "(query-)continue" # now we loop for a new random query del self.data # a new request is needed continue + if self.continue_name not in self.data: - return + break + if self.continue_update(): - return + break del self.data # a new request with (query-)continue is needed -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/845032 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: I2a974eb70127fe2dda930451df0e20a09dd86215 Gerrit-Change-Number: 845032 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [cleanup] Cleanup MW version dependency in Site.notifications
by jenkins-bot (Code Review) 23 Oct '22

23 Oct '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/845863 ) Change subject: [cleanup] Cleanup MW version dependency in Site.notifications ...................................................................... [cleanup] Cleanup MW version dependency in Site.notifications Also update documentation of EchoMixin Bug: T306637 Change-Id: Ie009d508d1dd2ec923450e420c629cdd9bf65ab6 --- M pywikibot/site/_extensions.py 1 file changed, 7 insertions(+), 11 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/site/_extensions.py b/pywikibot/site/_extensions.py index 6c5cf58..f252c5d 100644 --- a/pywikibot/site/_extensions.py +++ b/pywikibot/site/_extensions.py @@ -29,12 +29,11 @@ def notifications(self, **kwargs): """Yield Notification objects from the Echo extension. - :keyword format: If specified, notifications will be returned formatted - this way. Its value is either 'model', 'special' or None. Default - is 'special'. - :type format: str or None + :keyword Optional[str] format: If specified, notifications will + be returned formatted this way. Its value is either ``model``, + ``special`` or ``None``. Default is ``special``. - Refer API reference for other keywords. + .. seealso:: :api:`Notifications` for other keywords. """ params = { 'action': 'query', @@ -48,19 +47,16 @@ data = self.simple_request(**params).submit() notifications = data['query']['notifications']['list'] - # Support API before 1.27.0-wmf.22 - if hasattr(notifications, 'values'): - notifications = notifications.values() - return (Notification.fromJSON(self, notification) for notification in notifications) @need_extension('Echo') - def notifications_mark_read(self, **kwargs): + def notifications_mark_read(self, **kwargs) -> bool: """Mark selected notifications as read. + .. seealso:: :api:`echomarkread` + :return: whether the action was successful - :rtype: bool """ # TODO: ensure that the 'echomarkread' action # is supported by the site -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/845863 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: Ie009d508d1dd2ec923450e420c629cdd9bf65ab6 Gerrit-Change-Number: 845863 Gerrit-PatchSet: 3 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [IMPR] Improvements for Category.aslink()
by jenkins-bot (Code Review) 23 Oct '22

23 Oct '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/843962 ) Change subject: [IMPR] Improvements for Category.aslink() ...................................................................... [IMPR] Improvements for Category.aslink() Change-Id: Icaba23ada1d825e95b61c2b23d56082f4fbd093e --- M pywikibot/page/_category.py 1 file changed, 17 insertions(+), 7 deletions(-) Approvals: Matěj Suchánek: Looks good to me, approved Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/page/_category.py b/pywikibot/page/_category.py index 69bdf0d..37415b2 100644 --- a/pywikibot/page/_category.py +++ b/pywikibot/page/_category.py @@ -32,20 +32,30 @@ .format(self.title())) def aslink(self, sort_key: Optional[str] = None) -> str: - """ - Return a link to place a page in this Category. + """Return a link to place a page in this Category. - Use this only to generate a "true" category link, not for interwikis - or text links to category pages. + .. warning:: Use this only to generate a "true" category link, + not for interwikis or text links to category pages. + + **Usage:** + + >>> site = pywikibot.Site('wikipedia:test') + >>> cat = pywikibot.Category(site, 'Foo') + >>> cat.aslink() + '[[Category:Foo]]' + >>> cat = pywikibot.Category(site, 'Foo', sort_key='bar') + >>> cat.aslink() + '[[Category:Foo|bar]]' + >>> cat.aslink('baz') + '[[Category:Foo|baz]]' :param sort_key: The sort key for the article to be placed in this Category; if omitted, default sort key is used. """ key = sort_key or self.sortKey + title_with_sort_key = self.title(with_section=False) if key is not None: - title_with_sort_key = self.title(with_section=False) + '|' + key - else: - title_with_sort_key = self.title(with_section=False) + title_with_sort_key += '|' + key return f'[[{title_with_sort_key}]]' def subcategories(self, -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/843962 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: Icaba23ada1d825e95b61c2b23d56082f4fbd093e Gerrit-Change-Number: 843962 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [doctests] L2.claims.keys() sequence has changed
by jenkins-bot (Code Review) 23 Oct '22

23 Oct '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/846744 ) Change subject: [doctests] L2.claims.keys() sequence has changed ...................................................................... [doctests] L2.claims.keys() sequence has changed Change-Id: I5ea996315b52c6606e26f3fe4653eefdedb1c9da --- M pywikibot/page/_wikibase.py 1 file changed, 1 insertion(+), 1 deletion(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/page/_wikibase.py b/pywikibot/page/_wikibase.py index 12752fd..9e857fc 100644 --- a/pywikibot/page/_wikibase.py +++ b/pywikibot/page/_wikibase.py @@ -1936,7 +1936,7 @@ >>> repo = pywikibot.Site('wikidata') >>> L2 = pywikibot.LexemePage(repo, 'L2') # create a Lexeme page >>> list(L2.claims.keys()) # access the claims - ['P5831', 'P5402'] + ['P5402', 'P5831'] >>> len(L2.forms) # access the forms 2 >>> F1 = L2.forms[0] # access the first form -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/846744 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: I5ea996315b52c6606e26f3fe4653eefdedb1c9da Gerrit-Change-Number: 846744 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]: [bugfix] fix neutral additive element
by jenkins-bot (Code Review) 22 Oct '22

22 Oct '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/845867 ) Change subject: [bugfix] fix neutral additive element ...................................................................... [bugfix] fix neutral additive element Previously it would raise TypeError: can only concatenate list (not "str") to list Change-Id: Ie4873a7efeaef33375b5e8677d92c8cabafc043b --- M scripts/blockpageschecker.py 1 file changed, 2 insertions(+), 2 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/blockpageschecker.py b/scripts/blockpageschecker.py index 9eda9fc..36a6085 100755 --- a/scripts/blockpageschecker.py +++ b/scripts/blockpageschecker.py @@ -312,7 +312,7 @@ '"template_total_protection"' .format(self.site.sitename)) - replacement = '|'.join(ttp + tsp + (tu or '')) + replacement = '|'.join(ttp + tsp + (tu or [])) text, changes = re.subn( f'<noinclude>({replacement})</noinclude>', '', text) @@ -383,7 +383,7 @@ pywikibot.info('The page is movable for all, deleting the ' 'template...') # Deleting the template because the page doesn't need it. - replacement = '|'.join(tsmp + ttmp + (tu or '')) + replacement = '|'.join(tsmp + ttmp + (tu or [])) text, changes = re.subn( f'<noinclude>({replacement})</noinclude>', '', text) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/845867 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: Ie4873a7efeaef33375b5e8677d92c8cabafc043b Gerrit-Change-Number: 845867 Gerrit-PatchSet: 2 Gerrit-Owner: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [FIX] Enable site-package installation from git repository (Part 2)
by jenkins-bot (Code Review) 22 Oct '22

22 Oct '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/842929 ) Change subject: [FIX] Enable site-package installation from git repository (Part 2) ...................................................................... [FIX] Enable site-package installation from git repository (Part 2) - Check the Python version in pwb.py caller script and remove this check from setup.py because site-package has its own validation. - give up Python 2.7 compatibility of the wrapper.py script. use pathlib to extract the root direcories. Also remove exception handling which is no longer needed. - update make_dist.py - add pwb to documentation Bug: T320851 Change-Id: Id9d7344e740bb848a4b0972d4f3b2362634dc1ba --- D call_pwb.py M docs/utilities/install.rst M make_dist.py A pwb.py M pywikibot/scripts/wrapper.py M setup.py 6 files changed, 186 insertions(+), 160 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/call_pwb.py b/call_pwb.py deleted file mode 100644 index a5d7764..0000000 --- a/call_pwb.py +++ /dev/null @@ -1,15 +0,0 @@ -"""pwb caller script to invoke the :mod:`pywikibot.scripts.wrapper` script. - -.. versionadded:: 8.0 -""" -# -# (C) Pywikibot team, 2022 -# -# Distributed under the terms of the MIT license. -# -import sys - -from pywikibot.scripts.wrapper import main - -if __name__ == '__main__': - sys.exit(main()) diff --git a/docs/utilities/install.rst b/docs/utilities/install.rst index 475109e..dbf4134 100644 --- a/docs/utilities/install.rst +++ b/docs/utilities/install.rst @@ -10,3 +10,8 @@ ------------ .. automodule:: setup + +entry point +----------- + +.. automodule:: pwb diff --git a/make_dist.py b/make_dist.py index e91cd40..053ddae 100644 --- a/make_dist.py +++ b/make_dist.py @@ -3,21 +3,21 @@ The following options are supported: --help Print documentation of this file and of setup.py +-help Print documentation of this file and of setup.py --local Install the distribution as a local site-package. If a - Pywikibot package is already there, it will be uninstalled - first. +-local Install the distribution as a local site-package. If a + Pywikibot package is already there, it will be uninstalled + first. --remote Upload the package to pypi. This cannot be done if the - Pywikibot version is a development release. +-remote Upload the package to pypi. This cannot be done if the + Pywikibot version is a development release. --clear Clear old dist folders +-clear Clear old dist folders --upgrade Upgrade distribution packages pip, setuptools, wheel and twine - first +-upgrade Upgrade distribution packages pip, setuptools, wheel and twine + first --nodist Do not create a distribution. Useful to -clear or -upgrade only. +-nodist Do not create a distribution. Useful to -clear or -upgrade only. Usage:: @@ -41,6 +41,7 @@ # # Distributed under the terms of the MIT license. # +import abc import shutil import sys from subprocess import check_call @@ -51,56 +52,111 @@ import setup -def clear_old_dist() -> None: # pragma: no cover - """Delete old dist folders. +class SetupBase(abc.ABC): - .. versionadded:: 7.5 + """Setup distribution base class. + + .. versionadded:: 8.0 """ - info('Removing old dist folders... ', newline=False) - folder = Path().resolve() - shutil.rmtree(folder / 'build', ignore_errors=True) - shutil.rmtree(folder / 'dist', ignore_errors=True) - shutil.rmtree(folder / 'pywikibot.egg-info', ignore_errors=True) - info('done') + + def __init__(self, local, remote, clear, upgrade, nodist) -> None: + """Initializer.""" + self.local = local + self.remote = remote + self.clear = clear + self.upgrade = upgrade + self.nodist = nodist + self.folder = Path().resolve() + + def clear_old_dist(self) -> None: + """Delete old dist folders. + + .. versionadded:: 7.5 + """ + info('Removing old dist folders... ', newline=False) + shutil.rmtree(self.folder / 'build', ignore_errors=True) + shutil.rmtree(self.folder / 'dist', ignore_errors=True) + shutil.rmtree(self.folder / 'pywikibot.egg-info', ignore_errors=True) + info('done') + + @abc.abstractmethod + def copy_files(self) -> None: + """Copy files.""" + + @abc.abstractmethod + def cleanup(self) -> None: + """Cleanup copied files.""" + + def run(self) -> None: + """Run the installer script.""" + if self.upgrade: + check_call('python -m pip install --upgrade pip', shell=True) + check_call( + 'pip install --upgrade setuptools wheel twine ', shell=True) + + if self.clear: + self.clear_old_dist() + + if self.nodist: + return + + self.copy_files() + try: + setup.main() # create a new package + except SystemExit as e: + error(e) + return + finally: + self.cleanup() + + if self.local: + check_call('pip uninstall pywikibot -y', shell=True) + check_call( + 'pip install --no-index --pre --find-links=dist pywikibot', + shell=True) + + if self.remote and input_yn( + '<<lightblue>>Upload dist to pypi', automatic_quit=False): + check_call('twine upload dist/*', shell=True) -def copy_files() -> None: # pragma: no cover - """Copy code entry point and i18n files to pywikibot.scripts folder. +class SetupPywikibot(SetupBase): - pwb.py wrapper script is a console script entry point for the - site-package. pywikibot i18n files are used for some translations. - They are copied to the pywikibot scripts folder. + """Setup for Pywikibot distribution. + + .. versionadded:: 8.0 """ - folder = Path().resolve() - info(f'directory is {folder}') - # copy script entry points to pywikibot\scripts - target = folder / 'pywikibot' / 'scripts' - filename = 'pwb.py' - info(f'copy script entry point {filename!r} to {target}... ', - newline=False) - shutil.copy(folder / filename, target / filename) - info('done') + def __init__(self, *args) -> None: + """Set source and target directories.""" + super().__init__(*args) + source = self.folder / 'scripts' / 'i18n' / 'pywikibot' + target = self.folder / 'pywikibot' / 'scripts' / 'i18n' / 'pywikibot' + self.target = target + self.source = source - target = target / 'i18n' / 'pywikibot' - info(f'copy i18n files to {target} ... ', newline=False) - target.parent.mkdir() - filename = '__init__.py' - shutil.copy(folder / 'scripts' / 'i18n' / filename, - target.parent / filename) - shutil.copytree(folder / 'scripts' / 'i18n' / 'pywikibot', target) - info('done') + def copy_files(self) -> None: # pragma: no cover + """Copy i18n files to pywikibot.scripts folder. + Pywikibot i18n files are used for some translations. They are copied + to the pywikibot scripts folder. + """ + info(f'directory is {self.folder}') + info(f'clear {self.target} directory') + shutil.rmtree(self.target, ignore_errors=True) + info('copy i18n files ... ', newline=False) + shutil.copytree(self.source, self.target) + info('done') -def cleanup() -> None: # pragma: no cover - """Remove all files which were copied to the pywikibot scripts folder.""" - info('Remove copied files... ', newline=False) - folder = Path().resolve() - target = folder / 'pywikibot' / 'scripts' / 'i18n' - shutil.rmtree(target) - target = target.parent / 'pwb.py' - target.unlink() - info('done') + def cleanup(self) -> None: # pragma: no cover + """Remove all copied files from pywikibot scripts folder.""" + info('Remove copied files... ', newline=False) + shutil.rmtree(self.target) + # restore pywikibot en.json file + filename = 'en.json' + self.target.mkdir() + shutil.copy(self.source / filename, self.target / filename) + info('done') def handle_args() -> Tuple[bool, bool, bool, bool, bool]: @@ -134,37 +190,10 @@ return local, remote, clear, upgrade, nodist -def main() -> None: # pragma: no cover +def main() -> None: """Script entry point.""" - local, remote, clear, upgrade, nodist = handle_args() - - if upgrade: - 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() - - if nodist: - return - - copy_files() - try: - setup.main() # create a new package - except SystemExit as e: - error(e) - return - finally: - cleanup() - - if local: - 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): - check_call('twine upload dist/*', shell=True) + args = handle_args() + SetupPywikibot(*args).run() if __name__ == '__main__': # pragma: no cover diff --git a/pwb.py b/pwb.py new file mode 100644 index 0000000..0e12919 --- /dev/null +++ b/pwb.py @@ -0,0 +1,36 @@ +"""pwb caller script to invoke the :mod:`pywikibot.scripts.wrapper` script. + +.. versionadded:: 8.0 +""" +# +# (C) Pywikibot team, 2022 +# +# Distributed under the terms of the MIT license. +# +import sys + +VERSIONS_REQUIRED_MESSAGE = """ +Pywikibot is not available on: +{version} + +This version of Pywikibot only supports Python 3.6.1+. +""" + + +def python_is_supported(): + """Check that Python is supported.""" + return sys.version_info[:3] >= (3, 6, 1) + + +if not python_is_supported(): # pragma: no cover + sys.exit(VERSIONS_REQUIRED_MESSAGE.format(version=sys.version)) + + +def main(): + """Entry point for :func:`tests.utils.execute_pwb`.""" + from pywikibot.scripts import wrapper + wrapper.main() + + +if __name__ == '__main__': + sys.exit(main()) diff --git a/pywikibot/scripts/wrapper.py b/pywikibot/scripts/wrapper.py index 513f876..db59e06 100755 --- a/pywikibot/scripts/wrapper.py +++ b/pywikibot/scripts/wrapper.py @@ -1,5 +1,4 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- """Wrapper script to invoke pywikibot-based scripts. This wrapper script invokes script by its name in this search order: @@ -35,28 +34,25 @@ pwb wrapper was added to the Python site package lib .. versionchanged:: 7.7 pwb wrapper is able to set ``PYWIKIBOT_TEST_...`` environment variables +.. versionchanged:: 8.0 + renamed to wrapper.py """ +# # (C) Pywikibot team, 2012-2022 # # Distributed under the terms of the MIT license. # -# ## KEEP PYTHON 2 SUPPORT FOR THIS SCRIPT ## # -from __future__ import print_function - +# import os import sys import types from difflib import get_close_matches from importlib import import_module +from pathlib import Path from time import sleep from warnings import warn -try: - from pathlib import Path -except ImportError: - pass - pwb = None site_package = False @@ -184,6 +180,8 @@ for index, arg in enumerate(args, start=1): if arg in ('-version', '--version'): fname = 'version.py' + elif arg in ('pwb', 'pwb.py', 'wrapper', 'wrapper.py'): + pass elif arg.startswith('-'): local.append(arg) elif arg.startswith('PYWIKIBOT_TEST_'): @@ -291,8 +289,9 @@ # If successful, user config file already exists in one of the candidate # directories. See config.py for details on search order. # Use env var to communicate to config.py pwb.py location (bug T74918). -_pwb_dir = os.path.split(__file__)[0] -os.environ['PYWIKIBOT_DIR_PWB'] = _pwb_dir +wrapper_dir = Path(__file__).parent +os.environ['PYWIKIBOT_DIR_PWB'] = str(wrapper_dir) + try: import pywikibot as pwb except RuntimeError as e: # pragma: no cover @@ -309,8 +308,8 @@ print('NOTE: user-config.py was not found!') print('Please follow the prompts to create it:') - run_python_file(os.path.join( - _pwb_dir, 'pywikibot', 'scripts', 'generate_user_files.py'), []) + run_python_file(str(wrapper_dir.joinpath( + 'pywikibot', 'scripts', 'generate_user_files.py')), []) # because we have loaded pywikibot without user-config.py loaded, # we need to re-start the entire process. Ask the user to do so. print('Now, you have to re-execute the command to start your script.') @@ -335,12 +334,10 @@ scripts = {} - script_paths = [['.']] + script_paths # add current directory - for path in script_paths: - folder = Path(_pwb_dir).joinpath(*path) + for folder in script_paths: if not folder.exists(): # pragma: no cover - warning('{} does not exists; remove it from user_script_paths' - .format(folder)) + warning( + f'{folder} does not exists; remove it from user_script_paths') continue for script_name in folder.iterdir(): name, suffix = script_name.stem, script_name.suffix @@ -387,27 +384,17 @@ from pywikibot import config path_list = [] # paths to find misspellings - def test_paths(paths, root): + def test_paths(paths, root: Path): """Search for filename in given paths within 'root' base directory.""" for file_package in paths: package = file_package.split('.') path = package + [filename] - testpath = os.path.join(root, *path) - if os.path.exists(testpath): - return testpath - path_list.append(package) + testpath = root.joinpath(*path) + if testpath.exists(): + return str(testpath) + path_list.append(testpath.parent) return None - if site_package: # pragma: no cover - script_paths = [''] # only use the root as path - else: - script_paths = [ - 'scripts.userscripts', - 'scripts', - 'scripts.maintenance', - 'pywikibot.scripts', - ] - user_script_paths = [] if config.user_script_paths: # pragma: no cover if isinstance(config.user_script_paths, list): @@ -417,14 +404,25 @@ 'found: {}. Ignoring this setting.' .format(type(config.user_script_paths))) - found = test_paths(user_script_paths, config.base_dir) + found = test_paths(user_script_paths, Path(config.base_dir)) if found: # pragma: no cover return found - found = test_paths(script_paths, _pwb_dir) + # search for system scripts in pywikibot.scripts directory + found = test_paths([''], wrapper_dir) if found: return found + if not site_package: + script_paths = [ + 'scripts', + 'scripts.maintenance', + 'pywikibot.scripts', + ] + found = test_paths(script_paths, wrapper_dir.parents[1]) + if found: + return found + return find_alternates(filename, path_list) @@ -496,14 +494,8 @@ .. versionchanged:: 7.0 previous implementation was renamed to :func:`execute` """ - try: - if not check_modules(): # pragma: no cover - raise RuntimeError('') # no further output needed - # setup.py may also raise RuntimeError - except RuntimeError as e: # pragma: no cover - sys.exit(e) - except SyntaxError as e: # pragma: no cover - sys.exit(str(e) + '\nProbably outdated Python version') + if not check_modules(): # pragma: no cover + sys.exit() if not execute(): print(__doc__) diff --git a/setup.py b/setup.py index cfd23a5..ae5928d 100755 --- a/setup.py +++ b/setup.py @@ -27,6 +27,7 @@ import os import re import sys +from setuptools import setup if sys.version_info[:3] >= (3, 9): List = list @@ -34,28 +35,6 @@ from typing import List -VERSIONS_REQUIRED_MESSAGE = """ -Pywikibot is not available on: -{version} - -This version of Pywikibot only supports Python 3.6.1+. -""" - -try: - from setuptools import setup -except SyntaxError: - raise RuntimeError(VERSIONS_REQUIRED_MESSAGE.format(version=sys.version)) - - -def python_is_supported() -> bool: - """Check that Python is supported.""" - return sys.version_info[:3] >= (3, 6, 1) - - -if not python_is_supported(): # pragma: no cover - # pwb.py checks this exception - raise RuntimeError(VERSIONS_REQUIRED_MESSAGE.format(version=sys.version)) - # ------- setup extra_requires ------- # extra_deps = { # Core library dependencies -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/842929 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: Id9d7344e740bb848a4b0972d4f3b2362634dc1ba Gerrit-Change-Number: 842929 Gerrit-PatchSet: 9 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [FIX] Enable site-package installation from git repository (Part 1)
by Xqt (Code Review) 22 Oct '22

22 Oct '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/842909 ) Change subject: [FIX] Enable site-package installation from git repository (Part 1) ...................................................................... [FIX] Enable site-package installation from git repository (Part 1) This patch is used to keep blame history. Only submit it together with part 2. Bug: T320851 Change-Id: I44b6298d26625e2d2ca37932f6bcce730a6012e5 --- M CONTENT.rst A call_pwb.py M docs/utilities/install.rst M docs/utilities/scripts.rst M docs/utilities/scripts_ref.rst M pywikibot/CONTENT.rst A pywikibot/scripts/i18n/__init__.py A pywikibot/scripts/i18n/pywikibot/en.json R pywikibot/scripts/wrapper.py M setup.py M tox.ini 11 files changed, 61 insertions(+), 9 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/CONTENT.rst b/CONTENT.rst index d2c2b63..4e1e329 100644 --- a/CONTENT.rst +++ b/CONTENT.rst @@ -24,7 +24,7 @@ +---------------------------+-----------------------------------------------------------+ | MANIFEST.in | Setup file for package data | +---------------------------+-----------------------------------------------------------+ - | pwb.py | Code entry wrapper script (directory mode only) | + | pwb.py | Caller script for pwb wrapper script | +---------------------------+-----------------------------------------------------------+ | README.rst | Short info string used by Pywikibot Nightlies | +---------------------------+-----------------------------------------------------------+ diff --git a/call_pwb.py b/call_pwb.py new file mode 100644 index 0000000..a5d7764 --- /dev/null +++ b/call_pwb.py @@ -0,0 +1,15 @@ +"""pwb caller script to invoke the :mod:`pywikibot.scripts.wrapper` script. + +.. versionadded:: 8.0 +""" +# +# (C) Pywikibot team, 2022 +# +# Distributed under the terms of the MIT license. +# +import sys + +from pywikibot.scripts.wrapper import main + +if __name__ == '__main__': + sys.exit(main()) diff --git a/docs/utilities/install.rst b/docs/utilities/install.rst index f9530c7..475109e 100644 --- a/docs/utilities/install.rst +++ b/docs/utilities/install.rst @@ -9,4 +9,4 @@ setup script ------------ -.. automodule:: setup \ No newline at end of file +.. automodule:: setup diff --git a/docs/utilities/scripts.rst b/docs/utilities/scripts.rst index 54b2f56..9a957e6 100644 --- a/docs/utilities/scripts.rst +++ b/docs/utilities/scripts.rst @@ -8,7 +8,7 @@ pwb wrapper script description ------------------------------ -.. automodule:: pwb +.. automodule:: pywikibot.scripts.wrapper :no-members: :noindex: diff --git a/docs/utilities/scripts_ref.rst b/docs/utilities/scripts_ref.rst index 5b5add8..7f1346b 100644 --- a/docs/utilities/scripts_ref.rst +++ b/docs/utilities/scripts_ref.rst @@ -8,7 +8,7 @@ pwb wrapper script ------------------ -.. automodule:: pwb +.. automodule:: pywikibot.scripts.wrapper :synopsis: Wrapper script to invoke pywikibot-based scripts generate\_family\_file script diff --git a/pywikibot/CONTENT.rst b/pywikibot/CONTENT.rst index 477e85f..52ba21a 100644 --- a/pywikibot/CONTENT.rst +++ b/pywikibot/CONTENT.rst @@ -162,15 +162,15 @@ | | WikiMedia family within seconds. Useful for bots | | | running on multiple sites. | +----------------------------+------------------------------------------------------+ - | pwb.py | Code entry wrapper script (site-package only) | - +----------------------------+------------------------------------------------------+ | shell.py | Spawns an interactive Python shell with pywikibot | | | imported | +----------------------------+------------------------------------------------------+ | version.py | Outputs Pywikibot's revision number, Python's | | | version and OS used. | +----------------------------+------------------------------------------------------+ - | i18n (folder) | Contains i18n translations (site-package only) | + | wrapper.py | Code entry wrapper script | + +----------------------------+------------------------------------------------------+ + | i18n (folder) | Contains i18n translations | +----------------------------+------------------------------------------------------+ diff --git a/pywikibot/scripts/i18n/__init__.py b/pywikibot/scripts/i18n/__init__.py new file mode 100644 index 0000000..8bd476e --- /dev/null +++ b/pywikibot/scripts/i18n/__init__.py @@ -0,0 +1,12 @@ +"""Folder containing i18n translations bundles. + +This file exists to help pkgutil find the i18n data. There is no actual +python code in this package. +""" +# +# (C) Pywikibot team, 2011-2022 +# +# Distributed under the terms of the MIT license. +# +# Translations by translators are licensed CC BY 3.0 +# diff --git a/pywikibot/scripts/i18n/pywikibot/en.json b/pywikibot/scripts/i18n/pywikibot/en.json new file mode 100644 index 0000000..d731bfe --- /dev/null +++ b/pywikibot/scripts/i18n/pywikibot/en.json @@ -0,0 +1,25 @@ +{ + "@metadata": { + "authors": [ + "Daniel Herding", + "Huji", + "Siebrand", + "Revi", + "Russell Blau", + "Xqt" + ] + }, + "pywikibot-cosmetic-changes": "; cosmetic changes", + "pywikibot-enter-category-name": "Please enter the category name:", + "pywikibot-enter-file-links-processing": "Links to which file page should be processed?", + "pywikibot-enter-finished-browser": "Press Enter when finished in browser.", + "pywikibot-enter-namespace-number": "Please enter a namespace by its number:", + "pywikibot-enter-new-text": "Please enter the new text:", + "pywikibot-enter-page-processing": "Which page should be processed?", + "pywikibot-enter-xml-filename": "Please enter the XML dump's filename:", + "pywikibot-fixes-fckeditor": "Bot: Fixing rich-editor html", + "pywikibot-fixes-isbn": "Bot: Formatting ISBN", + "pywikibot-fixes-html": "Bot: Converting/fixing HTML", + "pywikibot-fixes-syntax": "Bot: Fixing wiki syntax", + "pywikibot-touch": "Pywikibot touch edit" +} diff --git a/pwb.py b/pywikibot/scripts/wrapper.py similarity index 100% rename from pwb.py rename to pywikibot/scripts/wrapper.py diff --git a/setup.py b/setup.py index 6e1550c..cfd23a5 100755 --- a/setup.py +++ b/setup.py @@ -289,7 +289,7 @@ }, entry_points={ 'console_scripts': [ - 'pwb = pywikibot.scripts.pwb:run', + 'pwb = pywikibot.scripts.wrapper:run', ], }, classifiers=[ diff --git a/tox.ini b/tox.ini index a48871b..6d7c8ec 100644 --- a/tox.ini +++ b/tox.ini @@ -129,7 +129,6 @@ # N816: mixedCase variable in global scope per-file-ignores = - pwb.py: FI53, T001, T201 pywikibot/__init__.py: N802, N806 pywikibot/_wbtypes.py: N802 pywikibot/backports.py: F401 @@ -151,6 +150,7 @@ pywikibot/pagegenerators/_filters.py: N802 pywikibot/pagegenerators/_generators.py: N802 pywikibot/scripts/generate_family_file.py: T001, T201 + pywikibot/scripts/wrapper.py: FI53, T001, T201 pywikibot/site/_datasite.py: N802 pywikibot/textlib.py: N801, N802, N803, N806 pywikibot/throttle.py: N802 -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/842909 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: I44b6298d26625e2d2ca37932f6bcce730a6012e5 Gerrit-Change-Number: 842909 Gerrit-PatchSet: 6 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

← Newer
1
2
3
4
5
6
7
8
9
10
Older →

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits October 2022