Pretty print documentation

Author: Ignasi Barrera

examples/skel.py

@@ -13,7 +13,7 @@
 
 
 class SkeletonPlugin(AbsPlugin):
-    """ An example plugin that prints dummy messages. """
+    """ An example plugin that prints dummy messages """
     def __init__(self):
         pass
 
@@ -23,7 +23,7 @@ def __init__(self):
     # print the help of the command.
     # The arguments are the options given to the command itself
     def dummy(self, args):
-        """ Prints a dummy message. """
+        """ Prints a dummy message """
         print "This is the print_handler in the example plugin"
 
 

kahuna/abstract.py

@@ -2,12 +2,12 @@
 
 
 class AbsPlugin:
-    """ Abstract plugin. """
+    """ Abstract plugin """
     def _commands(self):
         """ Get the list of commands for the current plugin.
         By default all public methods in the plugin implementation
         will be used as plugin commands. This method can be overriden
-        in subclasses to customize the available command list. """
+        in subclasses to customize the available command list """
         attrs = filter(lambda attr: not attr.startswith('_'), dir(self))
         commands = {}
         for attr in attrs:

kahuna/cli.py

@@ -4,13 +4,13 @@
 
 
 class CLI:
-    """ Main command line interface. """
+    """ Main command line interface """
     def __init__(self):
-        """ Initialize the plugin manager. """
+        """ Initialize the plugin manager """
         self.__pluginmanager = PluginManager()
 
     def parse_input(self):
-        """ Validates user input and delegates to the plugin manager. """
+        """ Validates user input and delegates to the plugin manager """
         if len(sys.argv) < 2:
             print "Usage: kahuna <plugin> <command> [<options>]"
             print "The following plugins are available:\n"

kahuna/config.py

@@ -11,14 +11,14 @@
 
 
 class ConfigLoader:
-    """ Loads configuration files from a given location. """
+    """ Loads configuration files from a given location """
     def __init__(self, basedir="kahuna"):
-        """ Initializes the ConfigLoader. """
+        """ Initializes the ConfigLoader """
         self.user_dir = os.environ['HOME'] + "/." + basedir
         self.sys_dir = "/etc/" + basedir
 
     def load(self, file_name, default=None):
-        """ Loads the given configuration file ftom the default locations. """
+        """ Loads the given configuration file ftom the default locations """
         user_config = self.user_dir + "/" + file_name
         sys_config = self.sys_dir + "/" + file_name
         config_found = user_config
@@ -53,7 +53,7 @@ def load(self, file_name, default=None):
 
 @singleton
 class Config:
-    """ Main configuration. """
+    """ Main configuration """
     def __init__(self):
         config = ConfigLoader().load("kahuna.conf", "config/kahuna.conf")
 

kahuna/pluginmanager.py

@@ -10,13 +10,13 @@
 
 
 class PluginManager:
-    """ Manages available plugins. """
+    """ Manages available plugins """
     def __init__(self):
-        """ Initialize the plugin list. """
+        """ Initialize the plugin list """
         self.__plugins = {}
 
     def load_plugin(self, plugin_name):
-        """ Loads a single plugin given its name. """
+        """ Loads a single plugin given its name """
         if not plugin_name in __all__:
             raise KeyError("Plugin " + plugin_name + " not found")
         try:
@@ -36,7 +36,7 @@ def call(self, plugin_name, command_name, args):
             return self._call(context, plugin_name, command_name, args)
 
     def _call(self, context, plugin_name, command_name, args):
-        """ Calls the given command on the given plugin. """
+        """ Calls the given command on the given plugin """
         try:
             plugin = self.load_plugin(plugin_name)
             plugin._load_context(context)
@@ -54,7 +54,7 @@ def _call(self, context, plugin_name, command_name, args):
             self.help_all()
 
     def help(self, plugin):
-        """ Prints the help for the given plugin. """
+        """ Prints the help for the given plugin """
         commands = plugin._commands()
         tokens = plugin.__module__.split('.')
         plugin_name = tokens[len(tokens) - 1]
@@ -64,7 +64,7 @@ def help(self, plugin):
                     commands[command].__doc__)
 
     def help_all(self):
-        """ Prints the help for all registered plugins. """
+        """ Prints the help for all registered plugins """
         for name in sorted(__all__):
             plugin = self.load_plugin(name)
             self.help(plugin)
@@ -74,7 +74,7 @@ def help_all(self):
 @contextmanager
 def opencontext():
     """ Loads the context each plugin needs to be initialized
-    in order to be executed. """
+    in order to be executed """
     log.debug("Loading context for plugin execution")
     context = ContextLoader().load()
     yield context

kahuna/plugins/env.py

@@ -17,12 +17,12 @@
 
 
 class EnvironmentPlugin(AbsPlugin):
-    """ Environment generator plugin. """
+    """ Environment generator plugin """
     def __init__(self):
         self.__config = ConfigLoader().load("env.conf", "config/env.conf")
 
     def create(self, args):
-        """ Creates the environment. """
+        """ Creates the environment """
         try:
             apply_default_configuration(self.__config, self._context)
             dc = create_infrastructure_compute(self.__config, self._context)
@@ -35,7 +35,7 @@ def create(self, args):
             print "Error: %s" % ex.getMessage()
 
     def clean(self, args):
-        """ Cleans up the environment. """
+        """ Cleans up the environment """
         try:
             cleanup_cloud_compute(self.__config, self._context)
             cleanup_default_tenants(self.__config, self._context)

kahuna/plugins/environment/cloud/compute.py

@@ -14,15 +14,15 @@
 
 
 class CloudCompute:
-    """ Provides access to cloud compute features. """
+    """ Provides access to cloud compute features """
 
     def __init__(self, context):
-        """ Initialize the cloud creator with an existent context. """
+        """ Initialize the cloud creator with an existent context """
         self.__context = context.getApiContext()
 
     def create_virtual_datacenter(self, datacenter, enterprise, type,
             name, netname, netaddress, netmask, netgateway):
-        """ Creates a new virtual datacenter. """
+        """ Creates a new virtual datacenter """
         log.info("Creating virtual datacenter %s of type %s..." % (name, type))
         network = PrivateNetwork.builder(self.__context) \
                   .name(netname) \
@@ -40,7 +40,7 @@ def create_virtual_datacenter(self, datacenter, enterprise, type,
         return vdc
 
     def create_virtual_appliance(self, vdc, name):
-        """ Creates a new virtual appliance inside a virtual datacenter. """
+        """ Creates a new virtual appliance inside a virtual datacenter """
         log.info("Creating virtual appliance %s..." % name)
         vapp = VirtualAppliance.builder(self.__context, vdc) \
                .name(name) \
@@ -49,21 +49,21 @@ def create_virtual_appliance(self, vdc, name):
         return vapp
 
     def create_virtual_machine(self, vapp, template):
-        """ Create a virtual machine based on the given template. """
+        """ Create a virtual machine based on the given template """
         log.info(("Creating virtual machine from "
                 "template: %s...") % template.getName())
         vm = VirtualMachine.builder(self.__context, vapp, template).build()
         vm.save()
         return vm
 
     def refresh_template_repository(self, enterprise, datacenter):
-        """ Refresh the virtual machines templates in the given repository. """
+        """ Refresh the virtual machines templates in the given repository """
         log.info("Refreshing template repository...")
         enterprise.refreshTemplateRepository(datacenter)
 
 
 def find_smallest_template(context, vdc):
-    """ Finds the smallest template available to the virtual datacenter. """
+    """ Finds the smallest template available to the virtual datacenter """
     log.info("Looking for the smallest available template...")
     templates = sorted(vdc.listAvailableTemplates(),
             key=lambda t: t.getDiskFileSize())
@@ -76,7 +76,7 @@ def find_smallest_template(context, vdc):
 
 
 def find_template_by_name(context, vdc, name):
-    """ Finds the template with the given name. """
+    """ Finds the template with the given name """
     template = vdc.findAvailableTemplate(
             VirtualMachineTemplatePredicates.name(name))
     if template:
@@ -88,7 +88,7 @@ def find_template_by_name(context, vdc, name):
 
 
 def create_cloud_compute(config, context, dc):
-    """ Creates the default cloud compute entities. """
+    """ Creates the default cloud compute entities """
     log.info("### Configuring the cloud ###")
     cloud = CloudCompute(context)
     # Create it into the 'abiquo' enterprise, to make it easier to use
@@ -111,7 +111,7 @@ def create_cloud_compute(config, context, dc):
 
 
 def cleanup_cloud_compute(config, context):
-    """ Cleans up a previously created cloud compute resources. """
+    """ Cleans up a previously created cloud compute resources """
     log.info("### Cleaning up the cloud ###")
     cloud = context.getCloudService()
     for vdc in cloud.listVirtualDatacenters():

kahuna/plugins/environment/cloud/storage.py

@@ -8,14 +8,14 @@
 
 
 class CloudStorage:
-    """ Provides access to cloud storage features. """
+    """ Provides access to cloud storage features """
 
     def __init__(self, context):
-        """ Initialize the cloud creator with an existent context. """
+        """ Initialize the cloud creator with an existent context """
         self.__context = context.getApiContext()
 
     def create_volume(self, vdc, tier, name, size):
-        """ Creates a new volume in the given virtual datacenter. """
+        """ Creates a new volume in the given virtual datacenter """
         log.info("Creating volume %s of %s MB..." % (name, size))
         volume = Volume.builder(self.__context, vdc, tier) \
                  .name(name) \
@@ -26,7 +26,7 @@ def create_volume(self, vdc, tier, name, size):
 
 
 def create_cloud_storage(config, context, vdc):
-    """ Creates the default cloud storage entities. """
+    """ Creates the default cloud storage entities """
     log.info("### Adding persistent storage ###")
     storage = CloudStorage(context)
     tier = vdc.findStorageTier(TierPredicates.name(config.get("tier", "name")))
@@ -36,7 +36,7 @@ def create_cloud_storage(config, context, vdc):
 
 
 def cleanup_cloud_storage(config, context, vdc):
-    """ Cleans up a previously created cloud storage resources. """
+    """ Cleans up a previously created cloud storage resources """
     log.info(("Removing persistent volumes in "
             "virtual datacenter %s...") % vdc.getName())
     for volume in vdc.listVolumes():

kahuna/plugins/environment/config/sysconfig.py

@@ -13,24 +13,24 @@ class SystemConfig:
     """
 
     def __init__(self, context):
-        """ Initialize with an existing context. """
+        """ Initialize with an existing context """
         self.__context = context
 
     def get(self, property_name):
-        """ Returns value if a given configuration property. """
+        """ Returns value if a given configuration property """
         admin = self.__context.getAdministrationService()
         return admin.getSystemProperty(property_name)
 
     def set(self, property_name, property_value):
-        """ Set a value to a given configuration property. """
+        """ Set a value to a given configuration property """
         admin = self.__context.getAdministrationService()
         prop = admin.getSystemProperty(property_name)
         prop.setValue(property_value)
         prop.update()
 
 
 def apply_default_configuration(config, context):
-    """ Applies the default platform configuration. """
+    """ Applies the default platform configuration """
     log.info("### Applying default configuration ###")
     sysconf = SystemConfig(context)
     log.info("Disabling initial popup...")

kahuna/plugins/environment/infrastructure/compute.py

@@ -12,14 +12,14 @@
 
 
 class InfrastructureCompute:
-    """ Provides access to infrastructure compute features. """
+    """ Provides access to infrastructure compute features """
 
     def __init__(self, context):
-        """ Initialize with an existent context. """
+        """ Initialize with an existent context """
         self.__context = context.getApiContext()
 
     def create_datacenter(self, name, location):
-        """ Creates a new datacenter. """
+        """ Creates a new datacenter """
         log.info("Creating datacenter %s at %s..." % (name, location))
         rs_address = self.__context.getEndpoint().getHost()
         datacenter = Datacenter.builder(self.__context) \
@@ -31,7 +31,7 @@ def create_datacenter(self, name, location):
         return datacenter
 
     def create_rack(self, datacenter, name, vlan_id_min, vlan_id_max, nrsq):
-        """ Creates a new rack. """
+        """ Creates a new rack """
         log.info("Adding rack %s..." % name)
         rack = Rack.builder(self.__context, datacenter) \
                .name(name) \
@@ -44,7 +44,7 @@ def create_rack(self, datacenter, name, vlan_id_min, vlan_id_max, nrsq):
 
     def create_machine(self, rack, hyp, address, user, password,
             datastore, vswitch):
-        """ Creates a new machine. """
+        """ Creates a new machine """
         log.info("Adding %s hypervisor at %s..." % (hyp, address))
         datacenter = rack.getDatacenter()
 
@@ -66,7 +66,7 @@ def create_machine(self, rack, hyp, address, user, password,
 
 
 def create_infrastructure_compute(config, context):
-    """ Creates the default infrastructure compute entities.. """
+    """ Creates the default infrastructure compute entities. """
     log.info("### Configuring infrastructure ###")
     comp = InfrastructureCompute(context)
     dc = comp.create_datacenter(config.get("datacenter", "name"),
@@ -89,7 +89,7 @@ def create_infrastructure_compute(config, context):
 
 
 def cleanup_infrastructure_compute(config, context):
-    """ Cleans up previously created infrastructure compute resources. """
+    """ Cleans up previously created infrastructure compute resources """
     log.info("### Cleaning up infrastructure ###")
     admin = context.getAdministrationService()
     for datacenter in admin.listDatacenters():

kahuna/plugins/environment/infrastructure/network.py

@@ -9,15 +9,15 @@
 
 
 class InfrastructureNetwork:
-    """ Provides access to infrastructure network features. """
+    """ Provides access to infrastructure network features """
 
     def __init__(self, context):
-        """ Initialize with an existent context. """
+        """ Initialize with an existent context """
         self.__context = context.getApiContext()
 
     def create_public_network(self, datacenter, netname, netaddress,
             netmask, netgateway, nettag, netdns):
-        """ Creates a new public network . """
+        """ Creates a new public network  """
         log.info(("Adding public network %s (%s) to "
             "datacenter %s...") % (netname, netaddress, datacenter.getName()))
         network = PublicNetwork.builder(self.__context, datacenter) \
@@ -33,7 +33,7 @@ def create_public_network(self, datacenter, netname, netaddress,
 
     def create_external_network(self, datacenter, enterprise, netname,
             netaddress, netmask, netgateway, nettag, netdns):
-        """ Creates a new external network . """
+        """ Creates a new external network  """
         log.info(("Adding external network %s (%s) to "
             "enterprise %s...") % (netname, netaddress, enterprise.getName()))
         network = ExternalNetwork \
@@ -50,7 +50,7 @@ def create_external_network(self, datacenter, enterprise, netname,
 
 
 def create_infrastructure_network(config, context, dc):
-    """ Creates the default infrastructure network entities. """
+    """ Creates the default infrastructure network entities """
     log.info("### Configuring networking ###")
     admin = context.getAdministrationService()
     enterprise = admin.findEnterprise(EnterprisePredicates.name("Abiquo"))
@@ -73,7 +73,7 @@ def create_infrastructure_network(config, context, dc):
 
 
 def cleanup_infrastructure_network(config, dc):
-    """ Cleans up previously created infrastructure networking resources. """
+    """ Cleans up previously created infrastructure networking resources """
     log.info("Removing networks in datacenter %s..." % dc.getName())
     for network in dc.listNetworks():
         network.delete()