mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-11-05 02:29:22 +01:00
314 lines
12 KiB
Python
314 lines
12 KiB
Python
#!/usr/bin/env python3
|
|
|
|
###
|
|
# Copyright (c) 2005, Ali Afshar
|
|
# Copyright (c) 2009, James McCoy
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright notice,
|
|
# this list of conditions, and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions, and the following disclaimer in the
|
|
# documentation and/or other materials provided with the distribution.
|
|
# * Neither the name of the author of this software nor the name of
|
|
# contributors to this software may be used to endorse or promote products
|
|
# derived from this software without specific prior written consent.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
# POSSIBILITY OF SUCH DAMAGE.
|
|
###
|
|
|
|
import os
|
|
import sys
|
|
import shutil
|
|
import string
|
|
|
|
import supybot
|
|
|
|
def error(s):
|
|
sys.stderr.write('%s\n' % s)
|
|
sys.exit(-1)
|
|
|
|
# We need to do this before we import conf.
|
|
if not os.path.exists('doc-conf'):
|
|
os.mkdir('doc-conf')
|
|
|
|
registryFilename = os.path.join('doc-conf', 'doc.conf')
|
|
try:
|
|
fd = open(registryFilename, 'w')
|
|
fd.write("""
|
|
supybot.directories.data: doc-data
|
|
supybot.directories.conf: doc-conf
|
|
supybot.directories.log: doc-logs
|
|
supybot.log.stdout: False
|
|
supybot.log.level: DEBUG
|
|
supybot.log.format: %(levelname)s %(message)s
|
|
supybot.log.plugins.individualLogfiles: False
|
|
supybot.databases: sqlite3 anydbm cdb flat pickle
|
|
""")
|
|
fd.close()
|
|
except EnvironmentError as e:
|
|
error('Unable to open %s for writing.' % registryFilename)
|
|
|
|
import supybot.registry as registry
|
|
registry.open_registry(registryFilename)
|
|
|
|
import supybot.log as log
|
|
import supybot.conf as conf
|
|
conf.supybot.flush.setValue(False)
|
|
|
|
import textwrap
|
|
|
|
import supybot.utils as utils
|
|
import supybot.world as world
|
|
import supybot.plugin as plugin
|
|
import supybot.registry as registry
|
|
|
|
world.documenting = True
|
|
|
|
TITLE_TEMPLATE = 'Documentation for the $name plugin for Supybot'
|
|
|
|
class PluginDoc(object):
|
|
def __init__(self, mod, titleTemplate):
|
|
self.mod = mod
|
|
self.inst = self.mod.Class(None)
|
|
self.name = self.mod.Class.__name__
|
|
self.appendExtraBlankLine = False
|
|
self.titleTemplate = string.Template(titleTemplate)
|
|
self.lines = []
|
|
|
|
def appendLine(self, line, indent=0):
|
|
line = line.strip()
|
|
indent = ' ' * indent
|
|
lines = textwrap.wrap(line, 79,
|
|
initial_indent=indent,
|
|
subsequent_indent=indent)
|
|
self.lines.extend(lines)
|
|
if self.appendExtraBlankLine:
|
|
self.lines.append('')
|
|
|
|
def renderRST(self):
|
|
self.appendExtraBlankLine = False
|
|
self.appendLine('.. _plugin-%s:' % self.name)
|
|
self.lines.append('')
|
|
s = self.titleTemplate.substitute(name=self.name)
|
|
self.appendLine(s)
|
|
self.appendLine('=' * len(s))
|
|
self.lines.append('')
|
|
self.appendLine('Purpose')
|
|
self.appendLine('-------')
|
|
pdoc = getattr(self.mod, '__doc__',
|
|
'My author didn\'t give me a purpose.')
|
|
self.appendLine(pdoc)
|
|
self.lines.append('')
|
|
cdoc = getattr(self.mod.Class, '__doc__', None)
|
|
if cdoc is not None:
|
|
self.appendLine('Usage')
|
|
self.appendLine('-----')
|
|
self.appendLine(cdoc)
|
|
self.lines.append('')
|
|
commands = self.inst.listCommands()
|
|
if len(commands):
|
|
self.appendLine('Commands')
|
|
self.appendLine('--------')
|
|
for command in commands:
|
|
log.debug('command: %s', command)
|
|
line = '%s ' % command
|
|
command = command.split()
|
|
doc = self.inst.getCommandHelp(command)
|
|
if doc:
|
|
doc = doc.replace('\x02', '')
|
|
(args, help) = doc.split(')', 1)
|
|
args = args.split('(', 1)[1]
|
|
args = args[len(' '.join(command)):].strip()
|
|
help = help.split('--', 1)[1].strip()
|
|
self.appendLine(line + args)
|
|
self.appendLine(help, 1)
|
|
else:
|
|
self.appendLine('No help associated with this command')
|
|
self.lines.append('')
|
|
# now the config
|
|
try:
|
|
confs = conf.supybot.plugins.get(self.name)
|
|
self.appendLine('Configuration')
|
|
self.appendLine('-------------')
|
|
except registry.NonExistentRegistryEntry:
|
|
log.info('No configuration for plugin %s', plugin)
|
|
self.appendLine('No configuration for this plugin')
|
|
else:
|
|
for confValues in self.genConfig(confs, 0):
|
|
(name, isChan, isNet, help, default, indent) = confValues
|
|
self.appendLine('%s' % name, indent - 1)
|
|
self.appendLine(
|
|
('This config variable defaults to %s, '
|
|
'is%s network-specific, and is %s channel-specific.')
|
|
% (default, isNet, isChan), indent)
|
|
self.lines.append('')
|
|
self.appendLine(help, indent)
|
|
self.lines.append('')
|
|
return '\n'.join(self.lines) + '\n'
|
|
|
|
def renderSTX(self):
|
|
self.appendExtraBlankLine = True
|
|
self.appendLine(self.titleTemplate.substitute(name=self.name))
|
|
self.appendLine('Purpose', 1)
|
|
pdoc = getattr(self.mod, '__doc__',
|
|
'My author didn\'t give me a purpose.')
|
|
self.appendLine(pdoc, 2)
|
|
cdoc = getattr(self.mod.Class, '__doc__', None)
|
|
if cdoc is not None:
|
|
self.appendLine('Usage', 1)
|
|
self.appendLine(cdoc, 2)
|
|
commands = self.inst.listCommands()
|
|
if len(commands):
|
|
self.appendLine('Commands', 1)
|
|
for command in commands:
|
|
log.debug('command: %s', command)
|
|
line = '* %s ' % command
|
|
command = command.split()
|
|
doc = self.inst.getCommandHelp(command)
|
|
if doc:
|
|
doc = doc.replace('\x02', '')
|
|
(args, help) = doc.split(')', 1)
|
|
args = args.split('(', 1)[1]
|
|
args = args[len(' '.join(command)):].strip()
|
|
help = help.split('--', 1)[1].strip()
|
|
self.appendLine(line + args, 2)
|
|
self.appendLine(help, 3)
|
|
else:
|
|
self.appendLine('No help associated with this command', 3)
|
|
# now the config
|
|
try:
|
|
confs = conf.supybot.plugins.get(self.name)
|
|
self.appendLine('Configuration', 1)
|
|
except registry.NonExistentRegistryEntry:
|
|
log.info('No configuration for plugin %s', plugin)
|
|
self.appendLine('No configuration for this plugin', 2)
|
|
else:
|
|
for confValues in self.genConfig(confs, 2):
|
|
(name, isChan, isNet, help, default, indent) = confValues
|
|
self.appendLine('* %s' % name, indent - 1)
|
|
self.appendLine(
|
|
('This config variable defaults to %s, '
|
|
'is%s network-specific, and is %s channel-specific.')
|
|
% (default, isNet, isChan), indent)
|
|
self.appendLine(help, indent)
|
|
return '\n'.join(self.lines) + '\n'
|
|
|
|
def genConfig(self, item, origindent):
|
|
confVars = item.getValues(getChildren=False, fullNames=False)
|
|
if not confVars:
|
|
return
|
|
for (c, v) in confVars:
|
|
if not isinstance(v, registry.Value):
|
|
# Don't log groups
|
|
continue
|
|
name = v._name
|
|
indent = origindent + 1
|
|
try:
|
|
default = str(v)
|
|
if not isinstance(v._default, str):
|
|
default = utils.str.dqrepr(default)
|
|
help = v.help()
|
|
except registry.NonExistentRegistryEntry:
|
|
pass
|
|
else:
|
|
cv = '' if v._channelValue else ' not'
|
|
nv = '' if v._networkValue else ' not'
|
|
yield (name, cv, nv, help, default, indent)
|
|
for confValues in self.genConfig(v, indent):
|
|
yield confValues
|
|
|
|
def genDoc(m, options):
|
|
Plugin = PluginDoc(m, options.titleTemplate)
|
|
print('Generating documentation for %s...' % Plugin.name)
|
|
path = os.path.join(options.outputDir, '%s.%s' % (Plugin.name,
|
|
options.format))
|
|
try:
|
|
fd = open(path, 'w')
|
|
except EnvironmentError as e:
|
|
error('Unable to open %s for writing.' % path)
|
|
f = getattr(Plugin, 'render%s' % options.format.upper(), None)
|
|
if f is None:
|
|
fd.close()
|
|
error('Unknown render format: `%s\'' % options.format)
|
|
try:
|
|
fd.write(f())
|
|
finally:
|
|
fd.close()
|
|
|
|
if __name__ == '__main__':
|
|
import glob
|
|
import os.path
|
|
import optparse
|
|
import supybot.plugin as plugin
|
|
|
|
parser = optparse.OptionParser(usage='Usage: %prog [options] [plugins]',
|
|
version='Supybot %s' % conf.version)
|
|
parser.add_option('-c', '--clean', action='store_true', default=False,
|
|
dest='clean', help='Cleans the various data/conf/logs '
|
|
'directories after generating the docs.')
|
|
parser.add_option('-o', '--output-dir', dest='outputDir', default='.',
|
|
help='Specifies the directory in which to write the '
|
|
'documentation for the plugin.')
|
|
parser.add_option('-f', '--format', dest='format', choices=['rst', 'stx'],
|
|
default='stx', help='Specifies which output format to '
|
|
'use.')
|
|
parser.add_option('--plugins-dir',
|
|
action='append', dest='pluginsDirs', default=[],
|
|
help='Looks in in the given directory for plugins and '
|
|
'generates documentation for all of them.')
|
|
parser.add_option('--title-template',
|
|
default=TITLE_TEMPLATE, dest='titleTemplate',
|
|
help='Template string for the title of generated files')
|
|
(options, args) = parser.parse_args()
|
|
|
|
# This must go before checking for args, of course.
|
|
for pluginDir in options.pluginsDirs:
|
|
for name in glob.glob(os.path.join(pluginDir, '*')):
|
|
if os.path.isdir(name):
|
|
args.append(name)
|
|
|
|
if not args:
|
|
parser.print_help()
|
|
sys.exit(-1)
|
|
|
|
args = [s.rstrip('\\/') for s in args]
|
|
pluginDirs = set([os.path.dirname(s) or '.' for s in args])
|
|
conf.supybot.directories.plugins.setValue(list(pluginDirs))
|
|
pluginNames = set([os.path.basename(s) for s in args])
|
|
plugins = set([])
|
|
for pluginName in pluginNames:
|
|
if pluginName.endswith('.py'):
|
|
pluginName = pluginName[:-3]
|
|
try:
|
|
pluginModule = plugin.loadPluginModule(pluginName)
|
|
except ImportError as e:
|
|
s = 'Failed to load plugin %s: %s\n' \
|
|
'%s(pluginDirs: %s)' % (pluginName, e, s,
|
|
conf.supybot.directories.plugins())
|
|
error(s)
|
|
plugins.add(pluginModule)
|
|
|
|
for Plugin in plugins:
|
|
genDoc(Plugin, options)
|
|
|
|
if options.clean:
|
|
shutil.rmtree(conf.supybot.directories.log())
|
|
shutil.rmtree(conf.supybot.directories.conf())
|
|
shutil.rmtree(conf.supybot.directories.data())
|
|
|
|
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=78:
|