jenkins-bot has submitted this change and it was merged.
Change subject: Fix docstring warnings
......................................................................
Fix docstring warnings
Change-Id: Ic2d5dfd499089157644bf01c3d08ae9ab0529bfe
---
M pywikibot/data/api.py
M pywikibot/site.py
M tox.ini
3 files changed, 84 insertions(+), 20 deletions(-)
Approvals:
XZise: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/data/api.py b/pywikibot/data/api.py
index 47cb74d..2cac9a3 100644
--- a/pywikibot/data/api.py
+++ b/pywikibot/data/api.py
@@ -87,10 +87,12 @@
class TimeoutError(Error):
- pass
+
+ """API request failed with a timeout error."""
class EnableSSLSiteWrapper(object):
+
"""Wrapper to change the site protocol to https."""
def __init__(self, site):
@@ -653,6 +655,9 @@
class CachedRequest(Request):
+
+ """Cached request."""
+
def __init__(self, expiry, *args, **kwargs):
"""Construct a CachedRequest object.
@@ -906,7 +911,6 @@
def update_limit(self):
"""Set query limit for self.module based on api
response."""
-
for mod in self.module.split('|'):
for param in self._modules[mod].get("parameters", []):
if param["name"] == "limit":
diff --git a/pywikibot/site.py b/pywikibot/site.py
index 49f50dc..b976ae4 100644
--- a/pywikibot/site.py
+++ b/pywikibot/site.py
@@ -219,6 +219,7 @@
def _contains_lowercase_name(self, name):
"""Determine a lowercase normalised name is a name of this
namespace.
+ @rtype: bool
"""
return name in [x.lower() for x in self._distinct()]
@@ -230,6 +231,7 @@
@param item: name to check
@type item: basestring
+ @rtype: bool
"""
if item == '' and self.id == 0:
return True
@@ -2314,7 +2316,6 @@
Valid tokens depend on mw version.
"""
-
_version = LV(self.version())
if _version < LV('1.20'):
valid_types = [token for token in types if token in self.TOKENS_0]
@@ -2357,7 +2358,6 @@
return: a dict with retrieved valid tokens.
"""
-
def warn_handler(mod, text):
"""Filter warnings for not available
tokens."""
return re.match(r'Action \'\w+\' is not allowed for the current
user',
@@ -4060,7 +4060,6 @@
@yield: dict with 'rcid', 'ns' and 'title' of the
patrolled page.
"""
-
# If patrol is not enabled, attr will be set the first time a
# request is done.
if hasattr(self, u'_patroldisabled'):
@@ -4205,7 +4204,7 @@
@deprecated("Site().exturlusage")
def linksearch(self, siteurl, limit=None):
- """Backwards-compatible interface to
exturlusage()"""
+ """Backwards-compatible interface to
exturlusage()."""
return self.exturlusage(siteurl, total=limit)
def getFilesFromAnHash(self, hash_found=None):
@@ -4287,7 +4286,6 @@
and the chunk size is positive but lower than the file size.
@type chunk_size: int
"""
-
upload_warnings = {
# map API warning codes to user error messages
# %(msg)s will be replaced by message string from API responsse
@@ -4492,6 +4490,8 @@
Yields a tuple of Page object, length(int).
+ @param step: request batch size
+ @param total: number of pages to return
"""
lpgen = self._generator(api.ListGenerator,
type_arg="querypage",
qppage="Longpages",
@@ -4507,6 +4507,8 @@
Yields a tuple of Page object, length(int).
+ @param step: request batch size
+ @param total: number of pages to return
"""
spgen = self._generator(api.ListGenerator,
type_arg="querypage",
qppage="Shortpages",
@@ -4518,7 +4520,11 @@
@deprecate_arg("number", None)
@deprecate_arg("repeat", None)
def deadendpages(self, step=None, total=None):
- """Yield Page objects retrieved from
Special:Deadendpages."""
+ """Yield Page objects retrieved from Special:Deadendpages.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
degen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="Deadendpages",
step=step, total=total)
@@ -4527,7 +4533,11 @@
@deprecate_arg("number", None)
@deprecate_arg("repeat", None)
def ancientpages(self, step=None, total=None):
- """Yield Pages, datestamps from
Special:Ancientpages."""
+ """Yield Pages, datestamps from Special:Ancientpages.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
apgen = self._generator(api.ListGenerator,
type_arg="querypage",
qppage="Ancientpages",
step=step, total=total)
@@ -4538,7 +4548,11 @@
@deprecate_arg("number", None)
@deprecate_arg("repeat", None)
def lonelypages(self, step=None, total=None):
- """Yield Pages retrieved from
Special:Lonelypages."""
+ """Yield Pages retrieved from Special:Lonelypages.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
lpgen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="Lonelypages",
step=step, total=total)
@@ -4549,6 +4563,8 @@
def unwatchedpages(self, step=None, total=None):
"""Yield Pages from Special:Unwatchedpages (requires Admin
privileges).
+ @param step: request batch size
+ @param total: number of pages to return
"""
uwgen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="Unwatchedpages",
@@ -4558,6 +4574,8 @@
def wantedpages(self, step=None, total=None):
"""Yield Pages from Special:Wantedpages.
+ @param step: request batch size
+ @param total: number of pages to return
"""
wpgen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="Wantedpages",
@@ -4568,7 +4586,11 @@
@deprecate_arg("repeat", None)
def uncategorizedcategories(self, number=None, repeat=True,
step=None, total=None):
- """Yield Categories from
Special:Uncategorizedcategories."""
+ """Yield Categories from Special:Uncategorizedcategories.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
ucgen = self._generator(api.CategoryPageGenerator,
type_arg="querypage",
gqppage="Uncategorizedcategories",
@@ -4579,7 +4601,11 @@
@deprecate_arg("repeat", None)
def uncategorizedimages(self, number=None, repeat=True,
step=None, total=None):
- """Yield FilePages from
Special:Uncategorizedimages."""
+ """Yield FilePages from Special:Uncategorizedimages.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
uigen = self._generator(api.ImagePageGenerator,
type_arg="querypage",
gqppage="Uncategorizedimages",
@@ -4593,7 +4619,11 @@
@deprecate_arg("repeat", None)
def uncategorizedpages(self, number=None, repeat=True,
step=None, total=None):
- """Yield Pages from Special:Uncategorizedpages."""
+ """Yield Pages from Special:Uncategorizedpages.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
upgen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="Uncategorizedpages",
@@ -4604,7 +4634,11 @@
@deprecate_arg("repeat", None)
def uncategorizedtemplates(self, number=None, repeat=True, step=None,
total=None):
- """Yield Pages from
Special:Uncategorizedtemplates."""
+ """Yield Pages from Special:Uncategorizedtemplates.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
utgen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="Uncategorizedtemplates",
@@ -4614,7 +4648,11 @@
@deprecate_arg("number", None)
@deprecate_arg("repeat", None)
def unusedcategories(self, step=None, total=None):
- """Yield Category objects from
Special:Unusedcategories."""
+ """Yield Category objects from Special:Unusedcategories.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
ucgen = self._generator(api.CategoryPageGenerator,
type_arg="querypage",
gqppage="Unusedcategories",
@@ -4622,7 +4660,11 @@
return ucgen
def unusedfiles(self, step=None, total=None):
- """Yield FilePage objects from
Special:Unusedimages."""
+ """Yield FilePage objects from Special:Unusedimages.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
uigen = self._generator(api.ImagePageGenerator,
type_arg="querypage",
gqppage="Unusedimages",
@@ -4638,7 +4680,11 @@
@deprecate_arg("number", None)
@deprecate_arg("repeat", None)
def withoutinterwiki(self, step=None, total=None):
- """Yield Pages without language links from
Special:Withoutinterwiki."""
+ """Yield Pages without language links from
Special:Withoutinterwiki.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
wigen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="Withoutinterwiki",
@@ -4647,7 +4693,11 @@
@need_version("1.18")
def broken_redirects(self, step=None, total=None):
- """Yield Pages without language links from
Special:BrokenRedirects."""
+ """Yield Pages without language links from
Special:BrokenRedirects.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
brgen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="BrokenRedirects",
@@ -4656,7 +4706,11 @@
@need_version("1.18")
def double_redirects(self, step=None, total=None):
- """Yield Pages without language links from
Special:BrokenRedirects."""
+ """Yield Pages without language links from
Special:BrokenRedirects.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
drgen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="DoubleRedirects",
@@ -4665,7 +4719,11 @@
@need_version("1.18")
def redirectpages(self, step=None, total=None):
- """Yield redirect pages from
Special:ListRedirects."""
+ """Yield redirect pages from Special:ListRedirects.
+
+ @param step: request batch size
+ @param total: number of pages to return
+ """
lrgen = self._generator(api.PageGenerator,
type_arg="querypage",
gqppage="Listredirects",
diff --git a/tox.ini b/tox.ini
index 2049adb..341cf42 100644
--- a/tox.ini
+++ b/tox.ini
@@ -38,6 +38,7 @@
./pywikibot/interwiki_graph.py \
./pywikibot/page.py \
./pywikibot/plural.py \
+ ./pywikibot/site.py \
./pywikibot/tools.py \
./pywikibot/version.py \
./pywikibot/weblib.py \
@@ -46,6 +47,7 @@
./pywikibot/compat/catlib.py \
./pywikibot/compat/query.py \
./pywikibot/data/__init__.py \
+ ./pywikibot/data/api.py \
./pywikibot/userinterfaces/transliteration.py \
./pywikibot/userinterfaces/terminal_interface.py \
./scripts/claimit.py \
--
To view, visit
https://gerrit.wikimedia.org/r/165250
To unsubscribe, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ic2d5dfd499089157644bf01c3d08ae9ab0529bfe
Gerrit-PatchSet: 1
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: John Vandenberg <jayvdb(a)gmail.com>
Gerrit-Reviewer: Ladsgroup <ladsgroup(a)gmail.com>
Gerrit-Reviewer: Merlijn van Deen <valhallasw(a)arctus.nl>
Gerrit-Reviewer: XZise <CommodoreFabianus(a)gmx.de>
Gerrit-Reviewer: jenkins-bot <>