Harmon
94c0cb0d5c
[commands] Add missing word in HelpCommand documentation
2019-06-20 22:52:47 -04:00
Rapptz
671a19a24a
[commands] Ensure cooldowns are properly copied.
2019-06-12 23:40:43 -04:00
Rapptz
af4e3ad79b
Some documentation touch-ups and missing stuff in the changelog.
2019-06-09 01:24:41 -04:00
Rapptz
991140eebe
Replace Enum with an internal one for significant speed improvements.
...
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)
2019-06-09 00:06:34 -04:00
NCPlayz
3c9bcc2851
Improve documentation
2019-06-07 19:27:46 -04:00
Dante Dam
92731bbf5f
[commands] Fixed extra "only" in dm_only docs
2019-05-19 20:04:42 -07:00
Rapptz
82b54933e2
Add asyncio.Task subclass for better __repr__ for events.
2019-05-19 19:17:29 -04:00
Suhail
db9a293f14
[tasks] Add version added note to Loop.change_interval
2019-05-19 19:17:28 -04:00
Dante Dam
1fac7a7e71
[commands] Add missing backtick for is_nsfw docs
2019-05-17 15:25:45 -07:00
Suhail6inkling
aadb6953ff
[tasks] Add way to change interval at run-time
...
PR: #2162
Fixes : #2158
2019-05-17 18:25:21 -04:00
Rapptz
6bc9d7c01a
[tasks] Add indicator for internal task failure
...
Fixes #2151
2019-05-13 22:10:38 -04:00
Rapptz
a4a362b4c7
[tasks] Log exception when something failed to logging.
2019-05-13 22:08:31 -04:00
SnowyLuma
859ee751f9
[tasks] Return coro from before and after decorators
2019-05-13 20:29:07 -04:00
Rapptz
49a7e58d17
[tasks] Keep retrying before gracefully exiting.
2019-05-12 01:31:09 -04:00
Rapptz
4eead39b3c
[tasks] Add Loop.stop to gracefully stop a task.
...
Updated docs will follow shortly.
2019-05-12 01:04:24 -04:00
Rapptz
bcdecd4e07
[tasks] Reset iteration count when loop terminates.
2019-05-12 00:49:19 -04:00
Rapptz
f74d73327b
[commands] Explicitly assign invoked_subcommand to None before invoking
...
This should fix instances of it not working as expected in nested
groups.
2019-05-11 18:17:57 -04:00
Steve C
8f111c521c
Fix typo in Loop.restart documentation
2019-05-10 18:44:07 -04:00
Rapptz
47808a7e96
[tasks] Add Loop.restart
...
This implementation waits until the task is done before starting it
again.
Closes #2075
2019-05-10 18:37:37 -04:00
Benjamin Mintz
0a0c43321b
[commands] MinimalHelpCommand: add cog description
2019-05-09 06:11:21 -04:00
Rapptz
bdea50e1db
[commands] Better note for Command.invoke
2019-05-05 03:15:38 -04:00
Rapptz
91e00d8426
[tasks] Add way to query cancellation state for Loop.after_loop
...
Fixes #2121
2019-04-30 01:45:15 -04:00
Rapptz
40cac30da1
[commands] Fix MessageConverter not inheriting from Converter
...
Closes #2126
2019-04-29 23:37:27 -04:00
Rapptz
55e3e242ff
[tasks] Remove support for awaitables due to gotchas.
...
Fixes #2079
2019-04-29 23:34:20 -04:00
Rapptz
05d4f7f962
[commands] Fix Context.send_help to work with the copied HelpCommand
2019-04-29 00:08:08 -04:00
Rapptz
ad5beed8dd
[commands] Copy HelpCommand instances to prevent race conditions.
...
Fixes #2123
Slight breaking change if someone had an expectation that no copies
were made behind the scene (which is sensible), however writing code
that relies on this expectation is probably buggy anyway.
2019-04-29 00:05:46 -04:00
Rapptz
6dcd68b8d7
[commands] Allow passing current
to more cooldown mapping methods.
...
Also adds a CooldownMapping.update_rate_limit helper function.
2019-04-24 23:26:33 -04:00
Rapptz
5a7b5cd14b
[commands] Allow passing of a message to NoPrivateMessage again.
...
Prevents an accidental breaking change.
2019-04-20 17:28:44 -04:00
Rapptz
188bd4e708
[commands] DM channels are NSFW in commands.is_nsfw check.
2019-04-20 17:27:04 -04:00
Rapptz
919dbcafb3
Consistent use of __all__ to prevent merge conflicts.
2019-04-20 17:20:58 -04:00
Rapptz
c6410ea9ab
[commands] Clean docstrings in Command.parents and Command.root_parent
2019-04-20 17:01:01 -04:00
Rapptz
6620fcc038
[commands] Consistently mention inheritance of exceptions.
2019-04-20 16:59:54 -04:00
Vexs
bbf9a42f87
[commands] Add Command.parents
...
Make command.root_parent use new command.parents property
2019-04-20 16:59:53 -04:00
Vexs
bb3ebc0ebc
[commands] Add custom exception classes for built-in checks
...
Added:
* MissingRole
* BotMissingRole
* MissingAnyRole
* BotMissingAnyRole
2019-04-20 16:45:37 -04:00
Rapptz
4ca934eb22
[commands] Missing an extra ] in the documented return type.
2019-04-19 18:29:12 -04:00
Vexs
dd84773f45
[commands] Allow passing cls to the commands.group decorator
2019-04-19 18:29:11 -04:00
sirtezza451
dbe946a767
[commands] Update default on_command_error
2019-04-18 07:58:28 -04:00
Rapptz
296d4bf580
[commands] Add new MessageConverter to commands prose page.
2019-04-17 22:41:58 -04:00
retke
440db2a568
[commands] Add MessageConverter to fetch messages by URL or ID.
2019-04-17 20:47:21 -04:00
Danny
2a301a4eb4
[tasks] Fix assignment of tuple when appending
2019-04-15 14:49:52 -04:00
Rapptz
7a1102ccf0
[commands] Use message creation as the reference time in cooldowns
2019-04-14 17:33:56 -04:00
Rapptz
ec7a701ceb
[commands] Allow passing reference time to update_rate_limit
2019-04-14 16:57:47 -04:00
Rapptz
6574c97a8b
[commands] Support callables in Greedy converter
2019-04-13 07:28:26 -04:00
Rapptz
ac1b9f5628
[commands] Fix lambda converters in non-module contexts.
...
Not sure why anyone would do this but might as well fix it.
2019-04-13 07:15:54 -04:00
Steve C
ac2cda1ffc
[tasks] set internal task to None after canceling
2019-04-12 20:56:40 -04:00
Rapptz
e46842a7cd
[tasks] Add before_loop and after_loop decorators
2019-04-12 04:08:42 -04:00
Rapptz
015404b01c
[commands] Add versionadded to dm_only
2019-04-12 03:21:49 -04:00
Rapptz
4513dac7a3
[tasks] Ensure total number of seconds is not less than 0.
2019-04-11 08:21:45 -04:00
Rapptz
10bc939348
[tasks] Rename Loop.run to Loop.start to avoid blocking connotations
2019-04-11 08:19:32 -04:00
Rapptz
b0c7f48caf
[tasks] Add a new background helper 'tasks' extension.
2019-04-11 08:04:26 -04:00