[Pywikibot-commits] [Gerrit] Deprecate UserActionRefuse and User.sendMail - change (pywikibot/core)

jenkins-bot has submitted this change and it was merged. Change subject: Deprecate UserActionRefuse and User.sendMail ...................................................................... Deprecate UserActionRefuse and User.sendMail UserActionRefuse is present tense, which is strange for an exception. UserActionRefuse is used for both user permissions and target preference to not accept email. Create new exceptions UserRightsError and NotEmailableError for the two scenarios. Change-Id: I4d6e21d0c7dc7db8d3878a3f67861631d6d21331 --- M pywikibot/__init__.py M pywikibot/exceptions.py M pywikibot/page.py M scripts/checkimages.py 4 files changed, 77 insertions(+), 23 deletions(-) Approvals: John Vandenberg: Looks good to me, but someone else must approve XZise: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/__init__.py b/pywikibot/__init__.py index 21b4dbf..d6ea7ec 100644 --- a/pywikibot/__init__.py +++ b/pywikibot/__init__.py @@ -41,7 +41,7 @@ Error, InvalidTitle, BadTitle, NoPage, SectionError, SiteDefinitionError, NoSuchSite, UnknownSite, UnknownFamily, UnknownExtension, - NoUsername, UserBlocked, UserActionRefuse, + NoUsername, UserBlocked, PageRelatedError, IsRedirectPage, IsNotRedirectPage, PageSaveRelatedError, PageNotSaved, OtherPageSaveError, LockedPage, CascadeLockedPage, LockedNoPage, NoCreateError, @@ -750,3 +750,7 @@ 'PageNotFound', pywikibot.exceptions.DeprecatedPageNotFoundError, warning_message=('{0}.{1} is deprecated, and no longer ' 'used by pywikibot; use http.fetch() instead.')) +wrapper._add_deprecated_attr( + 'UserActionRefuse', pywikibot.exceptions._EmailUserError, + warning_message='UserActionRefuse is deprecated; ' + 'use UserRightsError and/or NotEmailableError') diff --git a/pywikibot/exceptions.py b/pywikibot/exceptions.py index 7684d9f..4a30d02 100644 --- a/pywikibot/exceptions.py +++ b/pywikibot/exceptions.py @@ -6,7 +6,7 @@ - NoUsername: Username is not in user-config.py, or it is invalid. - UserBlocked: Username or IP has been blocked - AutoblockUser: requested action on a virtual autoblock user not valid - - UserActionRefuse: requested user action, such as email user, refused + - UserRightsError: insufficient rights for requested action - BadTitle: Server responded with BadTitle - InvalidTitle: Invalid page title - CaptchaError: Captcha is asked and config.solve_captcha == False @@ -23,8 +23,9 @@ - IsRedirectPage: Page is a redirect page - IsNotRedirectPage: Page is not a redirect page - CircularRedirect: Page is a circular redirect - - InterwikiRedirectPage: Page is a redirect to another site. + - InterwikiRedirectPage: Page is a redirect to another site - SectionError: The section specified by # does not exist + - NotEmailableError: The target user has disabled email PageSaveRelatedError: page exceptions within the save operation on a Page (alias: PageNotSaved). @@ -463,9 +464,18 @@ pass -class UserActionRefuse(Error): +class UserRightsError(Error): - """User action was refused.""" + """Insufficient user rights to perform an action.""" + + pass + + +class NotEmailableError(PageRelatedError): + + """This user is not emailable.""" + + message = "%s is not emailable." pass @@ -503,9 +513,21 @@ pass +(a)pywikibot.tools.deprecated +class _EmailUserError(UserRightsError, NotEmailableError): + + """Email related error.""" + + pass + + wrapper = pywikibot.tools.ModuleDeprecationWrapper(__name__) wrapper._add_deprecated_attr('UploadWarning', pywikibot.data.api.UploadWarning) wrapper._add_deprecated_attr('PageNotFound', DeprecatedPageNotFoundError, warning_message='{0}.{1} is deprecated, and no ' 'longer used by pywikibot; use ' 'http.fetch() instead.') +wrapper._add_deprecated_attr( + 'UserActionRefuse', _EmailUserError, + warning_message='UserActionRefuse is deprecated; ' + 'use UserRightsError and/or NotEmailableError') diff --git a/pywikibot/page.py b/pywikibot/page.py index c724519..159ba82 100644 --- a/pywikibot/page.py +++ b/pywikibot/page.py @@ -45,8 +45,11 @@ from pywikibot.family import Family from pywikibot.site import Namespace from pywikibot.exceptions import ( - AutoblockUser, UserActionRefuse, - SiteDefinitionError + AutoblockUser, + _EmailUserError, + NotEmailableError, + SiteDefinitionError, + UserRightsError, ) from pywikibot.tools import ( UnicodeMixin, DotReadableDict, @@ -2789,13 +2792,8 @@ return Page(Link(self.title(withNamespace=False) + subpage, self.site, defaultNamespace=3)) - def sendMail(self, subject, text, ccme=False): + def send_email(self, subject, text, ccme=False): """Send an email to this user via MediaWiki's email interface. - - Return True on success, False otherwise. - This method can raise an UserActionRefuse exception in case this user - doesn't allow sending email to him or the currently logged in bot - doesn't have the right to send emails. @param subject: the subject header of the mail @type subject: unicode @@ -2803,12 +2801,16 @@ @type text: unicode @param ccme: if True, sends a copy of this email to the bot @type ccme: bool + @raises NotEmailableError: the user of this User is not emailable + @raises UserRightsError: logged in user does not have 'sendemail' right + @return: operation successful indicator + @rtype: bool """ if not self.isEmailable(): - raise UserActionRefuse('This user is not mailable') + raise NotEmailableError('%s is not mailable' % self.username) if not self.site.has_right('sendemail'): - raise UserActionRefuse('You don\'t have permission to send mail') + raise UserRightsError('You don\'t have permission to send mail') params = { 'action': 'emailuser', @@ -2822,16 +2824,40 @@ mailrequest = pywikibot.data.api.Request(site=self.site, **params) maildata = mailrequest.submit() - if 'error' in maildata: - code = maildata['error']['code'] - if code == u'usermaildisabled ': - pywikibot.output(u'User mail has been disabled') - elif 'emailuser' in maildata: + if 'emailuser' in maildata: if maildata['emailuser']['result'] == u'Success': - pywikibot.output(u'Email sent.') return True return False + @deprecated('send_email') + def sendMail(self, subject, text, ccme=False): + """Send an email to this user via MediaWiki's email interface. + + Outputs 'Email sent' if the email was sent. + + @param subject: the subject header of the mail + @type subject: unicode + @param text: mail body + @type text: unicode + @param ccme: if True, sends a copy of this email to the bot + @type ccme: bool + @raises _EmailUserError: logged in user does not have 'sendemail' right + or the target has disabled receiving emails + @return: operation successful indicator + @rtype: bool + """ + if not self.isEmailable(): + raise _EmailUserError('This user is not mailable') + + if not self.site.has_right('sendemail'): + raise _EmailUserError('You don\'t have permission to send mail') + + if self.send_email(subject, text, ccme=ccme): + pywikibot.output('Email sent.') + return True + else: + return False + def block(self, expiry, reason, anononly=True, nocreate=True, autoblock=True, noemail=False, reblock=False): """ diff --git a/scripts/checkimages.py b/scripts/checkimages.py index 71da9ec..28d6ade 100755 --- a/scripts/checkimages.py +++ b/scripts/checkimages.py @@ -97,6 +97,8 @@ from pywikibot import pagegenerators as pg from pywikibot import i18n + +from pywikibot.exceptions import NotEmailableError from pywikibot.family import Family from pywikibot.tools import deprecated @@ -830,8 +832,8 @@ % self.luser, emailText) emailClass = pywikibot.User(self.site, self.luser) try: - emailClass.sendMail(emailSubj, text_to_send) - except pywikibot.UserActionRefuse: + emailClass.send_email(emailSubj, text_to_send) + except NotEmailableError: pywikibot.output("User is not mailable, aborted") return -- To view, visit https://gerrit.wikimedia.org/r/180713 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I4d6e21d0c7dc7db8d3878a3f67861631d6d21331 Gerrit-PatchSet: 11 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: John Vandenberg &lt;jayvdb(a)gmail.com&gt; Gerrit-Reviewer: John Vandenberg &lt;jayvdb(a)gmail.com&gt; Gerrit-Reviewer: Ladsgroup &lt;ladsgroup(a)gmail.com&gt; Gerrit-Reviewer: Merlijn van Deen &lt;valhallasw(a)arctus.nl&gt; Gerrit-Reviewer: XZise &lt;CommodoreFabianus(a)gmx.de&gt; Gerrit-Reviewer: jenkins-bot <>