From 34aff9f18f7a8ee59e8e07ceaf89d79bd6e96509 Mon Sep 17 00:00:00 2001
From: "Chris St. Pierre" <chris.a.st.pierre@gmail.com>
Date: Tue, 14 May 2013 11:43:14 -0400
Subject: doc: added devel docs for bcfg2-lint plugins

---
 src/lib/Bcfg2/Server/Lint/GroupNames.py | 28 +++++++++++++++++++++-------
 1 file changed, 21 insertions(+), 7 deletions(-)

(limited to 'src/lib/Bcfg2/Server/Lint/GroupNames.py')

diff --git a/src/lib/Bcfg2/Server/Lint/GroupNames.py b/src/lib/Bcfg2/Server/Lint/GroupNames.py
index 52e42aa7b..b180083d5 100644
--- a/src/lib/Bcfg2/Server/Lint/GroupNames.py
+++ b/src/lib/Bcfg2/Server/Lint/GroupNames.py
@@ -1,4 +1,4 @@
-""" ensure that all named groups are valid group names """
+""" Ensure that all named groups are valid group names. """
 
 import os
 import re
@@ -11,8 +11,15 @@ except ImportError:
 
 
 class GroupNames(Bcfg2.Server.Lint.ServerPlugin):
-    """ ensure that all named groups are valid group names """
+    """ Ensure that all named groups are valid group names. """
+
+    #: A string regex that matches only valid group names.  Currently,
+    #: a group name is considered valid if it contains only
+    #: non-whitespace characters.
     pattern = r'\S+$'
+
+    #: A compiled regex for
+    #: :attr:`Bcfg2.Server.Lint.GroupNames.GroupNames.pattern`
     valid = re.compile(r'^' + pattern)
 
     def Run(self):
@@ -31,7 +38,7 @@ class GroupNames(Bcfg2.Server.Lint.ServerPlugin):
         return {"invalid-group-name": "error"}
 
     def check_rules(self):
-        """ Check groups used in the Rules plugin for validity """
+        """ Check groups used in the Rules plugin for validity. """
         for rules in self.core.plugins['Rules'].entries.values():
             if not self.HandlesFile(rules.name):
                 continue
@@ -40,7 +47,7 @@ class GroupNames(Bcfg2.Server.Lint.ServerPlugin):
                                os.path.join(self.config['repo'], rules.name))
 
     def check_bundles(self):
-        """ Check groups used in the Bundler plugin for validity """
+        """ Check groups used in the Bundler plugin for validity. """
         for bundle in self.core.plugins['Bundler'].entries.values():
             if (self.HandlesFile(bundle.name) and
                 (not HAS_GENSHI or
@@ -50,7 +57,7 @@ class GroupNames(Bcfg2.Server.Lint.ServerPlugin):
 
     def check_metadata(self):
         """ Check groups used or declared in the Metadata plugin for
-        validity """
+        validity. """
         self.check_entries(self.metadata.groups_xml.xdata.xpath("//Group"),
                            os.path.join(self.config['repo'],
                                         self.metadata.groups_xml.name))
@@ -68,7 +75,7 @@ class GroupNames(Bcfg2.Server.Lint.ServerPlugin):
 
     def check_cfg(self):
         """ Check groups used in group-specific files in the Cfg
-        plugin for validity """
+        plugin for validity. """
         for root, _, files in os.walk(self.core.plugins['Cfg'].data):
             for fname in files:
                 basename = os.path.basename(root)
@@ -81,7 +88,14 @@ class GroupNames(Bcfg2.Server.Lint.ServerPlugin):
 
     def check_entries(self, entries, fname):
         """ Check a generic list of XML entries for <Group> tags with
-        invalid name attributes """
+        invalid name attributes.
+
+        :param entries: A list of XML <Group> tags whose ``name``
+                        attributes will be validated.
+        :type entries: list of lxml.etree._Element
+        :param fname: The filename the entry list came from
+        :type fname: string
+        """
         for grp in entries:
             if not self.valid.search(grp.get("name")):
                 self.LintError("invalid-group-name",
-- 
cgit v1.2.3-1-g7c22