python - विकल्पों का एक संग्रह प्राप्त करने के लिए पार्स कॉन्फ़िगरेशन फ़ाइलें, पर्यावरण, और कमांड-लाइन तर्क




environment-variables command-line-arguments (6)

पायथन की मानक लाइब्रेरी में कॉन्फ़िगरेशन फ़ाइल पार्सिंग ( configparser ), पर्यावरण परिवर्तनीय पढ़ने ( os.environ ), और कमांड लाइन तर्क पार्सिंग ( argparse ) के लिए argparse । मैं एक कार्यक्रम लिखना चाहता हूं जो उन सभी को करता है, और यह भी:

  • विकल्प मूल्यों का एक कैस्केड है :

    • डिफ़ॉल्ट विकल्प मान, द्वारा ओवरराइड
    • कॉन्फ़िगरेशन फ़ाइल विकल्प, द्वारा ओवरराइड
    • पर्यावरण चर, द्वारा ओवरराइड
    • कमांड लाइन विकल्प।
  • कमांड लाइन पर निर्दिष्ट एक या अधिक कॉन्फ़िगरेशन फ़ाइल स्थानों को उदाहरण के साथ --config-file foo.conf , और इसे पढ़ता है (या तो सामान्य कॉन्फ़िगरेशन फ़ाइल के बजाय, या अतिरिक्त)। यह अभी भी उपरोक्त कैस्केड का पालन करना होगा।

  • विन्यास फाइलों और कमांड लाइन के लिए पार्सिंग व्यवहार निर्धारित करने के लिए एक ही स्थान पर विकल्प परिभाषाओं को अनुमति देता है।

  • पार्स किए गए विकल्पों को विकल्प के मूल्यों के एक संग्रह में एकीकृत करता है, बाकी कार्यक्रमों के लिए पहुंचने के बिना, जहां से वे आए थे।

मुझे जो कुछ भी चाहिए वह पाइथन मानक पुस्तकालय में स्पष्ट रूप से है, लेकिन वे आसानी से मिलकर काम नहीं करते हैं।

मैं पाइथन मानक पुस्तकालय से न्यूनतम विचलन के साथ इसे कैसे प्राप्त कर सकता हूं?


Argparse मॉड्यूल यह पागल नहीं बनाता है, जब तक आप एक कॉन्फ़िगरेशन फ़ाइल से खुश हैं जो कमांड लाइन की तरह दिखता है। (मुझे लगता है कि यह एक फायदा है, क्योंकि उपयोगकर्ताओं को केवल एक वाक्यविन्यास सीखना होगा।) उदाहरण के लिए, fromfile_prefix_chars को सेट करना, @ , ऐसा करता है,

my_prog --foo=bar

के बराबर है

my_prog @baz.conf

अगर @baz.conf है,

--foo
bar

आप argv को संशोधित करके स्वचालित रूप से foo.conf लिए अपना कोड भी देख सकते हैं

if os.path.exists('foo.conf'):
    argv = ['@foo.conf'] + argv
args = argparser.parse_args(argv)

इन कॉन्फ़िगरेशन फ़ाइलों का प्रारूप ArgumentParser का उप-वर्ग बनाकर और एक convert_arg_line_to_args विधि जोड़कर convert_arg_line_to_args है।


उन सभी आवश्यकताओं को हिट करने के लिए, मैं आपकी अपनी लाइब्रेरी लिखने की अनुशंसा करता हूं जो अंतर्निहित कार्यक्षमता के लिए [opt | arg] parse और configparser दोनों का उपयोग करता है।

पहले दो और आखिरी आवश्यकता को देखते हुए, मैं कहूंगा कि आप चाहते हैं:

चरण एक: एक कमांड लाइन पार्सर पास करें जो केवल --config-file विकल्प को देखता है।

चरण दो: कॉन्फ़िगर फ़ाइल को पार्स करें।

चरण तीन: डिफ़ॉल्ट फ़ाइल के रूप में कॉन्फ़िगरेशन फ़ाइल पास के आउटपुट का उपयोग करके दूसरा कमांड लाइन पार्सर पास सेट करें।

तीसरी आवश्यकता का मतलब है कि आपको अपने स्वयं के विकल्प परिभाषा प्रणाली को डिज़ाइन करना है जो ऑप्टपर और कॉन्फ़िगरर्स की सभी कार्यक्षमताओं का पर्दाफाश करने के लिए तैयार है, और आप बीच में रूपांतरण करने के लिए कुछ नलसाजी लिखते हैं।


जबकि मैंने इसे स्वयं नहीं किया है, वहां ConfigArgParse लाइब्रेरी है जो बताती है कि यह अधिकतर चीजें जो आप चाहते हैं:

Argparse के लिए एक ड्रॉप-इन प्रतिस्थापन जो कॉन्फ़िगरेशन फ़ाइलों और / या पर्यावरण चर के माध्यम से विकल्पों को भी सेट करने की अनुमति देता है।


जहां तक ​​मुझे पता है, पाइथन मानक पुस्तकालय यह प्रदान नहीं करता है। मैंने कमांड लाइन और कॉन्फ़िगरेशन फ़ाइलों को पार्स करने के लिए optparse और ConfigParser optparse का उपयोग करने के लिए कोड लिखकर स्वयं को हल किया, और उनमें से शीर्ष पर एक अमूर्त परत प्रदान की। हालांकि, आपको इसे एक अलग निर्भरता के रूप में आवश्यकता होगी, जो आपकी पिछली टिप्पणी से असंभव प्रतीत होता है।

यदि आप मेरे द्वारा लिखे गए कोड को देखना चाहते हैं, तो यह http://liw.fi/cliapp/ । यह मेरे "कमांड लाइन एप्लिकेशन फ्रेमवर्क" लाइब्रेरी में एकीकृत है, क्योंकि फ्रेमवर्क को क्या करना है इसका एक बड़ा हिस्सा है।


यहां एक मॉड्यूल है जिसे मैंने एक साथ हैक किया है जो कमांड लाइन तर्क, पर्यावरण सेटिंग्स, आईएनआई फ़ाइलें, और कीरिंग मान भी पढ़ता है। यह एक gist में भी उपलब्ध है।

"""
Configuration Parser

Configurable parser that will parse config files, environment variables,
keyring, and command-line arguments.



Example test.ini file:

    [defaults]
    gini=10

    [app]
    xini = 50

Example test.arg file:

    --xfarg=30

Example test.py file:

    import os
    import sys

    import config


    def main(argv):
        '''Test.'''
        options = [
            config.Option("xpos",
                          help="positional argument",
                          nargs='?',
                          default="all",
                          env="APP_XPOS"),
            config.Option("--xarg",
                          help="optional argument",
                          default=1,
                          type=int,
                          env="APP_XARG"),
            config.Option("--xenv",
                          help="environment argument",
                          default=1,
                          type=int,
                          env="APP_XENV"),
            config.Option("--xfarg",
                          help="@file argument",
                          default=1,
                          type=int,
                          env="APP_XFARG"),
            config.Option("--xini",
                          help="ini argument",
                          default=1,
                          type=int,
                          ini_section="app",
                          env="APP_XINI"),
            config.Option("--gini",
                          help="global ini argument",
                          default=1,
                          type=int,
                          env="APP_GINI"),
            config.Option("--karg",
                          help="secret keyring arg",
                          default=-1,
                          type=int),
        ]
        ini_file_paths = [
            '/etc/default/app.ini',
            os.path.join(os.path.dirname(os.path.abspath(__file__)),
                         'test.ini')
        ]

        # default usage
        conf = config.Config(prog='app', options=options,
                             ini_paths=ini_file_paths)
        conf.parse()
        print conf

        # advanced usage
        cli_args = conf.parse_cli(argv=argv)
        env = conf.parse_env()
        secrets = conf.parse_keyring(namespace="app")
        ini = conf.parse_ini(ini_file_paths)
        sources = {}
        if ini:
            for key, value in ini.iteritems():
                conf[key] = value
                sources[key] = "ini-file"
        if secrets:
            for key, value in secrets.iteritems():
                conf[key] = value
                sources[key] = "keyring"
        if env:
            for key, value in env.iteritems():
                conf[key] = value
                sources[key] = "environment"
        if cli_args:
            for key, value in cli_args.iteritems():
                conf[key] = value
                sources[key] = "command-line"
        print '\n'.join(['%s:\t%s' % (k, v) for k, v in sources.items()])


    if __name__ == "__main__":
        if config.keyring:
            config.keyring.set_password("app", "karg", "13")
        main(sys.argv)

Example results:

    $APP_XENV=10 python test.py api --xarg=2 @test.arg
    <Config xpos=api, gini=1, xenv=10, xini=50, karg=13, xarg=2, xfarg=30>
    xpos:   command-line
    xenv:   environment
    xini:   ini-file
    karg:   keyring
    xarg:   command-line
    xfarg:  command-line


"""
import argparse
import ConfigParser
import copy
import os
import sys

try:
    import keyring
except ImportError:
    keyring = None


class Option(object):
    """Holds a configuration option and the names and locations for it.

    Instantiate options using the same arguments as you would for an
    add_arguments call in argparse. However, you have two additional kwargs
    available:

        env: the name of the environment variable to use for this option
        ini_section: the ini file section to look this value up from
    """

    def __init__(self, *args, **kwargs):
        self.args = args or []
        self.kwargs = kwargs or {}

    def add_argument(self, parser, **override_kwargs):
        """Add an option to a an argparse parser."""
        kwargs = {}
        if self.kwargs:
            kwargs = copy.copy(self.kwargs)
            try:
                del kwargs['env']
            except KeyError:
                pass
            try:
                del kwargs['ini_section']
            except KeyError:
                pass
        kwargs.update(override_kwargs)
        parser.add_argument(*self.args, **kwargs)

    @property
    def type(self):
        """The type of the option.

        Should be a callable to parse options.
        """
        return self.kwargs.get("type", str)

    @property
    def name(self):
        """The name of the option as determined from the args."""
        for arg in self.args:
            if arg.startswith("--"):
                return arg[2:].replace("-", "_")
            elif arg.startswith("-"):
                continue
            else:
                return arg.replace("-", "_")

    @property
    def default(self):
        """The default for the option."""
        return self.kwargs.get("default")


class Config(object):
    """Parses configuration sources."""

    def __init__(self, options=None, ini_paths=None, **parser_kwargs):
        """Initialize with list of options.

        :param ini_paths: optional paths to ini files to look up values from
        :param parser_kwargs: kwargs used to init argparse parsers.
        """
        self._parser_kwargs = parser_kwargs or {}
        self._ini_paths = ini_paths or []
        self._options = copy.copy(options) or []
        self._values = {option.name: option.default
                        for option in self._options}
        self._parser = argparse.ArgumentParser(**parser_kwargs)
        self.pass_thru_args = []

    @property
    def prog(self):
        """Program name."""
        return self._parser.prog

    def __getitem__(self, key):
        return self._values[key]

    def __setitem__(self, key, value):
        self._values[key] = value

    def __delitem__(self, key):
        del self._values[key]

    def __contains__(self, key):
        return key in self._values

    def __iter__(self):
        return iter(self._values)

    def __len__(self):
        return len(self._values)

    def get(self, key, *args):
        """
        Return the value for key if it exists otherwise the default.
        """
        return self._values.get(key, *args)

    def __getattr__(self, attr):
        if attr in self._values:
            return self._values[attr]
        else:
            raise AttributeError("'config' object has no attribute '%s'"
                                 % attr)

    def build_parser(self, options, **override_kwargs):
        """."""
        kwargs = copy.copy(self._parser_kwargs)
        kwargs.update(override_kwargs)
        if 'fromfile_prefix_chars' not in kwargs:
            kwargs['fromfile_prefix_chars'] = '@'
        parser = argparse.ArgumentParser(**kwargs)
        if options:
            for option in options:
                option.add_argument(parser)
        return parser

    def parse_cli(self, argv=None):
        """Parse command-line arguments into values."""
        if not argv:
            argv = sys.argv
        options = []
        for option in self._options:
            temp = Option(*option.args, **option.kwargs)
            temp.kwargs['default'] = argparse.SUPPRESS
            options.append(temp)
        parser = self.build_parser(options=options)
        parsed, extras = parser.parse_known_args(argv[1:])
        if extras:
            valid, pass_thru = self.parse_passthru_args(argv[1:])
            parsed, extras = parser.parse_known_args(valid)
            if extras:
                raise AttributeError("Unrecognized arguments: %s" %
                                     ' ,'.join(extras))
            self.pass_thru_args = pass_thru + extras
        return vars(parsed)

    def parse_env(self):
        results = {}
        for option in self._options:
            env_var = option.kwargs.get('env')
            if env_var and env_var in os.environ:
                value = os.environ[env_var]
                results[option.name] = option.type(value)
        return results

    def get_defaults(self):
        """Use argparse to determine and return dict of defaults."""
        parser = self.build_parser(options=self._options)
        parsed, _ = parser.parse_known_args([])
        return vars(parsed)

    def parse_ini(self, paths=None):
        """Parse config files and return configuration options.

        Expects array of files that are in ini format.
        :param paths: list of paths to files to parse (uses ConfigParse logic).
                      If not supplied, uses the ini_paths value supplied on
                      initialization.
        """
        results = {}
        config = ConfigParser.SafeConfigParser()
        config.read(paths or self._ini_paths)
        for option in self._options:
            ini_section = option.kwargs.get('ini_section')
            if ini_section:
                try:
                    value = config.get(ini_section, option.name)
                    results[option.name] = option.type(value)
                except ConfigParser.NoSectionError:
                    pass
        return results

    def parse_keyring(self, namespace=None):
        """."""
        results = {}
        if not keyring:
            return results
        if not namespace:
            namespace = self.prog
        for option in self._options:
            secret = keyring.get_password(namespace, option.name)
            if secret:
                results[option.name] = option.type(secret)
        return results

    def parse(self, argv=None):
        """."""
        defaults = self.get_defaults()
        args = self.parse_cli(argv=argv)
        env = self.parse_env()
        secrets = self.parse_keyring()
        ini = self.parse_ini()

        results = defaults
        results.update(ini)
        results.update(secrets)
        results.update(env)
        results.update(args)

        self._values = results
        return self

    @staticmethod
    def parse_passthru_args(argv):
        """Handles arguments to be passed thru to a subprocess using '--'.

        :returns: tuple of two lists; args and pass-thru-args
        """
        if '--' in argv:
            dashdash = argv.index("--")
            if dashdash == 0:
                return argv[1:], []
            elif dashdash > 0:
                return argv[0:dashdash], argv[dashdash + 1:]
        return argv, []

    def __repr__(self):
        return "<Config %s>" % ', '.join([
            '%s=%s' % (k, v) for k, v in self._values.iteritems()])


def comma_separated_strings(value):
    """Handles comma-separated arguments passed in command-line."""
    return map(str, value.split(","))


def comma_separated_pairs(value):
    """Handles comma-separated key/values passed in command-line."""
    pairs = value.split(",")
    results = {}
    for pair in pairs:
        key, pair_value = pair.split('=')
        results[key] = pair_value
    return results

यहां कुछ ऐसा है जो मैंने एक साथ हैक किया था। टिप्पणियों में मुफ्त सुझाव सुधार / बग-रिपोर्ट महसूस करें:

import argparse
import ConfigParser
import os

def _identity(x):
    return x

_SENTINEL = object()


class AddConfigFile(argparse.Action):
    def __call__(self,parser,namespace,values,option_string=None):
        # I can never remember if `values` is a list all the time or if it
        # can be a scalar string; this takes care of both.
        if isinstance(values,basestring):
            parser.config_files.append(values)
        else:
            parser.config_files.extend(values)


class ArgumentConfigEnvParser(argparse.ArgumentParser):
    def __init__(self,*args,**kwargs):
        """
        Added 2 new keyword arguments to the ArgumentParser constructor:

           config --> List of filenames to parse for config goodness
           default_section --> name of the default section in the config file
        """
        self.config_files = kwargs.pop('config',[])  #Must be a list
        self.default_section = kwargs.pop('default_section','MAIN')
        self._action_defaults = {}
        argparse.ArgumentParser.__init__(self,*args,**kwargs)


    def add_argument(self,*args,**kwargs):
        """
        Works like `ArgumentParser.add_argument`, except that we've added an action:

           config: add a config file to the parser

        This also adds the ability to specify which section of the config file to pull the 
        data from, via the `section` keyword.  This relies on the (undocumented) fact that
        `ArgumentParser.add_argument` actually returns the `Action` object that it creates.
        We need this to reliably get `dest` (although we could probably write a simple
        function to do this for us).
        """

        if 'action' in kwargs and kwargs['action'] == 'config':
            kwargs['action'] = AddConfigFile
            kwargs['default'] = argparse.SUPPRESS

        # argparse won't know what to do with the section, so 
        # we'll pop it out and add it back in later.
        #
        # We also have to prevent argparse from doing any type conversion,
        # which is done explicitly in parse_known_args.  
        #
        # This way, we can reliably check whether argparse has replaced the default.
        #
        section = kwargs.pop('section', self.default_section)
        type = kwargs.pop('type', _identity)
        default = kwargs.pop('default', _SENTINEL)

        if default is not argparse.SUPPRESS:
            kwargs.update(default=_SENTINEL)
        else:  
            kwargs.update(default=argparse.SUPPRESS)

        action = argparse.ArgumentParser.add_argument(self,*args,**kwargs)
        kwargs.update(section=section, type=type, default=default)
        self._action_defaults[action.dest] = (args,kwargs)
        return action

    def parse_known_args(self,args=None, namespace=None):
        # `parse_args` calls `parse_known_args`, so we should be okay with this...
        ns, argv = argparse.ArgumentParser.parse_known_args(self, args=args, namespace=namespace)
        config_parser = ConfigParser.SafeConfigParser()
        config_files = [os.path.expanduser(os.path.expandvars(x)) for x in self.config_files]
        config_parser.read(config_files)

        for dest,(args,init_dict) in self._action_defaults.items():
            type_converter = init_dict['type']
            default = init_dict['default']
            obj = default

            if getattr(ns,dest,_SENTINEL) is not _SENTINEL: # found on command line
                obj = getattr(ns,dest)
            else: # not found on commandline
                try:  # get from config file
                    obj = config_parser.get(init_dict['section'],dest)
                except (ConfigParser.NoSectionError, ConfigParser.NoOptionError): # Nope, not in config file
                    try: # get from environment
                        obj = os.environ[dest.upper()]
                    except KeyError:
                        pass

            if obj is _SENTINEL:
                setattr(ns,dest,None)
            elif obj is argparse.SUPPRESS:
                pass
            else:
                setattr(ns,dest,type_converter(obj))

        return ns, argv


if __name__ == '__main__':
    fake_config = """
[MAIN]
foo:bar
bar:1
"""
    with open('_config.file','w') as fout:
        fout.write(fake_config)

    parser = ArgumentConfigEnvParser()
    parser.add_argument('--config-file', action='config', help="location of config file")
    parser.add_argument('--foo', type=str, action='store', default="grape", help="don't know what foo does ...")
    parser.add_argument('--bar', type=int, default=7, action='store', help="This is an integer (I hope)")
    parser.add_argument('--baz', type=float, action='store', help="This is an float(I hope)")
    parser.add_argument('--qux', type=int, default='6', action='store', help="this is another int")
    ns = parser.parse_args([])

    parser_defaults = {'foo':"grape",'bar':7,'baz':None,'qux':6}
    config_defaults = {'foo':'bar','bar':1}
    env_defaults = {"baz":3.14159}

    # This should be the defaults we gave the parser
    print ns
    assert ns.__dict__ == parser_defaults

    # This should be the defaults we gave the parser + config defaults
    d = parser_defaults.copy()
    d.update(config_defaults)
    ns = parser.parse_args(['--config-file','_config.file'])
    print ns
    assert ns.__dict__ == d

    os.environ['BAZ'] = "3.14159"

    # This should be the parser defaults + config defaults + env_defaults
    d = parser_defaults.copy()
    d.update(config_defaults)
    d.update(env_defaults)
    ns = parser.parse_args(['--config-file','_config.file'])
    print ns
    assert ns.__dict__ == d

    # This should be the parser defaults + config defaults + env_defaults + commandline
    commandline = {'foo':'3','qux':4} 
    d = parser_defaults.copy()
    d.update(config_defaults)
    d.update(env_defaults)
    d.update(commandline)
    ns = parser.parse_args(['--config-file','_config.file','--foo=3','--qux=4'])
    print ns
    assert ns.__dict__ == d

    os.remove('_config.file')

करने के लिए

यह कार्यान्वयन अभी भी अपूर्ण है। यहां आंशिक TODO सूची है:

दस्तावेजी व्यवहार के अनुरूप है

  • (आसान) Action ऑब्जेक्ट पर भरोसा करने के बजाय add_argument में add_argument से add_argument फ़ंक्शन को लिखें
  • (तुच्छ) एक parse_args फ़ंक्शन लिखें जो parse_known_args का उपयोग करता है। (उदाहरण के लिए cpython कार्यान्वयन से parse_args प्रतिलिपि parse_args लिए यह parse_known_args कॉल parse_known_args ।)

कम आसान सामग्री ...

मैंने अभी तक इस में से कोई भी कोशिश नहीं की है। यह असंभव है-लेकिन अभी भी संभव है! -यह बस काम कर सकता है ...

  • (कठिन?) म्यूचुअल बहिष्करण
  • (कठिन?) तर्क समूह (यदि लागू किया गया है, तो इन समूहों को कॉन्फ़िगरेशन फ़ाइल में एक section प्राप्त करना चाहिए।)
  • (हार्ड?) उप कमांड (सब-कमांड को कॉन्फ़िगरेशन फ़ाइल में भी एक section प्राप्त करना चाहिए।)




configuration-files