在ConfigParser中列出

时间:2008-12-02 22:29:06

标签: python configparser

典型的ConfigParser生成的文件如下所示:

[Section]
bar=foo
[Section 2]
bar2= baz

现在,有没有办法索引列表,例如:

[Section 3]
barList={
    item1,
    item2
}

相关问题:Python’s ConfigParser unique keys per section

17 个答案:

答案 0 :(得分:183)

也有点晚,但对某些人可能有所帮助。 我正在使用ConfigParser和JSON的组合:

[Foo]
fibs: [1,1,2,3,5,8,13]

只需阅读:

>>> json.loads(config.get("Foo","fibs"))
[1, 1, 2, 3, 5, 8, 13]

如果你的名单很长,你甚至可以打破行(感谢@ peter-smit):

[Bar]
files_to_check = [
     "/path/to/file1",
     "/path/to/file2",
     "/path/to/another file with space in the name"
     ]

当然我可以使用JSON,但我发现配置文件更具可读性,[DEFAULT]部分非常方便。

答案 1 :(得分:114)

没有什么可以阻止你将列表打包成分隔的字符串,然后在从配置中获取字符串后解压缩它。如果您这样做,您的配置部分将如下所示:

[Section 3]
barList=item1,item2

它并不漂亮,但它适用于大多数简单列表。

答案 2 :(得分:86)

这个派对迟到了,但是我最近用配置文件中的专用部分实现了这个列表:

[paths]
path1           = /some/path/
path2           = /another/path/
...

并使用config.items( "paths" )获取可迭代的路径项列表,如下所示:

path_items = config.items( "paths" )
for key, path in path_items:
    #do something with path

希望这有助于其他民间谷歌搜索这个问题;)

答案 3 :(得分:57)

许多人不知道的一件事是允许使用多行配置值。例如:

;test.ini
[hello]
barlist = 
    item1
    item2

config.get('hello','barlist')的值现在为:

"\nitem1\nitem2"

您可以使用splitlines方法轻松拆分(不要忘记过滤空项)。

如果我们看一下像Pyramid这样的大框架,他们就会使用这种技术:

def aslist_cronly(value):
    if isinstance(value, string_types):
        value = filter(None, [x.strip() for x in value.splitlines()])
    return list(value)

def aslist(value, flatten=True):
    """ Return a list of strings, separating the input based on newlines
    and, if flatten=True (the default), also split on spaces within
    each line."""
    values = aslist_cronly(value)
    if not flatten:
        return values
    result = []
    for value in values:
        subvalues = value.split()
        result.extend(subvalues)
    return result

Source

我自己,如果这对你来说很常见,我可能会扩展ConfigParser:

class MyConfigParser(ConfigParser):
    def getlist(self,section,option):
        value = self.get(section,option)
        return list(filter(None, (x.strip() for x in value.splitlines())))

    def getlistint(self,section,option):
        return [int(x) for x in self.getlist(section,option)]

请注意,使用此技术时需要注意一些事项

  1. 作为项目的新行应以空格开头(例如空格或制表符)
  2. 以空格开头的所有后续行都被视为上一项的一部分。如果它有一个=符号或者它以a开头;跟随空白。

答案 4 :(得分:31)

如果您希望字面传递一个列表,那么您可以使用:

ast.literal_eval()

例如配置:

[section]
option=["item1","item2","item3"]

代码是:

import ConfigParser
import ast

my_list = ast.literal_eval(config.get("section", "option"))
print(type(my_list))
print(my_list)

输出:

<type'list'>
["item1","item2","item3"]

答案 5 :(得分:15)

我降落在这里寻求消费......

[global]
spys = richard.sorge@cccp.gov, mata.hari@deutschland.gov

答案是将其拆分为逗号并删除空格:

SPYS = [e.strip() for e in parser.get('global', 'spys').split(',')]

获取列表结果:

['richard.sorge@cccp.gov', 'mata.hari@deutschland.gov']

它可能无法准确回答OP的问题,但可能是一些人正在寻找的简单答案。

答案 6 :(得分:8)

这是我用于列表的内容:

配置文件内容:

[sect]
alist = a
        b
        c

代码:

l = config.get('sect', 'alist').split('\n')

适用于字符串

如果是数字

配置内容:

nlist = 1
        2
        3

代码:

nl = config.get('sect', 'alist').split('\n')
l = [int(nl) for x in nl]

感谢。

答案 7 :(得分:8)

在所有这些答案中都没有提到converters kwarg for ConfigParser()令人失望。

根据文档,您可以将字典传递给ConfigParser,这将为解析器和节代理添加get方法。因此,获得一个列表:

example.ini

[Germ]
germs: a,list,of,names, and,1,2, 3,numbers

解析器示例:

cp = ConfigParser(converters={'list': lambda x: [i.strip() for i in x.split(',')]})
cp.read('example.ini')
cp.getlist('Germ', 'germs')
['a', 'list', 'of', 'names', 'and', '1', '2', '3', 'numbers']
cp['Germ'].getlist('germs')
['a', 'list', 'of', 'names', 'and', '1', '2', '3', 'numbers']

这是我个人的最爱,因为不需要子类化,并且我不必依靠最终用户来完美地编写JSON或可由ast.literal_eval解释的列表。

答案 8 :(得分:2)

我过去遇到过同样的问题。如果您需要更复杂的列表,请考虑通过继承ConfigParser来创建自己的解析器。然后你将用以下方法覆盖get方法:

    def get(self, section, option):
    """ Get a parameter
    if the returning value is a list, convert string value to a python list"""
    value = SafeConfigParser.get(self, section, option)
    if (value[0] == "[") and (value[-1] == "]"):
        return eval(value)
    else:
        return value

使用此解决方案,您还可以在配置文件中定义词典。

但要小心!这不安全:这意味着任何人都可以通过配置文件运行代码。如果安全性不是项目中的问题,我会考虑直接使用python类作为配置文件。以下功能比ConfigParser文件更强大,更具消耗性:

class Section
    bar = foo
class Section2
    bar2 = baz
class Section3
    barList=[ item1, item2 ]

答案 9 :(得分:2)

配置解析器只支持序列化的基本类型。我会使用JSON或YAML来满足这种要求。

答案 10 :(得分:2)

因此,我更喜欢的另一种方法是只拆分值,例如:

#/path/to/config.cfg
[Numbers]
first_row = 1,2,4,8,12,24,36,48

可以像这样将其加载到字符串或整数列表中,如下所示:

import configparser

config = configparser.ConfigParser()
config.read('/path/to/config.cfg')

# Load into a list of strings
first_row_strings = config.get('Numbers', 'first_row').split(',')

# Load into a list of integers
first_row_integers = [int(x) for x in config.get('Numbers', 'first_row').split(',')]

此方法使您无需将值包装在方括号中即可作为JSON加载。

答案 11 :(得分:1)

import ConfigParser
import os

class Parser(object):
    """attributes may need additional manipulation"""
    def __init__(self, section):
        """section to retun all options on, formatted as an object
        transforms all comma-delimited options to lists
        comma-delimited lists with colons are transformed to dicts
        dicts will have values expressed as lists, no matter the length
        """
        c = ConfigParser.RawConfigParser()
        c.read(os.path.join(os.path.dirname(__file__), 'config.cfg'))

        self.section_name = section

        self.__dict__.update({k:v for k, v in c.items(section)})

        #transform all ',' into lists, all ':' into dicts
        for key, value in self.__dict__.items():
            if value.find(':') > 0:
                #dict
                vals = value.split(',')
                dicts = [{k:v} for k, v in [d.split(':') for d in vals]]
                merged = {}
                for d in dicts:
                    for k, v in d.items():
                        merged.setdefault(k, []).append(v)
                self.__dict__[key] = merged
            elif value.find(',') > 0:
                #list
                self.__dict__[key] = value.split(',')

现在我的config.cfg文件看起来像这样:

[server]
credentials=username:admin,password:$3<r3t
loggingdirs=/tmp/logs,~/logs,/var/lib/www/logs
timeoutwait=15

可以为我的小项目解析为细粒度足够的对象。

>>> import config
>>> my_server = config.Parser('server')
>>> my_server.credentials
{'username': ['admin'], 'password', ['$3<r3t']}
>>> my_server.loggingdirs:
['/tmp/logs', '~/logs', '/var/lib/www/logs']
>>> my_server.timeoutwait
'15'

这是为了非常快速地解析简单配置,你无法转换从Parser返回的对象,或者重新完成解析工作其他地方的Parser类。

答案 12 :(得分:0)

json.loads&amp; ast.literal_eval似乎正在工作,但是配置中的简单列表将每个字符视为字节,因此返回方括号....

表示如果配置有fieldvalue = [1,2,3,4,5]

然后config.read(*.cfg) config['fieldValue'][0]返回[代替1

答案 13 :(得分:0)

我在项目中完成了类似的任务,该部分的键没有值:

import configparser

# allow_no_value param says that no value keys are ok
config = configparser.ConfigParser(allow_no_value=True)

# overwrite optionxform method for overriding default behaviour (I didn't want lowercased keys)
config.optionxform = lambda optionstr: optionstr

config.read('./app.config')

features = list(self.config['FEATURES'].keys())

print(features)

输出:

['BIOtag', 'TextPosition', 'IsNoun', 'IsNomn']

app.config:

[FEATURES]
BIOtag
TextPosition
IsNoun
IsNomn

答案 14 :(得分:0)

如Peter Smit(https://stackoverflow.com/a/11866695/7424596)所述 您可能要扩展ConfigParser,此外,可以使用Interpolator自动在列表中进行转换。

作为参考,您可以在下面找到自动转换配置的代码,例如:

[DEFAULT]
keys = [
    Overall cost structure, Capacity, RAW MATERIALS,
    BY-PRODUCT CREDITS, UTILITIES, PLANT GATE COST,
    PROCESS DESCRIPTION, AT 50% CAPACITY, PRODUCTION COSTS,
    INVESTMENT, US$ MILLION, PRODUCTION COSTS, US ¢/LB,
    VARIABLE COSTS, PRODUCTION COSTS, MAINTENANCE MATERIALS
  ]

因此,如果您请求密钥,则会得到:

<class 'list'>: ['Overall cost structure', 'Capacity', 'RAW MATERIALS', 'BY-PRODUCT CREDITS', 'UTILITIES', 'PLANT GATE COST', 'PROCESS DESCRIPTION', 'AT 50% CAPACITY', 'PRODUCTION COSTS', 'INVESTMENT', 'US$ MILLION', 'PRODUCTION COSTS', 'US ¢/LB', 'VARIABLE COSTS', 'PRODUCTION COSTS', 'MAINTENANCE MATERIALS']

代码:

class AdvancedInterpolator(Interpolation):
    def before_get(self, parser, section, option, value, defaults):
        is_list = re.search(parser.LIST_MATCHER, value)
        if is_list:
            return parser.getlist(section, option, raw=True)
        return value


class AdvancedConfigParser(ConfigParser):

    _DEFAULT_INTERPOLATION = AdvancedInterpolator()

    LIST_SPLITTER = '\s*,\s*'
    LIST_MATCHER = '^\[([\s\S]*)\]$'

    def _to_list(self, str):
        is_list = re.search(self.LIST_MATCHER, str)
        if is_list:
            return re.split(self.LIST_SPLITTER, is_list.group(1))
        else:
            return re.split(self.LIST_SPLITTER, str)


    def getlist(self, section, option, conv=lambda x:x.strip(), *, raw=False, vars=None,
                  fallback=_UNSET, **kwargs):
        return self._get_conv(
                section, option,
                lambda value: [conv(x) for x in self._to_list(value)],
                raw=raw,
                vars=vars,
                fallback=fallback,
                **kwargs
        )

    def getlistint(self, section, option, *, raw=False, vars=None,
            fallback=_UNSET, **kwargs):
        return self.getlist(section, option, int, raw=raw, vars=vars,
                fallback=fallback, **kwargs)

    def getlistfloat(self, section, option, *, raw=False, vars=None,
            fallback=_UNSET, **kwargs):
        return self.getlist(section, option, float, raw=raw, vars=vars,
                fallback=fallback, **kwargs)

    def getlistboolean(self, section, option, *, raw=False, vars=None,
            fallback=_UNSET, **kwargs):
        return self.getlist(section, option, self._convert_to_boolean,
                raw=raw, vars=vars, fallback=fallback, **kwargs)
  

Ps 要记住缩进的重要性。如ConfigParser文档字符串中所读:

     
    

值可以跨多行,只要它们缩进得更深             比值的第一行。根据解析器的模式,空白             行可能被视为多行值的一部分或被忽略。

  

答案 15 :(得分:0)

你可以在配置文件中使用列表然后在python中解析它

from ast import literal_eval

literal_eval("[1,2,3,4]")

import json

json.loads("[1,2,3,4]")

你也可以像这样在你的配置文件后面使用 json 文件:

your config file :
[A]
json_dis = .example.jason
--------------------
your code :
import configparser
config = configparser.ConfigParser()
config.read('config.ini')
# getting items of section A
config.items('A')
# result is a list of key-values

答案 16 :(得分:0)

为了让 Grr 的答案(我最喜欢的)更进一步,您可以使用 map 函数,而不是在 .ini 文件中用引号将列表项括起来。这允许您以 Python 方式指定列表项数据类型。

配置文件:

[section]
listKey1: 1001, 1002, 1003
listKey2: AAAA, BBBB, CCCC

代码:

cfgFile = 'config.ini'
parser = ConfigParser(converters={'list': lambda x: [i.strip() for i in x.split(',')]})
parser.read(cfgFile)

list1 = list(map(int, parser.getlist('section', 'listKey1')))
list2 = list(map(str, parser.getlist('section', 'listKey2')))

print(list1)
print(list2)

输出:

[1001, 1002, 1003]
['AAAA', 'BBBB', 'CCCC']