[gentoo-commits] proj/g-sorcery:master commit in: g_sorcery/

[Jauhien Piatlicki]

commit:     1ec0b070a11e10b8111538a8b8bdb865497bc82f
Author:     Jauhien Piatlicki (jauhien) <piatlicki <AT> gmail <DOT> com>
AuthorDate: Thu Aug  1 11:32:06 2013 +0000
Commit:     Jauhien Piatlicki <piatlicki <AT> gmail <DOT> com>
CommitDate: Thu Aug  1 11:32:06 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/g-sorcery.git;a=commit;h=1ec0b070

g_sorcery/ebuild: Docstrings added

---
 g_sorcery/ebuild.py | 48 +++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/g_sorcery/ebuild.py b/g_sorcery/ebuild.py
index 0c720a6..a1bd6b8 100644
--- a/g_sorcery/ebuild.py
+++ b/g_sorcery/ebuild.py
@@ -46,6 +46,15 @@ class EbuildGenerator(object):
         return ebuild
 
     def process_ebuild_data(self, ebuild_data):
+        """
+        A hook allowing changing ebuild_data before ebuild generation.
+
+        Args:
+            ebuild_data: Dictinary with ebuild data.
+
+        Returns:
+            Dictinary with ebuild data.
+        """
         return ebuild_data
 
     def process(self, ebuild, ebuild_data):
@@ -89,7 +98,7 @@ class EbuildGenerator(object):
         
     def postprocess(self, ebuild, ebuild_data):
         """
-        Hook to be overriden.
+        A hook for changing of a generated ebuild.
 
         Args:
             ebuild: Ebuild source as a list of strings.
@@ -141,6 +150,27 @@ class EbuildGeneratorFromFile(EbuildGenerator):
 
 
 class DefaultEbuildGenerator(EbuildGenerator):
+    """
+    Default ebuild generator.
+
+    Takes a layout dictinary that describes ebuild structure and generates
+    an ebuild temlate basing on it.
+
+    Layout has entries for vars and inherited eclasses. Each entry is a list.
+    Entries are processed in the following order:
+    
+    vars_before_inherit
+    inherit
+    vars_after_inherit
+    vars_after_description
+    vars_after_keywords
+
+    inherit entry is just a list of eclass names.
+    vars* entries are lists of variables in tw0 possible formats:
+    1. A string with variable name
+    2. A tuple (varname, value)
+    Variable names are automatically transformed to the upper-case.
+    """
     def __init__(self, package_db, layout):
         super(DefaultEbuildGenerator, self).__init__(package_db)
         self.template = ["# automatically generated by g-sorcery",
@@ -182,6 +212,12 @@ class DefaultEbuildGenerator(EbuildGenerator):
         
 
     def _append_vars_to_template(self, variables):
+        """
+        Add a list of variables to the end of template.
+
+        Args:
+            variables: List of variables.
+        """
         VAR_NAME = 0
         VAR_VALUE = 1
 
@@ -193,4 +229,14 @@ class DefaultEbuildGenerator(EbuildGenerator):
 
 
     def get_template(self, package, ebuild_data):
+        """
+        Generate ebuild template.
+
+        Args:
+            package: package_db.Package instance.
+            ebuild_data: Dictionary with ebuild data.
+
+        Returns:
+            Ebuild template.
+        """
         return self.template