Add enumeration of IRC events

Closes #960

sopel/tools/__init__.py

@@ -22,6 +22,8 @@
 import traceback
 from collections import defaultdict
 
+from sopel.tools._events import events  # NOQA
+
 if sys.version_info.major >= 3:
     unicode = str
     iteritems = dict.items

sopel/tools/_events.py

@@ -0,0 +1,202 @@
+# coding=utf-8
+from __future__ import unicode_literals, absolute_import, print_function, division
+
+
+class events(object):
+    """An enumeration of all the standardized and notable IRC numeric events
+
+    This allows you to do, for example, @module.event(events.RPL_WELCOME)
+    rather than @module.event('001')
+    """
+    # ###################################################### Non-RFC / Non-IRCv3
+    # Only add things here if they're actually in common use across multiple
+    # ircds.
+    RPL_ISUPPORT = '005'
+
+    # ################################################################### IRC v3
+    # ## 3.1
+    # CAP
+    ERR_INVALIDCAPCMD = '410'
+    # SASL
+    RPL_LOGGEDIN = '900'
+    RPL_LOGGEDOUT = '901'
+    ERR_NICKLOCKED = '902'
+    RPL_SASLSUCCESS = '903'
+    ERR_SASLFAIL = '904'
+    ERR_SASLTOOLONG = '905'
+    ERR_SASLABORTED = '906'
+    ERR_SASLALREADY = '907'
+    RPL_SASLMECHS = '908'
+    # TLS
+    RPL_STARTTLS = '670'
+    ERR_STARTTLS = '691'
+    # ## 3.2
+    # Metadata
+    RPL_WHOISKEYVALUE = '760'
+    RPL_KEYVALUE = '761'
+    RPL_METADATAEND = '762'
+    ERR_METADATALIMIT = '764'
+    ERR_TARGETINVALID = '765'
+    ERR_NOMATCHINGKEY = '766'
+    ERR_KEYINVALID = '767'
+    ERR_KEYNOTSET = '768'
+    ERR_KEYNOPERMISSION = '769'
+    # Monitor
+    RPL_MONONLINE = '730'
+    RPL_MONOFFLINE = '731'
+    RPL_MONLIST = '732'
+    RPL_ENDOFMONLIST = '733'
+    ERR_MONLISTFULL = '734'
+
+    # ################################################################# RFC 1459
+    # ## 6.1 Error Replies.
+    ERR_NOSUCHNICK = '401'
+    ERR_NOSUCHSERVER = '402'
+    ERR_NOSUCHCHANNEL = '403'
+    ERR_CANNOTSENDTOCHAN = '404'
+    ERR_TOOMANYCHANNELS = '405'
+    ERR_WASNOSUCHNICK = '406'
+    ERR_TOOMANYTARGETS = '407'
+    ERR_NOORIGIN = '409'
+    ERR_NORECIPIENT = '411'
+    ERR_NOTEXTTOSEND = '412'
+    ERR_NOTOPLEVEL = '413'
+    ERR_WILDTOPLEVEL = '414'
+    ERR_UNKNOWNCOMMAND = '421'
+    ERR_NOMOTD = '422'
+    ERR_NOADMININFO = '423'
+    ERR_FILEERROR = '424'
+    ERR_NONICKNAMEGIVEN = '431'
+    ERR_ERRONEUSNICKNAME = '432'
+    ERR_NICKNAMEINUSE = '433'
+    ERR_NICKCOLLISION = '436'
+    ERR_USERNOTINCHANNEL = '441'
+    ERR_NOTONCHANNEL = '442'
+    ERR_USERONCHANNEL = '443'
+    ERR_NOLOGIN = '444'
+    ERR_SUMMONDISABLED = '445'
+    ERR_USERSDISABLED = '446'
+    ERR_NOTREGISTERED = '451'
+    ERR_NEEDMOREPARAMS = '461'
+    ERR_ALREADYREGISTRED = '462'
+    ERR_NOPERMFORHOST = '463'
+    ERR_PASSWDMISMATCH = '464'
+    ERR_YOUREBANNEDCREEP = '465'
+    ERR_KEYSET = '467'
+    ERR_CHANNELISFULL = '471'
+    ERR_UNKNOWNMODE = '472'
+    ERR_INVITEONLYCHAN = '473'
+    ERR_BANNEDFROMCHAN = '474'
+    ERR_BADCHANNELKEY = '475'
+    ERR_NOPRIVILEGES = '481'
+    ERR_CHANOPRIVSNEEDED = '482'
+    ERR_CANTKILLSERVER = '483'
+    ERR_NOOPERHOST = '491'
+    ERR_UMODEUNKNOWNFLAG = '501'
+    ERR_USERSDONTMATCH = '502'
+    # ## 6.2 Command responses.
+    RPL_NONE = '300'
+    RPL_USERHOST = '302'
+    RPL_ISON = '303'
+    RPL_AWAY = '301'
+    RPL_UNAWAY = '305'
+    RPL_NOWAWAY = '306'
+    RPL_WHOISUSER = '311'
+    RPL_WHOISSERVER = '312'
+    RPL_WHOISOPERATOR = '313'
+    RPL_WHOISIDLE = '317'
+    RPL_ENDOFWHOIS = '318'
+    RPL_WHOISCHANNELS = '319'
+    RPL_WHOWASUSER = '314'
+    RPL_ENDOFWHOWAS = '369'
+    RPL_LISTSTART = '321'
+    RPL_LIST = '322'
+    RPL_LISTEND = '323'
+    RPL_CHANNELMODEIS = '324'
+    RPL_NOTOPIC = '331'
+    RPL_TOPIC = '332'
+    RPL_INVITING = '341'
+    RPL_SUMMONING = '342'
+    RPL_VERSION = '351'
+    RPL_WHOREPLY = '352'
+    RPL_ENDOFWHO = '315'
+    RPL_NAMREPLY = '353'
+    RPL_ENDOFNAMES = '366'
+    RPL_LINKS = '364'
+    RPL_ENDOFLINKS = '365'
+    RPL_BANLIST = '367'
+    RPL_ENDOFBANLIST = '368'
+    RPL_INFO = '371'
+    RPL_ENDOFINFO = '374'
+    RPL_MOTDSTART = '375'
+    RPL_MOTD = '372'
+    RPL_ENDOFMOTD = '376'
+    RPL_YOUREOPER = '381'
+    RPL_REHASHING = '382'
+    RPL_TIME = '391'
+    RPL_USERSSTART = '392'
+    RPL_USERS = '393'
+    RPL_ENDOFUSERS = '394'
+    RPL_NOUSERS = '395'
+    RPL_TRACELINK = '200'
+    RPL_TRACECONNECTING = '201'
+    RPL_TRACEHANDSHAKE = '202'
+    RPL_TRACEUNKNOWN = '203'
+    RPL_TRACEOPERATOR = '204'
+    RPL_TRACEUSER = '205'
+    RPL_TRACESERVER = '206'
+    RPL_TRACENEWTYPE = '208'
+    RPL_TRACELOG = '261'
+    RPL_STATSLINKINFO = '211'
+    RPL_STATSCOMMANDS = '212'
+    RPL_STATSCLINE = '213'
+    RPL_STATSNLINE = '214'
+    RPL_STATSILINE = '215'
+    RPL_STATSKLINE = '216'
+    RPL_STATSYLINE = '218'
+    RPL_ENDOFSTATS = '219'
+    RPL_STATSLLINE = '241'
+    RPL_STATSUPTIME = '242'
+    RPL_STATSOLINE = '243'
+    RPL_STATSHLINE = '244'
+    RPL_UMODEIS = '221'
+    RPL_LUSERCLIENT = '251'
+    RPL_LUSEROP = '252'
+    RPL_LUSERUNKNOWN = '253'
+    RPL_LUSERCHANNELS = '254'
+    RPL_LUSERME = '255'
+    RPL_ADMINME = '256'
+    RPL_ADMINLOC1 = '257'
+    RPL_ADMINLOC2 = '258'
+    RPL_ADMINEMAIL = '259'
+
+    # ################################################################# RFC 2812
+    # ## 5.1 Command responses
+    RPL_WELCOME = '001'
+    RPL_YOURHOST = '002'
+    RPL_CREATED = '003'
+    RPL_MYINFO = '004'
+    RPL_BOUNCE = '005'
+    RPL_UNIQOPIS = '325'
+    RPL_INVITELIST = '346'
+    RPL_ENDOFINVITELIST = '347'
+    RPL_EXCEPTLIST = '348'
+    RPL_ENDOFEXCEPTLIST = '349'
+    RPL_YOURESERVICE = '383'
+    RPL_TRACESERVICE = '207'
+    RPL_TRACECLASS = '209'
+    RPL_TRACERECONNECT = '210'
+    RPL_TRACEEND = '262'
+    RPL_SERVLIST = '234'
+    RPL_SERVLISTEND = '235'
+    RPL_TRYAGAIN = '263'
+    # ## 5.2 Error Replies
+    ERR_NOSUCHSERVICE = '408'
+    ERR_BADMASK = '415'
+    ERR_UNAVAILRESOURCE = '437'
+    ERR_YOUWILLBEBANNED = '466'
+    ERR_BADCHANMASK = '476'
+    ERR_NOCHANMODES = '477'
+    ERR_BANLISTFULL = '478'
+    ERR_RESTRICTED = '484'
+    ERR_UNIQOPPRIVSNEEDED = '485'