Package pyraf :: Module irafhelp

[frames] | no frames]

Module irafhelp

Give help on variables, functions, modules, classes, IRAF tasks,
IRAF packages, etc.

- help() with no arguments will list all the defined variables.
- help("taskname") or help(IrafTaskObject) display the IRAF help for the task
- help("taskname",html=1) or help(IrafTaskObject,html=1) will direct Netscape
  to display the HTML version of IRAF help for the task
- help(object) where object is a module, instance, ? will display
  information on the attributes and methods of the object (or the
  variables, functions, and classes in the module)
- help(function) will give the calling sequence for the function (except
  for built-in functions)

and so on.  There are optional keyword arguments to help that specify
what information is to be printed:

variables=1     Print info on variables/attributes
functions=1     Print info on function/method calls
modules=1       Print info on modules
tasks=0         Print info on IrafTask objects
packages=0      Print info on IrafPkg objects
hidden=0        Print info on hidden variables/attributes (starting with '_')
html=0          Use HTML help instead of standard IRAF help for tasks

regexp=None     Specify a regular expression that matches the names of
                        variables of interest.  E.g. help(sys, regexp='std') will
                        give help on all attributes of sys that start with std.
                        regexp can use all the re patterns.

The padchars keyword determines some details of the format of the output.

The **kw argument allows minimum matching for the keyword arguments
(so help(func=1) will work).

$Id: irafhelp.py 779 2007-02-09 16:52:50Z rij $

R. White, 1999 September 23

Functions

help(object=__main__, variables=1, functions=1, modules=1, tasks=0, packages=0, hidden=0, padchars=16, regexp=None, html=0, **kw)
List the type and value of all the variables in the specified object.

source code

_help(object, variables, functions, modules, tasks, packages, hidden, padchars, regexp, html, irafkw)

source code

_printIrafHelp(object, html, irafkw)

source code

_valueHelp(object, padchars)

source code

_getContents(vlist, regexp, object)

source code

_printValueList(varlist, hidden, padchars)

source code

_sortOrder(type)

source code

_valueString(value, verbose=0)
Returns name and, for some types, value of the variable as a string.

source code

_irafHelp(taskname, irafkw)
Display IRAF help for given task.

source code

_htmlHelp(taskname)
Display HTML help for given IRAF task in Netscape.

source code

Variables

_numpyArrayType = None

_numpyTypeName = {}

_MODULE = 0

_FUNCTION = 1

_METHOD = 2

_OTHER = 3

_functionTypes = types.BuiltinFunctionType, types.FunctionType...

_methodTypes = types.BuiltinMethodType, types.MethodType, type...

_listTypes = list, tuple, dict

_numericTypes = _numericTypes+(bool,)

_allSingleTypes = _functionTypes+ _methodTypes+ _listTypes+ _n...

_kwdict = minmatch.MinMatchDict()

_irafkwdict = {}

_HelpURL = "http://stsdas.stsci.edu/cgi-bin/gethelp.cgi?task="

_Netscape = "netscape"

Imports: __main__, re, os, types, minmatch, describe, iraf, irafutils, IrafTask, IrafPkg, numpy

Function Details

help(object=main, variables=1, functions=1, modules=1, tasks=0, packages=0, hidden=0, padchars=16, regexp=None, html=0, **kw)

List the type and value of all the variables in the specified object.

- help() with no arguments will list all the defined variables.
- help("taskname") or help(IrafTaskObject) displays IRAF help for the task
- help(object) where object is a module, instance, etc., will display
information on the attributes and methods of the object.
- help(function) will give the calling sequence for the function.

Optional keyword arguments specify what information is to be printed.
The keywords can be abbreviated:

variables=1 Print info on variables/attributes
functions=1 Print info on function/method calls
modules=1   Print info on modules
tasks=0     Print info on IrafTask objects
packages=0  Print info on IrafPkg objects
hidden=0    Print info on hidden variables/attributes (starting with '_')
html=0      Use HTML help instead of standard IRAF help for tasks

regexp=None Specify a regular expression that matches the names of variables of
        interest.  E.g., help(sys, regexp='std') will give help on all attr-
        ibutes of sys that start with std.  All the re patterns can be used.

Other keywords are passed on to the IRAF help task if it is called.

_irafHelp(taskname, irafkw)

Display IRAF help for given task. Task can be either a name or an IrafTask object. Returns 1 on success or 0 on failure.

_htmlHelp(taskname)

Display HTML help for given IRAF task in Netscape. Task can be either a name or an IrafTask object. Tries using 'netscape -remote' command to load the page in a running Netscape. If that fails, starts a new netscape.

Variables Details

_functionTypes

Value:

types.BuiltinFunctionType, types.FunctionType, types.LambdaType

_methodTypes

Value:

types.BuiltinMethodType, types.MethodType, types.UnboundMethodType

_allSingleTypes

Value:

_functionTypes+ _methodTypes+ _listTypes+ _numericTypes