def docstring(obj_name, globs, system='sage'):
r"""
Format an object's docstring to process and display in the FEMhub
notebook.
INPUT:
- ``obj_name`` - a string; a name of an object
- ``globs`` - a string:object dictionary; a context in which to
evaluate ``obj_name``
- ``system`` - a string (default: 'sage'); the system to which to
confine the search
OUTPUT:
- a string containing the object's file, type, definition, and
docstring or a message stating the object is not defined
AUTHORS:
- William Stein: partly taken from IPython for use in FEMhub
- Nick Alexander: extensions
"""
if system not in ['sage', 'python']:
obj_name = system + '.' + obj_name
try:
obj = eval(obj_name, globs)
except (AttributeError, NameError, SyntaxError):
return "No object '%s' currently defined."%obj_name
s = ''
newline = "\n\n" # blank line to start new paragraph
try:
filename = sageinspect.sage_getfile(obj)
#i = filename.find('site-packages/sage/')
#if i == -1:
s += '**File:** %s'%filename
s += newline
#else:
# file = filename[i+len('site-packages/sage/'):]
# s += 'File: <html><a href="src_browser?%s">%s</a></html>\n'%(file,file)
except TypeError:
pass
s += '**Type:** %s'%type(obj)
s += newline
s += '**Definition:** %s'%sageinspect.sage_getdef(obj, obj_name)
s += newline
s += '**Docstring:**'
s += newline
s += sageinspect.sage_getdoc(obj, obj_name)
s = s.rstrip()
return html_markup(s)
def my_getdoc(obj):
try:
ds = obj._sage_doc_()
except (AttributeError, TypeError): # TypeError for interfaces
try:
ds = sageinspect.sage_getdoc(obj)
except:
return None
if ds is None:
return None
return sagedoc.format(ds)
def docstring(obj_name, globs, system='sage'):
r"""
Format an object's docstring to process and display in the Sage
notebook.
INPUT:
- ``obj_name`` - a string; a name of an object
- ``globs`` - a string:object dictionary; a context in which to
evaluate ``obj_name``
- ``system`` - a string (default: 'sage'); the system to which to
confine the search
OUTPUT:
- a string containing the object's file, type, definition, and
docstring or a message stating the object is not defined
AUTHORS:
- William Stein: partly taken from IPython for use in Sage
- Nick Alexander: extensions
"""
if system not in ['sage', 'python']:
obj_name = system + '.' + obj_name
try:
obj = eval(obj_name, globs)
except (AttributeError, NameError, SyntaxError):
return "No object '%s' currently defined." % obj_name
s = ''
newline = "\n\n" # blank line to start new paragraph
try:
filename = sageinspect.sage_getfile(obj)
#i = filename.find('site-packages/sage/')
#if i == -1:
s += '**File:** %s' % filename
s += newline
#else:
# file = filename[i+len('site-packages/sage/'):]
# s += 'File: <html><a href="src_browser?%s">%s</a></html>\n'%(file,file)
except TypeError:
pass
s += '**Type:** %s' % type(obj)
s += newline
s += '**Definition:** %s' % sageinspect.sage_getdef(obj, obj_name)
s += newline
s += '**Docstring:**'
s += newline
s += sageinspect.sage_getdoc(obj, obj_name)
s = s.rstrip()
return html_markup(s)
def my_getdoc(obj):
try:
ds = obj._sage_doc_()
except (AttributeError, TypeError): # TypeError for interfaces
try:
ds = sageinspect.sage_getdoc(obj)
except:
return None
if ds is None:
return None
return sagedoc.format(ds)
def docstring(obj_name, globs, system="sage"):
r"""
Format an object's docstring to process and display in the Sage
notebook.
INPUT:
- ``obj_name`` - a string; a name of an object
- ``globs`` - a string:object dictionary; a context in which to
evaluate ``obj_name``
- ``system`` - a string (default: 'sage'); the system to which to
confine the search
OUTPUT:
- a string containing the object's file, type, definition, and
docstring or a message stating the object is not defined
AUTHORS:
- William Stein: partly taken from IPython for use in Sage
- Nick Alexander: extensions
TESTS:
Check that Trac 10860 is fixed and we can handle Unicode help
strings in the notebook::
sage: from sagenb.misc.support import docstring
sage: D = docstring("r.lm", globs=globals())
"""
if system not in ["sage", "python"]:
obj_name = system + "." + obj_name
try:
obj = eval(obj_name, globs)
except (AttributeError, NameError, SyntaxError):
return "No object '%s' currently defined." % obj_name
s = ""
newline = "\n\n" # blank line to start new paragraph
try:
filename = sageinspect.sage_getfile(obj)
# i = filename.find('site-packages/sage/')
# if i == -1:
s += "**File:** %s" % filename
s += newline
# else:
# file = filename[i+len('site-packages/sage/'):]
# s += 'File: <html><a href="src_browser?%s">%s</a></html>\n'%(file,file)
except TypeError:
pass
s += "**Type:** %s" % type(obj)
s += newline
s += "**Definition:** %s" % sageinspect.sage_getdef(obj, obj_name)
s += newline
s += "**Docstring:**"
s += newline
s += sageinspect.sage_getdoc(obj, obj_name)
s = s.rstrip()
return html_markup(s.decode("utf-8"))
