API Reference for Enthought Tool Suite 2.7.1

Function summary

• class_link(obj)
• encode_entities(s)
• fix_indent(docstring)
• format_params(argnames, defaults, context)
• hierarchicalize_modules(module_list)
• object_link(obj)
• unparse(e, context = None, trait_mode = False)

Functions

• class_link(obj)

  return a URL linking to the class page for obj

• encode_entities(s)

  returns s, with <, >, and & replaced with proper XML entities

• fix_indent(docstring)

  Some docstrings are formatted like this one.

  This function removes the common indentation from all lines but the first.

• format_params(argnames, defaults, context)

  Format parameter list

  • argnames : list of argument names (from AST)
  • defaults : list of defaults (from AST)
  • context : namespace.Namespace instance for linking names encountered

  Returns a string with parameters joined with commas

• hierarchicalize_modules(module_list)

  Generate module hierarchy from list

  returns [ ((top_module, [ (submodule1, [ submodule1_1, ...]),
                          (submodule2, [ ... ]), ... ]),
            number_of_modules_read_from_list),
            ((top_module2, [ ... ]),
            number_of_modules_read_form_list)
          ]
  

• object_link(obj)

  return a URL linking to the documentation for obj

• unparse(e, context = None, trait_mode = False)

  Unparse an AST node to text

  • e is an AST expression
  • context (optional) is a namespace for resolving (+ linking) identifiers
  • trait_mode is True if resolved identifiers inside strings should be linked

Imported Names

Copyright © 2002-2008 Enthought, Inc.