/usr/lib/python3/dist-packages/sphinxcontrib/autoprogram.py is in python3-sphinxcontrib.autoprogram 0.1.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 | """
sphinxcontrib.autoprogram
~~~~~~~~~~~~~~~~~~~~~~~~~
Documenting CLI programs.
:copyright: Copyright 2014 by Hong Minhee
:license: BSD, see LICENSE for details.
"""
# pylint: disable=protected-access,missing-docstring
import argparse
import collections
try:
import builtins
except ImportError:
import __builtin__ as builtins
import functools
import re
import unittest
import six
from docutils import nodes
from docutils.parsers.rst.directives import unchanged
from docutils.statemachine import ViewList
from sphinx.util.compat import Directive
from sphinx.util.nodes import nested_parse_with_titles
from sphinx.domains import std
__all__ = ('BOOLEAN_OPTIONS', 'AutoprogramDirective', 'ScannerTestCase',
'import_object', 'scan_programs', 'setup', 'suite')
def scan_programs(parser, command=[]):
options = []
for arg in parser._actions:
if not (arg.option_strings or
isinstance(arg, argparse._SubParsersAction)):
name = (arg.metavar or arg.dest).lower()
desc = (arg.help or '') % {'default': arg.default}
options.append(([name], desc))
for arg in parser._actions:
if arg.option_strings:
if isinstance(arg, (argparse._StoreAction,
argparse._AppendAction)):
if arg.choices is None:
metavar = (arg.metavar or arg.dest).lower()
names = ['{0} <{1}>'.format(option_string, metavar)
for option_string in arg.option_strings]
else:
choices = '{0}'.format(','.join(arg.choices))
names = ['{0} {{{1}}}'.format(option_string, choices)
for option_string in arg.option_strings]
else:
names = list(arg.option_strings)
desc = (arg.help or '') % {'default': arg.default}
options.append((names, desc))
yield command, options, parser.description, parser.epilog or ''
if parser._subparsers:
choices = parser._subparsers._actions[-1].choices.items()
if not (hasattr(collections, 'OrderedDict') and
isinstance(choices, collections.OrderedDict)):
choices = sorted(choices, key=lambda pair: pair[0])
for cmd, sub in choices:
if isinstance(sub, argparse.ArgumentParser):
for program in scan_programs(sub, command + [cmd]):
yield program
def import_object(import_name):
module_name, expr = import_name.split(':', 1)
try:
mod = __import__(module_name)
except ImportError:
# This happens if the file is a script with no .py extension. Here we
# trick autoprogram to load a module in memory with the contents of
# the script, if there is a script named module_name. Otherwise, raise
# an ImportError as it did before.
import glob
import sys
import os
import imp
for p in sys.path:
f = glob.glob(os.path.join(p, module_name))
if len(f) > 0:
with open(f[0]) as fobj:
codestring = fobj.read()
foo = imp.new_module("foo")
six.exec_(codestring, foo.__dict__)
sys.modules["foo"] = foo
mod = __import__("foo")
break
else:
raise ImportError("No module named {}".format(module_name))
reduce_ = getattr(functools, 'reduce', None) or reduce
mod = reduce_(getattr, module_name.split('.')[1:], mod)
globals_ = builtins
if not isinstance(globals_, dict):
globals_ = globals_.__dict__
return eval(expr, globals_, mod.__dict__)
class AutoprogramDirective(Directive):
has_content = False
required_arguments = 1
option_spec = {'prog': unchanged}
def make_rst(self):
import_name, = self.arguments
parser = import_object(import_name or '__undefined__')
parser.prog = self.options.get('prog', parser.prog)
for commands, options, desc, epilog in scan_programs(parser):
command = ' '.join(commands)
title = '{0} {1}'.format(parser.prog, command).rstrip()
yield ''
yield '.. program:: ' + title
yield ''
yield title
yield ('!' if commands else '?') * len(title)
yield ''
yield desc or ''
yield ''
yield parser.format_usage()
yield ''
for option_strings, help_ in options:
yield '.. option:: {0}'.format(', '.join(option_strings))
yield ''
yield ' ' + help_.replace('\n', ' \n')
yield ''
yield ''
for line in epilog.splitlines():
yield line or ''
def run(self):
node = nodes.section()
node.document = self.state.document
result = ViewList()
for line in self.make_rst():
result.append(line, '<autoprogram>')
nested_parse_with_titles(self.state, result, node)
return node.children
def patch_option_role_to_allow_argument_form():
"""Before Sphinx 1.2.2, :rst:dir:`.. option::` directive hadn't
allowed to not start with a dash or slash, so it hadn't been possible
to represent positional arguments (not options).
https://bitbucket.org/birkenfeld/sphinx/issue/1357/
It monkeypatches the :rst:dir:`.. option::` directive's behavior.
"""
std.option_desc_re = re.compile(r'((?:/|-|--)?[-_a-zA-Z0-9]+)(\s*.*)')
def setup(app):
app.add_directive('autoprogram', AutoprogramDirective)
patch_option_role_to_allow_argument_form()
class ScannerTestCase(unittest.TestCase):
def test_simple_parser(self):
parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='*',
help='an integer for the accumulator')
parser.add_argument('-i', '--identity', type=int, default=0,
help='the default result for no arguments '
'(default: 0)')
parser.add_argument('--sum', dest='accumulate', action='store_const',
const=sum, default=max,
help='sum the integers (default: find the max)')
programs = scan_programs(parser)
programs = list(programs)
self.assertEqual(1, len(programs))
parser_info, = programs
program, options, desc, _ = parser_info
self.assertEqual([], program)
self.assertEqual('Process some integers.', desc)
self.assertEqual(4, len(options))
self.assertEqual(
(['n'], 'an integer for the accumulator'),
options[0]
)
self.assertEqual(
(['-h', '--help'], 'show this help message and exit'),
options[1]
)
self.assertEqual(
(['-i <identity>', '--identity <identity>'],
'the default result for no arguments (default: 0)'),
options[2]
)
self.assertEqual(
(['--sum'], 'sum the integers (default: find the max)'),
options[3]
)
def test_subcommands(self):
parser = argparse.ArgumentParser(description='Process some integers.')
subparsers = parser.add_subparsers()
max_parser = subparsers.add_parser('max', description='Find the max.')
max_parser.set_defaults(accumulate=max)
max_parser.add_argument('integers', metavar='N', type=int, nargs='+',
help='An integer for the accumulator.')
sum_parser = subparsers.add_parser('sum',
description='Sum the integers.')
sum_parser.set_defaults(accumulate=sum)
sum_parser.add_argument('integers', metavar='N', type=int, nargs='+',
help='An integer for the accumulator.')
programs = scan_programs(parser)
programs = list(programs)
self.assertEqual(3, len(programs))
# main
program, options, desc, _ = programs[0]
self.assertEqual([], program)
self.assertEqual('Process some integers.', desc)
self.assertEqual(1, len(options))
self.assertEqual(
(['-h', '--help'],
'show this help message and exit'),
options[0]
)
# max
program, options, desc, _ = programs[1]
self.assertEqual(['max'], program)
self.assertEqual('Find the max.', desc)
self.assertEqual(2, len(options))
self.assertEqual((['n'], 'An integer for the accumulator.'),
options[0])
self.assertEqual(
(['-h', '--help'],
'show this help message and exit'),
options[1]
)
# sum
program, options, desc, _ = programs[2]
self.assertEqual(['sum'], program)
self.assertEqual('Sum the integers.', desc)
self.assertEqual(2, len(options))
self.assertEqual((['n'], 'An integer for the accumulator.'),
options[0])
def test_choices(self):
parser = argparse.ArgumentParser()
parser.add_argument("--awesomeness", choices=["meh", "awesome"])
program, options, desc, _ = list(scan_programs(parser))[0]
log_option = options[1]
self.assertEqual((["--awesomeness {meh,awesome}"], ''), log_option)
def test_parse_epilog(self):
parser = argparse.ArgumentParser(
description='Process some integers.',
epilog='The integers will be processed.'
)
programs = scan_programs(parser)
programs = list(programs)
self.assertEqual(1, len(programs))
parser_data, = programs
program, options, desc, epilog = parser_data
self.assertEqual('The integers will be processed.', epilog)
class UtilTestCase(unittest.TestCase):
def test_import_object(self):
cls = import_object('sphinxcontrib.autoprogram:UtilTestCase')
self.assertTrue(cls is UtilTestCase)
instance = import_object(
'sphinxcontrib.autoprogram:UtilTestCase("test_import_object")'
)
self.assertIsInstance(instance, UtilTestCase)
if not hasattr(unittest.TestCase, 'assertIsInstance'):
def assertIsInstance(self, instance, cls):
self.assertTrue(isinstance(instance, cls),
'{0!r} is not an instance of {1.__module__}.'
'{1.__name__}'.format(instance, cls))
suite = unittest.TestSuite()
suite.addTests(
unittest.defaultTestLoader.loadTestsFromTestCase(ScannerTestCase)
)
suite.addTests(unittest.defaultTestLoader.loadTestsFromTestCase(UtilTestCase))
|