def test_synopsis_sourceless_empty_doc(self):
with test.support.temp_cwd() as test_dir:
init_path = os.path.join(test_dir, 'foomod42.py')
cached_path = importlib.util.cache_from_source(init_path)
with open(init_path, 'w') as fobj:
fobj.write("foo = 1")
py_compile.compile(init_path)
synopsis = pydoc.synopsis(init_path, {})
self.assertIsNone(synopsis)
synopsis_cached = pydoc.synopsis(cached_path, {})
self.assertIsNone(synopsis_cached)
def test_synopsis_sourceless_empty_doc(self):
with test.test_support.temp_cwd() as test_dir:
init_path = os.path.join(test_dir, "foomod42.py")
cached_path = os.path.join(test_dir, "foomod42.pyc")
with open(init_path, "w") as fobj:
fobj.write("foo = 1")
py_compile.compile(init_path)
synopsis = pydoc.synopsis(init_path, {})
self.assertIsNone(synopsis)
synopsis_cached = pydoc.synopsis(cached_path, {})
self.assertIsNone(synopsis_cached)
def test_synopsis_sourceless_empty_doc(self):
with test.support.temp_cwd() as test_dir:
init_path = os.path.join(test_dir, 'foomod42.py')
cached_path = importlib.util.cache_from_source(init_path)
with open(init_path, 'w') as fobj:
fobj.write("foo = 1")
py_compile.compile(init_path)
synopsis = pydoc.synopsis(init_path, {})
self.assertIsNone(synopsis)
synopsis_cached = pydoc.synopsis(cached_path, {})
self.assertIsNone(synopsis_cached)
def extract(filenames, verbose, rest, title, outfile):
"""Modify or replace this function for your own needs.
"""
if rest:
titlelen = len(title)
print >> outfile, '=' * titlelen
print >> outfile, title
print >> outfile, '=' * titlelen
module_list = []
for filename in filenames:
if verbose:
print 'adding file: %s' % (filename, )
modname = os.path.splitext(os.path.split(filename)[1])[0]
modname = os.path.split(filename)[1]
synopsis = pydoc.synopsis(modname)
if rest:
module_list.append(modname)
print >> outfile
s1 = '- `%s <%s>`_ (`%s.html <%s.html>`_, ' + \
'`%s.pdf <%s.pdf>`_) -- %s' % (
modname, modname,
modname, modname,
modname, modname,
synopsis, )
print >> outfile, s1
else:
print >> outfile, '--'
print >> outfile, '%s' % modname
print >> outfile, synopsis
print
def shortusage():
print(pydoc.synopsis(sys.argv[0]))
print("""
For simple text summary:
find-fix.py [options] query-set-1.tsv YYYY-MM-DD YYYY-MM-DD
For gnuplot presentation:
find-fix.py [options] query-set-1.tsv outfile
""")
def shortusage():
print(pydoc.synopsis(sys.argv[0]))
print("""
For simple text summary:
find-fix.py [options] query-set-1.tsv YYYY-MM-DD YYYY-MM-DD
For gnuplot presentation:
find-fix.py [options] query-set-1.tsv outfile
""")
def test_synopsis(self):
self.addCleanup(unlink, TESTFN)
for encoding in ("ISO-8859-1", "UTF-8"):
with open(TESTFN, "w", encoding=encoding) as script:
if encoding != "UTF-8":
print("#coding: {}".format(encoding), file=script)
print('"""line 1: h\xe9', file=script)
print('line 2: hi"""', file=script)
synopsis = pydoc.synopsis(TESTFN, {})
self.assertEqual(synopsis, "line 1: h\xe9")
def test_synopsis(self):
self.addCleanup(unlink, TESTFN)
for encoding in ('ISO-8859-1', 'UTF-8'):
with open(TESTFN, 'w', encoding=encoding) as script:
if encoding != 'UTF-8':
print('#coding: {}'.format(encoding), file=script)
print('"""line 1: h\xe9', file=script)
print('line 2: hi"""', file=script)
synopsis = pydoc.synopsis(TESTFN, {})
self.assertEqual(synopsis, 'line 1: h\xe9')
def test_synopsis(self):
self.addCleanup(unlink, TESTFN)
for encoding in ('ISO-8859-1', 'UTF-8'):
with open(TESTFN, 'w', encoding=encoding) as script:
if encoding != 'UTF-8':
print('#coding: {}'.format(encoding), file=script)
print('"""line 1: h\xe9', file=script)
print('line 2: hi"""', file=script)
synopsis = pydoc.synopsis(TESTFN, {})
self.assertEqual(synopsis, 'line 1: h\xe9')
def test_synopsis(self):
with test.test_support.temp_cwd() as test_dir:
init_path = os.path.join(test_dir, 'dt.py')
with open(init_path, 'w') as fobj:
fobj.write('''\
"""
my doc
second line
"""
foo = 1
''')
py_compile.compile(init_path)
synopsis = pydoc.synopsis(init_path, {})
self.assertEqual(synopsis, 'my doc')
def test_synopsis(self):
with test.test_support.temp_cwd() as test_dir:
init_path = os.path.join(test_dir, 'dt.py')
with open(init_path, 'w') as fobj:
fobj.write('''\
"""
my doc
second line
"""
foo = 1
''')
py_compile.compile(init_path)
synopsis = pydoc.synopsis(init_path, {})
self.assertEqual(synopsis, 'my doc')
def run(self, callback, key=None, completer=None):
if key: key = lower(key)
self.quit = False
seen = {}
for modname in sys.builtin_module_names:
if modname != '__main__':
seen[modname] = 1
if key is None:
callback(None, modname, '')
else:
desc = split(__import__(modname).__doc__ or '', '\n')[0]
if key in lower('%s - %s' % (modname, desc)):
callback(None, modname, desc)
while not self.quit:
node = self.next()
if not node: break
path, package = node
path_parts = split(path, os.sep)
build_path = ''
found_package_info = False
for path in path_parts:
if path.endswith(':'): path = os.path.join(path, os.sep)
build_path = os.path.join(build_path, path)
if os.path.exists(
os.path.join(build_path, 'opus_package_info.py')):
found_package_info = True
break
if not found_package_info: continue
modname = inspect.getmodulename(path)
if os.path.isfile(path) and modname:
modname = package + (package and '.') + modname
if not modname in seen:
seen[modname] = 1 # if we see spam.py, skip spam.pyc
if key is None:
callback(path, modname, '')
else:
desc = synopsis(path) or ''
if key in lower('%s - %s' % (modname, desc)):
callback(path, modname, desc)
if completer: completer()
def run(self, callback, key=None, completer=None):
if key: key = lower(key)
self.quit = False
seen = {}
for modname in sys.builtin_module_names:
if modname != '__main__':
seen[modname] = 1
if key is None:
callback(None, modname, '')
else:
desc = split(__import__(modname).__doc__ or '', '\n')[0]
if key in lower('%s - %s' % (modname, desc)):
callback(None, modname, desc)
while not self.quit:
node = self.next()
if not node: break
path, package = node
path_parts = split(path, os.sep)
build_path = ''
found_package_info = False
for path in path_parts:
if path.endswith(':'): path = os.path.join(path, os.sep)
build_path = os.path.join(build_path, path)
if os.path.exists(os.path.join(build_path, 'opus_package_info.py')):
found_package_info = True
break
if not found_package_info: continue
modname = inspect.getmodulename(path)
if os.path.isfile(path) and modname:
modname = package + (package and '.') + modname
if not modname in seen:
seen[modname] = 1 # if we see spam.py, skip spam.pyc
if key is None:
callback(path, modname, '')
else:
desc = synopsis(path) or ''
if key in lower('%s - %s' % (modname, desc)):
callback(path, modname, desc)
if completer: completer()
def shortusage():
print pydoc.synopsis(sys.argv[0])
print """
def test_synopsis_sourceless(self):
expected = os.__doc__.splitlines()[0]
filename = os.__cached__
synopsis = pydoc.synopsis(filename)
self.assertEqual(synopsis, expected)
def shortusage():
"Print one-line usage summary."
print("%s - %s" % (me, pydoc.synopsis(sys.argv[0])))
def update_event(self, inp=-1):
self.set_output_val(0, pydoc.synopsis(self.input(0), self.input(1)))
def shortusage():
"Print one-line usage summary."
print("%s - %s" % (me, pydoc.synopsis(sys.argv[0])))
def test_synopsis_sourceless(self):
expected = os.__doc__.splitlines()[0]
filename = os.__cached__
synopsis = pydoc.synopsis(filename)
self.assertEqual(synopsis, expected)
def shortusage(): print pydoc.synopsis(sys.argv[0]) print """
