source: TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/common_module.txt @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/common_module.txt@793
Revision 793, 1.7 KB checked in by astephen, 13 years ago (diff)

Put all the old code in the old_stuff branch.

Line 
1Help on module common:
2
3NAME
4    common
5
6FILE
7    /usr/local/dx-0.1.1/common.py
8
9DESCRIPTION
10    common.py
11    =========
12   
13    Holds common functions and classes used in the Data Extractor software.
14
15CLASSES
16    RedirectStdout
17   
18    class RedirectStdout
19     |  RedirectStdout class - used to direct standard output away from
20     |  the screen in CGI scripts.
21     | 
22     |  Methods defined here:
23     | 
24     |  flush(self)
25     |      Method to do nothing, again!
26     | 
27     |  write(self, item)
28     |      write method - allows dummy standard out to work.
29
30FUNCTIONS
31    checkSubDirectory(user=None)
32        checkSubDirectory method - checks if the required sub-directory exists
33        to write the output and if not it creates it.
34   
35    compareAxes(ax1, ax2)
36        Takes 2 cdms axis objects returning 1 if they are essentially
37        the same and 0 if not.
38   
39    compareGrids(grid1, grid2)
40        Takes 2 cdms grid objects returning 1 if they are essentially
41        the same and 0 if not.
42   
43    createTimeKeyList()
44        Returns all the separate date and time component arguments required as a list.
45   
46    getValuesInRange(start, end, array)
47        getValuesInRange function - takes a start and end value and returns the
48        values in the array that are between them.
49   
50    isUndefined(dict, item)
51        Function that returns 1 if item is not a key in dict or
52        is defined as None in dict.
53   
54    makeDirsAndPerms(basedir, dirs, permissions, owner, verbose='no')
55        A function for making directories recursively and setting permissions/ownership.
56   
57    overlap(list1, list2)
58        overlap function - returns a list of overlapping items in list1 and list2.
59        Otherwise returns None.
60
Note: See TracBrowser for help on using the repository browser.