Package analysis :: Module arguments :: Class Parameters
[show private | hide private]
[frames | no frames]

Class Parameters


A class providing convenience methods giving information about parameters.
Method Summary
  __init__(self, function)
Initialise the object with a 'function' node.
  get_defaults(self)
Return a list of default values for each of the normal positional parameters.
  get_dstar_parameter(self)
Return the name of the keyword arguments parameter, or None if no such parameter is defined.
  get_parameter_mapping(self)
Return a mapping of positional parameter names to default values, where None is specified for those parameters without default values.
  get_star_parameter(self)
Return the name of the variable arguments parameter, or None if no such parameter is defined.

Method Details

__init__(self, function)
(Constructor)

Initialise the object with a 'function' node.

get_defaults(self)

Return a list of default values for each of the normal positional parameters.

get_dstar_parameter(self)

Return the name of the keyword arguments parameter, or None if no such parameter is defined.

get_parameter_mapping(self)

Return a mapping of positional parameter names to default values, where None is specified for those parameters without default values.

get_star_parameter(self)

Return the name of the variable arguments parameter, or None if no such parameter is defined.

Generated by Epydoc 2.1 on Fri May 19 01:52:26 2006 http://epydoc.sf.net