10b0b62f50
Replaced server member lists, channel lists, and private channel lists with dicts. This allows O(1) lookups and removes (previously it would be an O(N) operation to lookup or remove). I did pretty extensive testing and benchmarking to compare the performance of using lists vs using dicts. Iterating through lists to find an item is only faster in the average case for extremely small lists (less than 3 items). For 100 items, using a dict is about 10 times faster on average (and about 100 times faster for 1000 items). The overhead in dicts is in memory usage and initial creation time. Creating and populating a dict is about 2 to 3 times slower than creating and appending items to a list. However this cost is still tiny. For 1000 items this equates to about a 70 microsecond difference (on an i7 CPU) for populating the entire dict. The memory overhead for a dict (compared to a list) is about 25-60 KB per 1000 items (can vary depending on dict resizing). Originally I wanted to use OrderedDicts to presereve order, but in my testing OrderedDicts have about 6x the memory overhead compared to normal dicts.
discord.py
discord.py is an API wrapper for Discord written in Python.
This was written to allow easier writing of bots or chat logs. Make sure to familiarise yourself with the API using the documentation.
Breaking Changes
The discord API is constantly changing and the wrapper API is as well. There will be no effort to keep backwards compatibility in versions before v1.0.0.
I recommend that you follow the discussion in the unofficial Discord API discord channel and update your installation periodically through pip install --upgrade discord.py. I will attempt to make note of breaking changes in the API channel.
Installing
Installing is pretty easy.
pip install discord.py
Will install the latest 'stable' version of the library.
If you want to install the development version of the library, then do the following:
pip install git+https://github.com/Rapptz/discord.py@develop
Installing the async beta is similar.
pip install git+https://github.com/Rapptz/discord.py@async
Note that this requires git to be installed.
Quick Example
import discord
import asyncio
client = discord.Client()
@client.event
async def on_ready():
print('Logged in as')
print(client.user.name)
print(client.user.id)
print('------')
@client.event
async def on_message(message):
if message.content.startswith('!test'):
logs = await client.logs_from(message.channel, limit=100)
counter = 0
tmp = await client.send_message(message.channel, 'Calculating messages...')
for log in logs:
if log.author == message.author:
counter += 1
await client.edit_message(tmp, 'You have {} messages.'.format(counter))
elif message.content.startswith('!sleep'):
await asyncio.sleep(5)
await client.send_message(message.channel, 'Done sleeping')
client.run('email', 'password')
Note that in Python 3.4 you use @asyncio.coroutine instead of async def and yield from instead of await.
You can find examples in the examples directory.
Requirements
- Python 3.4.2+
aiohttplibrarywebsocketslibrary
Usually pip will handle these for you.