aboutsummaryrefslogtreecommitdiffstats
path: root/lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/lore/scripts/lore.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/lore/scripts/lore.py')
-rwxr-xr-xlib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/lore/scripts/lore.py155
1 files changed, 0 insertions, 155 deletions
diff --git a/lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/lore/scripts/lore.py b/lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/lore/scripts/lore.py
deleted file mode 100755
index c82b2c69..00000000
--- a/lib/python2.7/site-packages/Twisted-12.2.0-py2.7-linux-x86_64.egg/twisted/lore/scripts/lore.py
+++ /dev/null
@@ -1,155 +0,0 @@
-# Copyright (c) Twisted Matrix Laboratories.
-# See LICENSE for details.
-
-import sys
-
-from zope.interface import Interface, Attribute
-
-from twisted.lore import process, indexer, numberer, htmlbook
-
-from twisted.python import usage, reflect
-from twisted import plugin as plugin
-
-class IProcessor(Interface):
- """
- """
-
- name = Attribute("The user-facing name of this processor")
-
- moduleName = Attribute(
- "The fully qualified Python name of the object defining "
- "this processor. This object (typically a module) should "
- "have a C{factory} attribute with C{generate_<output>} methods.")
-
-
-class Options(usage.Options):
-
- longdesc = "lore converts documentation formats."
-
- optFlags = [["plain", 'p', "Report filenames without progress bar"],
- ["null", 'n', "Do not report filenames"],
- ["number", 'N', "Add chapter/section numbers to section headings"],
-]
-
- optParameters = [
- ["input", "i", 'lore'],
- ["inputext", "e", ".xhtml", "The extension that your Lore input files have"],
- ["docsdir", "d", None],
- ["linkrel", "l", ''],
- ["output", "o", 'html'],
- ["index", "x", None, "The base filename you want to give your index file"],
- ["book", "b", None, "The book file to generate a book from"],
- ["prefixurl", None, "", "The prefix to stick on to relative links; only useful when processing directories"],
- ]
-
- compData = usage.Completions(
- extraActions=[usage.CompleteFiles(descr="files", repeat=True)])
-
- def __init__(self, *args, **kw):
- usage.Options.__init__(self, *args, **kw)
- self.config = {}
-
- def opt_config(self, s):
- if '=' in s:
- k, v = s.split('=', 1)
- self.config[k] = v
- else:
- self.config[s] = 1
-
- def parseArgs(self, *files):
- self['files'] = files
-
-
-def getProcessor(input, output, config):
- plugins = plugin.getPlugins(IProcessor)
- for plug in plugins:
- if plug.name == input:
- module = reflect.namedModule(plug.moduleName)
- break
- else:
- # try treating it as a module name
- try:
- module = reflect.namedModule(input)
- except ImportError:
- print '%s: no such input: %s' % (sys.argv[0], input)
- return
- try:
- return process.getProcessor(module, output, config)
- except process.NoProcessorError, e:
- print "%s: %s" % (sys.argv[0], e)
-
-
-def getWalker(df, opt):
- klass = process.Walker
- if opt['plain']:
- klass = process.PlainReportingWalker
- if opt['null']:
- klass = process.NullReportingWalker
- return klass(df, opt['inputext'], opt['linkrel'])
-
-
-def runGivenOptions(opt):
- """Do everything but parse the options; useful for testing.
- Returns a descriptive string if there's an error."""
-
- book = None
- if opt['book']:
- book = htmlbook.Book(opt['book'])
-
- df = getProcessor(opt['input'], opt['output'], opt.config)
- if not df:
- return 'getProcessor() failed'
-
- walker = getWalker(df, opt)
-
- if opt['files']:
- for filename in opt['files']:
- walker.walked.append(('', filename))
- elif book:
- for filename in book.getFiles():
- walker.walked.append(('', filename))
- else:
- walker.walkdir(opt['docsdir'] or '.', opt['prefixurl'])
-
- if opt['index']:
- indexFilename = opt['index']
- elif book:
- indexFilename = book.getIndexFilename()
- else:
- indexFilename = None
-
- if indexFilename:
- indexer.setIndexFilename("%s.%s" % (indexFilename, opt['output']))
- else:
- indexer.setIndexFilename(None)
-
- ## TODO: get numberSections from book, if any
- numberer.setNumberSections(opt['number'])
-
- walker.generate()
-
- if walker.failures:
- for (file, errors) in walker.failures:
- for error in errors:
- print "%s:%s" % (file, error)
- return 'Walker failures'
-
-
-def run():
- opt = Options()
- try:
- opt.parseOptions()
- except usage.UsageError, errortext:
- print '%s: %s' % (sys.argv[0], errortext)
- print '%s: Try --help for usage details.' % sys.argv[0]
- sys.exit(1)
-
- result = runGivenOptions(opt)
- if result:
- print result
- sys.exit(1)
-
-
-if __name__ == '__main__':
- run()
-