gsd
/
disco
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

First pass at documentation

pull/3/head
Andrei 9 years ago
parent
368f62d03a
commit
a144febe0b
21 changed files with 1581 additions and 60 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 1
      .gitignore
  2. 2
      disco/api/client.py
  3. 31
      disco/api/http.py
  4. 89
      disco/api/ratelimit.py
  5. 73
      disco/bot/bot.py
  6. 85
      disco/bot/command.py
  7. 72
      disco/bot/parser.py
  8. 61
      disco/bot/plugin.py
  9. 225
      docs/Makefile
  10. 343
      docs/conf.py
  11. 38
      docs/disco.api.rst
  12. 46
      docs/disco.bot.rst
  13. 38
      docs/disco.gateway.rst
  14. 50
      docs/disco.rst
  15. 78
      docs/disco.types.rst
  16. 62
      docs/disco.util.rst
  17. 30
      docs/disco.voice.rst
  18. 22
      docs/index.rst
  19. 281
      docs/make.bat
  20. 7
      docs/modules.rst
  21. 7
      docs/setup.rst

1
.gitignore
View File

@ -1,3 +1,4 @@
build/ build/
dist/ dist/
disco.egg-info/ disco.egg-info/
docs/_build

2
disco/api/client.py
View File

@ -20,7 +20,7 @@ def optional(**kwargs):
class APIClient(LoggingClass): class APIClient(LoggingClass):
""" """
An abstraction over the :class:`HTTPClient` that composes requests, and fits An abstraction over the :class:`disco.api.http.HTTPClient` that composes requests, and fits
the models with the returned data. the models with the returned data.
""" """
def __init__(self, client): def __init__(self, client):

31
disco/api/http.py
View File

@ -7,6 +7,7 @@ from holster.enum import Enum
from disco.util.logging import LoggingClass from disco.util.logging import LoggingClass
from disco.api.ratelimit import RateLimiter from disco.api.ratelimit import RateLimiter
# Enum of all HTTP methods used
HTTPMethod = Enum( HTTPMethod = Enum(
GET='GET', GET='GET',
POST='POST', POST='POST',
@ -17,6 +18,10 @@ HTTPMethod = Enum(
class Routes(object): class Routes(object):
"""
Simple Python object-enum of all method/url route combinations available to
this client.
"""
# Gateway # Gateway
GATEWAY_GET = (HTTPMethod.GET, '/gateway') GATEWAY_GET = (HTTPMethod.GET, '/gateway')
@ -87,6 +92,10 @@ class Routes(object):
class APIException(Exception): class APIException(Exception):
"""
Exception thrown when an HTTP-client level error occurs. Usually this will
be a non-success status-code, or a transient network issue.
"""
def __init__(self, msg, status_code=0, content=None): def __init__(self, msg, status_code=0, content=None):
self.status_code = status_code self.status_code = status_code
self.content = content self.content = content
@ -99,6 +108,10 @@ class APIException(Exception):
class HTTPClient(LoggingClass): class HTTPClient(LoggingClass):
"""
A simple HTTP client which wraps the requests library, adding support for
Discords rate-limit headers, authorization, and request/response validation.
"""
BASE_URL = 'https://discordapp.com/api/v6' BASE_URL = 'https://discordapp.com/api/v6'
MAX_RETRIES = 5 MAX_RETRIES = 5
@ -111,6 +124,15 @@ class HTTPClient(LoggingClass):
} }
def __call__(self, route, args=None, **kwargs): def __call__(self, route, args=None, **kwargs):
"""
Makes a request to the given route (as specified in
:class:`disco.api.http.Routes`) with a set of URL arguments, and keyword
arguments passed to requests.
:param route: the method/url route combination to call
:param args: url major arguments (used for Discord rate limits)
:param kwargs: any keyword arguments to be passed along to requests
"""
args = args or {} args = args or {}
retry = kwargs.pop('retry_number', 0) retry = kwargs.pop('retry_number', 0)
@ -158,5 +180,12 @@ class HTTPClient(LoggingClass):
@staticmethod @staticmethod
def random_backoff(): def random_backoff():
# 500 milliseconds to 5 seconds) """
Returns a random backoff (in milliseconds) to be used for any error the
client suspects is transient. Will always return a value between 500 and
5000 milliseconds.
:returns: a random backoff in milliseconds
:rtype: float
"""
return random.randint(500, 5000) / 1000.0 return random.randint(500, 5000) / 1000.0

89
disco/api/ratelimit.py
View File

@ -3,35 +3,66 @@ import gevent
class RouteState(object): class RouteState(object):
def __init__(self, route, request): """
An object which stores ratelimit state for a given method/url route
combination (as specified in :class:`disco.api.http.Routes`).
:ivar route: the route this state pertains too
:ivar remaining: the number of requests remaining before the rate limit is hit
:ivar reset_time: unix timestamp (in seconds) when this rate limit is reset
:ivar event: a :class:`gevent.event.Event` used for ratelimit cooldowns
"""
def __init__(self, route, response):
self.route = route self.route = route
self.remaining = 0 self.remaining = 0
self.reset_time = 0 self.reset_time = 0
self.event = None self.event = None
self.update(request) self.update(response)
@property @property
def chilled(self): def chilled(self):
"""
Whether this route is currently being cooldown (aka waiting until reset_time)
"""
return self.event is not None return self.event is not None
def update(self, request): @property
if 'X-RateLimit-Remaining' not in request.headers:
return
self.remaining = int(request.headers.get('X-RateLimit-Remaining'))
self.reset_time = int(request.headers.get('X-RateLimit-Reset'))
def wait(self, timeout=None):
self.event.wait(timeout)
def next_will_ratelimit(self): def next_will_ratelimit(self):
"""
Whether the next request to the route (at this moment in time) will
trigger the rate limit.
"""
if self.remaining - 1 < 0 and time.time() <= self.reset_time: if self.remaining - 1 < 0 and time.time() <= self.reset_time:
return True return True
return False return False
def update(self, response):
"""
Updates this route with a given Requests response object. Its expected
the response has the required headers, however in the case it doesn't
this function has no effect.
"""
if 'X-RateLimit-Remaining' not in response.headers:
return
self.remaining = int(response.headers.get('X-RateLimit-Remaining'))
self.reset_time = int(response.headers.get('X-RateLimit-Reset'))
def wait(self, timeout=None):
"""
Waits until this route is no longer under a cooldown
:param timeout: timeout after which waiting will be given up
"""
self.event.wait(timeout)
def cooldown(self): def cooldown(self):
"""
Waits for the current route to be cooled-down (aka waiting until reset time)
"""
if self.reset_time - time.time() < 0: if self.reset_time - time.time() < 0:
raise Exception('Cannot cooldown for negative time period; check clock sync') raise Exception('Cannot cooldown for negative time period; check clock sync')
@ -42,11 +73,26 @@ class RouteState(object):
class RateLimiter(object): class RateLimiter(object):
"""
A in-memory store of ratelimit states for all routes we've ever called.
:ivar states: a Route -> RouteState mapping
"""
def __init__(self): def __init__(self):
self.cooldowns = {}
self.states = {} self.states = {}
def check(self, route, timeout=None): def check(self, route, timeout=None):
"""
Checks whether a given route can be called. This function will return
immediately if no rate-limit cooldown is being imposed for the given
route, or will wait indefinently (unless timeout is specified) until
the route is finished being cooled down. This function should be called
before making a request to the specified route.
:param route: route to be checked
:param timeout: an optional timeout after which we'll stop waiting for
the cooldown to complete.
"""
return self._check(None, timeout) and self._check(route, timeout) return self._check(None, timeout) and self._check(route, timeout)
def _check(self, route, timeout=None): def _check(self, route, timeout=None):
@ -55,16 +101,23 @@ class RateLimiter(object):
if self.states[route].chilled: if self.states[route].chilled:
return self.states[route].wait(timeout) return self.states[route].wait(timeout)
if self.states[route].next_will_ratelimit(): if self.states[route].next_will_ratelimit:
gevent.spawn(self.states[route].cooldown).get(True, timeout) gevent.spawn(self.states[route].cooldown).get(True, timeout)
return True return True
def update(self, route, request): def update(self, route, response):
if 'X-RateLimit-Global' in request.headers: """
Updates the given routes state with the rate-limit headers inside the
response from a previous call to the route.
:param route: route to update
:param response: requests response to update the route with
"""
if 'X-RateLimit-Global' in response.headers:
route = None route = None
if route in self.states: if route in self.states:
self.states[route].update(request) self.states[route].update(response)
else: else:
self.states[route] = RouteState(route, request) self.states[route] = RouteState(route, response)

73
disco/bot/bot.py
View File

@ -5,34 +5,52 @@ from disco.bot.command import CommandEvent
class BotConfig(object): class BotConfig(object):
# Authentication token """
An object which specifies the runtime configuration for a Bot.
:ivar str token: Authentication token
:ivar bool commands_enabled: whether to enable the command parsing functionality
of the bot
:ivar bool command_require_mention: whether commands require a mention to be
triggered
:ivar dict command_mention_rules: a dictionary of rules about what types of
mentions will trigger a command. A string/bool mapping containing 'here',
'everyone', 'role', and 'user'. If set to false, the mention type will
not trigger commands.
:ivar str command_prefix: prefix required to trigger a command
:ivar bool command_allow_edit: whether editing the last-sent message in a channel,
which did not previously trigger a command, will cause the bot to recheck
the message contents and possibly trigger a command.
:ivar function plugin_config_provider: an optional function which when called
with a plugin name, returns relevant configuration for it.
"""
token = None token = None
# Whether to enable command parsing
commands_enabled = True commands_enabled = True
# Whether the bot must be mentioned to respond to a command
command_require_mention = True command_require_mention = True
# Rules about what mentions trigger the bot
command_mention_rules = { command_mention_rules = {
# 'here': False, # 'here': False,
'everyone': False, 'everyone': False,
'role': True, 'role': True,
'user': True, 'user': True,
} }
# The prefix required for EVERY command
command_prefix = '' command_prefix = ''
# Whether an edited message can trigger a command
command_allow_edit = True command_allow_edit = True
# Function that when given a plugin name, returns its configuration
plugin_config_provider = None plugin_config_provider = None
class Bot(object): class Bot(object):
"""
Disco's implementation of a simple but extendable Discord bot. Bots consist
of a set of plugins, and a Disco client.
:param client: the client this bot should use for its Discord connection
:param config: a :class:`BotConfig` instance
:ivar dict plugins: string -> :class:`disco.bot.plugin.Plugin` mapping of
all loaded plugins
"""
def __init__(self, client=None, config=None): def __init__(self, client=None, config=None):
self.client = client or DiscoClient(config.token) self.client = client or DiscoClient(config.token)
self.config = config or BotConfig() self.config = config or BotConfig()
@ -54,6 +72,12 @@ class Bot(object):
@classmethod @classmethod
def from_cli(cls, *plugins): def from_cli(cls, *plugins):
"""
Creates a new instance of the bot using the Disco-CLI utility, and a set
of passed-in plugin classes.
:param plugins: plugins to load after creaing the Bot instance
"""
from disco.cli import disco_main from disco.cli import disco_main
inst = cls(disco_main()) inst = cls(disco_main())
@ -64,11 +88,17 @@ class Bot(object):
@property @property
def commands(self): def commands(self):
"""
Generator of all commands this bots plugins have defined
"""
for plugin in self.plugins.values(): for plugin in self.plugins.values():
for command in plugin.commands.values(): for command in plugin.commands.values():
yield command yield command
def compute_command_matches_re(self): def compute_command_matches_re(self):
"""
Computes a single regex which matches all possible command combinations.
"""
re_str = '|'.join(command.regex for command in self.commands) re_str = '|'.join(command.regex for command in self.commands)
if re_str: if re_str:
self.command_matches_re = re.compile(re_str) self.command_matches_re = re.compile(re_str)
@ -76,6 +106,9 @@ class Bot(object):
self.command_matches_re = None self.command_matches_re = None
def get_commands_for_message(self, msg): def get_commands_for_message(self, msg):
"""
Generator of all commands a given message triggers.
"""
content = msg.content content = msg.content
if self.config.command_require_mention: if self.config.command_require_mention:
@ -105,6 +138,13 @@ class Bot(object):
yield (command, match) yield (command, match)
def handle_message(self, msg): def handle_message(self, msg):
"""
Attempts to handle a newely created or edited message in the context of
command parsing/triggering. Calls all relevant commands the message triggers.
:returns: whether any commands where successfully triggered
:rtype: bool
"""
commands = list(self.get_commands_for_message(msg)) commands = list(self.get_commands_for_message(msg))
if len(commands): if len(commands):
@ -135,6 +175,10 @@ class Bot(object):
self.last_message_cache[msg.channel_id] = (msg, triggered) self.last_message_cache[msg.channel_id] = (msg, triggered)
def add_plugin(self, cls): def add_plugin(self, cls):
"""
Adds and loads a given plugin, based on its class (which must be a subclass
of :class:`disco.bot.plugin.Plugin`).
"""
if cls.__name__ in self.plugins: if cls.__name__ in self.plugins:
raise Exception('Cannot add already added plugin: {}'.format(cls.__name__)) raise Exception('Cannot add already added plugin: {}'.format(cls.__name__))
@ -145,6 +189,10 @@ class Bot(object):
self.compute_command_matches_re() self.compute_command_matches_re()
def rmv_plugin(self, cls): def rmv_plugin(self, cls):
"""
Unloads and removes a given plugin, based on its class (which must be a
sub class of :class:`disco.bot.plugin.Plugin`).
"""
if cls.__name__ not in self.plugins: if cls.__name__ not in self.plugins:
raise Exception('Cannot remove non-existant plugin: {}'.format(cls.__name__)) raise Exception('Cannot remove non-existant plugin: {}'.format(cls.__name__))
@ -154,4 +202,7 @@ class Bot(object):
self.compute_command_matches_re() self.compute_command_matches_re()
def run_forever(self): def run_forever(self):
"""
Runs this bot forever
"""
self.client.run_forever() self.client.run_forever()

85
disco/bot/command.py
View File

@ -1,6 +1,6 @@
import re import re
from disco.bot.parser import parse_arguments, ArgumentError from disco.bot.parser import ArgumentSet, ArgumentError
from disco.util.cache import cached_property from disco.util.cache import cached_property
REGEX_FMT = '({})' REGEX_FMT = '({})'
@ -8,6 +8,17 @@ ARGS_REGEX = '( (.*)$|$)'
class CommandEvent(object): class CommandEvent(object):
"""
An event which is created when a command is triggered. Contains information
about the message, command, and parsed arguments (along with shortcuts to
message information).
:ivar Command command: the command this event was created for (e.g. triggered command)
:ivar Message msg: the message object which triggered the command
:ivar re.MatchObject match: the regex match object for the command
:ivar string name: the name of the command (or alias) which was triggered
:ivar list args: any arguments passed to the command
"""
def __init__(self, command, msg, match): def __init__(self, command, msg, match):
self.command = command self.command = command
self.msg = msg self.msg = msg
@ -17,36 +28,88 @@ class CommandEvent(object):
@cached_property @cached_property
def member(self): def member(self):
return self.guild.get_member(self.actor) """
Guild member (if relevant) for the user that created the message
"""
return self.guild.get_member(self.author)
@property @property
def channel(self): def channel(self):
"""
Channel the message was created in
"""
return self.msg.channel return self.msg.channel
@property @property
def guild(self): def guild(self):
"""
Guild (if relevant) the message was created in
"""
return self.msg.guild return self.msg.guild
@property @property
def actor(self): def author(self):
"""
Author of the message
"""
return self.msg.author return self.msg.author
class CommandError(Exception): class CommandError(Exception):
pass """
An exception which is thrown when the arguments for a command are invalid,
or don't match the commands specifications.
"""
class Command(object): class Command(object):
"""
An object which defines and handles the triggering of a function based on
user input (aka a command).
:ivar disco.bot.plugin.Plugin plugin: the plugin this command is part of
:ivar function func: the function this command is attached too
:ivar str trigger: the primary trigger (aka name) of this command
:ivar str args: argument specification for this command
:ivar list aliases: aliases this command also responds too
:ivar str group: grouping this command is under
:ivar bool is_regex: whether this command is triggered as a regex
"""
def __init__(self, plugin, func, trigger, args=None, aliases=None, group=None, is_regex=False): def __init__(self, plugin, func, trigger, args=None, aliases=None, group=None, is_regex=False):
self.plugin = plugin self.plugin = plugin
self.func = func self.func = func
self.triggers = [trigger] + (aliases or []) self.triggers = [trigger] + (aliases or [])
self.args = parse_arguments(args or '') self.args = ArgumentSet.from_string(args or '')
self.group = group self.group = group
self.is_regex = is_regex self.is_regex = is_regex
@cached_property
def compiled_regex(self):
"""
A compiled version of this commands regex
"""
return re.compile(self.regex)
@property
def regex(self):
"""
The regex string that defines/triggers this command
"""
if self.is_regex:
return REGEX_FMT.format('|'.join(self.triggers))
else:
group = self.group + ' ' if self.group else ''
return REGEX_FMT.format('|'.join(['^' + group + trigger for trigger in self.triggers]) + ARGS_REGEX)
def execute(self, event): def execute(self, event):
"""
Handles the execution of this command given a :class:`CommandEvent`
object.
:returns: whether this command was successful
:rtype: bool
"""
if len(event.args) < self.args.required_length: if len(event.args) < self.args.required_length:
raise CommandError('{} requires {} arguments (passed {})'.format( raise CommandError('{} requires {} arguments (passed {})'.format(
event.name, event.name,
@ -60,15 +123,3 @@ class Command(object):
raise CommandError(e.message) raise CommandError(e.message)
return self.func(event, *args) return self.func(event, *args)
@cached_property
def compiled_regex(self):
return re.compile(self.regex)
@property
def regex(self):
if self.is_regex:
return REGEX_FMT.format('|'.join(self.triggers))
else:
group = self.group + ' ' if self.group else ''
return REGEX_FMT.format('|'.join(['^' + group + trigger for trigger in self.triggers]) + ARGS_REGEX)

72
disco/bot/parser.py
View File

@ -2,8 +2,10 @@ import re
import copy import copy
# Regex which splits out argument parts
PARTS_RE = re.compile('(\<|\[)((?:\w+|\:|\||\.\.\.| (?:[0-9]+))+)(?:\>|\])') PARTS_RE = re.compile('(\<|\[)((?:\w+|\:|\||\.\.\.| (?:[0-9]+))+)(?:\>|\])')
# Mapping of types
TYPE_MAP = { TYPE_MAP = {
'str': str, 'str': str,
'int': int, 'int': int,
@ -13,10 +15,21 @@ TYPE_MAP = {
class ArgumentError(Exception): class ArgumentError(Exception):
pass """
An error thrown when passed in arguments cannot be conformed/casted to the
argument specification.
"""
class Argument(object): class Argument(object):
"""
A single argument, which is normally the member of a :class:`ArgumentSet`.
:ivar str name: name of this argument
:ivar int count: the number of actual raw arguments which compose this argument
:ivar bool required: whether this argument is required
:ivar list types: the types that this argument can be
"""
def __init__(self, raw): def __init__(self, raw):
self.name = None self.name = None
self.count = 1 self.count = 1
@ -26,9 +39,15 @@ class Argument(object):
@property @property
def true_count(self): def true_count(self):
"""
The true number of raw arguments this argument takes
"""
return self.count or 1 return self.count or 1
def parse(self, raw): def parse(self, raw):
"""
Attempts to parse arguments from their raw form
"""
prefix, part = raw prefix, part = raw
if prefix == '<': if prefix == '<':
@ -51,12 +70,40 @@ class Argument(object):
class ArgumentSet(object): class ArgumentSet(object):
"""
A set of :class:`Argument` instances which forms a larger argument specification
:ivar list args: list of :class:`Argument` instances for this set
:ivar dict types: dict of all possible types
"""
def __init__(self, args=None, custom_types=None): def __init__(self, args=None, custom_types=None):
self.args = args or [] self.args = args or []
self.types = copy.copy(TYPE_MAP) self.types = copy.copy(TYPE_MAP)
self.types.update(custom_types or {}) self.types.update(custom_types or {})
@classmethod
def from_string(cls, line, custom_types=None):
"""
Creates a new :class:`ArgumentSet` from a given argument string specification
"""
args = cls(custom_types=custom_types)
data = PARTS_RE.findall(line)
if len(data):
for item in data:
args.append(Argument(item))
return args
def convert(self, types, value): def convert(self, types, value):
"""
Attempts to convert a value to one or more types.
:param types: ordered list of types to try conversion to
:param value: the value to attempt conversion on
:type types: list
:param value: string
"""
for typ_name in types: for typ_name in types:
typ = self.types.get(typ_name) typ = self.types.get(typ_name)
if not typ: if not typ:
@ -70,6 +117,9 @@ class ArgumentSet(object):
raise e raise e
def append(self, arg): def append(self, arg):
"""
Add a new :class:`Argument` to this argument specification/set
"""
if self.args and not self.args[-1].required and arg.required: if self.args and not self.args[-1].required and arg.required:
raise Exception('Required argument cannot come after an optional argument') raise Exception('Required argument cannot come after an optional argument')
@ -79,6 +129,9 @@ class ArgumentSet(object):
self.args.append(arg) self.args.append(arg)
def parse(self, rawargs): def parse(self, rawargs):
"""
Parse a string of raw arguments into this argument specification.
"""
parsed = [] parsed = []
for index, arg in enumerate(self.args): for index, arg in enumerate(self.args):
@ -111,19 +164,14 @@ class ArgumentSet(object):
@property @property
def length(self): def length(self):
"""
The number of arguments in this set/specification
"""
return len(self.args) return len(self.args)
@property @property
def required_length(self): def required_length(self):
"""
The number of required arguments to compile this set/specificaiton
"""
return sum([i.true_count for i in self.args if i.required]) return sum([i.true_count for i in self.args if i.required])
def parse_arguments(line, custom_types=None):
args = ArgumentSet(custom_types=custom_types)
data = PARTS_RE.findall(line)
if len(data):
for item in data:
args.append(Argument(item))
return args

61
disco/bot/plugin.py
View File

@ -6,6 +6,10 @@ from disco.bot.command import Command, CommandError
class PluginDeco(object): class PluginDeco(object):
"""
A utility mixin which provides various function decorators that a plugin
author can use to create bound event/command handlers.
"""
@staticmethod @staticmethod
def add_meta_deco(meta): def add_meta_deco(meta):
def deco(f): def deco(f):
@ -19,6 +23,9 @@ class PluginDeco(object):
@classmethod @classmethod
def listen(cls, event_name): def listen(cls, event_name):
"""
Binds the function to listen for a given event name
"""
return cls.add_meta_deco({ return cls.add_meta_deco({
'type': 'listener', 'type': 'listener',
'event_name': event_name, 'event_name': event_name,
@ -26,6 +33,9 @@ class PluginDeco(object):
@classmethod @classmethod
def command(cls, *args, **kwargs): def command(cls, *args, **kwargs):
"""
Creates a new command attached to the function
"""
return cls.add_meta_deco({ return cls.add_meta_deco({
'type': 'command', 'type': 'command',
'args': args, 'args': args,
@ -34,30 +44,53 @@ class PluginDeco(object):
@classmethod @classmethod
def pre_command(cls): def pre_command(cls):
"""
Runs a function before a command is triggered
"""
return cls.add_meta_deco({ return cls.add_meta_deco({
'type': 'pre_command', 'type': 'pre_command',
}) })
@classmethod @classmethod
def post_command(cls): def post_command(cls):
"""
Runs a function after a command is triggered
"""
return cls.add_meta_deco({ return cls.add_meta_deco({
'type': 'post_command', 'type': 'post_command',
}) })
@classmethod @classmethod
def pre_listener(cls): def pre_listener(cls):
"""
Runs a function before a listener is triggered
"""
return cls.add_meta_deco({ return cls.add_meta_deco({
'type': 'pre_listener', 'type': 'pre_listener',
}) })
@classmethod @classmethod
def post_listener(cls): def post_listener(cls):
"""
Runs a function after a listener is triggered
"""
return cls.add_meta_deco({ return cls.add_meta_deco({
'type': 'post_listener', 'type': 'post_listener',
}) })
class Plugin(LoggingClass, PluginDeco): class Plugin(LoggingClass, PluginDeco):
"""
A plugin is a set of listeners/commands which can be loaded/unloaded by a bot.
:param disco.bot.Bot bot: the bot this plugin is loaded under
:param config: a untyped object containing configuration for this plugin
:ivar disco.client.DiscoClient client: an alias to the client
:ivar disco.state.State state: an alias to the client state
:ivar list listeners: all bound listeners for this plugin
:ivar dict commands: all bound commands for this plugin
"""
def __init__(self, bot, config): def __init__(self, bot, config):
super(Plugin, self).__init__() super(Plugin, self).__init__()
self.bot = bot self.bot = bot
@ -83,6 +116,9 @@ class Plugin(LoggingClass, PluginDeco):
self.register_trigger(typ, when, member) self.register_trigger(typ, when, member)
def execute(self, event): def execute(self, event):
"""
Executes a CommandEvent this plugin owns
"""
try: try:
return event.command.execute(event) return event.command.execute(event)
except CommandError as e: except CommandError as e:
@ -90,6 +126,9 @@ class Plugin(LoggingClass, PluginDeco):
return False return False
def register_trigger(self, typ, when, func): def register_trigger(self, typ, when, func):
"""
Registers a trigger
"""
getattr(self, '_' + when)[typ].append(func) getattr(self, '_' + when)[typ].append(func)
def _dispatch(self, typ, func, event, *args, **kwargs): def _dispatch(self, typ, func, event, *args, **kwargs):
@ -107,18 +146,40 @@ class Plugin(LoggingClass, PluginDeco):
return True return True
def register_listener(self, func, name): def register_listener(self, func, name):
"""
Registers a listener
:param func: function to be called
:param name: name of event to listen for
"""
func = functools.partial(self._dispatch, 'listener', func) func = functools.partial(self._dispatch, 'listener', func)
self.listeners.append(self.bot.client.events.on(name, func)) self.listeners.append(self.bot.client.events.on(name, func))
def register_command(self, func, *args, **kwargs): def register_command(self, func, *args, **kwargs):
"""
Registers a command
:param func: function to be called
:param args: args to be passed to the :class:`Command` object
:param kwargs: kwargs to be passed to the :class:`Command` object
"""
wrapped = functools.partial(self._dispatch, 'command', func) wrapped = functools.partial(self._dispatch, 'command', func)
self.commands[func.__name__] = Command(self, wrapped, *args, **kwargs) self.commands[func.__name__] = Command(self, wrapped, *args, **kwargs)
def destroy(self): def destroy(self):
"""
Destroys the plugin (removing all listeners)
"""
map(lambda k: k.remove(), self._events) map(lambda k: k.remove(), self._events)
def load(self): def load(self):
"""
Called when the plugin is loaded
"""
pass pass
def unload(self): def unload(self):
"""
Called when the plugin is unloaded
"""
pass pass

225
docs/Makefile
View File

@ -0,0 +1,225 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " epub3 to make an epub3"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/disco.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/disco.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/disco"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/disco"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: epub3
epub3:
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."

343
docs/conf.py
View File

@ -0,0 +1,343 @@
# -*- coding: utf-8 -*-
#
# disco documentation build configuration file, created by
# sphinx-quickstart on Tue Oct 4 22:15:06 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'disco'
copyright = u'2016, Andrei Zbikowski'
author = u'Andrei Zbikowski'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'0.0.1'
# The full version, including alpha/beta/rc tags.
release = u'0.0.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = u'disco v0.0.1'
# A shorter title for the navigation bar. Default is the same as html_title.
#
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}
# If false, no module index is generated.
#
# html_domain_indices = True
# If false, no index is generated.
#
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'discodoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'disco.tex', u'disco Documentation',
u'Andrei Zbikowski', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False
# If true, show page references after internal links.
#
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#
# latex_appendices = []
# It false, will not define \strong, \code, itleref, \crossref ... but only
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
# packages.
#
# latex_keep_old_macro_names = True
# If false, no module index is generated.
#
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'disco', u'disco Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'disco', u'disco Documentation',
author, 'disco', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []
# If false, no module index is generated.
#
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False

38
docs/disco.api.rst
View File

@ -0,0 +1,38 @@
disco.api package
=================
Submodules
----------
disco.api.client module
-----------------------
.. automodule:: disco.api.client
:members:
:undoc-members:
:show-inheritance:
disco.api.http module
---------------------
.. automodule:: disco.api.http
:members:
:undoc-members:
:show-inheritance:
disco.api.ratelimit module
--------------------------
.. automodule:: disco.api.ratelimit
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: disco.api
:members:
:undoc-members:
:show-inheritance:

46
docs/disco.bot.rst
View File

@ -0,0 +1,46 @@
disco.bot package
=================
Submodules
----------
disco.bot.bot module
--------------------
.. automodule:: disco.bot.bot
:members:
:undoc-members:
:show-inheritance:
disco.bot.command module
------------------------
.. automodule:: disco.bot.command
:members:
:undoc-members:
:show-inheritance:
disco.bot.parser module
-----------------------
.. automodule:: disco.bot.parser
:members:
:undoc-members:
:show-inheritance:
disco.bot.plugin module
-----------------------
.. automodule:: disco.bot.plugin
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: disco.bot
:members:
:undoc-members:
:show-inheritance:

38
docs/disco.gateway.rst
View File

@ -0,0 +1,38 @@
disco.gateway package
=====================
Submodules
----------
disco.gateway.client module
---------------------------
.. automodule:: disco.gateway.client
:members:
:undoc-members:
:show-inheritance:
disco.gateway.events module
---------------------------
.. automodule:: disco.gateway.events
:members:
:undoc-members:
:show-inheritance:
disco.gateway.packets module
----------------------------
.. automodule:: disco.gateway.packets
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: disco.gateway
:members:
:undoc-members:
:show-inheritance:

50
docs/disco.rst
View File

@ -0,0 +1,50 @@
disco package
=============
Subpackages
-----------
.. toctree::
disco.api
disco.bot
disco.gateway
disco.types
disco.util
disco.voice
Submodules
----------
disco.cli module
----------------
.. automodule:: disco.cli
:members:
:undoc-members:
:show-inheritance:
disco.client module
-------------------
.. automodule:: disco.client
:members:
:undoc-members:
:show-inheritance:
disco.state module
------------------
.. automodule:: disco.state
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: disco
:members:
:undoc-members:
:show-inheritance:

78
docs/disco.types.rst
View File

@ -0,0 +1,78 @@
disco.types package
===================
Submodules
----------
disco.types.base module
-----------------------
.. automodule:: disco.types.base
:members:
:undoc-members:
:show-inheritance:
disco.types.channel module
--------------------------
.. automodule:: disco.types.channel
:members:
:undoc-members:
:show-inheritance:
disco.types.guild module
------------------------
.. automodule:: disco.types.guild
:members:
:undoc-members:
:show-inheritance:
disco.types.invite module
-------------------------
.. automodule:: disco.types.invite
:members:
:undoc-members:
:show-inheritance:
disco.types.message module
--------------------------
.. automodule:: disco.types.message
:members:
:undoc-members:
:show-inheritance:
disco.types.permissions module
------------------------------
.. automodule:: disco.types.permissions
:members:
:undoc-members:
:show-inheritance:
disco.types.user module
-----------------------
.. automodule:: disco.types.user
:members:
:undoc-members:
:show-inheritance:
disco.types.voice module
------------------------
.. automodule:: disco.types.voice
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: disco.types
:members:
:undoc-members:
:show-inheritance:

62
docs/disco.util.rst
View File

@ -0,0 +1,62 @@
disco.util package
==================
Submodules
----------
disco.util.cache module
-----------------------
.. automodule:: disco.util.cache
:members:
:undoc-members:
:show-inheritance:
disco.util.json module
----------------------
.. automodule:: disco.util.json
:members:
:undoc-members:
:show-inheritance:
disco.util.logging module
-------------------------
.. automodule:: disco.util.logging
:members:
:undoc-members:
:show-inheritance:
disco.util.token module
-----------------------
.. automodule:: disco.util.token
:members:
:undoc-members:
:show-inheritance:
disco.util.types module
-----------------------
.. automodule:: disco.util.types
:members:
:undoc-members:
:show-inheritance:
disco.util.websocket module
---------------------------
.. automodule:: disco.util.websocket
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: disco.util
:members:
:undoc-members:
:show-inheritance:

30
docs/disco.voice.rst
View File

@ -0,0 +1,30 @@
disco.voice package
===================
Submodules
----------
disco.voice.client module
-------------------------
.. automodule:: disco.voice.client
:members:
:undoc-members:
:show-inheritance:
disco.voice.packets module
--------------------------
.. automodule:: disco.voice.packets
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: disco.voice
:members:
:undoc-members:
:show-inheritance:

22
docs/index.rst
View File

@ -0,0 +1,22 @@
.. disco documentation master file, created by
sphinx-quickstart on Tue Oct 4 22:15:06 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to disco's documentation!
=================================
Contents:
.. toctree::
:maxdepth: 2
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

281
docs/make.bat
View File

@ -0,0 +1,281 @@
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. epub3 to make an epub3
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. xml to make Docutils-native XML files
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
echo. coverage to run coverage check of the documentation if enabled
echo. dummy to check syntax errors of document sources
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
REM Check if sphinx-build is available and fallback to Python version if any
%SPHINXBUILD% 1>NUL 2>NUL
if errorlevel 9009 goto sphinx_python
goto sphinx_ok
:sphinx_python
set SPHINXBUILD=python -m sphinx.__init__
%SPHINXBUILD% 2> nul
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
:sphinx_ok
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\disco.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\disco.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "epub3" (
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %~dp0
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %~dp0
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
if "%1" == "coverage" (
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
if errorlevel 1 exit /b 1
echo.
echo.Testing of coverage in the sources finished, look at the ^
results in %BUILDDIR%/coverage/python.txt.
goto end
)
if "%1" == "xml" (
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The XML files are in %BUILDDIR%/xml.
goto end
)
if "%1" == "pseudoxml" (
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
goto end
)
if "%1" == "dummy" (
%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
if errorlevel 1 exit /b 1
echo.
echo.Build finished. Dummy builder generates no files.
goto end
)
:end

7
docs/modules.rst
View File

@ -0,0 +1,7 @@
disco
=====
.. toctree::
:maxdepth: 4
disco

7
docs/setup.rst
View File

@ -0,0 +1,7 @@
setup module
============
.. automodule:: setup
:members:
:undoc-members:
:show-inheritance:
Write Preview
Loading…
Cancel
Save