Add comments to backend_factory

e058e7a5 · Javier D. Garcia-Lasheras · b79ac4e1 · e058e7a5
Commit e058e7a5 authored Aug 09, 2016 by Javier D. Garcia-Lasheras
Hide whitespace changes
Inline Side-by-side

Showing with 7 additions and 1 deletion

backend_factory.py hdlmake/fetch/backend_factory.py +7 -1

No files found.
--- a/hdlmake/fetch/backend_factory.py
+++ b/hdlmake/fetch/backend_factory.py
@@ -19,12 +19,17 @@
 # You should have received a copy of the GNU General Public License
 # along with Hdlmake.  If not, see <http://www.gnu.org/licenses/>.

+"""Module providing the BackendFactory, a mechanism to create fetchers"""
+
 import logging
 from .constants import (LOCAL)


 class BackendFactory(object):

+    """Class providing instances that can be used to build fetchers
+    for the required source origin (Local, Git, SVN)"""
+
    def __init__(self):
        self.backend_table = {}

@@ -33,6 +38,7 @@ class BackendFactory(object):
        self.backend_table[backend_id] = backend

    def get_backend(self, module):
+        """Get the appropriated source origin backend for the given module"""
        try:
            if module.source != LOCAL:
                logging.info("Investigating module: " + str(module) +
@@ -45,5 +51,5 @@ class BackendFactory(object):
            for backend_id in self.backend_table.iterkeys():
                error_string += "\t%d" % (backend_id)
            logging.error(error_string)
-            raise  # this is serious enough we should let the exception keep going
+            raise
        return backend