Pywikibot-commits October 2021

pywikibot-commits@lists.wikimedia.org

1 participants
68 discussions

[Gerrit] ...core[master]: [doc] Add version hints to tools

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/729490 ) Change subject: [doc] Add version hints to tools ...................................................................... [doc] Add version hints to tools Change-Id: I7f7924cfeec646e2684e5719ed162b7c22a57554 --- M pywikibot/tools/__init__.py M pywikibot/tools/_deprecate.py 2 files changed, 108 insertions(+), 21 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 96bd494..a988b10 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -71,6 +71,9 @@ def is_ip_address(value: str) -> bool: """Check if a value is a valid IPv4 or IPv6 address. + .. versionadded:: 6.1 + Was renamed from ``is_IP()``. + :param value: value to check """ with suppress(ValueError): @@ -83,7 +86,11 @@ def has_module(module, version=None): """Check if a module can be imported. - *New in version 3.0.* + .. versionadded:: 3.0 + + .. versionchanged:: 6.1 + Dependency of distutils was dropped because the package will be + removed with Python 3.12. """ try: m = import_module(module) @@ -120,6 +127,8 @@ return cls._bar Foo.bar gives 'baz'. + + .. versionadded:: 3.0 """ def __init__(self, cls_method): @@ -139,7 +148,7 @@ Those suppressed warnings that do not match the parameters will be raised shown upon exit. - *New in vesion 3.0.* + .. versionadded:: 3.0 """ def __init__(self, message='', category=Warning, filename=''): @@ -193,7 +202,10 @@ # From http://python3porting.com/preparing.html class ComparableMixin: - """Mixin class to allow comparing to other objects which are comparable.""" + """Mixin class to allow comparing to other objects which are comparable. + + .. versionadded:: 3.0 + """ def __lt__(self, other): """Compare if self is less than other.""" @@ -255,7 +267,7 @@ >>> list(data) [] - *New in version 6.1.* + .. versionadded:: 6.1 """ def __init__(self, keyattr: str): @@ -336,6 +348,8 @@ Return a string with the first character uncapitalized. Empty strings are supported. The original string is not changed. + + .. versionadded:: 3.0 """ return string[:1].lower() + string[1:] @@ -346,6 +360,8 @@ Empty strings are supported. The original string is not changed. + .. versionadded:: 3.0 + :note: MediaWiki doesn't capitalize some characters the same way as Python. This function tries to be close to MediaWiki's capitalize function in title.php. See T179115 and T200357. @@ -355,7 +371,10 @@ def normalize_username(username) -> Optional[str]: - """Normalize the username.""" + """Normalize the username. + + .. versionadded:: 3.0 + """ if not username: return None username = re.sub('[_ ]+', ' ', username).strip() @@ -368,11 +387,9 @@ This Version provides propreties of vendor package 20.4 shipped with setuptools 49.4.0. - """ - def __init__(self, version): - """Add additional properties of not provided by base class.""" - super().__init__(version) + .. versionadded:: 6.4 + """ def __getattr__(self, name): """Provides propreties of vendor package 20.4.""" @@ -415,6 +432,12 @@ < 1.35-rc-1 < 1.35-rc.2 < 1.35 Any other suffixes are considered invalid. + + .. versionadded:: 3.0 + + .. versionchanged:: 6.1 + Dependency of distutils was dropped because the package will be + removed with Python 3.12. """ MEDIAWIKI_VERSION = re.compile( @@ -521,7 +544,7 @@ >>> lock.locked() False - *New in version 6.2* + .. versionadded:: 6.2 """ def __init__(self, *args, **kwargs): @@ -584,6 +607,7 @@ >>> data [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19] + ..versionadded:: 3.0 """ def __init__(self, group=None, target=None, name='GeneratorThread', @@ -796,6 +820,20 @@ >>> list(intersect_generators(*iterables, allow_duplicates=True)) ['m', 'i', 's', 's', 'i'] + + .. versionadded:: 3.0 + + .. versionchanged:: 5.0 + Avoid duplicates (T263947). + + .. versionchanged:: 6.4 + ``genlist`` was renamed to ``iterables``; consecutive iterables + are to be used as iterables parameters or '*' to unpack a list + + .. deprecated:: 6.4 + ``allow_duplicates`` as positional argument, + ``iterables`` as list type + :param iterables: page generators :param allow_duplicates: optional keyword argument to allow duplicates if present in all generators @@ -901,7 +939,10 @@ >>> tuple(roundrobin_generators('ABC', range(5))) ('A', 0, 'B', 1, 'C', 2, 3, 4) - *New in version 3.0.* + .. versionadded:: 3.0 + .. versionchanged:: 6.4 + A sentinel variable is used to determine the end of an iterable + instead of None. :param iterables: any iterable to combine in roundrobin way :type iterables: iterable @@ -942,6 +983,8 @@ Note: This is not thread safe. + .. versionadded: 3.0 + :param iterable: the source iterable :type iterable: collections.abc.Iterable :param container: storage of seen items @@ -978,7 +1021,10 @@ class CombinedError(KeyError, IndexError): - """An error that gets caught by both KeyError and IndexError.""" + """An error that gets caught by both KeyError and IndexError. + + .. versionadded:: 3.0 + """ class EmptyDefault(str, Mapping): @@ -992,6 +1038,10 @@ Accessing a value via __getitem__ will result in a combined KeyError and IndexError. + + .. versionadded:: 3.0 + .. versionchanged:: 6.2 + ``empty_iterator()`` was removed in favour of ``iter()``. """ def __init__(self): @@ -1017,29 +1067,45 @@ When '_own_desc' is defined it'll also issue a deprecation warning using issue_deprecation_warning('Calling ' + _own_desc, 'it directly'). + + .. versionadded:: 3.0 + .. deprecated:: 6.2 """ def __call__(self): """Do nothing and just return itself.""" issue_deprecation_warning('Referencing this attribute like a function', - 'it directly', since='20210420') + 'it directly', since='6.2') return self class SelfCallDict(SelfCallMixin, dict): - """Dict with SelfCallMixin.""" + """Dict with SelfCallMixin. + + .. versionadded:: 3.0 + .. deprecated:: 6.2 + """ class SelfCallString(SelfCallMixin, str): - """String with SelfCallMixin.""" + """String with SelfCallMixin. + + .. versionadded:: 3.0 + .. deprecated:: 6.2 + """ class DequeGenerator(Iterator, collections.deque): - """A generator that allows items to be added during generating.""" + """A generator that allows items to be added during generating. + + .. versionadded:: 3.0 + .. versionchanged:: 6.1 + Provide a representation string. + """ def __next__(self): """Iterator method.""" @@ -1067,6 +1133,8 @@ The compression is either selected via the magic number or file ending. + .. versionadded:: 3.0 + :param filename: The filename. :type filename: str :param use_extension: Use the file extension instead of the magic number @@ -1168,6 +1236,8 @@ The positional arguments are the dictionaries to be merged. It is also possible to define an additional dict using the keyword arguments. + + .. versionadded: 3.0 """ args = list(args) + [dict(kwargs)] conflicts = set() @@ -1185,6 +1255,8 @@ def file_mode_checker(filename: str, mode=0o600, quiet=False, create=False): """Check file mode and update it, if needed. + .. versionadded: 3.0 + :param filename: filename path :param mode: requested file mode :type mode: int @@ -1215,6 +1287,8 @@ Result is expressed as hexdigest(). + .. versionadded: 3.0 + :param filename: filename path :param sha: hashing function among the following in hashlib: md5(), sha1(), sha224(), sha256(), sha384(), and sha512() diff --git a/pywikibot/tools/_deprecate.py b/pywikibot/tools/_deprecate.py index 829b24c..a043e5d 100644 --- a/pywikibot/tools/_deprecate.py +++ b/pywikibot/tools/_deprecate.py @@ -15,7 +15,8 @@ only one arg, and that arg be a callable, as it will be detected as a deprecator without any arguments. -*Changed in version 6.4:* deprecation decorators moved to _deprecate module +.. versionchanged 6.4: + deprecation decorators moved to _deprecate module """ # # (C) Pywikibot team, 2008-2021 @@ -37,7 +38,10 @@ class _NotImplementedWarning(RuntimeWarning): - """Feature that is no longer implemented.""" + """Feature that is no longer implemented. + + .. versionadded:: 3.0 + """ def add_decorated_full_name(obj, stacklevel=1): @@ -66,7 +70,10 @@ def manage_wrapping(wrapper, obj): - """Add attributes to wrapper and wrapped functions.""" + """Add attributes to wrapper and wrapped functions. + + .. versionadded:: 3.0 + """ wrapper.__doc__ = obj.__doc__ wrapper.__name__ = obj.__name__ wrapper.__module__ = obj.__module__ @@ -91,7 +98,10 @@ def get_wrapper_depth(wrapper): - """Return depth of wrapper function.""" + """Return depth of wrapper function. + + .. versionadded:: 3.0 + """ return wrapper.__wrapped__.__wrappers__ + (1 - wrapper.__depth__) @@ -155,7 +165,10 @@ def _build_msg_string(instead, since): - """Build a deprecation warning message format string.""" + """Build a deprecation warning message format string. + + .. versionadded:: 3.0 + """ if not since: since = '' elif '.' in since: -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/729490 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: I7f7924cfeec646e2684e5719ed162b7c22a57554 Gerrit-Change-Number: 729490 Gerrit-PatchSet: 3 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

[Gerrit] ...core[master]: [bugfix] Require sphinx >= 4.1

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/729475 ) Change subject: [bugfix] Require sphinx >= 4.1 ...................................................................... [bugfix] Require sphinx >= 4.1 Bug: T292921 Change-Id: I29aee1719dd2fb8cd81036a1344c167ea0afd9d9 --- M docs/conf.py M docs/requirements-py3.txt 2 files changed, 2 insertions(+), 2 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/docs/conf.py b/docs/conf.py index d4430c2..d72fff1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -46,7 +46,7 @@ # If your documentation needs a minimal Sphinx version, state it here. # -needs_sphinx = '1.8' +needs_sphinx = '4.1' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom diff --git a/docs/requirements-py3.txt b/docs/requirements-py3.txt index f6022b4..3a80334 100644 --- a/docs/requirements-py3.txt +++ b/docs/requirements-py3.txt @@ -1,4 +1,4 @@ # This is a PIP requirements file for building Sphinx documentation of pywikibot # requirements.txt is also needed -sphinx > 3.5.0, != 4.0.0 \ No newline at end of file +sphinx >= 4.1.0 \ No newline at end of file -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/729475 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: I29aee1719dd2fb8cd81036a1344c167ea0afd9d9 Gerrit-Change-Number: 729475 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

[Gerrit] ...core[master]: Adding edit_restricted_template for Armenian Wikipedia

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/729238 ) Change subject: Adding edit_restricted_template for Armenian Wikipedia ...................................................................... Adding edit_restricted_template for Armenian Wikipedia Change-Id: Iee24ab131b44efe4e8b68c8ad94093bcae1ee971 --- M pywikibot/families/wikipedia_family.py 1 file changed, 1 insertion(+), 0 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/families/wikipedia_family.py b/pywikibot/families/wikipedia_family.py index 2736d2c..f6559c6 100644 --- a/pywikibot/families/wikipedia_family.py +++ b/pywikibot/families/wikipedia_family.py @@ -198,6 +198,7 @@ 'fr': ('En cours',), 'he': ('בעבודה',), 'hr': ('Radovi',), + 'hy': ('Խմբագրում եմ',), 'sr': ('Радови у току', 'Рут',), 'test': ('In use',), 'ur': ('زیر ترمیم',), -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/729238 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: Iee24ab131b44efe4e8b68c8ad94093bcae1ee971 Gerrit-Change-Number: 729238 Gerrit-PatchSet: 2 Gerrit-Owner: Ashot1997 <ashotjanibekyan(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

[Gerrit] ...core[master]: [doc] Update ROADMAP.rst and CHANGELOG.md

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/729142 ) Change subject: [doc] Update ROADMAP.rst and CHANGELOG.md ...................................................................... [doc] Update ROADMAP.rst and CHANGELOG.md Change-Id: I88d004ece927d75e9f6f7151b5b8da745938ca71 --- M ROADMAP.rst M pywikibot/exceptions.py M scripts/CHANGELOG.md 3 files changed, 47 insertions(+), 4 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/ROADMAP.rst b/ROADMAP.rst index 37e0783..eba2565 100644 --- a/ROADMAP.rst +++ b/ROADMAP.rst @@ -1,6 +1,14 @@ Current release changes ^^^^^^^^^^^^^^^^^^^^^^^ +Improvements and Bugfixes +------------------------- + +* Adjust groupsize within pagegenerators.PreloadingGenerator (T291770) +* New "maxlimit" property was added to APISite (T291770) + + + Breaking changes ---------------- @@ -10,6 +18,13 @@ Code cleanups ------------- +* Outdated parameter names has been dropped +* Deprecated pywikibot.Error exception were removed in favour of pywikibot.exceptions.Error classes (T280227) +* Deprecated exception identifiers were removed (T280227) +* Deprecated date.FormatDate class was removed in favour of date.format_date function +* language_by_size property of wowwiki Family was removed in favour of codes attribute +* availableOptions was removed in favour of available_options +* config2 was removed in favour of config * tools.RotatingFileHandler was removed in favour of logging.handlers.RotatingFileHandler * tools.DotReadableDict, tools.LazyRegex and tools.DeprecatedRegex classes were removed * tools.frozenmap was removed in favour of types.MappingProxyType @@ -29,8 +44,4 @@ * 6.4.0: Pywikibot `began using semantic versioning <https://www.mediawiki.org/wiki/Manual:Pywikibot/Development/Guidelines#Depr…>`_, all deprecated code will be removed in Pywikibot version 7.0.0. -* 6.2.0: Bot's availableOptions will be removed in favour of available_options -* 6.2.0: Usage of pywikibot.config2 is deprecated and will be dropped -* 6.2.0: Exceptions must be imported from exceptions namespace (T280227) -* 6.2.0: Deprecated exception identifiers will be removed (T280227) * 5.0.0: Methods deprecated for 5 years or longer will be removed diff --git a/pywikibot/exceptions.py b/pywikibot/exceptions.py index f844f98..0850418 100644 --- a/pywikibot/exceptions.py +++ b/pywikibot/exceptions.py @@ -155,6 +155,11 @@ .. versionchanged:: 6.0 exceptions were renamed and are ending with "Error". + +.. versionchanged:: 7.0 + All Pywikibot Error exceptions must be imported from + ``pywikibot.exceptions``. Deprecated exceptions identifiers were + removed. """ # # (C) Pywikibot team, 2008-2021 diff --git a/scripts/CHANGELOG.md b/scripts/CHANGELOG.md index f85a12a..0db9f4c 100644 --- a/scripts/CHANGELOG.md +++ b/scripts/CHANGELOG.md @@ -9,9 +9,36 @@ * Deprecated function put_text() was removed in favour of BaseBot.userPut() method * Deprecated function add_text() were remove in favour of textlib.add_text() +### blockpageschecker +* Use different edit comments when adding, changeing or removing templates (T291345) +* Derive CheckerBot from ConfigParserBot (T57106) +* Derive CheckerBot from CurrentPageBot (T196851, T171713) + +### category +* Deprecated code parts were removed + +### djvutext +* pass site arg only once (T292367) + ### newitem * Do not pass OtherPageSaveRelatedError silently +### pagefromfile +* Preload pages instead of reading them one by one before putting changes +* Don't ask for confirmation by default (T291757) + +### reflinks +* L10N updates + +### replace +* Deprecated "acceptall" and "addedCat" parameters were replaced by "always" and "addcat" + +### revertbot +* Deprecated "max" parameter was replaced by "total" + +### solve_disambiguation +* Remove deprecated properties in favour of DisambiguationRobot.opt options + ### touch *Do not pass OtherPageSaveRelatedError silently -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/729142 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: I88d004ece927d75e9f6f7151b5b8da745938ca71 Gerrit-Change-Number: 729142 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: D3r1ck01 <xsavitar.wiki(a)aol.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

[Gerrit] ...core[master]: [cleanup] Remove @deprecated_args decorator

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/725404 ) Change subject: [cleanup] Remove @deprecated_args decorator ...................................................................... [cleanup] Remove @deprecated_args decorator - Use issue_deprecation_warning instead of warn for outdated filterredir parameter value of APISite.allpages method - remove tests for outdated parameters Change-Id: Id217ec0813d1543ccdc5a461b25bb4b5b21d8b9b --- M ROADMAP.rst M pywikibot/bot.py M pywikibot/bot_choice.py M pywikibot/comms/eventstreams.py M pywikibot/comms/http.py M pywikibot/cosmetic_changes.py M pywikibot/daemonize.py M pywikibot/data/mysql.py M pywikibot/diff.py M pywikibot/family.py M pywikibot/i18n.py M pywikibot/login.py M pywikibot/page/__init__.py M pywikibot/pagegenerators.py M pywikibot/site/_apisite.py M pywikibot/site/_datasite.py M pywikibot/site/_extensions.py M pywikibot/site/_generators.py M pywikibot/specialbots/_upload.py M pywikibot/throttle.py M pywikibot/titletranslate.py M pywikibot/tools/djvu.py M pywikibot/userinterfaces/terminal_interface_base.py M tests/site_tests.py 24 files changed, 17 insertions(+), 229 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/ROADMAP.rst b/ROADMAP.rst index 715e7f7..37e0783 100644 --- a/ROADMAP.rst +++ b/ROADMAP.rst @@ -24,6 +24,7 @@ Deprecations ^^^^^^^^^^^^ +* 7.0.0: Values of APISite.allpages() parameter filterredir other than True, False and None are deprecated * 6.5.0: OutputOption.output() method will be removed in favour of OutputOption.out property * 6.4.0: Pywikibot `began using semantic versioning <https://www.mediawiki.org/wiki/Manual:Pywikibot/Development/Guidelines#Depr…>`_, diff --git a/pywikibot/bot.py b/pywikibot/bot.py index c1b3feb..d477031 100644 --- a/pywikibot/bot.py +++ b/pywikibot/bot.py @@ -173,7 +173,6 @@ from pywikibot.tools import ( PYTHON_VERSION, deprecated, - deprecated_args, issue_deprecation_warning, ) from pywikibot.tools._logging import LoggingFormatter @@ -1335,7 +1334,6 @@ return True - @deprecated_args(comment='summary') def userPut(self, page: 'pywikibot.page.BasePage', oldtext: str, newtext: str, **kwargs: Any) -> bool: """ @@ -1837,7 +1835,6 @@ self.current_page = page self.treat_page() - @deprecated_args(comment='summary') def put_current(self, new_text: str, ignore_save_related_errors: Optional[bool] = None, ignore_server_errors: Optional[bool] = None, @@ -2009,7 +2006,6 @@ use_from_page = True treat_missing_item = False - @deprecated_args(use_from_page=True) def __init__(self, **kwargs: Any) -> None: """Initializer of the WikidataBot.""" self.create_missing_item = False diff --git a/pywikibot/bot_choice.py b/pywikibot/bot_choice.py index 90810e4..90fc602 100755 --- a/pywikibot/bot_choice.py +++ b/pywikibot/bot_choice.py @@ -14,11 +14,7 @@ from pywikibot.backports import Iterable, Sequence -from pywikibot.tools import ( - deprecated, - deprecated_args, - issue_deprecation_warning, -) +from pywikibot.tools import deprecated, issue_deprecation_warning # TODO: replace these after T286867 @@ -274,7 +270,6 @@ end = min(len(self.text), self.end + self.context) return self.text[start:end] - @deprecated_args(start_context='start', end_context='end') @deprecated('pywikibot.output(ContextOption.out)', since='6.2.0') def output_range(self, start: int, end: int) -> None: """DEPRECATED. Output a section from the text.""" diff --git a/pywikibot/comms/eventstreams.py b/pywikibot/comms/eventstreams.py index a2059ab..c92bc7b 100644 --- a/pywikibot/comms/eventstreams.py +++ b/pywikibot/comms/eventstreams.py @@ -25,7 +25,6 @@ from requests.packages.urllib3.util.response import httplib from pywikibot import Site, Timestamp, config, debug, warning -from pywikibot.tools import deprecated_args try: @@ -76,7 +75,6 @@ >>> del stream """ - @deprecated_args(stream='streams') def __init__(self, **kwargs): """Initializer. diff --git a/pywikibot/comms/http.py b/pywikibot/comms/http.py index 695923b..23c1bce 100644 --- a/pywikibot/comms/http.py +++ b/pywikibot/comms/http.py @@ -50,7 +50,6 @@ from pywikibot.logging import critical, debug, error, log, warning from pywikibot.tools import ( deprecated, - deprecated_args, file_mode_checker, issue_deprecation_warning, ) @@ -222,7 +221,6 @@ return UserAgent().random -@deprecated_args(body='data') def request(site, uri: Optional[str] = None, headers: Optional[dict] = None, @@ -323,7 +321,6 @@ warning('Http response status {}'.format(response.status_code)) -@deprecated_args(body='data') def fetch(uri: str, method: str = 'GET', headers: Optional[dict] = None, default_error_handling: bool = True, use_fake_user_agent: Union[bool, str] = False, **kwargs): diff --git a/pywikibot/cosmetic_changes.py b/pywikibot/cosmetic_changes.py index 96ac707..7585269 100755 --- a/pywikibot/cosmetic_changes.py +++ b/pywikibot/cosmetic_changes.py @@ -71,7 +71,6 @@ ) from pywikibot.tools import ( deprecated, - deprecated_args, first_lower, first_upper, issue_deprecation_warning, @@ -225,7 +224,6 @@ """Cosmetic changes toolkit.""" - @deprecated_args(redirect=True, diff='show_diff', site='page') def __init__(self, page: 'pywikibot.page.BasePage', *, show_diff: bool = False, namespace: Optional[int] = None, @@ -312,7 +310,6 @@ @classmethod @deprecated('CosmeticChangesToolkit with pywikibot.Page object', since='20200415') - @deprecated_args(diff='show_diff') def from_page(cls, page: 'pywikibot.page.BasePage', show_diff: bool = False, ignore: IntEnum = CANCEL.ALL) -> 'CosmeticChangesToolkit': diff --git a/pywikibot/daemonize.py b/pywikibot/daemonize.py index 16f3716..0cba456 100644 --- a/pywikibot/daemonize.py +++ b/pywikibot/daemonize.py @@ -10,13 +10,10 @@ import sys from typing import Optional -from pywikibot.tools import deprecated_args - is_daemon = False -@deprecated_args(write_pid=True) def daemonize(close_fd: bool = True, chdir: bool = True, redirect_std: Optional[str] = None) -> None: """ diff --git a/pywikibot/data/mysql.py b/pywikibot/data/mysql.py index 6bfad0c..af8ae6e 100644 --- a/pywikibot/data/mysql.py +++ b/pywikibot/data/mysql.py @@ -10,7 +10,6 @@ import pywikibot from pywikibot import config -from pywikibot.tools import deprecated_args try: @@ -19,7 +18,6 @@ raise ImportError('MySQL python module not found. Please install PyMySQL.') -@deprecated_args(encoding=True) def mysql_query(query: str, params=None, dbname: Optional[str] = None, verbose: Optional[bool] = None): diff --git a/pywikibot/diff.py b/pywikibot/diff.py index 9c91a9b..d4eec47 100644 --- a/pywikibot/diff.py +++ b/pywikibot/diff.py @@ -15,7 +15,7 @@ import pywikibot from pywikibot.backports import Dict, Iterable, List, Sequence, Tuple -from pywikibot.tools import chars, deprecated_args +from pywikibot.tools import chars from pywikibot.tools.formatter import color_format @@ -249,7 +249,6 @@ If all hunks are approved, text_b will be obtained. """ - @deprecated_args(n='context') def __init__(self, text_a: str, text_b: str, context: int = 0, by_letter: bool = False, replace_invisible: bool = False) -> None: diff --git a/pywikibot/family.py b/pywikibot/family.py index f3222b8..adc19a4 100644 --- a/pywikibot/family.py +++ b/pywikibot/family.py @@ -21,12 +21,7 @@ from pywikibot import config from pywikibot.backports import Dict, List, Tuple from pywikibot.exceptions import FamilyMaintenanceWarning, UnknownFamilyError -from pywikibot.tools import ( - ModuleDeprecationWrapper, - classproperty, - deprecated, - deprecated_args, -) +from pywikibot.tools import classproperty, deprecated, ModuleDeprecationWrapper logger = logging.getLogger('pywiki.wiki.family') @@ -546,7 +541,6 @@ _families = {} @staticmethod - @deprecated_args(fatal=True) def load(fam: Optional[str] = None): """Import the named family. @@ -788,7 +782,6 @@ """ raise NotImplementedError('This family does not support EventStreams') - @deprecated_args(name='title') def get_address(self, code, title): """Return the path to title using index.php with redirects disabled.""" return '{}?title={}&redirect=no'.format(self.path(code), title) @@ -1227,7 +1220,6 @@ return '{}.wikimedia.org'.format(cls.name) -@deprecated_args(site=True) def AutoFamily(name: str, url: str): """ Family that automatically loads the site configuration. diff --git a/pywikibot/i18n.py b/pywikibot/i18n.py index 25d751d..2ae3f32 100644 --- a/pywikibot/i18n.py +++ b/pywikibot/i18n.py @@ -43,10 +43,7 @@ Sequence, ) from pywikibot.plural import plural_rule -from pywikibot.tools import ( - ModuleDeprecationWrapper, - deprecated_args, -) +from pywikibot.tools import ModuleDeprecationWrapper STR_OR_SITE_TYPE = Union[str, 'pywikibot.site.BaseSite'] @@ -637,7 +634,6 @@ return trans -@deprecated_args(code='source') def twtranslate(source: STR_OR_SITE_TYPE, twtitle: str, parameters: Union[Sequence[str], Mapping[str, int], @@ -763,7 +759,6 @@ return trans -@deprecated_args(code='source') def twhas_key(source: STR_OR_SITE_TYPE, twtitle: str) -> bool: """ Check if a message has a translation in the specified language code. diff --git a/pywikibot/login.py b/pywikibot/login.py index 144467d..6037795 100644 --- a/pywikibot/login.py +++ b/pywikibot/login.py @@ -19,9 +19,8 @@ from pywikibot.comms import http from pywikibot.exceptions import APIError, NoUsernameError from pywikibot.tools import ( - ModuleDeprecationWrapper, - deprecated_args, file_mode_checker, + ModuleDeprecationWrapper, normalize_username, ) @@ -88,7 +87,6 @@ """Site login manager.""" - @deprecated_args(username='user', verbose=True, sysop=True) def __init__(self, password: Optional[str] = None, site: OPT_SITE_TYPE = None, user: Optional[str] = None) -> None: @@ -367,7 +365,6 @@ # NOTE: Currently OauthLoginManager use mwoauth directly to complete OAuth # authentication process - @deprecated_args(sysop=True) def __init__(self, password: Optional[str] = None, site: OPT_SITE_TYPE = None, user: Optional[str] = None) -> None: diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index b2f0c5b..c7fafcf 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -70,7 +70,6 @@ ComparableMixin, compute_file_hash, deprecated, - deprecated_args, first_upper, is_ip_address, issue_deprecation_warning, @@ -259,10 +258,6 @@ self.site.loadpageinfo(self) return self._pageid - @deprecated_args( - savetitle='as_url', withNamespace='with_ns', - withSection='with_section', forceInterwiki='force_interwiki', - asUrl='as_url', asLink='as_link', allowInterwiki='allow_interwiki') def title(self, *, underscore=False, with_ns=True, with_section=True, as_url=False, as_link=False, allow_interwiki=True, force_interwiki=False, textlink=False, @@ -878,9 +873,6 @@ disambig_in_page = disambigs.intersection(templates) return self.namespace() != 10 and bool(disambig_in_page) - @deprecated_args(withTemplateInclusion='with_template_inclusion', - onlyTemplateInclusion='only_template_inclusion', - redirectsOnly='filter_redirects') def getReferences(self, follow_redirects: bool = True, with_template_inclusion: bool = True, @@ -924,8 +916,6 @@ content=content ) - @deprecated_args(followRedirects='follow_redirects', - filterRedirects='filter_redirects') def backlinks(self, follow_redirects: bool = True, filter_redirects: Optional[bool] = None, @@ -1142,7 +1132,6 @@ # no restricting template found return True - @deprecated_args(comment='summary') def save(self, summary: Optional[str] = None, watch: Union[str, bool, None] = None, @@ -1262,8 +1251,6 @@ fallback_prompt='; cosmetic changes') return summary - @deprecated_args(comment='summary', watchArticle='watch', - minorEdit='minor') def put(self, newtext, summary=None, watch=None, minor=True, botflag=None, force=False, asynchronous=False, callback=None, **kwargs): """ @@ -1283,8 +1270,6 @@ @deprecated('put(asynchronous=True) or save(asynchronous=True)', since='20180501') - @deprecated_args(comment='summary', watchArticle='watch', - minorEdit='minor') def put_async(self, newtext, summary=None, watch=None, minor=True, botflag=None, force=False, callback=None, **kwargs): # pragma: no cover @@ -1517,7 +1502,6 @@ """ return self.site.pageimages(self, total=total, content=content) - @deprecated_args(withSortKey='with_sort_key') def categories(self, with_sort_key: bool = False, total: Optional[int] = None, @@ -1613,7 +1597,6 @@ else: return lastmove.target_page - @deprecated_args(getText='content', reverseOrder='reverse') def revisions(self, reverse: bool = False, total: Optional[int] = None, @@ -1627,7 +1610,6 @@ return (self._revisions[rev] for rev in sorted(self._revisions, reverse=not reverse)[:total]) - @deprecated_args(reverseOrder='reverse') def getVersionHistoryTable(self, reverse: bool = False, total: Optional[int] = None): @@ -1697,7 +1679,6 @@ """ self.site.merge_history(self, dest, timestamp, reason) - @deprecated_args(deleteAndMove='noredirect', movetalkpage='movetalk') def move(self, newtitle: str, reason: Optional[str] = None, @@ -1808,7 +1789,6 @@ self._deletedRevs[rev['timestamp']] = rev yield rev['timestamp'] - @deprecated_args(retrieveText='content') def getDeletedRevision(self, timestamp, content=False, **kwargs) -> List: """ Return a particular deleted revision by timestamp. @@ -1847,7 +1827,6 @@ .format(timestamp)) self._deletedRevs[timestamp]['marked'] = undelete - @deprecated_args(comment='reason') def undelete(self, reason: Optional[str] = None): """ Undelete revisions based on the markers set by previous calls. @@ -1915,9 +1894,6 @@ self.site.protect(self, protections, reason, **kwargs) - @deprecated_args( - comment='summary', oldCat='old_cat', newCat='new_cat', - sortKey='sort_key', inPlace='in_place') def change_category( self, old_cat, new_cat, summary=None, sort_key=None, in_place=True, include=None @@ -2048,7 +2024,6 @@ """Page: A MediaWiki page.""" - @deprecated_args(defaultNamespace='ns') def __init__(self, source, title: str = '', ns=0): """Instantiate a Page object.""" if isinstance(source, pywikibot.site.BaseSite): @@ -2533,7 +2508,6 @@ """A page in the Category: namespace.""" - @deprecated_args(sortKey='sort_key') def __init__(self, source, title: str = '', sort_key=None): """ Initializer. @@ -2546,7 +2520,6 @@ raise ValueError("'{}' is not in the category namespace!" .format(self.title())) - @deprecated_args(sortKey='sort_key') def aslink(self, sort_key: Optional[str] = None) -> str: """ Return a link to place a page in this Category. @@ -2617,7 +2590,6 @@ if total == 0: return - @deprecated_args(startFrom='startprefix', startsort=True, endsort=True) def articles(self, recurse: Union[int, bool] = False, total: Optional[int] = None, @@ -2832,7 +2804,6 @@ This class also represents the Wiki page User:<username> """ - @deprecated_args(site='source', name='title') def __init__(self, source, title=''): """ Initializer for a User object. @@ -3107,7 +3078,6 @@ """ return next(iter(self.logevents(total=1)), None) - @deprecated_args(limit='total', namespace='namespaces') def contributions(self, total: int = 500, **kwargs) -> tuple: """ Yield tuples describing this user edits. @@ -4446,7 +4416,6 @@ SNAK_TYPES = ('value', 'somevalue', 'novalue') - @deprecated_args(isReference='is_reference', isQualifier='is_qualifier') def __init__(self, site, pid, snak=None, hash=None, is_reference=False, is_qualifier=False, rank='normal', **kwargs): """ @@ -5248,7 +5217,6 @@ '|&#x[0-9A-Fa-f]+;' ) - @deprecated_args(defaultNamespace='default_namespace') def __init__(self, text, source=None, default_namespace=0): """ Initializer. @@ -5833,7 +5801,6 @@ return _ENTITY_SUB(handle_entity, text) -@deprecated_args(site='encodings') @deprecated('pywikibot.tools.chars.url2string', since='6.2.0') def url2unicode(title: str, encodings='utf-8') -> str: """ diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py index fb2494b..3db0b91 100644 --- a/pywikibot/pagegenerators.py +++ b/pywikibot/pagegenerators.py @@ -62,7 +62,6 @@ from pywikibot.tools import ( DequeGenerator, deprecated, - deprecated_args, filter_unique, intersect_generators, itergroup, @@ -679,7 +678,6 @@ return dupfiltergen - @deprecated_args(arg='category') def getCategory(self, category: str ) -> Tuple['pywikibot.Category', Optional[str]]: """ @@ -711,7 +709,6 @@ default_namespace=14)) return cat, startfrom - @deprecated_args(arg='category') def getCategoryGen(self, category: str, recurse: bool = False, content: bool = False, @@ -1339,7 +1336,6 @@ @deprecated('Site.allpages()', since='20180512') -@deprecated_args(step=True) def AllpagesPageGenerator( start: str = '!', namespace: int = 0, @@ -1370,7 +1366,6 @@ filterredir=filterredir, total=total, content=content) -@deprecated_args(step=True) def PrefixingPageGenerator(prefix: str, namespace: NAMESPACE_OR_INT_TYPE = None, includeredirects: Union[None, bool, str] = True, @@ -1410,7 +1405,6 @@ filterredir=filterredir, total=total, content=content) -@deprecated_args(number='total', mode='logtype', repeat=True) def LogeventsPageGenerator(logtype: Optional[str] = None, user: Optional[str] = None, site: OPT_SITE_TYPE = None, @@ -1446,8 +1440,6 @@ pywikibot.exception(e) -@deprecated_args(number='total', step=True, namespace='namespaces', - repeat=True, get_redirect=True) def NewpagesPageGenerator(site: OPT_SITE_TYPE = None, namespaces: Tuple[int] = (0, ), total: Optional[int] = None @@ -1495,7 +1487,6 @@ @deprecated('site.unconnected_pages()', since='20180512') -@deprecated_args(step=True) def UnconnectedPageGenerator(site: OPT_SITE_TYPE = None, total: Optional[int] = None ) -> Iterable['pywikibot.page.Page']: @@ -1513,7 +1504,6 @@ @deprecated('File.usingPages()', since='20200515') -@deprecated_args(referredImagePage='referredFilePage', step=True) def FileLinksGenerator(referredFilePage: 'pywikibot.page.FilePage', total: Optional[int] = None, content: bool = False @@ -1524,7 +1514,6 @@ @deprecated('Page.imagelinks()', since='20200515') -@deprecated_args(step=True) def ImagesPageGenerator(pageWithImages: 'pywikibot.page.Page', total: Optional[int] = None, content: bool = False @@ -1540,7 +1529,6 @@ return (pywikibot.Page(link) for link in page.interwiki()) -@deprecated_args(step=True) def LanguageLinksPageGenerator(page: 'pywikibot.page.Page', total: Optional[int] = None ) -> Iterable['pywikibot.page.Page']: @@ -1548,7 +1536,6 @@ return (pywikibot.Page(link) for link in page.iterlanglinks(total=total)) -@deprecated_args(step=True) def CategorizedPageGenerator(category: pywikibot.page.Category, recurse: bool = False, start: Optional[int] = None, @@ -1580,7 +1567,6 @@ yield from category.articles(**kwargs) -@deprecated_args(step=True) def SubCategoriesPageGenerator(category: 'pywikibot.page.Category', recurse: bool = False, start: Optional[int] = None, @@ -1608,7 +1594,6 @@ @deprecated('Page.linkedPages()', since='20200515') -@deprecated_args(step=True) def LinkedPageGenerator(linkingPage: 'pywikibot.page.Page', total: Optional[int] = None, content: bool = False @@ -1724,7 +1709,6 @@ return site.load_pages_from_pageids(pageids) -@deprecated_args(number='total', step=True) def UserContributionsGenerator(username: str, namespaces: Optional[List[int]] = None, site: OPT_SITE_TYPE = None, @@ -1795,7 +1779,6 @@ return (page for page in generator if page.namespace() in namespaces) -@deprecated_args(ignoreList='ignore_list') def PageTitleFilterPageGenerator(generator: Iterable['pywikibot.page.Page'], ignore_list: Dict[str, Dict[str, str]] ) -> Iterable['pywikibot.page.Page']: @@ -1979,7 +1962,6 @@ return regex_list @classmethod - @deprecated_args(inverse='quantifier') def titlefilter(cls: REGEX_FILTER_CLASS, generator: Iterable['pywikibot.page.Page'], regex: PATTERN_STR_OR_SEQ_TYPE, @@ -2052,7 +2034,6 @@ yield page -@deprecated_args(site=True) def CategoryFilterPageGenerator(generator: Iterable['pywikibot.page.Page'], category_list: Sequence['pywikibot.page.Category'] @@ -2073,7 +2054,6 @@ RegexBodyFilterPageGenerator = RegexFilter.contentfilter -@deprecated_args(begintime='last_edit_start', endtime='last_edit_end') def EdittimeFilterPageGenerator( generator: Iterable['pywikibot.page.Page'], last_edit_start: Optional[datetime.datetime] = None, @@ -2270,7 +2250,6 @@ yield from reversed(list(filtered_generator())) -@deprecated_args(pageNumber='groupsize', step='groupsize', lookahead=True) def PreloadingGenerator(generator: Iterable['pywikibot.page.Page'], groupsize: int = 50 ) -> Iterable['pywikibot.page.Page']: @@ -2299,7 +2278,6 @@ yield from site.preloadpages(pages, groupsize=groupsize) -@deprecated_args(step='groupsize') def DequePreloadingGenerator(generator: Iterable['pywikibot.page.Page'], groupsize: int = 50 ) -> Iterable['pywikibot.page.Page']: @@ -2315,7 +2293,6 @@ yield from PreloadingGenerator(generator, page_count) -@deprecated_args(step='groupsize') def PreloadingEntityGenerator(generator: Iterable['pywikibot.page.Page'], groupsize: int = 50 ) -> Iterable['pywikibot.page.Page']: @@ -2343,7 +2320,6 @@ yield from repo.preload_entities(pages, groupsize) -@deprecated_args(number='total', step=True, repeat=True) def NewimagesPageGenerator(total: Optional[int] = None, site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2410,7 +2386,6 @@ @deprecated('Site.unusedfiles()', since='20200515') -@deprecated_args(extension=True, number='total', repeat=True) def UnusedFilesGenerator(total: Optional[int] = None, # pragma: no cover site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.FilePage']: @@ -2426,7 +2401,6 @@ @deprecated('Site.withoutinterwiki()', since='20200515') -@deprecated_args(number='total', repeat=True) def WithoutInterwikiPageGenerator(total: Optional[int] = None, site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2442,7 +2416,6 @@ @deprecated('Site.uncategorizedcategories()', since='20200515') -@deprecated_args(number='total', repeat=True) def UnCategorizedCategoryGenerator(total: Optional[int] = 100, site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.Category']: @@ -2458,7 +2431,6 @@ @deprecated('Site.uncategorizedimages()', since='20200515') -@deprecated_args(number='total', repeat=True) def UnCategorizedImageGenerator(total: int = 100, # pragma: no cover site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.FilePage']: @@ -2474,7 +2446,6 @@ @deprecated('Site.uncategorizedpages()', since='20200515') -@deprecated_args(number='total', repeat=True) def UnCategorizedPageGenerator(total: int = 100, # pragma: no cover site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2490,7 +2461,6 @@ @deprecated('Site.uncategorizedtemplates()', since='20200515') -@deprecated_args(number='total', repeat=True) def UnCategorizedTemplateGenerator(total: int = 100, # pragma: no cover site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2506,7 +2476,6 @@ @deprecated('Site.lonelypages()', since='20200515') -@deprecated_args(number='total', repeat=True) def LonelyPagesPageGenerator(total: Optional[int] = None, # pragma: no cover site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2522,7 +2491,6 @@ @deprecated('Site.unwatchedpages()', since='20200515') -@deprecated_args(number='total', repeat=True) def UnwatchedPagesPageGenerator(total: Optional[int] = None, site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2569,7 +2537,6 @@ return site.wantedpages(total=total) -@deprecated_args(number='total', repeat=True) def AncientPagesPageGenerator(total: int = 100, # pragma: no cover site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2585,7 +2552,6 @@ @deprecated('Site.deadendpages()', since='20200515') -@deprecated_args(number='total', repeat=True) def DeadendPagesPageGenerator(total: int = 100, # pragma: no cover site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2600,7 +2566,6 @@ return site.deadendpages(total=total) -@deprecated_args(number='total', repeat=True) def LongPagesPageGenerator(total: int = 100, site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2615,7 +2580,6 @@ return (page for page, _ in site.longpages(total=total)) -@deprecated_args(number='total', repeat=True) def ShortPagesPageGenerator(total: int = 100, site: OPT_SITE_TYPE = None ) -> Iterable['pywikibot.page.Page']: @@ -2631,7 +2595,6 @@ @deprecated('Site.randompages()', since='20200515') -@deprecated_args(number='total') def RandomPageGenerator(total: Optional[int] = None, # pragma: no cover site: OPT_SITE_TYPE = None, namespaces: Optional[ @@ -2649,7 +2612,6 @@ @deprecated('Site.randompages()', since='20200515') -@deprecated_args(number='total') def RandomRedirectPageGenerator(total: Optional[int] = None, site: OPT_SITE_TYPE = None, namespaces: Optional[ @@ -2668,7 +2630,6 @@ @deprecated('Site.exturlusage()', since='20200515') -@deprecated_args(link='url', euprotocol='protocol', step=True) def LinksearchPageGenerator(url: str, namespaces: Optional[List[int]] = None, total: Optional[int] = None, @@ -2693,7 +2654,6 @@ @deprecated('Site.search()', since='20200515') -@deprecated_args(number='total', step=True) def SearchPageGenerator(query: str, # pragma: no cover total: Optional[int] = None, namespaces: Optional[ @@ -2872,7 +2832,6 @@ :ivar parser: holds the xmlreader.XmlDump parse method """ - @deprecated_args(xmlFilename='filename') def __init__(self, filename: str, start: Optional[str] = None, namespaces: Union[ None, NAMESPACE_OR_STR_TYPE, @@ -2945,7 +2904,6 @@ yield pywikibot.Page(pywikibot.Link(current_year, site)) -@deprecated_args(startMonth='start_month', endMonth='end_month') def DayPageGenerator(start_month: int = 1, end_month: int = 12, site: OPT_SITE_TYPE = None, year: int = 2000 ) -> Iterable['pywikibot.page.Page']: diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index a32fe63..eb2623e 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -74,7 +74,6 @@ MediaWikiVersion, compute_file_hash, deprecated, - deprecated_args, issue_deprecation_warning, merge_unique_dicts, normalize_username, @@ -212,7 +211,6 @@ return pywikibot.Site(url=site['url'] + '/w/index.php') raise ValueError('Cannot parse a site out of {}.'.format(dbname)) - @deprecated_args(step=True) def _generator(self, gen_class, type_arg: Optional[str] = None, namespaces=None, total: Optional[int] = None, **args): """Convenience method that returns an API generator. @@ -662,7 +660,6 @@ return OrderedDict((key, _mw_msg_cache[amlang][key]) for key in keys) - @deprecated_args(forceReload=True) def mediawiki_message(self, key, lang=None) -> str: """Fetch the text for a MediaWiki message. @@ -754,7 +751,6 @@ return msgs['comma-separator'].join( args[:-2] + [concat.join(args[-2:])]) - @deprecated_args(string='text') def expand_text(self, text: str, title=None, includecomments=None) -> str: """Parse the given text for preprocessing and rendering. diff --git a/pywikibot/site/_datasite.py b/pywikibot/site/_datasite.py index ffe0e50..0dbb3e5 100644 --- a/pywikibot/site/_datasite.py +++ b/pywikibot/site/_datasite.py @@ -25,7 +25,6 @@ from pywikibot.site._decorators import need_right, need_version from pywikibot.tools import ( deprecated, - deprecated_args, issue_deprecation_warning, itergroup, merge_unique_dicts, @@ -278,7 +277,6 @@ return dtype - @deprecated_args(identification='entity') @need_right('edit') def editEntity(self, entity, data, bot=True, **kwargs): """ @@ -637,8 +635,6 @@ return req.submit() @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, summary=None, bot=True): """ @@ -694,7 +690,6 @@ req = self._simple_request(**params) return req.submit() - @deprecated_args(limit='total') def search_entities(self, search: str, language: str, total: Optional[int] = None, **kwargs): """ diff --git a/pywikibot/site/_extensions.py b/pywikibot/site/_extensions.py index 31f0344..98e4b75 100644 --- a/pywikibot/site/_extensions.py +++ b/pywikibot/site/_extensions.py @@ -14,7 +14,7 @@ SiteDefinitionError, ) from pywikibot.site._decorators import need_extension, need_right -from pywikibot.tools import deprecated_args, merge_unique_dicts +from pywikibot.tools import merge_unique_dicts class EchoMixin: @@ -232,7 +232,6 @@ """APISite mixin for WikibaseClient extension.""" - @deprecated_args(step=True) @need_extension('WikibaseClient') def unconnected_pages(self, total=None): """Yield Page objects from Special:UnconnectedPages. diff --git a/pywikibot/site/_generators.py b/pywikibot/site/_generators.py index efe03bf..2314a13 100644 --- a/pywikibot/site/_generators.py +++ b/pywikibot/site/_generators.py @@ -27,7 +27,6 @@ from pywikibot.site._decorators import need_right, need_version from pywikibot.tools import ( deprecated, - deprecated_args, filter_unique, is_ip_address, issue_deprecation_warning, @@ -195,8 +194,6 @@ priority, page = heapq.heappop(prio_queue) yield page - @deprecated_args( - followRedirects='follow_redirects', filterRedirects='filter_redirects') def pagebacklinks(self, page, *, follow_redirects=False, filter_redirects=None, namespaces=None, total=None, content=False): @@ -260,7 +257,6 @@ return itertools.chain(*genlist.values()) return blgen - @deprecated_args(step=True, filterRedirects='filter_redirects') def page_embeddedin(self, page, *, filter_redirects=None, namespaces=None, total=None, content=False): """Iterate all pages that embedded the given page as a template. @@ -292,11 +288,6 @@ namespaces=namespaces, total=total, g_content=content, **eiargs) - @deprecated_args( - step=None, followRedirects='follow_redirects', - filterRedirects='filter_redirects', - onlyTemplateInclusion='only_template_inclusion', - withTemplateInclusion='with_template_inclusion') def pagereferences(self, page, *, follow_redirects=False, filter_redirects=None, with_template_inclusion=True, only_template_inclusion=False, namespaces=None, @@ -335,7 +326,6 @@ namespaces=namespaces, content=content) ), total) - @deprecated_args(step=True) def pagelinks(self, page, *, namespaces=None, follow_redirects=False, total=None, content=False): """Iterate internal wikilinks contained (or transcluded) on page. @@ -367,7 +357,6 @@ **plargs) # Sortkey doesn't work with generator - @deprecated_args(withSortKey=True, step=True) def pagecategories(self, page, *, total=None, content=False): """Iterate categories to which page belongs. @@ -387,7 +376,6 @@ type_arg='categories', total=total, g_content=content, **clargs) - @deprecated_args(step=True) def pageimages(self, page, *, total=None, content=False): """Iterate images used (not just linked) on the page. @@ -403,7 +391,6 @@ titles=imtitle, total=total, g_content=content) - @deprecated_args(step=True) def pagetemplates(self, page, *, namespaces=None, total=None, content=False): """Iterate templates transcluded (not just linked) on the page. @@ -426,7 +413,6 @@ titles=tltitle, namespaces=namespaces, total=total, g_content=content) - @deprecated_args(step=True, startsort=True, endsort=True) def categorymembers(self, category, *, namespaces=None, sortby: Optional[str] = None, @@ -587,7 +573,6 @@ props.append('roles') return props - @deprecated_args(getText='content', sysop=True) def loadrevisions(self, page, *, content=False, section=None, **kwargs): """Retrieve revision information and store it in page object. @@ -715,7 +700,6 @@ raise NoPageError(page) api.update_page(page, pagedata, rvgen.props) - @deprecated_args(step=True) def pagelanglinks(self, page, *, total: Optional[int] = None, include_obsolete: bool = False, @@ -751,7 +735,6 @@ if link.title or include_empty_titles: yield link - @deprecated_args(step=True) def page_extlinks(self, page, *, total=None): """Iterate all external links on page, yielding URL strings. @@ -769,8 +752,6 @@ for linkdata in pageitem['extlinks']: yield linkdata['*'] - @deprecated_args(throttle=True, limit='total', step=True, - includeredirects='filterredir') def allpages(self, start='!', prefix='', namespace=0, filterredir=None, filterlanglinks=None, minsize=None, maxsize=None, protect_type=None, protect_level=None, reverse=False, @@ -808,16 +789,15 @@ # backward compatibility test if filterredir not in (True, False, None): old = filterredir - if filterredir: - if filterredir == 'only': - filterredir = True - else: - filterredir = None - else: + if not filterredir: filterredir = False - warn('The value "{0!r}" for "filterredir" is deprecated; use ' - '{1} instead.'.format(old, filterredir), - DeprecationWarning, 3) + elif filterredir == 'only': + filterredir = True + else: + filterredir = None + issue_deprecation_warning( + 'The value "{}" for "filterredir"'.format(old), + '"{}"'.format(filterredir), since='7.0.0') apgen = self._generator(api.PageGenerator, type_arg='allpages', namespaces=namespace, @@ -844,7 +824,6 @@ apgen.request['gapdir'] = 'descending' return apgen - @deprecated_args(step=True) def alllinks(self, start='!', prefix='', namespace=0, unique=False, fromids=False, total=None): """Iterate all links to pages (which need not exist) in one namespace. @@ -883,7 +862,6 @@ p._fromid = link['fromid'] yield p - @deprecated_args(step=True) def allcategories(self, start='!', prefix='', total=None, reverse=False, content=False): """Iterate categories used (which need not have a Category page). @@ -911,7 +889,6 @@ acgen.request['gacdir'] = 'descending' return acgen - @deprecated_args(step=True) def botusers(self, total=None): """Iterate bot users. @@ -929,7 +906,6 @@ yield from self._bots.values() - @deprecated_args(step=True) def allusers(self, start='!', prefix='', group=None, total=None): """Iterate registered users, ordered by username. @@ -955,7 +931,6 @@ augen.request['augroup'] = group return augen - @deprecated_args(step=True) def allimages(self, start='!', prefix='', minsize=None, maxsize=None, reverse=False, sha1=None, sha1base36=None, total=None, content=False): @@ -994,7 +969,6 @@ aigen.request['gaisha1base36'] = sha1base36 return aigen - @deprecated_args(limit='total') # ignore falimit setting def filearchive(self, start=None, end=None, reverse=False, total=None, **kwargs): """Iterate archived files. @@ -1026,7 +1000,6 @@ fagen.request['fadir'] = 'descending' return fagen - @deprecated_args(step=True) def blocks(self, starttime=None, endtime=None, reverse=False, blockids=None, users=None, iprange: Optional[str] = None, total: Optional[int] = None): @@ -1084,7 +1057,6 @@ bkgen.request['bkip'] = iprange return bkgen - @deprecated_args(step=True) def exturlusage(self, url: Optional[str] = None, protocol: Optional[str] = None, namespaces=None, total: Optional[int] = None, content=False): @@ -1123,7 +1095,6 @@ namespaces=namespaces, total=total, g_content=content) - @deprecated_args(step=True) def imageusage(self, image, namespaces=None, filterredir=None, total=None, content=False): """Iterate Pages that contain links to the given FilePage. @@ -1153,7 +1124,6 @@ namespaces=namespaces, total=total, g_content=content, **iuargs) - @deprecated_args(step=True) def logevents(self, logtype: Optional[str] = None, user: Optional[str] = None, page=None, namespace=None, start=None, end=None, @@ -1213,12 +1183,6 @@ return legen - @deprecated_args(includeredirects='redirect', namespace='namespaces', - number='total', rcend='end', rclimit='total', - rcnamespace='namespaces', rcstart='start', - rctype='changetype', showAnon='anon', showBot='bot', - showMinor='minor', showPatrolled='patrolled', - showRedirects='redirect', topOnly='top_only') def recentchanges(self, *, start=None, end=None, @@ -1306,8 +1270,6 @@ rcgen.request['rctag'] = tag return rcgen - @deprecated_args(number='total', step=True, key='searchstring', - getredirects=True, get_redirects=True) def search(self, searchstring: str, *, namespaces=None, where: str = 'text', @@ -1363,7 +1325,6 @@ total=total, g_content=content) return srgen - @deprecated_args(step=True, showMinor='minor') def usercontribs(self, user=None, userprefix=None, start=None, end=None, reverse=False, namespaces=None, minor=None, total: Optional[int] = None, top_only=False): @@ -1420,8 +1381,6 @@ ucgen.request['ucshow'] = option_set return ucgen - @deprecated_args(step=True, showMinor='minor', showAnon='anon', - showBot='bot') def watchlist_revs(self, start=None, end=None, reverse=False, namespaces=None, minor=None, bot=None, anon=None, total=None): @@ -1486,8 +1445,6 @@ or self.has_right('undelete'))): raise UserRightsError(err + 'deleted content.') - @deprecated_args(step=True, get_text='content', page='titles', - limit='total') def deletedrevs(self, titles=None, start=None, end=None, reverse: bool = False, content=False, total=None, **kwargs): @@ -1666,7 +1623,6 @@ 'ususers': usernames, 'usprop': usprop}) return usgen - @deprecated_args(step=True) def randompages(self, total=None, namespaces=None, redirects=False, content=False): """Iterate a number of random pages. @@ -1723,7 +1679,6 @@ } @need_right('patrol') - @deprecated_args(token=True) def patrol(self, rcid=None, revid=None, revision=None): """Return a generator of patrolled pages. @@ -1806,10 +1761,6 @@ yield result['patrol'] - @deprecated_args(number='total', repeat=True, namespace='namespaces', - rcshow=True, rc_show=True, get_redirect=True, step=True, - showBot='bot', showRedirects='redirect', - showPatrolled='patrolled') def newpages(self, user=None, returndict=False, start=None, end=None, reverse=False, bot=False, redirect=False, excludeuser=None, @@ -1855,8 +1806,6 @@ '', pageitem['user'], pageitem['comment']) @deprecated('APISite.logevents(logtype="upload")', since='20170619') - @deprecated_args(lestart='start', leend='end', leuser='user', letitle=True, - repeat=True, number='total', step=True) def newfiles(self, user=None, start=None, end=None, reverse=False, total=None): """Yield information about newly uploaded files. @@ -1896,7 +1845,6 @@ type_arg='querypage', gqppage=special_page, total=total) - @deprecated_args(number='total', step=True, repeat=True) def longpages(self, total=None): """Yield Pages and lengths from Special:Longpages. @@ -1911,7 +1859,6 @@ yield (pywikibot.Page(self, pageitem['title']), int(pageitem['value'])) - @deprecated_args(number='total', step=True, repeat=True) def shortpages(self, total=None): """Yield Pages and lengths from Special:Shortpages. @@ -1926,7 +1873,6 @@ yield (pywikibot.Page(self, pageitem['title']), int(pageitem['value'])) - @deprecated_args(number='total', step=True, repeat=True) def deadendpages(self, total=None): """Yield Page objects retrieved from Special:Deadendpages. @@ -1934,7 +1880,6 @@ """ return self.querypage('Deadendpages', total) - @deprecated_args(number='total', step=True, repeat=True) def ancientpages(self, total=None): """Yield Pages, datestamps from Special:Ancientpages. @@ -1947,7 +1892,6 @@ yield (pywikibot.Page(self, pageitem['title']), pywikibot.Timestamp.fromISOformat(pageitem['timestamp'])) - @deprecated_args(number='total', step=True, repeat=True) def lonelypages(self, total=None): """Yield Pages retrieved from Special:Lonelypages. @@ -1955,7 +1899,6 @@ """ return self.querypage('Lonelypages', total) - @deprecated_args(number='total', step=True, repeat=True) def unwatchedpages(self, total=None): """Yield Pages from Special:Unwatchedpages (requires Admin privileges). @@ -1963,7 +1906,6 @@ """ return self.querypage('Unwatchedpages', total) - @deprecated_args(step=True) def wantedpages(self, total=None): """Yield Pages from Special:Wantedpages. @@ -1985,7 +1927,6 @@ """ return self.querypage('Wantedtemplates', total) - @deprecated_args(number='total', step=True, repeat=True) def wantedcategories(self, total=None): """Yield Pages from Special:Wantedcategories. @@ -1993,7 +1934,6 @@ """ return self.querypage('Wantedcategories', total) - @deprecated_args(number='total', step=True, repeat=True) def uncategorizedcategories(self, total=None): """Yield Categories from Special:Uncategorizedcategories. @@ -2001,7 +1941,6 @@ """ return self.querypage('Uncategorizedcategories', total) - @deprecated_args(number='total', step=True, repeat=True) def uncategorizedimages(self, total=None): """Yield FilePages from Special:Uncategorizedimages. @@ -2012,7 +1951,6 @@ # synonym uncategorizedfiles = uncategorizedimages - @deprecated_args(number='total', step=True, repeat=True) def uncategorizedpages(self, total=None): """Yield Pages from Special:Uncategorizedpages. @@ -2020,7 +1958,6 @@ """ return self.querypage('Uncategorizedpages', total) - @deprecated_args(number='total', step=True, repeat=True) def uncategorizedtemplates(self, total=None): """Yield Pages from Special:Uncategorizedtemplates. @@ -2028,7 +1965,6 @@ """ return self.querypage('Uncategorizedtemplates', total) - @deprecated_args(number='total', step=True, repeat=True) def unusedcategories(self, total=None): """Yield Category objects from Special:Unusedcategories. @@ -2036,7 +1972,6 @@ """ return self.querypage('Unusedcategories', total) - @deprecated_args(extension=True, number='total', step=True, repeat=True) def unusedfiles(self, total=None): """Yield FilePage objects from Special:Unusedimages. @@ -2044,7 +1979,6 @@ """ return self.querypage('Unusedimages', total) - @deprecated_args(number='total', step=True, repeat=True) def withoutinterwiki(self, total=None): """Yield Pages without language links from Special:Withoutinterwiki. @@ -2052,7 +1986,6 @@ """ return self.querypage('Withoutinterwiki', total) - @deprecated_args(step=True) def broken_redirects(self, total=None): """Yield Pages with broken redirects from Special:BrokenRedirects. @@ -2060,7 +1993,6 @@ """ return self.querypage('BrokenRedirects', total) - @deprecated_args(step=True) def double_redirects(self, total=None): """Yield Pages with double redirects from Special:DoubleRedirects. @@ -2068,7 +2000,6 @@ """ return self.querypage('DoubleRedirects', total) - @deprecated_args(step=True) def redirectpages(self, total=None): """Yield redirect pages from Special:ListRedirects. @@ -2076,7 +2007,6 @@ """ return self.querypage('Listredirects', total) - @deprecated_args(lvl='level') def protectedpages(self, namespace=0, type='edit', level=False, total=None): """ @@ -2126,7 +2056,6 @@ return self._generator(api.PageGenerator, type_arg='pageswithprop', gpwppropname=propname, total=total) - @deprecated_args(step=True, sysop=True) def watched_pages(self, force=False, total=None): """ Return watchlist. diff --git a/pywikibot/specialbots/_upload.py b/pywikibot/specialbots/_upload.py index 92d9c4f..f3babaf 100644 --- a/pywikibot/specialbots/_upload.py +++ b/pywikibot/specialbots/_upload.py @@ -25,7 +25,6 @@ from pywikibot.backports import List from pywikibot.bot import BaseBot, QuitKeyboardInterrupt from pywikibot.exceptions import APIError, FatalServerError, NoPageError -from pywikibot.tools import deprecated_args from pywikibot.tools.formatter import color_format @@ -33,10 +32,6 @@ """Upload bot.""" - @deprecated_args(urlEncoding='url_encoding', useFilename='use_filename', - keepFilename='keep_filename', - verifyDescription='verify_description', - ignoreWarning='ignore_warning', targetSite='target_site') def __init__(self, url: Union[List[str], str], *, url_encoding=None, description: str = '', diff --git a/pywikibot/throttle.py b/pywikibot/throttle.py index 172d9bb..71b7a1d 100644 --- a/pywikibot/throttle.py +++ b/pywikibot/throttle.py @@ -17,7 +17,7 @@ from pywikibot import config -from pywikibot.tools import deprecated, deprecated_args, PYTHON_VERSION +from pywikibot.tools import deprecated, PYTHON_VERSION if PYTHON_VERSION < (3, 6): from hashlib import md5 @@ -51,7 +51,6 @@ """ - @deprecated_args(multiplydelay=True) def __init__(self, site, *, mindelay: Optional[int] = None, maxdelay: Optional[int] = None, diff --git a/pywikibot/titletranslate.py b/pywikibot/titletranslate.py index e3e72d5..9812ff6 100644 --- a/pywikibot/titletranslate.py +++ b/pywikibot/titletranslate.py @@ -6,10 +6,8 @@ # import pywikibot from pywikibot import config, date -from pywikibot.tools import deprecated_args -@deprecated_args(family=True) def translate(page=None, hints=(), auto=True, removebrackets=False, site=None) -> list: """ diff --git a/pywikibot/tools/djvu.py b/pywikibot/tools/djvu.py index 8b2a922..3474f5f 100644 --- a/pywikibot/tools/djvu.py +++ b/pywikibot/tools/djvu.py @@ -1,7 +1,7 @@ #!/usr/bin/python """Wrapper around djvulibre to access djvu files properties and content.""" # -# (C) Pywikibot team, 2015-2020 +# (C) Pywikibot team, 2015-2021 # # Distributed under the terms of the MIT license. # @@ -11,7 +11,6 @@ from collections import Counter import pywikibot -from pywikibot.tools import deprecated_args def _call_cmd(args, lib='djvulibre') -> tuple: @@ -58,7 +57,6 @@ """ - @deprecated_args(file_djvu='file') def __init__(self, file: str): """ Initializer. diff --git a/pywikibot/userinterfaces/terminal_interface_base.py b/pywikibot/userinterfaces/terminal_interface_base.py index e55d002..83d6684 100755 --- a/pywikibot/userinterfaces/terminal_interface_base.py +++ b/pywikibot/userinterfaces/terminal_interface_base.py @@ -22,7 +22,6 @@ StandardOption, ) from pywikibot.logging import INFO, INPUT, STDOUT, VERBOSE, WARNING -from pywikibot.tools import deprecated_args from pywikibot.userinterfaces import transliteration from pywikibot.userinterfaces._interface_base import ABUIC @@ -481,7 +480,6 @@ # create a class-level lock that can be shared by all instances sharedlock = threading.RLock() - @deprecated_args(strm='stream') def __init__(self, UI, stream=None): """Initialize the handler. diff --git a/tests/site_tests.py b/tests/site_tests.py index 6a2da89..ef485a5 100644 --- a/tests/site_tests.py +++ b/tests/site_tests.py @@ -2687,12 +2687,6 @@ self.assertEqual('File:' + item['name'].replace('_', ' '), item['title']) - def test_filearchive_limit(self): - """Test deprecated limit parameter.""" - fa = list(self.site.filearchive(limit=10)) - self.assertOneDeprecation() - self.assertLessEqual(len(fa), 10) - def test_filearchive_prefix(self): """Test prefix parameter.""" gen = self.site.filearchive(prefix='py') -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/725404 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: Id217ec0813d1543ccdc5a461b25bb4b5b21d8b9b Gerrit-Change-Number: 725404 Gerrit-PatchSet: 5 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

[Gerrit] ...core[master]: [cleanup] Remove @deprecate_arg decorators

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/725403 ) Change subject: [cleanup] Remove @deprecate_arg decorators ...................................................................... [cleanup] Remove @deprecate_arg decorators Change-Id: I0ac7877a0d96a44f9cd44d6e4dc5019c708c9cac --- M pywikibot/bot.py M pywikibot/flow.py M pywikibot/page/__init__.py M pywikibot/site/_apisite.py M pywikibot/site/_extensions.py M pywikibot/textlib.py 6 files changed, 3 insertions(+), 29 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/bot.py b/pywikibot/bot.py index 1877226..35ff565 100644 --- a/pywikibot/bot.py +++ b/pywikibot/bot.py @@ -172,7 +172,6 @@ ) from pywikibot.tools import ( PYTHON_VERSION, - deprecate_arg, deprecated, deprecated_args, issue_deprecation_warning, @@ -1338,7 +1337,6 @@ return True - @deprecate_arg('async', 'asynchronous') # T106230 @deprecated_args(comment='summary') def userPut(self, page: 'pywikibot.page.BasePage', oldtext: str, newtext: str, **kwargs: Any) -> bool: diff --git a/pywikibot/flow.py b/pywikibot/flow.py index 39c7b23..c99bb4f 100644 --- a/pywikibot/flow.py +++ b/pywikibot/flow.py @@ -1,6 +1,6 @@ """Objects representing Flow entities, like boards, topics, and posts.""" # -# (C) Pywikibot team, 2015-2020 +# (C) Pywikibot team, 2015-2021 # # Distributed under the terms of the MIT license. # @@ -18,7 +18,6 @@ UnknownExtensionError, ) from pywikibot.page import BasePage, User -from pywikibot.tools import deprecate_arg logger = logging.getLogger('pywiki.wiki.flow') @@ -114,7 +113,6 @@ new_params[key] = value return new_params - @deprecate_arg('format', 'content_format') def topics(self, content_format: str = 'wikitext', limit: int = 100, sort_by: str = 'newest', offset: Union[str, datetime.datetime, None] = None, @@ -147,7 +145,6 @@ cont_args = self._parse_url(data['links']['pagination']) data = self.site.load_topiclist(self, **cont_args) - @deprecate_arg('format', 'content_format') def new_topic(self, title: str, content: str, content_format: str = 'wikitext') -> 'Topic': """Create and return a Topic object for a new topic on this Board. @@ -181,7 +178,6 @@ self.root._load(load_from_topic=True) @classmethod - @deprecate_arg('format', 'content_format') def create_topic(cls: TOPIC_CLASS_TYPE, board: 'Board', title: str, content: str, content_format: str = 'wikitext' ) -> 'Topic': @@ -238,7 +234,6 @@ """Whether this topic is moderated.""" return self.root._current_revision['isModerated'] - @deprecate_arg('format', 'content_format') def replies(self, content_format: str = 'wikitext', force: bool = False ) -> List['Post']: """A list of replies to this topic's root post. @@ -250,7 +245,6 @@ """ return self.root.replies(content_format=content_format, force=force) - @deprecate_arg('format', 'content_format') def reply(self, content: str, content_format: str = 'wikitext') -> 'Post': """A convenience method to reply to this topic's root post. @@ -437,7 +431,6 @@ self._current_revision['creator']['name']) return self._creator - @deprecate_arg('format', 'content_format') def get(self, content_format: str = 'wikitext', force: bool = False) -> str: """Return the contents of the post in the given format. @@ -450,7 +443,6 @@ self._load(content_format=content_format) return self._content[content_format] - @deprecate_arg('format', 'content_format') def replies(self, content_format: str = 'wikitext', force: bool = False ) -> List['Post']: """Return this post's replies. @@ -476,7 +468,6 @@ return self._replies - @deprecate_arg('format', 'content_format') def reply(self, content: str, content_format: str = 'wikitext') -> 'Post': """Reply to this post. diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index ee06a02..f60bd62 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -69,7 +69,6 @@ from pywikibot.tools import ( ComparableMixin, compute_file_hash, - deprecate_arg, deprecated, deprecated_args, first_upper, @@ -648,7 +647,6 @@ """ return self.properties(force=force).get('defaultsort') - @deprecate_arg('refresh', 'force') def expand_text(self, force=False, includecomments=False) -> str: """Return the page text with all templates and parser words expanded. @@ -1150,7 +1148,6 @@ # no restricting template found return True - @deprecate_arg('async', 'asynchronous') # T106230 @deprecated_args(comment='summary') def save(self, summary: Optional[str] = None, @@ -1271,7 +1268,6 @@ fallback_prompt='; cosmetic changes') return summary - @deprecate_arg('async', 'asynchronous') # T106230 @deprecated_args(comment='summary', watchArticle='watch', minorEdit='minor') def put(self, newtext, summary=None, watch=None, minor=True, botflag=None, @@ -1731,7 +1727,6 @@ movetalk=movetalk, noredirect=noredirect) - @deprecate_arg('quit', 'automatic_quit') def delete(self, reason: Optional[str] = None, prompt: bool = True, @@ -3190,7 +3185,6 @@ for contrib in data['revisions']: yield page, Revision(**contrib) - @deprecate_arg('number', 'total') def uploadedImages(self, total=10): """ Yield tuples describing files uploaded by this user. diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index 57503f0..34f4739 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -73,7 +73,6 @@ from pywikibot.tools import ( MediaWikiVersion, compute_file_hash, - deprecate_arg, deprecated, deprecated_args, issue_deprecation_warning, @@ -2205,7 +2204,6 @@ return set(self.siteinfo.get('restrictions')['levels']) @need_right('protect') - @deprecate_arg('summary', 'reason') def protect(self, page, protections: dict, reason: str, expiry=None, **kwargs): """(Un)protect a wiki page. Requires administrator status. @@ -2456,7 +2454,6 @@ siiprop=props) return req.submit()['query']['stashimageinfo'][0] - @deprecate_arg('imagepage', 'filepage') @need_right('upload') def upload(self, filepage, *, source_filename: Optional[str] = None, diff --git a/pywikibot/site/_extensions.py b/pywikibot/site/_extensions.py index 6a1d2df..31f0344 100644 --- a/pywikibot/site/_extensions.py +++ b/pywikibot/site/_extensions.py @@ -14,7 +14,7 @@ SiteDefinitionError, ) from pywikibot.site._decorators import need_extension, need_right -from pywikibot.tools import deprecate_arg, deprecated_args, merge_unique_dicts +from pywikibot.tools import deprecated_args, merge_unique_dicts class EchoMixin: @@ -370,7 +370,6 @@ return data['flow']['view-topiclist']['result']['topiclist'] @need_extension('Flow') - @deprecate_arg('format', 'content_format') def load_topiclist(self, page, content_format: str = 'wikitext', limit=100, sortby='newest', toconly=False, offset=None, offset_id=None, reverse=False, include_offset=False): @@ -413,7 +412,6 @@ return data['flow']['view-topiclist']['result']['topiclist'] @need_extension('Flow') - @deprecate_arg('format', 'content_format') def load_topic(self, page, content_format: str): """ Retrieve the data for a Flow topic. @@ -432,7 +430,6 @@ return data['flow']['view-topic']['result']['topic'] @need_extension('Flow') - @deprecate_arg('format', 'content_format') def load_post_current_revision(self, page, post_id, content_format: str): """ Retrieve the data for a post to a Flow topic. @@ -454,7 +451,6 @@ @need_right('edit') @need_extension('Flow') - @deprecate_arg('format', 'content_format') def create_new_topic(self, page, title, content, content_format): """ Create a new topic on a Flow board. @@ -480,7 +476,6 @@ @need_right('edit') @need_extension('Flow') - @deprecate_arg('format', 'content_format') def reply_to_post(self, page, reply_to_uuid: str, content: str, content_format: str) -> dict: """Reply to a post on a Flow topic. diff --git a/pywikibot/textlib.py b/pywikibot/textlib.py index b5e5bfe..ec06c67 100644 --- a/pywikibot/textlib.py +++ b/pywikibot/textlib.py @@ -24,7 +24,7 @@ from pywikibot.backports import Tuple from pywikibot.exceptions import InvalidTitleError, SiteDefinitionError from pywikibot.family import Family -from pywikibot.tools import deprecate_arg, issue_deprecation_warning +from pywikibot.tools import issue_deprecation_warning try: @@ -969,7 +969,6 @@ # do not find or change links of other kinds, nor any that are formatted # as in-line interwiki links (e.g., "[[:es:Artículo]]". -@deprecate_arg('pageLink', True) def getLanguageLinks(text: str, insite=None, template_subpage=False) -> dict: """ Return a dict of inter-language links found in text. -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/725403 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: I0ac7877a0d96a44f9cd44d6e4dc5019c708c9cac Gerrit-Change-Number: 725403 Gerrit-PatchSet: 3 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

[Gerrit] ...core[master]: [cleanup] Remove @remove_last_args decorator

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/725402 ) Change subject: [cleanup] Remove @remove_last_args decorator ...................................................................... [cleanup] Remove @remove_last_args decorator Change-Id: I5c9ecb351d22671b408ffe1e5d60aca80679ecd7 --- M pywikibot/bot.py M pywikibot/data/wikistats.py M pywikibot/login.py M pywikibot/page/__init__.py M pywikibot/site/_apisite.py M pywikibot/site/_basesite.py M pywikibot/site/_generators.py M pywikibot/site/_obsoletesites.py M scripts/archive/imagecopy.py M scripts/noreferences.py 10 files changed, 1 insertion(+), 39 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/bot.py b/pywikibot/bot.py index 1877226..7f6be26 100644 --- a/pywikibot/bot.py +++ b/pywikibot/bot.py @@ -176,7 +176,6 @@ deprecated, deprecated_args, issue_deprecation_warning, - remove_last_args, ) from pywikibot.tools._logging import LoggingFormatter from pywikibot.tools.formatter import color_format @@ -320,7 +319,6 @@ return '{}.{}{}'.format(root, qualifier, ext) -@remove_last_args(['strm']) def init_handlers() -> None: """Initialize logging system for terminal-based bots. diff --git a/pywikibot/data/wikistats.py b/pywikibot/data/wikistats.py index 6865f57..f6db4b4 100644 --- a/pywikibot/data/wikistats.py +++ b/pywikibot/data/wikistats.py @@ -1,6 +1,6 @@ """Objects representing WikiStats API.""" # -# (C) Pywikibot team, 2014-2020 +# (C) Pywikibot team, 2014-2021 # # Distributed under the terms of the MIT license. # @@ -10,7 +10,6 @@ import pywikibot from pywikibot.comms import http -from pywikibot.tools import remove_last_args class WikiStats: @@ -77,7 +76,6 @@ self.url = url self._data = {} - @remove_last_args(['format']) def get(self, table: str) -> list: """Get a list of a table of data. @@ -99,7 +97,6 @@ self._data[table] = data return data - @remove_last_args(['format']) def get_dict(self, table: str) -> dict: """Get dictionary of a table of data. diff --git a/pywikibot/login.py b/pywikibot/login.py index ba49ba1..144467d 100644 --- a/pywikibot/login.py +++ b/pywikibot/login.py @@ -23,7 +23,6 @@ deprecated_args, file_mode_checker, normalize_username, - remove_last_args, ) @@ -190,7 +189,6 @@ # THIS IS OVERRIDDEN IN data/api.py raise NotImplementedError - @remove_last_args(['data']) def storecookiedata(self) -> None: """Store cookie data.""" http.cookie_jar.save(ignore_discard=True) diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index ee06a02..dce0e77 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -77,7 +77,6 @@ issue_deprecation_warning, ModuleDeprecationWrapper, redirect_func, - remove_last_args, ) @@ -351,7 +350,6 @@ title = title.replace(forbidden, '_') return title - @remove_last_args(('decode', 'underscore')) def section(self) -> Optional[str]: """ Return the name of the section this Page refers to. @@ -420,7 +418,6 @@ """Return True if title of this Page is in the autoFormat dict.""" return self.autoFormat()[0] is not None - @remove_last_args(['sysop']) def get(self, force: bool = False, get_redirect: bool = False) -> str: """Return the wiki-text of the page. @@ -483,7 +480,6 @@ self._getexception = IsRedirectPageError(self) raise self._getexception - @remove_last_args(['sysop']) def getOldVersion(self, oldid, force: bool = False, get_redirect: bool = False) -> str: """ @@ -698,7 +694,6 @@ return self._lastNonBotUser - @remove_last_args(('datetime', )) def editTime(self): """Return timestamp of last revision to page. @@ -827,7 +822,6 @@ """Return True if this is a file description page, False otherwise.""" return self.namespace() == 6 - @remove_last_args(['get_Index']) def isDisambig(self) -> bool: """ Return True if this is a disambiguation page, False otherwise. @@ -1708,7 +1702,6 @@ self.site.merge_history(self, dest, timestamp, reason) @deprecated_args(deleteAndMove='noredirect', movetalkpage='movetalk') - @remove_last_args(['safe']) def move(self, newtitle: str, reason: Optional[str] = None, diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index 57503f0..368fe76 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -79,7 +79,6 @@ issue_deprecation_warning, merge_unique_dicts, normalize_username, - remove_last_args, ) @@ -109,7 +108,6 @@ Do not instantiate directly; use :py:obj:`pywikibot.Site` function. """ - @remove_last_args(['sysop']) def __init__(self, code, fam=None, user=None): """Initializer.""" super().__init__(code, fam, user) @@ -284,7 +282,6 @@ return self._request_class({'parameters': kwargs}).create_simple( self, **kwargs) - @remove_last_args(['sysop']) def logged_in(self): """Verify the bot is logged into the site as the expected user. @@ -521,7 +518,6 @@ self._globaluserinfo['registration'] = iso_ts return self._globaluserinfo - @remove_last_args(['sysop']) def is_blocked(self): """ Return True when logged in user is blocked. @@ -605,7 +601,6 @@ start=start, end=end, reverse=reverse, is_ts=is_ts)) - @remove_last_args(['sysop']) def has_right(self, right): """Return true if and only if the user has a specific right. @@ -617,7 +612,6 @@ """ return right.lower() in self.userinfo['rights'] - @remove_last_args(['sysop']) def has_group(self, group): """Return true if and only if the user is a member of specified group. @@ -627,7 +621,6 @@ """ return group.lower() in self.userinfo['groups'] - @remove_last_args(['sysop']) def messages(self): """Return true if the user has new messages, and false otherwise.""" return 'messages' in self.userinfo @@ -830,7 +823,6 @@ return self._magicwords[word] return [word] - @remove_last_args(('default', )) def redirect(self): """Return the localized #REDIRECT keyword.""" # return the magic word without the preceding '#' character @@ -858,12 +850,10 @@ pattern = None return super().redirectRegex(pattern) - @remove_last_args(('default', )) def pagenamecodes(self): """Return list of localized PAGENAME tags for the site.""" return self.getmagicwords('pagename') - @remove_last_args(('default', )) def pagename2codes(self): """Return list of localized PAGENAMEE tags for the site.""" return self.getmagicwords('pagenamee') diff --git a/pywikibot/site/_basesite.py b/pywikibot/site/_basesite.py index 7a8e354..3a3a605 100644 --- a/pywikibot/site/_basesite.py +++ b/pywikibot/site/_basesite.py @@ -25,7 +25,6 @@ deprecated, first_upper, normalize_username, - remove_last_args, ) @@ -33,7 +32,6 @@ """Site methods that are independent of the communication interface.""" - @remove_last_args(['sysop']) def __init__(self, code: str, fam=None, user=None) -> None: """ Initializer. @@ -186,7 +184,6 @@ return self.username() return None - @remove_last_args(['sysop']) def username(self): """Return the username used for the site.""" return self._username @@ -264,17 +261,14 @@ index = self.namespaces.lookup_name(value) return self.namespace(index) - @remove_last_args(('default', )) def redirect(self): """Return list of localized redirect tags for the site.""" return ['REDIRECT'] - @remove_last_args(('default', )) def pagenamecodes(self): """Return list of localized PAGENAME tags for the site.""" return ['PAGENAME'] - @remove_last_args(('default', )) def pagename2codes(self): """Return list of localized PAGENAMEE tags for the site.""" return ['PAGENAMEE'] diff --git a/pywikibot/site/_generators.py b/pywikibot/site/_generators.py index 0a5d745..efe03bf 100644 --- a/pywikibot/site/_generators.py +++ b/pywikibot/site/_generators.py @@ -32,7 +32,6 @@ is_ip_address, issue_deprecation_warning, itergroup, - remove_last_args, ) @@ -589,7 +588,6 @@ return props @deprecated_args(getText='content', sysop=True) - @remove_last_args(['rollback']) def loadrevisions(self, page, *, content=False, section=None, **kwargs): """Retrieve revision information and store it in page object. diff --git a/pywikibot/site/_obsoletesites.py b/pywikibot/site/_obsoletesites.py index f306d5b..f66c9d4 100644 --- a/pywikibot/site/_obsoletesites.py +++ b/pywikibot/site/_obsoletesites.py @@ -8,7 +8,6 @@ from pywikibot.exceptions import NoPageError from pywikibot.site._apisite import APISite from pywikibot.site._basesite import BaseSite -from pywikibot.tools import remove_last_args class RemovedSite(BaseSite): @@ -21,7 +20,6 @@ class ClosedSite(APISite): """Site closed to read-only mode.""" - @remove_last_args(['sysop']) def __init__(self, code, fam, user=None): """Initializer.""" super().__init__(code, fam, user) diff --git a/scripts/archive/imagecopy.py b/scripts/archive/imagecopy.py index 49577d0..3b36af9 100755 --- a/scripts/archive/imagecopy.py +++ b/scripts/archive/imagecopy.py @@ -72,7 +72,6 @@ from pywikibot import config, i18n, pagegenerators from pywikibot.comms.http import fetch from pywikibot.specialbots import UploadRobot -from pywikibot.tools import remove_last_args from scripts.image import ImageRobot @@ -382,7 +381,6 @@ """The dialog window for image info.""" - @remove_last_args(('commonsconflict',)) def __init__(self, image_title, content, uploader, url, templates): """Initializer.""" # Check if `Tkinter` wasn't imported diff --git a/scripts/noreferences.py b/scripts/noreferences.py index d719948..de7ea9a 100755 --- a/scripts/noreferences.py +++ b/scripts/noreferences.py @@ -41,7 +41,6 @@ from pywikibot.bot import ExistingPageBot, NoRedirectPageBot, SingleSiteBot from pywikibot.exceptions import LockedPageError from pywikibot.pagegenerators import XMLDumpPageGenerator -from pywikibot.tools import remove_last_args # This is required for the text that is shown when you run this script @@ -516,7 +515,6 @@ """References section bot.""" - @remove_last_args(['gen']) def __init__(self, **kwargs) -> None: """Initializer.""" self.available_options.update({ -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/725402 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: I5c9ecb351d22671b408ffe1e5d60aca80679ecd7 Gerrit-Change-Number: 725402 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: D3r1ck01 <xsavitar.wiki(a)aol.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

[Gerrit] ...core[master]: [IMPR] i18n.py type hints

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/710116 ) Change subject: [IMPR] i18n.py type hints ...................................................................... [IMPR] i18n.py type hints Bug: T286403 Change-Id: Ida30c87350c79d6657461f7514c182a736aa90bf --- M pywikibot/i18n.py M pywikibot/plural.py 2 files changed, 56 insertions(+), 35 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/i18n.py b/pywikibot/i18n.py index ac015f2..25d751d 100644 --- a/pywikibot/i18n.py +++ b/pywikibot/i18n.py @@ -23,21 +23,32 @@ import os import pkgutil import re -from collections import defaultdict -from collections.abc import Mapping + +from collections import abc, defaultdict from contextlib import suppress from textwrap import fill from typing import Optional, Union import pywikibot + from pywikibot import __url__, config -from pywikibot.backports import List, cache +from pywikibot.backports import ( + cache, + Dict, + Iterable, + Iterator, + List, + Mapping, + Match, + Sequence, +) from pywikibot.plural import plural_rule from pywikibot.tools import ( ModuleDeprecationWrapper, deprecated_args, ) +STR_OR_SITE_TYPE = Union[str, 'pywikibot.site.BaseSite'] PLURAL_PATTERN = r'{{PLURAL:(?:%\()?([^\)]*?)(?:\)d)?\|(.*?)}}' @@ -349,10 +360,11 @@ 'yi': ['he', 'de'], 'zh-classical': ['zh', 'zh-hans', 'zh-tw', 'zh-cn', 'zh-classical', 'lzh'], 'zh-min-nan': [ - 'cdo', 'zh', 'zh-hans', 'zh-tw', 'zh-cn', 'zh-classical', 'lzh']} + 'cdo', 'zh', 'zh-hans', 'zh-tw', 'zh-cn', 'zh-classical', 'lzh'] +} # type: Dict[str, List[str]] -def set_messages_package(package_name: str): +def set_messages_package(package_name: str) -> None: """Set the package name where i18n messages are located.""" global _messages_package_name global _messages_available @@ -413,8 +425,9 @@ message_bundle = twtitle.split('-')[0] filename = '{}/{}.json'.format(message_bundle, lang) try: - trans_text = pkgutil.get_data( - _messages_package_name, filename).decode('utf-8') + data = pkgutil.get_data(_messages_package_name, filename) + assert data is not None + trans_text = data.decode('utf-8') except OSError: # file open can cause several exceptions return None @@ -422,18 +435,20 @@ return transdict.get(twtitle) -def _extract_plural(lang: str, message: str, parameters: Mapping) -> str: +def _extract_plural(lang: str, message: str, parameters: Mapping[str, int] + ) -> str: """Check for the plural variants in message and replace them. :param message: the message to be replaced :param parameters: plural parameters passed from other methods - :type parameters: Mapping of str to int :return: The message with the plural instances replaced """ - def static_plural_value(n): - return rule['plural'] + def static_plural_value(n: int) -> int: + plural_rule = rule['plural'] + assert not callable(plural_rule) + return plural_rule - def replace_plural(match): + def replace_plural(match: Match[str]) -> str: selector = match.group(1) variants = match.group(2) num = parameters[selector] @@ -459,6 +474,8 @@ if num in specific_entries: return specific_entries[num] + assert callable(plural_value) + index = plural_value(num) needed = rule['nplurals'] if needed == 1: @@ -474,15 +491,17 @@ 'parameters is not Mapping but {}'.format(type(parameters)) rule = plural_rule(lang) - plural_value = rule['plural'] - if not callable(plural_value): + + if callable(rule['plural']): + plural_value = rule['plural'] + else: assert rule['nplurals'] == 1 plural_value = static_plural_value return re.sub(PLURAL_PATTERN, replace_plural, message) -class _PluralMappingAlias(Mapping): +class _PluralMappingAlias(abc.Mapping): """ Aliasing class to allow non mappings in _extract_plural. @@ -490,15 +509,16 @@ That function only uses __getitem__ so this is only implemented here. """ - def __init__(self, source): + def __init__(self, source: Union[int, str, Sequence[int], + Mapping[str, int]]) -> None: + self.source = source if isinstance(source, str): self.source = int(source) - else: - self.source = source + self.index = -1 super().__init__() - def __getitem__(self, key): + def __getitem__(self, key: str) -> int: self.index += 1 if isinstance(self.source, dict): return int(self.source[key]) @@ -508,22 +528,23 @@ return int(self.source[self.index]) raise ValueError('Length of parameter does not match PLURAL ' 'occurrences.') + assert isinstance(self.source, int) return self.source - def __iter__(self): + def __iter__(self) -> Iterator[int]: raise NotImplementedError # pragma: no cover - def __len__(self): + def __len__(self) -> int: raise NotImplementedError # pragma: no cover DEFAULT_FALLBACK = ('_default', ) -def translate(code, - xdict: Union[dict, str], - parameters: Optional[Mapping] = None, - fallback=False) -> str: +def translate(code: STR_OR_SITE_TYPE, + xdict: Union[str, Mapping[str, str]], + parameters: Optional[Mapping[str, int]] = None, + fallback: Union[bool, Iterable[str]] = False) -> Optional[str]: """Return the most appropriate localization from a localization dict. Given a site code and a dictionary, returns the dictionary's value for @@ -542,7 +563,6 @@ extended dictionary the Site object should be used in favour of the code string. Otherwise localizations from a wrong family might be used. - :type code: str or Site object :param xdict: dictionary with language codes as keys or extended dictionary with family names as keys containing code dictionaries or a single string. May contain PLURAL tags as described in @@ -550,7 +570,6 @@ :param parameters: For passing (plural) parameters :param fallback: Try an alternate language code. If it's iterable it'll also try those entries and choose the first match. - :type fallback: boolean or iterable :return: the localized string :raise IndexError: If the language supports and requires more plurals than defined for the given PLURAL pattern. @@ -561,6 +580,7 @@ if hasattr(code, 'code'): family = code.family.name code = code.code + assert isinstance(code, str) try: lookup = xdict[code] @@ -581,6 +601,7 @@ if fallback is True: codes += _altlang(code) + ['_default', 'en'] elif fallback is not False: + assert not isinstance(fallback, bool) codes.extend(fallback) for code in codes: if code in lookup: @@ -593,7 +614,7 @@ trans = None if trans is None: - if 'wikipedia' in xdict: + if isinstance(xdict, dict) and 'wikipedia' in xdict: # fallback to wikipedia family return translate(code, xdict['wikipedia'], parameters=parameters, fallback=fallback) @@ -617,9 +638,11 @@ @deprecated_args(code='source') -def twtranslate(source, +def twtranslate(source: STR_OR_SITE_TYPE, twtitle: str, - parameters: Optional[Mapping] = None, *, + parameters: Union[Sequence[str], Mapping[str, int], + None] = None, + *, fallback: bool = True, fallback_prompt: Optional[str] = None, only_plural: bool = False) -> Optional[str]: @@ -676,7 +699,6 @@ :param source: When it's a site it's using the lang attribute and otherwise it is using the value directly. - :type source: BaseSite or str :param twtitle: The TranslateWiki string title, in <package>-<key> format :param parameters: For passing parameters. It should be a mapping but for backwards compatibility can also be a list, tuple or a single value. @@ -742,7 +764,7 @@ @deprecated_args(code='source') -def twhas_key(source, twtitle: str) -> bool: +def twhas_key(source: STR_OR_SITE_TYPE, twtitle: str) -> bool: """ Check if a message has a translation in the specified language code. @@ -753,7 +775,6 @@ :param source: When it's a site it's using the lang attribute and otherwise it is using the value directly. - :type source: BaseSite or str :param twtitle: The TranslateWiki string title, in <package>-<key> format """ # If a site is given instead of a code, use its language @@ -787,7 +808,7 @@ def input(twtitle: str, - parameters: Optional[Mapping] = None, + parameters: Optional[Mapping[str, int]] = None, password: bool = False, fallback_prompt: Optional[str] = None) -> str: """ diff --git a/pywikibot/plural.py b/pywikibot/plural.py index fc786f0..bb4c9d0 100644 --- a/pywikibot/plural.py +++ b/pywikibot/plural.py @@ -9,7 +9,7 @@ from pywikibot.backports import Dict -PluralRule = Dict[str, Union[int, Callable]] +PluralRule = Dict[str, Union[int, Callable[[int], Union[bool, int]]]] plural_rules = { '_default': {'nplurals': 2, 'plural': lambda n: (n != 1)}, -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/710116 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: Ida30c87350c79d6657461f7514c182a736aa90bf Gerrit-Change-Number: 710116 Gerrit-PatchSet: 4 Gerrit-Owner: Damian <atagar1(a)gmail.com> Gerrit-Reviewer: Huji <huji.huji(a)gmail.com> Gerrit-Reviewer: Isaacandy <isaac(a)iznd.xyz> Gerrit-Reviewer: Siebrand <siebrand(a)kitano.nl> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

[Gerrit] ...core[master]: [IMPR]: preload pages in pagefromfile.py

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/720472 ) Change subject: [IMPR]: preload pages in pagefromfile.py ...................................................................... [IMPR]: preload pages in pagefromfile.py Preload pages instead of reading them one by one before putting changes. Change-Id: I6205fb2cb052ac7b0c103456925fcf75ea5f54ca --- M scripts/pagefromfile.py 1 file changed, 15 insertions(+), 15 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/pagefromfile.py b/scripts/pagefromfile.py index e54e409..f79297b 100755 --- a/scripts/pagefromfile.py +++ b/scripts/pagefromfile.py @@ -73,6 +73,9 @@ from pywikibot import config, i18n from pywikibot.backports import Tuple from pywikibot.bot import CurrentPageBot, OptionHandler, SingleSiteBot +from pywikibot.pagegenerators import PreloadingGenerator + +CTX_ATTR = '_content_ctx' class NoTitleError(Exception): @@ -104,21 +107,12 @@ 'showdiff': False, } - def init_page(self, item) -> pywikibot.Page: - """Get the tuple and return the page object to be processed.""" - title, content = item - page = pywikibot.Page(self.site, title) - page.text = content.strip() - return super().init_page(page) - def treat_page(self) -> None: """Upload page content.""" page = self.current_page title = page.title() # save the content retrieved from generator - contents = page.text - # delete page's text to get it from live wiki - del page.text + contents = getattr(page, CTX_ATTR) if self.opt.summary: comment = self.opt.summary @@ -195,7 +189,7 @@ 'title': None, } - def __init__(self, filename, **kwargs) -> None: + def __init__(self, filename, site=None, **kwargs) -> None: """Initializer. Check if self.file name exists. If not, ask for a new filename. @@ -204,8 +198,9 @@ """ super().__init__(**kwargs) self.filename = filename + self.site = site or pywikibot.Site() - def __iter__(self) -> Generator[Tuple[str, str], None, None]: + def __iter__(self) -> Generator[pywikibot.Page, None, None]: """Read file and yield a tuple of page title and content.""" pywikibot.output("\n\nReading '{}'...".format(self.filename)) try: @@ -235,7 +230,10 @@ if length == 0: break position += length - yield title, contents + + page = pywikibot.Page(self.site, title) + setattr(page, CTX_ATTR, contents.strip()) + yield page def findpage(self, text) -> Tuple[int, str, str]: """Find page to work on.""" @@ -320,8 +318,10 @@ if failed_filename: pywikibot.bot.suggest_help(missing_parameters=['-file']) else: - reader = PageFromFileReader(filename, **r_options) - bot = PageFromFileRobot(generator=reader, **options) + site = pywikibot.Site() + reader = PageFromFileReader(filename, site=site, **r_options) + reader = PreloadingGenerator(reader) + bot = PageFromFileRobot(generator=reader, site=site, **options) bot.run() -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/720472 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: I6205fb2cb052ac7b0c103456925fcf75ea5f54ca Gerrit-Change-Number: 720472 Gerrit-PatchSet: 9 Gerrit-Owner: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: D3r1ck01 <xsavitar.wiki(a)aol.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

[Gerrit] ...core[master]: [cleanup] Remove deprecated properties of solve_disambiguation.py

by jenkins-bot (Code Review)

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/722854 ) Change subject: [cleanup] Remove deprecated properties of solve_disambiguation.py ...................................................................... [cleanup] Remove deprecated properties of solve_disambiguation.py Change-Id: I5fcfbe5b571b871e0e9c18e8770f89b32b6ed5a9 --- M scripts/solve_disambiguation.py 1 file changed, 1 insertion(+), 90 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/solve_disambiguation.py b/scripts/solve_disambiguation.py index 6ca824c..16506b1 100755 --- a/scripts/solve_disambiguation.py +++ b/scripts/solve_disambiguation.py @@ -106,12 +106,7 @@ NoPageError, PageSaveRelatedError, ) -from pywikibot.tools import ( - deprecated, - first_lower, - first_upper, - issue_deprecation_warning, -) +from pywikibot.tools import first_lower, first_upper, issue_deprecation_warning from pywikibot.tools.formatter import SequenceOutputter @@ -704,90 +699,6 @@ DisambiguationRobot""".format(options=added_keys, classname=self.__class__.__name__)) - # Deprecated properties --------------------------------------- - - @property - @deprecated('opt.always', since='20210303') - def always(self): # noqa: D102 - return self.opt.always - - @always.setter - @deprecated('opt.always', since='20210303') - def always(self, value): - self.opt.always = value - - @property - @deprecated('opt.dnskip', since='20210303') - def dnSkip(self): # noqa: D102 - return self.opt.dnskip - - @dnSkip.setter - @deprecated('opt.dnskip', since='20210303') - def dnSkip(self, value): - self.opt.dnskip = value - - @property - @deprecated('opt.primary', since='20210303') - def primary(self): # noqa: D102 - return self.opt.primary - - @primary.setter - @deprecated('opt.primary', since='20210303') - def primary(self, value): - self.opt.primary = value - - @property - @deprecated('opt.main', since='20210303') - def main_only(self): # noqa: D102 - return self.opt.main - - @main_only.setter - @deprecated('opt.main', since='20210303') - def main_only(self, value): - self.opt.main = value - - @property - @deprecated('opt.first', since='20210303') - def first_only(self): # noqa: D102 - return self.opt.first - - @first_only.setter - @deprecated('opt.first', since='20210303') - def first_only(self, value): - self.opt.first = value - - @property - @deprecated('opt.min', since='20210303') - def minimum(self): # noqa: D102 - return self.opt.min - - @minimum.setter - @deprecated('opt.min', since='20210303') - def minimum(self, value): - self.opt.min = value - - @property - @deprecated('opt.pos', since='20210303') - def alternatives(self): # noqa: D102 - return self.opt.pos - - @alternatives.setter - @deprecated('opt.pos', since='20210303') - def alternatives(self, value): - self.opt.pos = value - - @property - @deprecated('opt.just', since='20210303') - def getAlternatives(self): # noqa: D102 - return self.opt.just - - @getAlternatives.setter - @deprecated('opt.just', since='20210303') - def getAlternatives(self, value): - self.opt.just = value - - # ------------------------------------------------------------- - def checkContents(self, text: str) -> Optional[str]: # noqa: N802 """ Check if the text matches any of the ignore regexes. -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/722854 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: I5fcfbe5b571b871e0e9c18e8770f89b32b6ed5a9 Gerrit-Change-Number: 722854 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: D3r1ck01 <xsavitar.wiki(a)aol.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

2 years, 6 months

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits October 2021