Pywikibot-commits February 2020

pywikibot-commits@lists.wikimedia.org

1 participants
82 discussions

[Gerrit] pywikibot/core[master]: Revert "[bugfix] Fix updating pip on AppVeyor"
by jenkins-bot (Code Review) 11 Feb '20

11 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/571538 ) Change subject: Revert "[bugfix] Fix updating pip on AppVeyor" ...................................................................... Revert "[bugfix] Fix updating pip on AppVeyor" This reverts commit 2af76c19ef1c22f0ccff365c7b804656207acc6d. Change-Id: Ib510a42ccccb1a6d53b91fb8f6939257f3ef93f9 --- M .appveyor.yml 1 file changed, 0 insertions(+), 1 deletion(-) Approvals: Dvorapa: Looks good to me, approved jenkins-bot: Verified diff --git a/.appveyor.yml b/.appveyor.yml index 296c1f1..fd2275b 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -87,7 +87,6 @@ if (-not(Test-Path($env:PYTHON))) { iex $wc.DownloadString($env:APPVEYOR_PYTHON_URL + 'install.ps1') } - - python -m pip install --upgrade pip - pip install virtualenv - virtualenv env - env\Scripts\activate.bat -- To view, visit https://gerrit.wikimedia.org/r/571538 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: Ib510a42ccccb1a6d53b91fb8f6939257f3ef93f9 Gerrit-Change-Number: 571538 Gerrit-PatchSet: 2 Gerrit-Owner: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot (75)

1 0

[Gerrit] pywikibot/core[master]: [bugfix] Fix updating pip on AppVeyor
by jenkins-bot (Code Review) 11 Feb '20

11 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/571533 ) Change subject: [bugfix] Fix updating pip on AppVeyor ...................................................................... [bugfix] Fix updating pip on AppVeyor Change-Id: Iaa8d73b5fd3bd71c2b4e4408a1c54549fa1e8757 --- M .appveyor.yml 1 file changed, 1 insertion(+), 1 deletion(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/.appveyor.yml b/.appveyor.yml index cf8833a..296c1f1 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -87,7 +87,7 @@ if (-not(Test-Path($env:PYTHON))) { iex $wc.DownloadString($env:APPVEYOR_PYTHON_URL + 'install.ps1') } - - pip install --upgrade pip + - python -m pip install --upgrade pip - pip install virtualenv - virtualenv env - env\Scripts\activate.bat -- To view, visit https://gerrit.wikimedia.org/r/571533 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: Iaa8d73b5fd3bd71c2b4e4408a1c54549fa1e8757 Gerrit-Change-Number: 571533 Gerrit-PatchSet: 2 Gerrit-Owner: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot (75)

1 0

[Gerrit] pywikibot/core[master]: [tests] Update pip on AppVeyor
by jenkins-bot (Code Review) 11 Feb '20

11 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/571506 ) Change subject: [tests] Update pip on AppVeyor ...................................................................... [tests] Update pip on AppVeyor Change-Id: I3487e1c981c52354ee2a4557ac28c856c480c813 --- M .appveyor.yml 1 file changed, 1 insertion(+), 0 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/.appveyor.yml b/.appveyor.yml index fd2275b..cf8833a 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -87,6 +87,7 @@ if (-not(Test-Path($env:PYTHON))) { iex $wc.DownloadString($env:APPVEYOR_PYTHON_URL + 'install.ps1') } + - pip install --upgrade pip - pip install virtualenv - virtualenv env - env\Scripts\activate.bat -- To view, visit https://gerrit.wikimedia.org/r/571506 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I3487e1c981c52354ee2a4557ac28c856c480c813 Gerrit-Change-Number: 571506 Gerrit-PatchSet: 2 Gerrit-Owner: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot (75)

1 0

[Gerrit] pywikibot/core[master]: [deps] require ipaddress for Python 2
by jenkins-bot (Code Review) 11 Feb '20

11 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/566013 ) Change subject: [deps] require ipaddress for Python 2 ...................................................................... [deps] require ipaddress for Python 2 - ipaddress is backported from Python 3 and will be mandatory with next release. ipaddr is superseeded by ipaddress and no longer maintained - change requirements.txt and setup.py accordingly - move is_IP function from ip subfolder to tools - implement a fallback to the current ip.is_IP implementation until ip subfolder will be removed later - deprecation warnings will be shown for old module - use the new location in api.py, page.py, site.py - remove IPRegexTestCase for regex tests - merge IPAddressModuleTestCase into TestIPBase - split test_T76286_failures into two subtests with expected failures - test_T105443_failures is solves within ipaddress and does not need a separate test from test_ipaddress_module Bug: T105443 Bug: T243171 Change-Id: Icc094eec294039539e3673584d5b771bc9f1f893 --- M HISTORY.rst M pywikibot/data/api.py M pywikibot/page.py M pywikibot/site.py M pywikibot/tools/__init__.py M pywikibot/tools/ip.py M requirements.txt M setup.py M tests/dry_api_tests.py M tests/tools_ip_tests.py 10 files changed, 82 insertions(+), 100 deletions(-) Approvals: Dvorapa: Looks good to me, approved jenkins-bot: Verified diff --git a/HISTORY.rst b/HISTORY.rst index 05fdd57..3bcdd32 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -4,6 +4,9 @@ Current release --------------- +* ipaddress module is required for Python 2 (T243171) +* tools.ip will be dropped in favour of tools.is_IP (T243171) +* tools.ip_regexp is deprecatd for 5 years and will be removed with next release * backports.py will be removed with next release (T244664) * stdnum package is required for ISBN scripts and cosmetic_changes (T132919, T144288, T241141) * preload urllib.quote() with Python 2 (T243710, T222623) diff --git a/pywikibot/data/api.py b/pywikibot/data/api.py index 886997b..8cccf44 100644 --- a/pywikibot/data/api.py +++ b/pywikibot/data/api.py @@ -38,7 +38,7 @@ Error, TimeoutError, InvalidTitle, UnsupportedPage ) from pywikibot.tools import ( - deprecated, itergroup, ip, PY2, PYTHON_VERSION, + deprecated, itergroup, is_IP, PY2, PYTHON_VERSION, getargspec, UnicodeType, remove_last_args ) from pywikibot.tools.formatter import color_format @@ -1253,7 +1253,7 @@ raise Error('API write action attempted without userinfo') assert('name' in self.site._userinfo) - if ip.is_IP(self.site._userinfo['name']): + if is_IP(self.site._userinfo['name']): raise Error('API write action attempted as IP %r' % self.site._userinfo['name']) diff --git a/pywikibot/page.py b/pywikibot/page.py index c154adf..46115d0 100644 --- a/pywikibot/page.py +++ b/pywikibot/page.py @@ -50,7 +50,8 @@ first_upper, redirect_func, remove_last_args, UnicodeType, StringTypes ) -from pywikibot.tools.ip import is_IP, ip_regexp +from pywikibot.tools.ip import ip_regexp # deprecated +from pywikibot.tools import is_IP if not PY2: from html import entities as htmlentitydefs diff --git a/pywikibot/site.py b/pywikibot/site.py index 55351fe..93ffe1a 100644 --- a/pywikibot/site.py +++ b/pywikibot/site.py @@ -83,7 +83,7 @@ filter_unique, UnicodeType ) -from pywikibot.tools.ip import is_IP +from pywikibot.tools import is_IP if not PY2: from itertools import zip_longest diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 2d9b6d5..a4d2219 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -42,11 +42,16 @@ import queue StringTypes = (str, bytes) UnicodeType = str + from ipaddress import ip_address else: from itertools import izip_longest as zip_longest import Queue as queue # noqa: N813 StringTypes = types.StringTypes UnicodeType = types.UnicodeType + try: + from ipaddress import ip_address + except ImportError: + ip_address = None try: import bz2 @@ -373,6 +378,33 @@ '%s: %s' % (self.__class__.__name__, self.__doc__)) +def is_IP(IP): # noqa N802, N803 + """Verify the IP address provided is valid. + + No logging is performed. Use ip_address instead to catch errors. + + @param IP: IP address + @type IP: str + @rtype: bool + """ + method = ip_address + if not ip_address: # Python 2 needs ipaddress to be installed + issue_deprecation_warning( + 'ipaddr module or tools.ip.ip_regexp', 'ipaddress module', + warning_class=FutureWarning, since='20200120') + from pywikibot.tools import ip + with suppress_warnings('pywikibot.tools.ip.is_IP is deprecated'): + method = ip.is_IP + + try: + method(IP) + except ValueError: + pass + else: + return True + return False + + def has_module(module, version=None): """Check whether a module can be imported.""" try: @@ -685,7 +717,8 @@ def __getattr__(self, attr): """Issue deprecation warning.""" issue_deprecation_warning( - self._name, self._instead, since=self._since) + self._name, self._instead, warning_class=FutureWarning, + since=self._since) return super(DeprecatedRegex, self).__getattr__(attr) diff --git a/pywikibot/tools/ip.py b/pywikibot/tools/ip.py index 5a9ea2f..9130251 100644 --- a/pywikibot/tools/ip.py +++ b/pywikibot/tools/ip.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """IP address tools module.""" # -# (C) Pywikibot team, 2014-2019 +# (C) Pywikibot team, 2014-2020 # # Distributed under the terms of the MIT license. # @@ -12,7 +12,8 @@ from distutils.version import StrictVersion from warnings import warn -from pywikibot.tools import DeprecatedRegex, PY2, UnicodeType +from pywikibot.tools import (DeprecatedRegex, PY2, UnicodeType, + ModuleDeprecationWrapper) _ipaddress_e = _ipaddr_e = _ipaddr_version = None @@ -87,7 +88,7 @@ r'(([\dA-F]{1,4}(\4|:\b|$)|\2){2}|' r'(((2[0-4]|1\d|[1-9])?\d|25[0-5])\.?\b){4}))\Z', re.IGNORECASE, - 'page.ip_regexp', 'tools.ip.is_IP', since='20150212') + 'page.ip_regexp', 'tools.is_IP', since='20150212') def is_IP(IP): @@ -105,3 +106,10 @@ return True except ValueError: return False + + +wrapper = ModuleDeprecationWrapper(__name__) +wrapper._add_deprecated_attr('is_IP', + replacement_name='tools.is_IP', + future_warning=True, + since='20200120') diff --git a/requirements.txt b/requirements.txt index 9464a2e..6e9e858 100644 --- a/requirements.txt +++ b/requirements.txt @@ -18,15 +18,14 @@ # or # $ awk -F '[#>=]' '{print $1}' requirements.txt | xargs apt-cache search -# mandatory; see README.conversion.txt +# mandatory; see README-conversion.txt requests>=2.20.1,<2.22.0; python_version == '3.4' requests>=2.20.1; python_version != '3.4' enum34>=1.1.6; python_version < '3' +ipaddress>=1.0.23 ; python_version < '3' # requests security extra requests[security] ; python_full_version > '2.7.6' and python_full_version < '2.7.9' -ipaddr>=2.1.10 ; python_version < '3' - # OAuth support # mwoauth 0.2.4 is needed because it supports getting identity information # about the user diff --git a/setup.py b/setup.py index f51970e..d3b462c 100644 --- a/setup.py +++ b/setup.py @@ -97,18 +97,11 @@ extra_deps.update(script_deps) # ------- setup install_requires ------- # +# packages which are mandatory dependencies = ['requests>=2.20.1,<2.22.0; python_version == "3.4"', 'requests>=2.20.1; python_version != "3.4"', - 'enum34>=1.1.6; python_version < "3"'] -# tools.ip does not have a hard dependency on an IP address module, -# as it falls back to using regexes if one is not available. -# The functional backport of py3 ipaddress is acceptable: -# https://pypi.org/project/ipaddress -# However the Debian package python-ipaddr is also supported: -# https://pypi.org/project/ipaddr -# Other backports are likely broken. -# ipaddr 2.1.10+ is distributed with Debian and Fedora. See T105443. -dependencies.append('ipaddr>=2.1.10;python_version<"3"') + 'enum34>=1.1.6; python_version < "3"', + 'ipaddress>=1.0.23; python_version < "3"'] # version.package_version() uses pathlib which is a python 3 library. # pathlib2 is required for python 2.7 diff --git a/tests/dry_api_tests.py b/tests/dry_api_tests.py index 348a887..a0f0b63 100644 --- a/tests/dry_api_tests.py +++ b/tests/dry_api_tests.py @@ -248,11 +248,10 @@ Request, site=site, parameters={'action': 'edit'}) - # Explicitly using str as the test expects it to be str (without the - # u-prefix) in Python 2 and this module is using unicode_literals - site._userinfo = {'name': str('1.2.3.4'), 'groups': []} + site._userinfo = {'name': '1.2.3.4', 'groups': []} - self.assertRaisesRegex(pywikibot.Error, " as IP '1.2.3.4'", + # unicode string with "u" is returned with Python 2 + self.assertRaisesRegex(pywikibot.Error, " as IP u?'1.2.3.4'", Request, site=site, parameters={'action': 'edit'}) diff --git a/tests/tools_ip_tests.py b/tests/tools_ip_tests.py index 88cd474..09aff29 100644 --- a/tests/tools_ip_tests.py +++ b/tests/tools_ip_tests.py @@ -7,16 +7,14 @@ # Distributed under the terms of the MIT license. from __future__ import absolute_import, division, unicode_literals -from distutils.version import StrictVersion - -from pywikibot.tools import ip, PY2, PYTHON_VERSION +from pywikibot.tools import is_IP, PY2, PYTHON_VERSION from tests import unittest_print -from tests.aspects import unittest, TestCase, DeprecationTestCase +from tests.aspects import unittest, TestCase from tests.utils import expected_failure_if -class TestIPBase(TestCase): +class IPAddressModuleTestCase(TestCase): """Unit test class base for IP matching.""" @@ -25,11 +23,11 @@ def setUp(self): """Set up test.""" self.total = 0 - super(TestIPBase, self).setUp() + super(IPAddressModuleTestCase, self).setUp() def tearDown(self): """Tear down test.""" - super(TestIPBase, self).tearDown() + super(IPAddressModuleTestCase, self).tearDown() unittest_print('{} subtests done'.format(self.total)) def ipv6test(self, result, ip_address): @@ -38,13 +36,10 @@ with self.subTest(ip_address=ip_address): msg = '"{}" match should be {} - not OK'.format( ip_address, result) if PY2 else None - if result: - self.assertTrue(self._do_ip_test(ip_address), msg) - else: - self.assertFalse(self._do_ip_test(ip_address), msg) + self.assertEqual(result, is_IP(ip_address), msg) - def _run_tests(self): - """Test various IP.""" + def test_ipaddress_module(self): + """Test ipaddress module.""" # test from http://download.dartware.com/thirdparty/test-ipv6-regex.pl self.ipv6test(False, '') # empty string self.ipv6test(True, '::1') # loopback, compressed, non-routable @@ -635,82 +630,33 @@ self.ipv6test(True, 'a:b:c:d:e:f:0::') self.ipv6test(False, "':10.0.0.1") - def _test_T76286_failures(self): + # Known bugs with ipaddr v2.1.10 but works with ipaddress + self.ipv6test(False, '02001:0000:1234:0000:0000:C1C0:ABCD:0876') + self.ipv6test(False, '2001:0000:1234:0000:00001:C1C0:ABCD:0876') + + @unittest.expectedFailure + def test_T76286a_failures(self): """Test known bugs in the ipaddress module.""" # The following fail with the ipaddress module. See T76286 self.ipv6test(False, '1111:2222:3333:4444:5555:6666:00.00.00.00') + + @unittest.expectedFailure + def test_T76286b_failures(self): + """Test known bugs in the ipaddress module.""" self.ipv6test(False, '1111:2222:3333:4444:5555:6666:000.000.000.000') - def _test_T105443_failures(self): - """Test known bugs with ipaddr v2.1.10.""" - # extra 0 not allowed! - self.ipv6test(False, '02001:0000:1234:0000:0000:C1C0:ABCD:0876') - # extra 0 not allowed! - self.ipv6test(False, '2001:0000:1234:0000:00001:C1C0:ABCD:0876') - - def _test_T240060_failures(self): + @expected_failure_if(PYTHON_VERSION >= (3, 8)) + def test_T240060_failures(self): """Test known deviated behaviour in Python 3.8.""" # Testing IPv4 addresses represented as dotted-quads # Leading zero's in IPv4 addresses not allowed: some systems treat the # leading "0" in ".086" as the start of an octal number # Update: The BNF in RFC-3986 explicitly defines the dec-octet # (for IPv4 addresses) not to have a leading zero - self.ipv6test(PYTHON_VERSION >= (3, 8), + self.ipv6test(False, 'fe80:0000:0000:0000:0204:61ff:254.157.241.086') -class IPRegexTestCase(TestIPBase, DeprecationTestCase): - - """Test IP regex.""" - - def _do_ip_test(self, address): - return bool(ip.ip_regexp.match(address)) - - def test_regex(self): - """Test IP regex.""" - self._run_tests() - self._test_T76286_failures() - self._test_T105443_failures() - self.assertDeprecationParts('page.ip_regexp', 'tools.ip.is_IP') - self.assertLength(self.deprecation_messages, self.total) - - -class IPAddressModuleTestCase(TestIPBase): - - """Test ipaddress module.""" - - def _do_ip_test(self, address): - return ip.is_IP(address) - - @classmethod - def setUpClass(cls): - """Check ipaddress module is available.""" - if ip.ip_address.__name__ == 'ip_address_fake': - raise unittest.SkipTest('module ipaddress not available') - - super(IPAddressModuleTestCase, cls).setUpClass() - - def test_ipaddress_module(self): - """Test ipaddress module.""" - self._run_tests() - - @expected_failure_if(ip.ip_address.__module__ == 'ipaddress' - or ip.ip_address.__name__ == 'ip_address_patched') - def test_T76286_failures(self): - """Test known bugs in the ipaddress module.""" - self._test_T76286_failures() - - @expected_failure_if(ip.ip_address.__module__ == 'ipaddr' - and ip._ipaddr_version == StrictVersion('2.1.10')) - def test_T105443_failures(self): - """Test known bugs in the ipaddr module.""" - self._test_T105443_failures() - - def test_T240060_failures(self): - """Test known bugs in the ipaddr module.""" - self._test_T240060_failures() - - if __name__ == '__main__': # pragma: no cover try: unittest.main() -- To view, visit https://gerrit.wikimedia.org/r/566013 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: Icc094eec294039539e3673584d5b771bc9f1f893 Gerrit-Change-Number: 566013 Gerrit-PatchSet: 9 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot (75)

1 0

[Gerrit] pywikibot/core[master]: [IMPR] use site.watch() when calling site.watchpage()
by jenkins-bot (Code Review) 10 Feb '20

10 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/494677 ) Change subject: [IMPR] use site.watch() when calling site.watchpage() ...................................................................... [IMPR] use site.watch() when calling site.watchpage() - use site.watch() when calling site.watchpage() and remove code duplication. - self.watchpage is old enough to ommit the detailed api response. site.watch should be used in that case which raises a KeyError in such case. Change-Id: I1143f0a8fa5c409760a656f154f28b79ad2ece94 --- M pywikibot/site.py 1 file changed, 7 insertions(+), 10 deletions(-) Approvals: Huji: Looks good to me, approved D3r1ck01: Looks good to me, but someone else must approve jenkins-bot: Verified diff --git a/pywikibot/site.py b/pywikibot/site.py index ffa45da..36ba13c 100644 --- a/pywikibot/site.py +++ b/pywikibot/site.py @@ -6082,6 +6082,7 @@ if False add them (default). @return: True if API returned expected response; False otherwise @rtype: bool + @raises KeyError: 'watch' isn't in API response """ parameters = {'action': 'watch', @@ -6125,16 +6126,12 @@ @rtype: bool """ - parameters = {'action': 'watch', - 'title': page, - 'token': self.tokens['watch'], - 'unwatch': unwatch} - req = self._simple_request(**parameters) - result = req.submit() - if 'watch' not in result: - pywikibot.error('watchpage: Unexpected API response:\n%s' % result) - return False - return ('unwatched' if unwatch else 'watched') in result['watch'] + try: + result = self.watch(page, unwatch) + except KeyError: + pywikibot.error('watchpage: Unexpected API response') + result = False + return result @must_be(group='user') def purgepages( -- To view, visit https://gerrit.wikimedia.org/r/494677 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I1143f0a8fa5c409760a656f154f28b79ad2ece94 Gerrit-Change-Number: 494677 Gerrit-PatchSet: 3 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: D3r1ck01 <xsavitar.wiki(a)aol.com> Gerrit-Reviewer: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: Huji <huji.huji(a)gmail.com> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: jenkins-bot (75)

1 0

[Gerrit] pywikibot/core[master]: [IMPR] Replace @must_be with @need_right
by jenkins-bot (Code Review) 10 Feb '20

10 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/565624 ) Change subject: [IMPR] Replace @must_be with @need_right ...................................................................... [IMPR] Replace @must_be with @need_right After dropping of user/sysop dualism, introduce a need_right decorator in favour of must_be decorator which primarily checks group membership. This decorator checks user right to be needed before a method will be executed. - deprecate "right" parameter in must_be - do not try to login with must_be decorator. login() method does not have the sysop parameter any longer - must_be enables checking for other user groups than just sysop and user - must_be and need_right checks for "steward" user group if any request is taken for obsolete wikis - replace all must_be usage with the new need_right decorator - tests added and modified Bug: T57296 Bug: T71283 Bug: T233608 Change-Id: I61622c2a7cfbcd8a6d33b5fdbaeefb355c47e3e9 --- M pywikibot/site.py M tests/dry_site_tests.py 2 files changed, 195 insertions(+), 75 deletions(-) Approvals: Huji: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/site.py b/pywikibot/site.py index f2bd0b3..e16d78f 100644 --- a/pywikibot/site.py +++ b/pywikibot/site.py @@ -1285,33 +1285,31 @@ return self.getUrl(address, data=data) -def must_be(group=None, right=None): +@deprecated_args(right=None) +def must_be(group=None): """Decorator to require a certain user status when method is called. - @param group: The group the logged in user should belong to - this parameter can be overridden by + @param group: The group the logged in user should belong to. + This parameter can be overridden by keyword argument 'as_group'. - @type group: str ('user' or 'sysop') - @param right: The rights the logged in user should have. - + @type group: str @return: method decorator + @raises UserRightsError: user is not part of the required user group. """ def decorator(fn): def callee(self, *args, **kwargs): grp = kwargs.pop('as_group', group) - if self.obsolete and not self.has_group('steward'): - raise UserRightsError('Site {} has been closed. Only steward ' - 'can perform requested action.' - .format(self.sitename)) - if right is not None: - if self.has_right(right): - return fn(self, *args, **kwargs) - if grp == 'user': - self.login(False) - elif grp == 'sysop': - self.login(True) - else: - raise Exception('Not implemented') + if self.obsolete: + if not self.has_group('steward'): + raise UserRightsError( + 'Site {} has been closed. Only steward ' + 'can perform requested action.' + .format(self.sitename)) + + elif not self.has_group(grp): + raise UserRightsError('User "{}" is not part of the required ' + 'user group "{}"' + .format(self.user(), grp)) return fn(self, *args, **kwargs) @@ -1319,7 +1317,38 @@ return fn manage_wrapping(callee, fn) + return callee + return decorator + + +def need_right(right=None): + """Decorator to require a certain user right when method is called. + + @param right: The right the logged in user should have. + @type right: str + @return: method decorator + @raises UserRightsError: user has insufficient rights. + """ + def decorator(fn): + def callee(self, *args, **kwargs): + if self.obsolete: + if not self.has_group('steward'): + raise UserRightsError( + 'Site {} has been closed. Only steward ' + 'can perform requested action.' + .format(self.sitename)) + + elif right is not None and not self.has_right(right): + raise UserRightsError('User "{}" does not have required ' + 'user right "{}"' + .format(self.user, right)) + return fn(self, *args, **kwargs) + + if not __debug__: + return fn + + manage_wrapping(callee, fn) return callee return decorator @@ -2271,13 +2300,11 @@ def has_right(self, right): """Return true if and only if the user has a specific right. - Possible values of 'right' may vary depending on wiki settings, - but will usually include: - - * Actions: edit, move, delete, protect, upload - * User levels: autoconfirmed, sysop, bot - + Possible values of 'right' may vary depending on wiki settings. U{https://www.mediawiki.org/wiki/API:Userinfo} + + @param right: a specific right to be validated + @type right: str """ return right.lower() in self._userinfo['rights'] @@ -5210,7 +5237,7 @@ } _ep_text_overrides = {'appendtext', 'prependtext', 'undo'} - @must_be(group='user') + @need_right('edit') def editpage(self, page, summary=None, minor=True, notminor=False, bot=True, recreate=True, createonly=False, nocreate=False, watch=None, **kwargs): @@ -5430,7 +5457,7 @@ 'destination revisions of {dest}' } - @must_be(group='sysop', right='mergehistory') + @need_right('mergehistory') def merge_history(self, source, dest, timestamp=None, reason=None): """Merge revisions from one page into another. @@ -5549,7 +5576,7 @@ '[[%(oldtitle)s]]', } - @must_be(group='user') + @need_right('move') def movepage(self, page, newtitle, summary, movetalk=True, noredirect=False): """Move a Page to a new title. @@ -5652,7 +5679,7 @@ 'Page [[%(title)s]] already rolled back; action aborted.', } # other errors shouldn't arise because we check for those errors - @must_be('user') + @need_right('rollback') def rollbackpage(self, page, **kwargs): """Roll back page to version before last user's edits. @@ -5717,7 +5744,7 @@ 'Revision may not exist or was already undeleted.' } # other errors shouldn't occur because of pre-submission checks - @must_be(group='sysop', right='delete') + @need_right('delete') @deprecate_arg('summary', 'reason') def deletepage(self, page, reason): """Delete page from the wiki. Requires appropriate privilege level. @@ -5755,7 +5782,7 @@ finally: self.unlock_page(page) - @must_be(group='sysop', right='undelete') + @need_right('undelete') @deprecate_arg('summary', 'reason') def undelete_page(self, page, reason, revisions=None): """Undelete page from the wiki. Requires appropriate privilege level. @@ -5828,7 +5855,7 @@ # implemented in b73b5883d486db0e9278ef16733551f28d9e096d return set(self.siteinfo.get('restrictions')['levels']) - @must_be(group='sysop', right='protect') + @need_right('protect') @deprecate_arg('summary', 'reason') def protect(self, page, protections, reason, expiry=None, **kwargs): """(Un)protect a wiki page. Requires administrator status. @@ -5897,7 +5924,7 @@ "The revision %(revid)s can't be patrolled as it's too old." } - @must_be(group='user') + @need_right('patrol') @deprecated_args(token=None) def patrol(self, rcid=None, revid=None, revision=None): """Return a generator of patrolled pages. @@ -5986,7 +6013,7 @@ yield result['patrol'] - @must_be(group='sysop', right='block') + @need_right('block') def blockuser(self, user, expiry, reason, anononly=True, nocreate=True, autoblock=True, noemail=False, reblock=False, allowusertalk=False): @@ -6044,7 +6071,7 @@ data = req.submit() return data - @must_be(group='sysop', right='block') + @need_right('unblock') def unblockuser(self, user, reason=None): """ Remove the block for the user. @@ -6064,7 +6091,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('editmywatchlist') def watch(self, pages, unwatch=False): """Add or remove pages from watchlist. @@ -6104,7 +6131,7 @@ return False return True - @must_be(group='user') + @need_right('editmywatchlist') @deprecated('Site().watch', since='20160102') def watchpage(self, page, unwatch=False): """ @@ -6131,7 +6158,7 @@ return False return ('unwatched' if unwatch else 'watched') in result['watch'] - @must_be(group='user') + @need_right('purge') def purgepages( self, pages, forcelinkupdate=False, forcerecursivelinkupdate=False, converttitles=False, redirects=False @@ -6211,7 +6238,7 @@ """ return self._get_titles_with_hash(hash_found) - @must_be(group='user') + @need_right('edit') def is_uploaddisabled(self): """Return True if upload is disabled on site. @@ -7269,7 +7296,7 @@ data = req.submit() return data['flow']['view-post']['result']['topic'] - @must_be('user') + @need_right('edit') @need_extension('Flow') def create_new_topic(self, page, title, content, format): """ @@ -7294,7 +7321,7 @@ data = req.submit() return data['flow']['new-topic']['committed']['topiclist'] - @must_be('user') + @need_right('edit') @need_extension('Flow') def reply_to_post(self, page, reply_to_uuid, content, format): """Reply to a post on a Flow topic. @@ -7318,7 +7345,7 @@ data = req.submit() return data['flow']['reply']['committed']['topic'] - @must_be('user', 'flow-lock') + @need_right('flow-lock') @need_extension('Flow') def lock_topic(self, page, lock, reason): """ @@ -7342,7 +7369,7 @@ data = req.submit() return data['flow']['lock-topic']['committed']['topic'] - @must_be('user') + @need_right('edit') @need_extension('Flow') def moderate_topic(self, page, state, reason): """ @@ -7365,7 +7392,7 @@ data = req.submit() return data['flow']['moderate-topic']['committed']['topic'] - @must_be('user', 'flow-delete') + @need_right('flow-delete') @need_extension('Flow') def delete_topic(self, page, reason): """ @@ -7380,7 +7407,7 @@ """ return self.moderate_topic(page, 'delete', reason) - @must_be('user', 'flow-hide') + @need_right('flow-hide') @need_extension('Flow') def hide_topic(self, page, reason): """ @@ -7395,7 +7422,7 @@ """ return self.moderate_topic(page, 'hide', reason) - @must_be('user', 'flow-suppress') + @need_right('flow-suppress') @need_extension('Flow') def suppress_topic(self, page, reason): """ @@ -7410,7 +7437,7 @@ """ return self.moderate_topic(page, 'suppress', reason) - @must_be('user') + @need_right('edit') @need_extension('Flow') def restore_topic(self, page, reason): """ @@ -7425,7 +7452,7 @@ """ return self.moderate_topic(page, 'restore', reason) - @must_be('user') + @need_right('edit') @need_extension('Flow') def moderate_post(self, post, state, reason): """ @@ -7450,7 +7477,7 @@ data = req.submit() return data['flow']['moderate-post']['committed']['topic'] - @must_be('user', 'flow-delete') + @need_right('flow-delete') @need_extension('Flow') def delete_post(self, post, reason): """ @@ -7465,7 +7492,7 @@ """ return self.moderate_post(post, 'delete', reason) - @must_be('user', 'flow-hide') + @need_right('flow-hide') @need_extension('Flow') def hide_post(self, post, reason): """ @@ -7480,7 +7507,7 @@ """ return self.moderate_post(post, 'hide', reason) - @must_be('user', 'flow-suppress') + @need_right('flow-suppress') @need_extension('Flow') def suppress_post(self, post, reason): """ @@ -7495,7 +7522,7 @@ """ return self.moderate_post(post, 'suppress', reason) - @must_be('user') + @need_right('edit') @need_extension('Flow') def restore_post(self, post, reason): """ @@ -7956,7 +7983,7 @@ return dtype @deprecated_args(identification='entity') - @must_be(group='user') + @need_right('edit') def editEntity(self, entity, data, bot=True, **kwargs): """ Edit entity. @@ -8010,7 +8037,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('edit') def addClaim(self, entity, claim, bot=True, summary=None): """ Add a claim. @@ -8041,7 +8068,7 @@ entity.claims[claim.getID()] = [claim] entity.latest_revision_id = data['pageinfo']['lastrevid'] - @must_be(group='user') + @need_right('edit') def changeClaimTarget(self, claim, snaktype='value', bot=True, summary=None): """ @@ -8073,7 +8100,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('edit') def save_claim(self, claim, summary=None, bot=True): """ Save the whole claim to the wikibase site. @@ -8103,7 +8130,7 @@ claim.on_item.latest_revision_id = data['pageinfo']['lastrevid'] return data - @must_be(group='user') + @need_right('edit') def editSource(self, claim, source, new=False, bot=True, summary=None, baserevid=None): """ @@ -8158,7 +8185,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('edit') def editQualifier(self, claim, qualifier, new=False, bot=True, summary=None, baserevid=None): """ @@ -8196,7 +8223,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('edit') def removeClaims(self, claims, bot=True, summary=None, baserevid=None): """ Remove claims. @@ -8230,7 +8257,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('edit') def removeSources(self, claim, sources, bot=True, summary=None, baserevid=None): """ @@ -8261,7 +8288,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('edit') def remove_qualifiers(self, claim, qualifiers, bot=True, summary=None, baserevid=None): """ @@ -8293,7 +8320,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('edit') def linkTitles(self, page1, page2, bot=True): """ Link two pages together. @@ -8321,7 +8348,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('item-merge') @deprecated_args(ignoreconflicts='ignore_conflicts', fromItem='from_item', toItem='to_item') def mergeItems(self, from_item, to_item, ignore_conflicts=None, @@ -8358,7 +8385,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('item-redirect') def set_redirect_target(self, from_item, to_item, bot=True): """ Make a redirect to another item. @@ -8381,7 +8408,7 @@ data = req.submit() return data - @must_be(group='user') + @need_right('edit') def createNewItemFromPage(self, page, bot=True, **kwargs): """ Create a new Wikibase item for a provided page. diff --git a/tests/dry_site_tests.py b/tests/dry_site_tests.py index a37454f..5a4652f 100644 --- a/tests/dry_site_tests.py +++ b/tests/dry_site_tests.py @@ -9,7 +9,7 @@ import pywikibot from pywikibot.tools import deprecated -from pywikibot.site import must_be, need_version +from pywikibot.site import must_be, need_right, need_version from pywikibot.comms.http import user_agent from pywikibot.exceptions import UserRightsError @@ -136,27 +136,38 @@ self.family.name = 'test' self.sitename = self.family.name + ':' + self.code self._logged_in_as = None + self._userinfo = [] self.obsolete = False super(TestMustBe, self).setUp() self.version = lambda: '1.14' # lowest supported release - def login(self, sysop): - """Fake the log in and just store who logged in.""" - self._logged_in_as = 'sysop' if sysop else 'user' + def login(self, group): + """Fake the log in as required user group.""" + self._logged_in_as = group + self._userinfo = [group] + + def user(self): + """Fake the logged in user.""" + return self._logged_in_as def has_group(self, group): """Fake the groups user belongs to.""" - return False + return group in self._userinfo def testMockInTest(self): """Test that setUp and login work.""" self.assertIsNone(self._logged_in_as) - self.login(True) - self.assertEqual(self._logged_in_as, 'sysop') + self.login('user') + self.assertEqual(self._logged_in_as, 'user') # Test that setUp is actually called between each test testMockInTestReset = testMockInTest # noqa: N815 + @must_be('steward') + def call_this_steward_req_function(self, *args, **kwargs): + """Require a sysop to function.""" + return args, kwargs + @must_be('sysop') def call_this_sysop_req_function(self, *args, **kwargs): """Require a sysop to function.""" @@ -167,43 +178,125 @@ """Require a user to function.""" return args, kwargs + def testMustBeSteward(self): + """Test a function which requires a sysop.""" + args = (1, 2, 'a', 'b') + kwargs = {'i': 'j', 'k': 'l'} + self.login('steward') + retval = self.call_this_steward_req_function(*args, **kwargs) + self.assertEqual(retval[0], args) + self.assertEqual(retval[1], kwargs) + def testMustBeSysop(self): """Test a function which requires a sysop.""" args = (1, 2, 'a', 'b') kwargs = {'i': 'j', 'k': 'l'} + self.login('sysop') retval = self.call_this_sysop_req_function(*args, **kwargs) self.assertEqual(retval[0], args) self.assertEqual(retval[1], kwargs) - self.assertEqual(self._logged_in_as, 'sysop') + self.assertRaises(UserRightsError, self.call_this_steward_req_function, + args, kwargs) def testMustBeUser(self): """Test a function which requires a user.""" args = (1, 2, 'a', 'b') kwargs = {'i': 'j', 'k': 'l'} + self.login('user') retval = self.call_this_user_req_function(*args, **kwargs) self.assertEqual(retval[0], args) self.assertEqual(retval[1], kwargs) - self.assertEqual(self._logged_in_as, 'user') + self.assertRaises(UserRightsError, self.call_this_sysop_req_function, + args, kwargs) def testOverrideUserType(self): """Test overriding the required group.""" args = (1, 2, 'a', 'b') kwargs = {'i': 'j', 'k': 'l'} + self.login('sysop') retval = self.call_this_user_req_function( *args, as_group='sysop', **kwargs) self.assertEqual(retval[0], args) self.assertEqual(retval[1], kwargs) - self.assertEqual(self._logged_in_as, 'sysop') def testObsoleteSite(self): """Test when the site is obsolete and shouldn't be edited.""" self.obsolete = True args = (1, 2, 'a', 'b') kwargs = {'i': 'j', 'k': 'l'} + self.login('steward') + retval = self.call_this_user_req_function(*args, **kwargs) + self.assertEqual(retval[0], args) + self.assertEqual(retval[1], kwargs) + self.login('user') self.assertRaises(UserRightsError, self.call_this_user_req_function, args, kwargs) +class TestNeedRight(DebugOnlyTestCase): + + """Test cases for the must_be decorator.""" + + net = False + + # Implemented without setUpClass(cls) and global variables as objects + # were not completely disposed and recreated but retained 'memory' + def setUp(self): + """Creating fake variables to appear as a site.""" + self.code = 'test' + self.family = lambda: None + self.family.name = 'test' + self.sitename = self.family.name + ':' + self.code + self._logged_in_as = None + self._userinfo = [] + self.obsolete = False + super(TestNeedRight, self).setUp() + self.version = lambda: '1.14' # lowest supported release + + def login(self, group, right): + """Fake the log in as required user group.""" + self._logged_in_as = group + self._userinfo = [right] + + def user(self): + """Fake the logged in user.""" + return self._logged_in_as + + def has_right(self, right): + """Fake the groups user belongs to.""" + return right in self._userinfo + + @need_right('edit') + def call_this_edit_req_function(self, *args, **kwargs): + """Require a sysop to function.""" + return args, kwargs + + @need_right('move') + def call_this_move_req_function(self, *args, **kwargs): + """Require a sysop to function.""" + return args, kwargs + + def testNeedRightEdit(self): + """Test a function which requires a sysop.""" + args = (1, 2, 'a', 'b') + kwargs = {'i': 'j', 'k': 'l'} + self.login('user', 'edit') + retval = self.call_this_edit_req_function(*args, **kwargs) + self.assertEqual(retval[0], args) + self.assertEqual(retval[1], kwargs) + + def testNeedRightMove(self): + """Test a function which requires a sysop.""" + args = (1, 2, 'a', 'b') + kwargs = {'i': 'j', 'k': 'l'} + self.login('user', 'move') + retval = self.call_this_move_req_function(*args, **kwargs) + self.assertEqual(retval[0], args) + self.assertEqual(retval[1], kwargs) + self.assertRaises(UserRightsError, self.call_this_edit_req_function, + args, kwargs) + + class TestNeedVersion(DeprecationTestCase): """Test cases for the need_version decorator.""" -- To view, visit https://gerrit.wikimedia.org/r/565624 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I61622c2a7cfbcd8a6d33b5fdbaeefb355c47e3e9 Gerrit-Change-Number: 565624 Gerrit-PatchSet: 6 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Huji <huji.huji(a)gmail.com> Gerrit-Reviewer: Martineznovo <martineznovo(a)gmail.com> Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot (75) Gerrit-CC: Matěj Suchánek <matejsuchanek97(a)gmail.com>

1 0

[Gerrit] pywikibot/core[master]: [IMPR] Issue DeprecationWarning for sysop in Site()
by jenkins-bot (Code Review) 10 Feb '20

10 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/569286 ) Change subject: [IMPR] Issue DeprecationWarning for sysop in Site() ...................................................................... [IMPR] Issue DeprecationWarning for sysop in Site() Issue DeprecationWarning for sysop in Site() Change-Id: I79fcfb475ea67ff9913d63a20536c3e5bc087b86 --- M pywikibot/__init__.py M tests/utils.py 2 files changed, 6 insertions(+), 1 deletion(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/__init__.py b/pywikibot/__init__.py index cbb6ff3..c8a66dc 100644 --- a/pywikibot/__init__.py +++ b/pywikibot/__init__.py @@ -62,6 +62,7 @@ classproperty, deprecated as __deprecated, deprecate_arg as _deprecate_arg, + issue_deprecation_warning, normalize_username, MediaWikiVersion as _MediaWikiVersion, redirect_func, @@ -1222,6 +1223,10 @@ """ _logger = 'wiki' + if sysop is not None: + issue_deprecation_warning('positional argument of "sysop"', depth=3, + warning_class=DeprecationWarning, + since='20190907') if url: # Either code and fam or only url if code or fam: diff --git a/tests/utils.py b/tests/utils.py index 56e5f09..f9118da 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -601,7 +601,7 @@ @type command: list of unicode """ if PY2 or PYTHON_VERSION < (3, 5, 0): - command.insert(1, '-W ignore::FutureWarning:pywikibot:127') + command.insert(1, '-W ignore::FutureWarning:pywikibot:128') if cryptography_version and cryptography_version < [1, 3, 4]: command.insert(1, '-W ignore:Old version of cryptography:Warning') # Any environment variables added on Windows must be of type -- To view, visit https://gerrit.wikimedia.org/r/569286 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I79fcfb475ea67ff9913d63a20536c3e5bc087b86 Gerrit-Change-Number: 569286 Gerrit-PatchSet: 6 Gerrit-Owner: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot (75)

1 0

[Gerrit] pywikibot/core[master]: [bugfix] Fix some typos in docs
by jenkins-bot (Code Review) 10 Feb '20

10 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/571103 ) Change subject: [bugfix] Fix some typos in docs ...................................................................... [bugfix] Fix some typos in docs Change-Id: I2ae165208e2b0818b0abc881988220f8bd887efd --- M pywikibot/site.py M scripts/replace.py 2 files changed, 2 insertions(+), 2 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/site.py b/pywikibot/site.py index ffa45da..6a8299e 100644 --- a/pywikibot/site.py +++ b/pywikibot/site.py @@ -8437,7 +8437,7 @@ @type language: str @param total: Maximum number of pages to retrieve in total, or None in case of no limit. - @type limit: int or None + @type total: int or None @return: 'search' list from API output. @rtype: api.APIGenerator """ diff --git a/scripts/replace.py b/scripts/replace.py index 1c30090..791250d 100755 --- a/scripts/replace.py +++ b/scripts/replace.py @@ -532,7 +532,7 @@ @param allowoverlap: when matches overlap, all of them are replaced. @type allowoverlap: bool @param recursive: Recurse replacement as long as possible. - @type recursice: bool + @type recursive: bool @warning: Be careful, this might lead to an infinite loop. @param addedCat: category to be added to every page touched @type addedCat: pywikibot.Category or str or None -- To view, visit https://gerrit.wikimedia.org/r/571103 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I2ae165208e2b0818b0abc881988220f8bd887efd Gerrit-Change-Number: 571103 Gerrit-PatchSet: 8 Gerrit-Owner: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot (75) Gerrit-CC: Mpaa <mpaa.wiki(a)gmail.com>

1 0

[Gerrit] pywikibot/core[master]: [IMPR] make date.FormatDate class a function (PEP20)
by jenkins-bot (Code Review) 09 Feb '20

09 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/512535 ) Change subject: [IMPR] make date.FormatDate class a function (PEP20) ...................................................................... [IMPR] make date.FormatDate class a function (PEP20) - deprecate date.FormatDate class which is a function encapsulated in a class - format_date function is to be used instead - reuse dayMnthFmts instead of concatening again - introduce full range checking for month and day value - replace FormatDate with format_date in pagegenerators.py Change-Id: I36900f2931398c4adb967acec010903e27b01e71 --- M pywikibot/date.py M pywikibot/pagegenerators.py 2 files changed, 37 insertions(+), 5 deletions(-) Approvals: Dvorapa: Looks good to me, but someone else must approve Mpaa: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/date.py b/pywikibot/date.py index 49a22ea..1cd5c5e 100644 --- a/pywikibot/date.py +++ b/pywikibot/date.py @@ -19,6 +19,7 @@ import re from string import digits as _decimalDigits # noqa: N812 +from pywikibot import Site from pywikibot.textlib import NON_LATIN_DIGITS from pywikibot.tools import first_lower, first_upper, deprecated, UnicodeType @@ -2215,9 +2216,10 @@ return None, None +@deprecated('date.format_date', since='20190526') class FormatDate(object): - """Format a date.""" + """DEPRECATED. Format a date.""" def __init__(self, site): """Initializer.""" @@ -2225,7 +2227,36 @@ def __call__(self, m, d): """Return a formatted month and day.""" - return formats[dayMnthFmts[m - 1]][self.site.lang](d) + return format_date(m, d, self.site) + + +def format_date(month, day, lang=None, year=2000): + """Format a date localized to given lang. + + @param month: month in range of 1..12 + @type month: int + @param day: day of month in range of 1..31 + @type day: int + @param lang: a site object or language key. Defaults to current site. + @type lang: BaseSite or string + @param year: year for which the date is to be formatted. always 29 will be + given For February except the year is given. Default is leap year 2000. + @type year: int + @return: localized date like "January 11" + @rtype: str + @raises ValueError: Wrong day value; must be 1-28/29/30/31 + @raises IllegalMonthError: bad month number; must be 1-12 + """ + if not lang: + lang = Site().lang + elif hasattr(lang, 'lang'): + lang = lang.lang + max_day = calendar.monthrange(year, month)[1] + if not 1 <= day <= max_day: + raise ValueError( + 'Wrong day value {day}; must be 1-{max_day}' + .format(day=day, max_day=max_day)) + return formats[dayMnthFmts[month - 1]][lang](day) def formatYear(lang, year): diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py index 325d905..011dfd9 100644 --- a/pywikibot/pagegenerators.py +++ b/pywikibot/pagegenerators.py @@ -2904,12 +2904,13 @@ """ if site is None: site = pywikibot.Site() - fd = date.FormatDate(site) - firstPage = pywikibot.Page(site, fd(start_month, 1)) + lang = site.lang + firstPage = pywikibot.Page(site, date.format_date(start_month, 1, lang)) pywikibot.output('Starting with %s' % firstPage.title(as_link=True)) for month in range(start_month, end_month + 1): for day in range(1, calendar.monthrange(year, month)[1] + 1): - yield pywikibot.Page(pywikibot.Link(fd(month, day), site)) + yield pywikibot.Page( + pywikibot.Link(date.format_date(month, day, lang), site)) def WikidataPageFromItemGenerator(gen, site): -- To view, visit https://gerrit.wikimedia.org/r/512535 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I36900f2931398c4adb967acec010903e27b01e71 Gerrit-Change-Number: 512535 Gerrit-PatchSet: 4 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: jenkins-bot (75)

1 0

[Gerrit] pywikibot/core[master]: [cleanup] Throw FutureWarning with backports.py functions
by jenkins-bot (Code Review) 09 Feb '20

09 Feb '20

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/571074 ) Change subject: [cleanup] Throw FutureWarning with backports.py functions ...................................................................... [cleanup] Throw FutureWarning with backports.py functions Bug: T244664 Change-Id: I59cb34bd43a0845751e3e8c6c47b17e813d2bd5e --- M HISTORY.rst M pywikibot/backports.py 2 files changed, 6 insertions(+), 4 deletions(-) Approvals: Dvorapa: Looks good to me, approved jenkins-bot: Verified diff --git a/HISTORY.rst b/HISTORY.rst index c9f0dfc..05fdd57 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -4,6 +4,7 @@ Current release --------------- +* backports.py will be removed with next release (T244664) * stdnum package is required for ISBN scripts and cosmetic_changes (T132919, T144288, T241141) * preload urllib.quote() with Python 2 (T243710, T222623) * Drop isbn_hyphenate package due to outdated data (T243157) diff --git a/pywikibot/backports.py b/pywikibot/backports.py index a190eba..59bc5f5 100644 --- a/pywikibot/backports.py +++ b/pywikibot/backports.py @@ -5,7 +5,7 @@ Their usage is deprecated and this module could be dropped soon. """ # -# (C) Pywikibot team, 2014-2018 +# (C) Pywikibot team, 2014-2020 # # Distributed under the terms of the MIT license. # @@ -18,7 +18,8 @@ from pywikibot.tools import deprecated -@deprecated('difflib._format_range_unified', since='20160111') +@deprecated('difflib._format_range_unified', since='20160111', + future_warning=True) def format_range_unified(start, stop): """ Convert range to the "ed" format. @@ -29,7 +30,7 @@ return _format_range_unified(start, stop) -@deprecated('logging.NullHandler', since='20160111') +@deprecated('logging.NullHandler', since='20160111', future_warning=True) class NullHandler(logging.NullHandler): """This handler does nothing.""" @@ -37,7 +38,7 @@ pass -@deprecated('logging.captureWarnings', since='20160111') +@deprecated('logging.captureWarnings', since='20160111', future_warning=True) def captureWarnings(capture): """ Capture warnings into logging. -- To view, visit https://gerrit.wikimedia.org/r/571074 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I59cb34bd43a0845751e3e8c6c47b17e813d2bd5e Gerrit-Change-Number: 571074 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Dvorapa <dvorapa(a)seznam.cz> Gerrit-Reviewer: jenkins-bot (75)

1 0

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

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits February 2020