mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-04-21 16:24:14 +00:00
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)
157 lines
4.9 KiB
Python
157 lines
4.9 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.
|
|
"""
|
|
|
|
from discord.enums import Enum
|
|
import time
|
|
|
|
__all__ = (
|
|
'BucketType',
|
|
'Cooldown',
|
|
'CooldownMapping',
|
|
)
|
|
|
|
class BucketType(Enum):
|
|
default = 0
|
|
user = 1
|
|
guild = 2
|
|
channel = 3
|
|
member = 4
|
|
category = 5
|
|
|
|
class Cooldown:
|
|
__slots__ = ('rate', 'per', 'type', '_window', '_tokens', '_last')
|
|
|
|
def __init__(self, rate, per, type):
|
|
self.rate = int(rate)
|
|
self.per = float(per)
|
|
self.type = type
|
|
self._window = 0.0
|
|
self._tokens = self.rate
|
|
self._last = 0.0
|
|
|
|
if not isinstance(self.type, BucketType):
|
|
raise TypeError('Cooldown type must be a BucketType')
|
|
|
|
def get_tokens(self, current=None):
|
|
if not current:
|
|
current = time.time()
|
|
|
|
tokens = self._tokens
|
|
|
|
if current > self._window + self.per:
|
|
tokens = self.rate
|
|
return tokens
|
|
|
|
def update_rate_limit(self, current=None):
|
|
current = current or time.time()
|
|
self._last = current
|
|
|
|
self._tokens = self.get_tokens(current)
|
|
|
|
# first token used means that we start a new rate limit window
|
|
if self._tokens == self.rate:
|
|
self._window = current
|
|
|
|
# check if we are rate limited
|
|
if self._tokens == 0:
|
|
return self.per - (current - self._window)
|
|
|
|
# we're not so decrement our tokens
|
|
self._tokens -= 1
|
|
|
|
# see if we got rate limited due to this token change, and if
|
|
# so update the window to point to our current time frame
|
|
if self._tokens == 0:
|
|
self._window = current
|
|
|
|
def reset(self):
|
|
self._tokens = self.rate
|
|
self._last = 0.0
|
|
|
|
def copy(self):
|
|
return Cooldown(self.rate, self.per, self.type)
|
|
|
|
def __repr__(self):
|
|
return '<Cooldown rate: {0.rate} per: {0.per} window: {0._window} tokens: {0._tokens}>'.format(self)
|
|
|
|
class CooldownMapping:
|
|
def __init__(self, original):
|
|
self._cache = {}
|
|
self._cooldown = original
|
|
|
|
def copy(self):
|
|
ret = CooldownMapping(self._cooldown)
|
|
ret._cache = self._cache.copy()
|
|
return ret
|
|
|
|
@property
|
|
def valid(self):
|
|
return self._cooldown is not None
|
|
|
|
@classmethod
|
|
def from_cooldown(cls, rate, per, type):
|
|
return cls(Cooldown(rate, per, type))
|
|
|
|
def _bucket_key(self, msg):
|
|
bucket_type = self._cooldown.type
|
|
if bucket_type is BucketType.user:
|
|
return msg.author.id
|
|
elif bucket_type is BucketType.guild:
|
|
return (msg.guild or msg.author).id
|
|
elif bucket_type is BucketType.channel:
|
|
return msg.channel.id
|
|
elif bucket_type is BucketType.member:
|
|
return ((msg.guild and msg.guild.id), msg.author.id)
|
|
elif bucket_type is BucketType.category:
|
|
return (msg.channel.category or msg.channel).id
|
|
|
|
def _verify_cache_integrity(self, current=None):
|
|
# we want to delete all cache objects that haven't been used
|
|
# in a cooldown window. e.g. if we have a command that has a
|
|
# cooldown of 60s and it has not been used in 60s then that key should be deleted
|
|
current = current or time.time()
|
|
dead_keys = [k for k, v in self._cache.items() if current > v._last + v.per]
|
|
for k in dead_keys:
|
|
del self._cache[k]
|
|
|
|
def get_bucket(self, message, current=None):
|
|
if self._cooldown.type is BucketType.default:
|
|
return self._cooldown
|
|
|
|
self._verify_cache_integrity(current)
|
|
key = self._bucket_key(message)
|
|
if key not in self._cache:
|
|
bucket = self._cooldown.copy()
|
|
self._cache[key] = bucket
|
|
else:
|
|
bucket = self._cache[key]
|
|
|
|
return bucket
|
|
|
|
def update_rate_limit(self, message, current=None):
|
|
bucket = self.get_bucket(message, current)
|
|
return bucket.update_rate_limit(current)
|