API Reference for Enthought Tool Suite 3.0.1

Variables

• logger

  Globals

  logger = logging.getLogger(__name__)
  
  

Function summary

• find_functions(package, import_method = False)
• find_functions_ast(package)
• find_functions_import(package)
• find_functions_import_recurse(module_name)
• find_package_sub_modules(package, recurse = True)
• find_path_sub_modules(path, recurse = True)
• get_module_path(module_name)
• is_module(module_name)
• is_package(module_name)
• normalize_path_separator(file_path)
• python_path_from_file_path(package, file_path, package_path = None)
• visit_ast_node(node, path, python_path)

Functions

• find_functions(package, import_method = False)

  Recursively find all the functions in a package or module.

  By default, find_functions searches for functions by "scanning" the code for function definitions. It does this by using Python's AST. This prevents python from loading all of the modules into memory, but it also can miss some functions. Setting import_method=True will actually import the modules in its search and may find functions that are not found using the other method.

  Parameters

  package: str

  A string such as 'foo.bar' that specifies the package to search. The package must be on the python path.

  import_method: bool

  Default is False. When True, modules are imported when searching for functions.

  Returns

  functions: list of tuples

  A list of tuples with (module, name). module is a string for specifying the python module and the function name. For example function 'foo.bar' would be returned as ('foo','bar')

• find_functions_ast(package)

  Find functions by traversing an abstract syntax tree generated by the compiler module. fixme: expand docstring, possibly provide response about non-existant modules/packages

• find_functions_import(package)

  Find functions using an import statement. Sloppier and consumes more memory than find_functions_ast, but also get submodules of the modules, which the ast method cannot do. For example, giving it 'os', it would also find functions from os.path. It also follows import statements in the files, which may or may not be desirable.

• find_functions_import_recurse(module_name)

  Search a module and all the modules within it for functions.

  The function imports the module and searches its __dict__ for functions. It also search any module found within the module for functions.

• find_package_sub_modules(package, recurse = True)

  Return a list of python modules (.py files) in a package.

• find_path_sub_modules(path, recurse = True)

  Return a list of python modules (.py files) in a directory. If an __init__.py file is not present, do not look in the directory.

• get_module_path(module_name)

  Given a module, get an absolute path to it.

  pkgutil, instead of imp, is used for 2 reasons:

  • pkgutil works with dotted names
  • pkgutil works with eggs

  There are a couple of downsides, the methods we use are not documented and the method was added in python 2.5. For convenience, _pkgutil is used instread, which is copied from Python 2.5 to support Python 2.4.

• is_module(module_name)

  Return whether the given module name is a module.

• is_package(module_name)

  Return whether the given module name is a package.

  This function will search the standard python path for the module. If it is defined as an __init__.py, we return True. Otherwise False.

• normalize_path_separator(file_path)

  Ensure the file path uses the platform's directory separator.

• python_path_from_file_path(package, file_path, package_path = None)

  Given a package/module name and the absolute path to a python file, return a path in the form that python can understand (ie one that could be specified in an import statement) package_path can be optionally specified to give the file path to the package. This is automatically determined if not specified, but as determining this is an expensive operation, it is best to calculate this outside the function if one will be looking up many functions in the same module.

• visit_ast_node(node, path, python_path)

  Given a and _ast node produced by 'compile' with the _ast.PyCF_ONLY_AST flag, returns a list of CallableObjects s from that node's toplevel functions.

Imported Names

© Copyright 2002-2008 Enthought, Inc.