991140eebe
This has been a massive pain point for me personally due to the poor
design of the Enum class leading to the common use cases used in the
library being significantly slow. Since this Enum is not public facing
in terms of *creation*, I can only implement the APIs that are used
when *accessing* them.
This Enum is a drop-in replacement to the pre-existing enum.Enum class
except it comes with significant speed-ups. Since this is a lot to go
over, I will let the numbers speak for themselves:
In [4]: %timeit enums.try_enum(enums.Status, 'offline')
263 ns ± 34.3 ns per loop (7 runs, 1000000 loops each)
In [5]: %timeit NeoStatus.try_value('offline')
134 ns ± 0.859 ns per loop (7 runs, 10000000 loops each)
In [6]: %timeit enums.Status.offline
116 ns ± 0.378 ns per loop (7 runs, 10000000 loops each)
In [7]: %timeit NeoStatus.offline
31.6 ns ± 0.327 ns per loop (7 runs, 10000000 loops each)
In [8]: %timeit enums.Status.offline.value
382 ns ± 15.2 ns per loop (7 runs, 1000000 loops each)
In [9]: %timeit NeoStatus.offline.value
65.5 ns ± 0.953 ns per loop (7 runs, 10000000 loops each)
In [10]: %timeit str(enums.Status.offline)
630 ns ± 14.8 ns per loop (7 runs, 1000000 loops each)
In [11]: %timeit str(NeoStatus.offline)
253 ns ± 3.53 ns per loop (7 runs, 1000000 loops each)
In [12]: %timeit enums.Status('offline')
697 ns ± 8.42 ns per loop (7 runs, 1000000 loops each)
In [13]: %timeit NeoStatus('offline')
182 ns ± 1.83 ns per loop (7 runs, 10000000 loops each)
391 lines
11 KiB
Python
391 lines
11 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2015-2019 Rapptz
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a
|
|
copy of this software and associated documentation files (the "Software"),
|
|
to deal in the Software without restriction, including without limitation
|
|
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
and/or sell copies of the Software, and to permit persons to whom the
|
|
Software is furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
DEALINGS IN THE SOFTWARE.
|
|
"""
|
|
|
|
import types
|
|
import inspect
|
|
from collections import namedtuple
|
|
from operator import attrgetter
|
|
|
|
__all__ = (
|
|
'Enum',
|
|
'ChannelType',
|
|
'MessageType',
|
|
'VoiceRegion',
|
|
'SpeakingState',
|
|
'VerificationLevel',
|
|
'ContentFilter',
|
|
'Status',
|
|
'DefaultAvatar',
|
|
'RelationshipType',
|
|
'AuditLogAction',
|
|
'AuditLogActionCategory',
|
|
'UserFlags',
|
|
'ActivityType',
|
|
'HypeSquadHouse',
|
|
'NotificationLevel',
|
|
'PremiumType',
|
|
'UserContentFilter',
|
|
'FriendFlags',
|
|
'Theme',
|
|
)
|
|
|
|
def _create_value_cls(name):
|
|
cls = namedtuple('_EnumValue_' + name, 'name value')
|
|
cls.__repr__ = lambda self: '<%s.%s: %r>' % (name, self.name, self.value)
|
|
cls.__str__ = lambda self: '%s.%s' % (name, self.name)
|
|
return cls
|
|
|
|
class EnumMeta(type):
|
|
def __new__(cls, name, bases, attrs):
|
|
value_mapping = {}
|
|
member_mapping = {}
|
|
member_names = []
|
|
|
|
value_cls = _create_value_cls(name)
|
|
for key, value in list(attrs.items()):
|
|
is_function = isinstance(value, types.FunctionType)
|
|
if key[0] == '_' and not is_function:
|
|
continue
|
|
|
|
if is_function:
|
|
setattr(value_cls, key, value)
|
|
del attrs[key]
|
|
continue
|
|
|
|
if inspect.ismethoddescriptor(value):
|
|
continue
|
|
|
|
try:
|
|
new_value = value_mapping[value]
|
|
except KeyError:
|
|
new_value = value_cls(name=key, value=value)
|
|
value_mapping[value] = new_value
|
|
member_names.append(key)
|
|
|
|
member_mapping[key] = new_value
|
|
attrs[key] = new_value
|
|
|
|
attrs['_enum_value_map_'] = value_mapping
|
|
attrs['_enum_member_map_'] = member_mapping
|
|
attrs['_enum_member_names_'] = member_names
|
|
actual_cls = super().__new__(cls, name, bases, attrs)
|
|
value_cls._actual_enum_cls_ = actual_cls
|
|
return actual_cls
|
|
|
|
def __iter__(cls):
|
|
return (cls._enum_member_map_[name] for name in cls._enum_member_names_)
|
|
|
|
def __repr__(cls):
|
|
return '<enum %r>' % cls.__name__
|
|
|
|
@property
|
|
def __members__(cls):
|
|
return types.MappingProxyType(cls._enum_member_map_)
|
|
|
|
def __call__(cls, value):
|
|
try:
|
|
return cls._enum_value_map_[value]
|
|
except (KeyError, TypeError):
|
|
raise ValueError("%r is not a valid %s" % (value, cls.__name__))
|
|
|
|
def __getitem__(cls, key):
|
|
return cls._enum_member_map_[key]
|
|
|
|
def __setattr__(cls, name, value):
|
|
raise TypeError('Enums are immutable.')
|
|
|
|
def __instancecheck__(self, instance):
|
|
# isinstance(x, Y)
|
|
# -> __instancecheck__(Y, x)
|
|
try:
|
|
return instance._actual_enum_cls_ is self
|
|
except AttributeError:
|
|
return False
|
|
|
|
class Enum(metaclass=EnumMeta):
|
|
@classmethod
|
|
def try_value(cls, value):
|
|
try:
|
|
return cls._enum_value_map_[value]
|
|
except (KeyError, TypeError):
|
|
return value
|
|
|
|
|
|
class ChannelType(Enum):
|
|
text = 0
|
|
private = 1
|
|
voice = 2
|
|
group = 3
|
|
category = 4
|
|
news = 5
|
|
store = 6
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
class MessageType(Enum):
|
|
default = 0
|
|
recipient_add = 1
|
|
recipient_remove = 2
|
|
call = 3
|
|
channel_name_change = 4
|
|
channel_icon_change = 5
|
|
pins_add = 6
|
|
new_member = 7
|
|
premium_guild_subscription = 8
|
|
premium_guild_tier_1 = 9
|
|
premium_guild_tier_2 = 10
|
|
premium_guild_tier_3 = 11
|
|
|
|
class VoiceRegion(Enum):
|
|
us_west = 'us-west'
|
|
us_east = 'us-east'
|
|
us_south = 'us-south'
|
|
us_central = 'us-central'
|
|
eu_west = 'eu-west'
|
|
eu_central = 'eu-central'
|
|
singapore = 'singapore'
|
|
london = 'london'
|
|
sydney = 'sydney'
|
|
amsterdam = 'amsterdam'
|
|
frankfurt = 'frankfurt'
|
|
brazil = 'brazil'
|
|
hongkong = 'hongkong'
|
|
russia = 'russia'
|
|
japan = 'japan'
|
|
southafrica = 'southafrica'
|
|
india = 'india'
|
|
vip_us_east = 'vip-us-east'
|
|
vip_us_west = 'vip-us-west'
|
|
vip_amsterdam = 'vip-amsterdam'
|
|
|
|
def __str__(self):
|
|
return self.value
|
|
|
|
class SpeakingState(Enum):
|
|
none = 0
|
|
voice = 1
|
|
soundshare = 2
|
|
priority = 4
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
def __int__(self):
|
|
return self.value
|
|
|
|
class VerificationLevel(Enum):
|
|
none = 0
|
|
low = 1
|
|
medium = 2
|
|
high = 3
|
|
table_flip = 3
|
|
extreme = 4
|
|
double_table_flip = 4
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
class ContentFilter(Enum):
|
|
disabled = 0
|
|
no_role = 1
|
|
all_members = 2
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
class UserContentFilter(Enum):
|
|
disabled = 0
|
|
friends = 1
|
|
all_messages = 2
|
|
|
|
class FriendFlags(Enum):
|
|
noone = 0
|
|
mutual_guilds = 1
|
|
mutual_friends = 2
|
|
guild_and_friends = 3
|
|
everyone = 4
|
|
|
|
class Theme(Enum):
|
|
light = 'light'
|
|
dark = 'dark'
|
|
|
|
class Status(Enum):
|
|
online = 'online'
|
|
offline = 'offline'
|
|
idle = 'idle'
|
|
dnd = 'dnd'
|
|
do_not_disturb = 'dnd'
|
|
invisible = 'invisible'
|
|
|
|
def __str__(self):
|
|
return self.value
|
|
|
|
class DefaultAvatar(Enum):
|
|
blurple = 0
|
|
grey = 1
|
|
gray = 1
|
|
green = 2
|
|
orange = 3
|
|
red = 4
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
class RelationshipType(Enum):
|
|
friend = 1
|
|
blocked = 2
|
|
incoming_request = 3
|
|
outgoing_request = 4
|
|
|
|
class NotificationLevel(Enum):
|
|
all_messages = 0
|
|
only_mentions = 1
|
|
|
|
class AuditLogActionCategory(Enum):
|
|
create = 1
|
|
delete = 2
|
|
update = 3
|
|
|
|
class AuditLogAction(Enum):
|
|
guild_update = 1
|
|
channel_create = 10
|
|
channel_update = 11
|
|
channel_delete = 12
|
|
overwrite_create = 13
|
|
overwrite_update = 14
|
|
overwrite_delete = 15
|
|
kick = 20
|
|
member_prune = 21
|
|
ban = 22
|
|
unban = 23
|
|
member_update = 24
|
|
member_role_update = 25
|
|
role_create = 30
|
|
role_update = 31
|
|
role_delete = 32
|
|
invite_create = 40
|
|
invite_update = 41
|
|
invite_delete = 42
|
|
webhook_create = 50
|
|
webhook_update = 51
|
|
webhook_delete = 52
|
|
emoji_create = 60
|
|
emoji_update = 61
|
|
emoji_delete = 62
|
|
message_delete = 72
|
|
|
|
@property
|
|
def category(self):
|
|
lookup = {
|
|
AuditLogAction.guild_update: AuditLogActionCategory.update,
|
|
AuditLogAction.channel_create: AuditLogActionCategory.create,
|
|
AuditLogAction.channel_update: AuditLogActionCategory.update,
|
|
AuditLogAction.channel_delete: AuditLogActionCategory.delete,
|
|
AuditLogAction.overwrite_create: AuditLogActionCategory.create,
|
|
AuditLogAction.overwrite_update: AuditLogActionCategory.update,
|
|
AuditLogAction.overwrite_delete: AuditLogActionCategory.delete,
|
|
AuditLogAction.kick: None,
|
|
AuditLogAction.member_prune: None,
|
|
AuditLogAction.ban: None,
|
|
AuditLogAction.unban: None,
|
|
AuditLogAction.member_update: AuditLogActionCategory.update,
|
|
AuditLogAction.member_role_update: AuditLogActionCategory.update,
|
|
AuditLogAction.role_create: AuditLogActionCategory.create,
|
|
AuditLogAction.role_update: AuditLogActionCategory.update,
|
|
AuditLogAction.role_delete: AuditLogActionCategory.delete,
|
|
AuditLogAction.invite_create: AuditLogActionCategory.create,
|
|
AuditLogAction.invite_update: AuditLogActionCategory.update,
|
|
AuditLogAction.invite_delete: AuditLogActionCategory.delete,
|
|
AuditLogAction.webhook_create: AuditLogActionCategory.create,
|
|
AuditLogAction.webhook_update: AuditLogActionCategory.update,
|
|
AuditLogAction.webhook_delete: AuditLogActionCategory.delete,
|
|
AuditLogAction.emoji_create: AuditLogActionCategory.create,
|
|
AuditLogAction.emoji_update: AuditLogActionCategory.update,
|
|
AuditLogAction.emoji_delete: AuditLogActionCategory.delete,
|
|
AuditLogAction.message_delete: AuditLogActionCategory.delete,
|
|
}
|
|
return lookup[self]
|
|
|
|
@property
|
|
def target_type(self):
|
|
v = self.value
|
|
if v == -1:
|
|
return 'all'
|
|
elif v < 10:
|
|
return 'guild'
|
|
elif v < 20:
|
|
return 'channel'
|
|
elif v < 30:
|
|
return 'user'
|
|
elif v < 40:
|
|
return 'role'
|
|
elif v < 50:
|
|
return 'invite'
|
|
elif v < 60:
|
|
return 'webhook'
|
|
elif v < 70:
|
|
return 'emoji'
|
|
elif v < 80:
|
|
return 'message'
|
|
|
|
class UserFlags(Enum):
|
|
staff = 1
|
|
partner = 2
|
|
hypesquad = 4
|
|
bug_hunter = 8
|
|
hypesquad_bravery = 64
|
|
hypesquad_brilliance = 128
|
|
hypesquad_balance = 256
|
|
early_supporter = 512
|
|
|
|
class ActivityType(Enum):
|
|
unknown = -1
|
|
playing = 0
|
|
streaming = 1
|
|
listening = 2
|
|
watching = 3
|
|
|
|
class HypeSquadHouse(Enum):
|
|
bravery = 1
|
|
brilliance = 2
|
|
balance = 3
|
|
|
|
class PremiumType(Enum):
|
|
nitro_classic = 1
|
|
nitro = 2
|
|
|
|
def try_enum(cls, val):
|
|
"""A function that tries to turn the value into enum ``cls``.
|
|
|
|
If it fails it returns the value instead.
|
|
"""
|
|
|
|
try:
|
|
return cls._enum_value_map_[val]
|
|
except (KeyError, TypeError, AttributeError):
|
|
return val
|