jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/840161 )
Change subject: [IMPR] Use API formatversion 2 with userinfo
......................................................................
[IMPR] Use API formatversion 2 with userinfo
Also deprecated APISite.messages() method; it is easy enough
to use APISite.userinfo['messages'] instead.
Bug: T121334
Change-Id: I14b2d635444cb04dac9328c2a09ddfbc568a2d3e
---
M pywikibot/site/_apisite.py
1 file changed, 42 insertions(+), 5 deletions(-)
Approvals:
JJMC89: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py
index 2050db3..7fe3f4a 100644
--- a/pywikibot/site/_apisite.py
+++ b/pywikibot/site/_apisite.py
@@ -475,16 +475,47 @@
To force retrieving userinfo ignoring cache, just delete this
property.
+ **Usage**
+
+ >>> site = pywikibot.Site('test')
+ >>> info = site.userinfo
+ >>> info['id'] # returns 0 if no ip user
+ ... # doctest: +SKIP
+ 0
+ >>> info['name'] # username or ip
+ ...
+ ... # doctest: +SKIP
+ '92.198.174.192'
+ >>> info['groups']
+ ['*']
+ >>> info['rights'] # doctest: +ELLIPSIS
+ ['createaccount', 'read', 'edit', 'createpage', 'createtalk', ...]
+ >>> info['messages']
+ False
+ >>> del site.userinfo # delete userinfo cache
+ >>> 'blockinfo' in site.userinfo
+ False
+ >>> 'anon' in site.userinfo
+ True
+
+ **Usefull alternatives to userinfo property**
+
+ - :meth:`has_group` to verify the group membership
+ - :meth:`has_right` to verify that the user has a given right
+ - :meth:`logged_in` to verify the user is loggend in to a site
+
.. seealso:: :api:`Userinfo`
+ .. versionchanged:: 8.0.0
+ Use API formatversion 2.
:return: A dict with the following keys and values:
- - id: user id (numeric str)
+ - id: user id (int)
- name: username (if user is logged in)
- anon: present if user is not logged in
- groups: list of groups (could be empty)
- rights: list of rights (could be empty)
- - message: present if user has a new message on talk page
+ - messages: True if user has a new message on talk page (bool)
- blockinfo: present if user is blocked (dict)
"""
@@ -492,7 +523,8 @@
uirequest = self.simple_request(
action='query',
meta='userinfo',
- uiprop='blockinfo|hasmsg|groups|rights|ratelimits'
+ uiprop='blockinfo|hasmsg|groups|rights|ratelimits',
+ formatversion=2,
)
uidata = uirequest.submit()
assert 'query' in uidata, \
@@ -776,9 +808,14 @@
"""
return group.lower() in self.userinfo['groups']
+ @deprecated("userinfo['messages']", since='8.0.0')
def messages(self) -> bool:
- """Return true if the user has new messages, and false otherwise."""
- return 'messages' in self.userinfo
+ """Return true if the user has new messages, and false otherwise.
+
+ .. deprecated:: 8.0
+ Replaced by :attr:`userinfo['messages']<userinfo>`.
+ """
+ return self.userinfo['messages']
def mediawiki_messages(
self,
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/840161
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: I14b2d635444cb04dac9328c2a09ddfbc568a2d3e
Gerrit-Change-Number: 840161
Gerrit-PatchSet: 9
Gerrit-Owner: Xqt <[email protected]>
Gerrit-Reviewer: JJMC89 <[email protected]>
Gerrit-Reviewer: jenkins-bot
Gerrit-CC: Sn1per <[email protected]>
Gerrit-MessageType: merged
_______________________________________________
Pywikibot-commits mailing list -- [email protected]
To unsubscribe send an email to [email protected]
