bumblebee-status/bumblebee/config.py

"""Configuration handling

This module provides configuration information (loaded modules,
module parameters, etc.) to all other components
"""

import os
import sys
import logging
import argparse
import textwrap
import importlib
import bumblebee.store

MODULE_HELP = "Specify a space-separated list of modules to load. The order of the list determines their order in the i3bar (from left to right). Use <module>:<alias> to provide an alias in case you want to load the same module multiple times, but specify different parameters."
THEME_HELP = "Specify the theme to use for drawing modules"
PARAMETER_HELP = "Provide configuration parameters in the form of <module>.<key>=<value>"
LIST_HELP = "Display a list of either available themes or available modules along with their parameters."
DEBUG_HELP = "Enable debug log, This will create '~/bumblebee-status-debug.log' by default, can be changed with the '-f' option"
ICONMARKUP_HELP = "A Python format string that is valid Pango markup used for low level customization of icons on top of themes. There is no validation performed, this is delegated to the user. Used together with --markup=pango. Example: \"<span foreground='#ffffff' background='#000000'>{}</span>\". WARNING: highly experimental feature"

class print_usage(argparse.Action):
    def __init__(self, option_strings, dest, nargs=None, **kwargs):
        argparse.Action.__init__(self, option_strings, dest, nargs, **kwargs)
        self._indent = " "*2

    def __call__(self, parser, namespace, value, option_string=None):
        if value == "modules":
            self._args = namespace
            self.print_modules()
        elif value == "themes":
            self.print_themes()
        sys.exit(0)

    def print_themes(self):
        print(", ".join(bumblebee.theme.themes()))

    def print_modules(self):
        if self._args.list_format == "markdown":
            print("# Table of modules")
            print("|Name |Description |")
            print("|-----|------------|")

        for m in bumblebee.engine.all_modules():
            try:
                mod = importlib.import_module("bumblebee.modules.{}".format(m["name"]))
                if self._args.list_format == "markdown":
                    doc = mod.__doc__.replace("<", "\<")
                    doc = doc.replace(">", "\>")
                    doc = doc.replace("\n", "<br>")
                    print("|{} |{} |".format(m["name"], doc))
                else:
                    print(textwrap.fill("{}:".format(m["name"]), 80,
                            initial_indent=self._indent*2, subsequent_indent=self._indent*2))
                    for line in mod.__doc__.split("\n"):
                        print(textwrap.fill(line, 80,
                            initial_indent=self._indent*3, subsequent_indent=self._indent*6))
            except:
                pass

def create_parser():
    """Create the argument parser"""
    parser = argparse.ArgumentParser(description="display system data in the i3bar")
    parser.add_argument("-m", "--modules", nargs="+", action='append', default=[],
        help=MODULE_HELP)
    parser.add_argument("-t", "--theme", default="default", help=THEME_HELP)
    parser.add_argument("--markup", default="none", help="Specify the markup type of the output (e.g. 'pango')")
    parser.add_argument("--iconmarkup", default="none", help=ICONMARKUP_HELP)
    parser.add_argument("-p", "--parameters", nargs="+", action='append', default=[],
        help=PARAMETER_HELP)
    parser.add_argument("-l", "--list", choices=["modules", "themes"], action=print_usage,
        help=LIST_HELP)
    parser.add_argument("--list-format", choices=["plain", "markdown"], help="output format of -l, *must* be specified before -l")
    parser.add_argument("-d", "--debug", action="store_true",
        help=DEBUG_HELP)
    parser.add_argument("-r", "--right-to-left", action="store_true",
        help="Draw widgets from right to left, rather than left to right (which is the default)")
    parser.add_argument("-f", "--logfile", default="~/bumblebee-status-debug.log",
        help="Location of the debug log file")
    parser.add_argument("-i", "--iconset", default="auto",
        help="Specify the name of an iconset to use (overrides theme default)")
    parser.add_argument("-a", "--autohide", nargs="+", default=[],
        help="Specify a list of modules to hide when not in warning/error state")

    return parser

class Config(bumblebee.store.Store):
    """Top-level configuration class

    Parses commandline arguments and provides non-module
    specific configuration information.
    """
    def __init__(self, args=None):
        super(Config, self).__init__()
        parser = create_parser()
        self._args = parser.parse_args(args if args else [])

        if not self._args.debug:
            logging.getLogger().disabled = True

        parameters = [item for sub in self._args.parameters for item in sub]
        for param in parameters:
            key, value = param.split("=", 1)
            self.set(key, value)

    def modules(self):
        modules = [item for sub in self._args.modules for item in sub]
        """Return a list of all activated modules"""
        return [{
            "module": x.split(":")[0],
            "name": x if not ":" in x else x.split(":")[1],
        } for x in modules]

    def theme(self):
        """Return the name of the selected theme"""
        return self._args.theme

    def iconset(self):
        """Return the name of a user-specified icon-set"""
        return self._args.iconset

    def debug(self):
        return self._args.debug

    def reverse(self):
        return self._args.right_to_left

    def logfile(self):
        return os.path.expanduser(self._args.logfile)

    def autohide(self):
        return self._args.autohide

    def markup(self):
        return self._args.markup

    def iconmarkup(self):
        return self._args.iconmarkup

# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4