Merge lp:~james-w/linaro-image-tools/config-docs into lp:linaro-image-tools/11.11

[James Westby]

Hi,

Here are the fixes you suggested on the last merge.

Thanks,

James

[lp:~james-w/linaro-image-tools/config-docs]

52. By James Westby on 2010-08-31

Consolidate more code in to the common method.

[Michael Hudson-Doyle (mwhudson)]

Looks good, thanks. Maaaybe _get_main_option could have a docstring and maybe its name is a bit generic (although it is my fault). Otherwise, +1

review: Approve

[lp:~james-w/linaro-image-tools/config-docs]

53. By James Westby on 2010-08-31

Add a docstring to _get_main_option and change the name. Thanks Michael.

=== modified file 'hwpack/config.py'
--- hwpack/config.py	2010-08-27 19:27:37 +0000
+++ hwpack/config.py	2010-08-31 00:21:40 +0000
@@ -41,10 +41,12 @@
 
     @property
     def name(self):
+        """The name of the hardware pack. A str."""
         return self.parser.get(self.MAIN_SECTION, self.NAME_KEY)
 
     @property
     def include_debs(self):
+        """Whether the hardware pack should contain .debs. A bool."""
         try:
             if not self.parser.get(
                 self.MAIN_SECTION, self.INCLUDE_DEBS_KEY):
@@ -54,36 +56,38 @@
         except ConfigParser.NoOptionError:
             return True
 
+    def _get_main_option(self, key):
+        try:
+            result = self.parser.get(self.MAIN_SECTION, key)
+            if not result:
+                return None
+            return result
+        except ConfigParser.NoOptionError:
+            return None
+
     @property
     def origin(self):
-        try:
-            origin = self.parser.get(self.MAIN_SECTION, self.ORIGIN_KEY)
-            if not origin:
-                return None
-            return origin
-        except ConfigParser.NoOptionError:
-            return None
+        """The origin that should be recorded in the hwpack.
+
+        A str or None if no origin should be recorded.
+        """
+        return self._get_main_option(self.ORIGIN_KEY)
 
     @property
     def maintainer(self):
-        try:
-            maintainer = self.parser.get(
-                self.MAIN_SECTION, self.MAINTAINER_KEY)
-            if not maintainer:
-                return None
-            return maintainer
-        except ConfigParser.NoOptionError:
-            return None
+        """The maintainer that should be recorded in the hwpack.
+
+        A str or None if not maintainer should be recorded.
+        """
+        return self._get_main_option(self.MAINTAINER_KEY)
 
     @property
     def support(self):
-        try:
-            support = self.parser.get(self.MAIN_SECTION, self.SUPPORT_KEY)
-            if not support:
-                return None
-            return support
-        except ConfigParser.NoOptionError:
-            return None
+        """The support level that should be recorded in the hwpack.
+
+        A str or None if no support level should be recorded.
+        """
+        return self._get_main_option(self.SUPPORT_KEY)
 
     def _validate_name(self):
         try: