API Reference for Enthought Tool Suite 3.2.0

Variables

• KW_ARGS

  KW_ARGS = 8
  
  

• VAR_ARGS

  Flags for func_code.co_flags that indicate whether we have a variable number of arguments or keyword arguments for the function.

  VAR_ARGS = 4
  
  

Classes

• FunctionCallWalker - Collects binding information from the CallFunc
• LocalDefinitionsWalker
• ReturnVariablesFinder - AST Visitor Class for finding the return_vals from a function

Function summary

• find_function_node(func_ast, check_name)
• find_local_defs(ast)
• function_arguments_from_ast(ast)
• function_arguments_from_function(func)
• function_inputs_from_call_ast(ast, info = None)
• function_returns_from_ast(ast)
• function_returns_from_code(code)
• function_returns_from_function(func)
• outputs_from_function_ast(func_ast)

Functions

• find_function_node(func_ast, check_name)

  finds the funtion node, optionally matching the name

  fixme: Why would you ever not want to check that the name matches?

  This seems dangerous.

• find_local_defs(ast)

  Given Block's ast, return a dictionary of def names and the Function ast that represents them. This will be used to create a LocalFunctionInfo.

• function_arguments_from_ast(ast)

  Convert the inputs found in the AST into InputVariable objects.

  This handles finding the keyword arguments and trying to convert them from their AST representation into something that is useful as a default argument. We also track whether the input arguments include a varargs (*args) and kwargs (**kw) style argument. If they do, we assign the names to the varargs and kwargs traits on the class.

• function_arguments_from_function(func)

  Given a function, return its args, keywords, and full argument list.

  Parameters

  func

  a function object.

  Returns

  args

  List of (name, default) argument pairs. name is always a string. default is None if it is not present. Otherwise, it is a string version of the default.

  var_args

  Name of the *args argument. Empty if it missing.

  kw_args

  Name of the **kw argument. Empty if it missing.

• function_inputs_from_call_ast(ast, info = None)

  Returns function names and input/output binding information from the CallFunc.

• function_returns_from_ast(ast)

  Find the function returns from a function's ast.

  Parameters:

  code: Str

  source code of the function

• function_returns_from_code(code)

  Find the function returns from its source

  Parameters:

  code: Str

  source code of the function

• function_returns_from_function(func)

  Find the return values names from a function by looking at its source.

  This isn't always possible, but this function gets the source code, looks for return statements for variable names. If all values in the return statement are variable names, it returns these names. If it is more complex, or it is unable to find the source code, it returns None.

  Example:

  >>> from ftplib import parse227
  >>> function_returns_from_function(parse227)
  ['host', 'port']
  

• outputs_from_function_ast(func_ast)

  Find the outputs by parsing the return statement in the ast and getting the names of the returned arguments.

Imported Names

© Copyright 2002-2009 Enthought, Inc.