CTAN backend: Docstrings and different fixes

3 files changed, 32 insertions, 3 deletions

diff --git a/gs_ctan/backend.py b/gs_ctan/backend.py
index 42a4a83..92245e6 100644
--- a/gs_ctan/backend.py
+++ b/gs_ctan/backend.py
@@ -23,10 +23,14 @@ from .ebuild import CtanEbuildWithoutDigestGenerator, CtanEbuildWithDigestGenera
 
 
 class CtanEclassGenerator(EclassGenerator):
+    """
+    Implementation of eclass generator. Only specifies a data directory.
+    """
     def __init__(self):
         super(CtanEclassGenerator, self).__init__(os.path.join(get_pkgpath(__file__), 'data'))
         
 
+#Backend instance to be loaded by g_sorcery
 instance = Backend(CtanDBGenerator,
                    CtanEbuildWithDigestGenerator, CtanEbuildWithoutDigestGenerator,
                    CtanEclassGenerator, MetadataGenerator)
diff --git a/gs_ctan/ctan_db.py b/gs_ctan/ctan_db.py
index 39195e8..0f7d939 100644
--- a/gs_ctan/ctan_db.py
+++ b/gs_ctan/ctan_db.py
@@ -12,17 +12,18 @@
 """
 
 import itertools
-import os
 import re
 
 import portage
 
 from g_sorcery.g_collections import Dependency, Package, serializable_elist
 from g_sorcery.package_db import DBGenerator
-from g_sorcery.exceptions import SyncError
 from g_sorcery.logger import Logger
 
 class CtanDBGenerator(DBGenerator):
+    """
+    Implementation of database generator for CTAN LaTeX backend.
+    """
     def __init__(self, package_db_class):
         super(CtanDBGenerator, self).__init__(package_db_class)
         
@@ -38,10 +39,25 @@ class CtanDBGenerator(DBGenerator):
 
 
     def get_download_uries(self, common_config, config):
+        """
+        Get download URI.
+        """
         tlpdb_uri = config["repo_uri"] + "/tlpkg/texlive.tlpdb.xz"
         return [tlpdb_uri]
         
     def parse_data(self, data_f):
+        """
+        Parse downloaded data.
+
+        Parsed data is a list of dictionaries.
+        Each dictionary corresponds to one package.
+
+        Args:
+            data_f: Open file wit data.
+
+        Returns:
+            Parsed data.
+        """
         data = data_f.read()
         
         data = data.split("\n")
@@ -98,7 +114,10 @@ class CtanDBGenerator(DBGenerator):
         return result
 
     def process_data(self, pkg_db, data, common_config, config):
-        
+        """
+        Process parsed data and fill database.
+        """
+
         category = "dev-tex"
         
         pkg_db.add_category(category)
diff --git a/gs_ctan/ebuild.py b/gs_ctan/ebuild.py
index a800cbd..d8b4f65 100644
--- a/gs_ctan/ebuild.py
+++ b/gs_ctan/ebuild.py
@@ -21,6 +21,9 @@ Layout = collections.namedtuple("Layout",
   
 
 class CtanEbuildWithoutDigestGenerator(DefaultEbuildGenerator):
+    """
+    Implementation of ebuild generator without sources digesting.
+    """
     def __init__(self, package_db):
 
         vars_before_inherit = \
@@ -39,6 +42,9 @@ class CtanEbuildWithoutDigestGenerator(DefaultEbuildGenerator):
         super(CtanEbuildWithoutDigestGenerator, self).__init__(package_db, layout)
 
 class CtanEbuildWithDigestGenerator(DefaultEbuildGenerator):
+    """
+    Implementation of ebuild generator with sources digesting.
+    """
     def __init__(self, package_db):
 
         vars_before_inherit = \