Package bscw :: Package api :: Module ap_get_api
[hide private]

Module ap_get_api

get api function definition as dict {name: params}

The grammar of an entry in that dict is

 api_entry :=  method: params
 params := { name, scalar_type,     {0|1}         |
             name, array_or_struct, {0|1}, params }+
            {0|1} :=  mandatory
 scalar_type := {INT | ... | BASE64 | None}
 array_or_struct := {ARRAY | STRUCT}
 method := alpha_string
 name := alpha_string
 alpha_string := {a-z,A-Z}+


API definition::

 API = (('module_names', 'array', 0, [('item', 'ASCII string', 1)]),)

(c) Fraunhofer FIT, 2003


Version: $Rev: 20822 $

Functions [hide private]
 
param_def()
return the parameter definition
 
do_it(request, module_names=None)
see above
 
call_func(mod_name, func, params=())
call function "func" of module "mod_name"
 
get_api(files)
return the API function definition from the files as described in api_def.py
 
get_api_m(modules)
return the API function definition from the modules as described in api_def.py
 
listfiles(dir='.')
list files of the directory
Variables [hide private]
  pref = 'ap_'
  suff = '.py'
  __package__ = 'bscw.api'