Python: module inputs

inputs | index /home/jim/Files/TekDefense/TekDefense-Automater-Private/inputs.py

`The inputs.py module represents some form of all inputs
to the Automater program to include target files, and
the standard config file - sites.xml. Any addition to
Automater that brings any other input requirement should
be programmed in this module.
Class(es):
TargetFile -- Provides a representation of a file containing target
strings for Automater to utilize.
SitesFile -- Provides a representation of the sites.xml
configuration file.
Function(s):
No global exportable functions are defined.
Exception(s):
No exceptions exported.`

Modules
`` |  |
os |  |  |

Classes
`` |  | __builtin__.object SitesFile TargetFile
class SitesFile(__builtin__.object)
`` | `SitesFile represents an XML Elementree object representing the program's configuration file. Returns XML Elementree object. Method(s): (Class Method) getXMLTree (Class Method) fileExists Instance variable(s): No instance variables.`
| Class methods defined here: fileExists(self) from __builtin__.type `Checks if a file exists. Returns boolean representing if file exists. Argument(s): No arguments are required. Return value(s): Boolean Restrictions: File must be named sites.xml and must be in same directory as caller. This Method is tagged as a Class Method` getXMLTree(self) from __builtin__.type `Opens a config file for reading. Returns XML Elementree object representing XML Config file. Argument(s): No arguments are required. Return value(s): ElementTree Restrictions: File must be named sites.xml and must be in same directory as caller. This Method is tagged as a Class Method` Data descriptors defined here: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`
class TargetFile(__builtin__.object)
`` | `TargetFile provides a Class Method to retrieve information from a file- based target when one is entered as the first parameter to the program. Public Method(s): (Class Method) TargetList Instance variable(s): No instance variables.`
| Class methods defined here: TargetList(self, filename) from __builtin__.type `Opens a file for reading. Returns each string from each line of a single or multi-line file. Argument(s): filename -- string based name of the file that will be retrieved and parsed. Return value(s): Iterator of string(s) found in a single or multi-line file. Restriction(s): This Method is tagged as a Class Method` Data descriptors defined here: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)`