Changeset 210 for trunk

Timestamp:

10/22/10 18:46:49 (14 years ago)

Author:

tim

Message:

beginnings of pyregfi documentation build script

File:

• trunk/python/pyregfi/__init__.py (modified) (14 diffs)

trunk/python/pyregfi/__init__.py

@@ -1 +1 @@
 #!/usr/bin/env python
+
+## @package pyregfi
+# Python interface to the regfi library.
+#
 
 import sys
@@ -106 +110 @@
 
 
-
-regfi.regfi_get_value
-
 regfi.regfi_init.argtypes = []
 regfi.regfi_init.restype = None
@@ -114 +115 @@
 
 
+## Retrieves messages produced by regfi during parsing and interpretation
+#
 def GetLogMessages():
     msgs = regfi.regfi_log_get_str()
@@ -142 +145 @@
 
     return ret_val
-                
-
+
+
+## Abstract class which Handles memory management and proxies attribute
+#  access to base structures  
 class _StructureWrapper():
-    "Handles memory management and proxies attribute access to base structures"
+
     hive = None
     base = None
@@ -166 +171 @@
         return (not self.__eq__(other))
 
-
+## Registry key 
 class Key(_StructureWrapper):
     pass
@@ -173 +178 @@
     pass
 
+## Registry value data
 class Data(_StructureWrapper):
     pass
 
+## Registry security record/permissions
 class Security(_StructureWrapper):
     pass
@@ -277 +284 @@
 
 
+## Registry value (metadata)
+#
+# These represent registry values (@ref REGFI_VK records) and provide
+# access to their associated data.
+# 
 class Value(_StructureWrapper):
     def __getattr__(self, name):
@@ -343 +355 @@
 
 
-class Hive():    
+## Represents a single registry hive (file)
+#
+class Hive():
     file = None
     raw_file = None
@@ -366 +380 @@
         return getattr(self.file.contents, name)
     
-    def __del__(self):    
+    def __del__(self):
         regfi.regfi_free(self.file)
         if self.raw_file != None:
@@ -375 +389 @@
         return HiveIterator(self)
 
+    ## Creates a @ref HiveIterator initialized at the specified path in
+    #  the hive. 
+    #
+    # Raises an Exception if the path could not be found/traversed.
     def subtree(self, path):
         hi = HiveIterator(self)
@@ -381 +399 @@
 
 
+## A special purpose iterator for registry hives
+#
+# Iterating over an object of this type causes all keys in a specific
+# hive subtree to be returned in a depth-first manner. These iterators
+# are typically created using the @ref Hive.subtree() function on a @ref Hive
+# object.
+#
+# HiveIterators can also be used to manually traverse up and down a
+# registry hive as they retain information about the current position in
+# the hive, along with which iteration state for subkeys and values for
+# every parent key.  See the @ref up and @ref down methods for more
+# information.
 class HiveIterator():
     hive = None
@@ -419 +449 @@
                 raise StopIteration('')
             
+            # XXX: Use non-generic exception
             if not regfi.regfi_iterator_down(self.iter):
                 raise Exception('Error traversing iterator downward.'+
@@ -439 +470 @@
         apath = (c_char_p*len(path))(*cpath)
 
+        # XXX: Use non-generic exception
         if not regfi.regfi_iterator_walk_path(self.iter,apath):
             raise Exception('Could not locate path.\n'+GetLogMessages())
@@ -444 +476 @@
     def current_key(self):
         return Key(self.hive, regfi.regfi_iterator_cur_key(self.iter))
+
+    #XXX Add subkey/value search accessor functions (?)