首頁 > 軟體

python configparser中預設值的設定方式

2022-02-10 19:00:13

configparser中預設值的設定

在做某一個專案時,在讀組態檔中,當出現組態檔中沒有對應專案時,如果要設定預設值,以前的做法是如下的:

try:
    apple = config.get(section, 'apple')
except NoSectionError, NoOptionError:
    apple = None

但當存在很多設定時,這種寫法太糟糕

幸好,在Configparser.get()函數中有一個vars()的引數,可以自定義;注:只能用ConfigParser.ConfigParser;rawconfigparser是不支援的

解決方案

1、定義函數:

class DefaultOption(dict):
    def __init__(self, config, section, **kv):
        self._config = config
        self._section = section
        dict.__init__(self, **kv)
    def items(self):
        _items = []
        for option in self:
            if not self._config.has_option(self._section, option):
                _items.append((option, self[option]))
            else:
                value_in_config = self._config.get(self._section, option)
                _items.append((option, value_in_config))
        return _items

2、使用

def read_config(section, location):
    config = configparser.ConfigParser()
    config.read(location)
    apple = config.get(section, 'apple',
                       vars=DefaultOption(config, section, apple=None))
    pear = config.get(section, 'pear',
                      vars=DefaultOption(config, section, pear=None))
    banana = config.get(section, 'banana',
                        vars=DefaultOption(config, section, banana=None))
    return apple, pear, banana

這樣就很好解決了讀取組態檔時沒有option時自動取預設值,而不是用rasie的方式取預設值

此方案來之stackoverflow

使用configparser的注意事項

以這個非常簡單的典型組態檔為例:

[DEFAULT]
ServerAliveInterval = 45
Compression = yes
CompressionLevel = 9
ForwardX11 = yes
[bitbucket.org]
User = hg
[topsecret.server.com]
Port = 50022
ForwardX11 = no

1、config parser 操作跟dict 類似,在資料存取方法基本一致

>> import configparser
>>> config = configparser.ConfigParser()
>>> config.sections()
[]
>>> config.read('example.ini')
['example.ini']
>>> config.sections()
['bitbucket.org', 'topsecret.server.com']
>>> 'bitbucket.org' in config
True
>>> 'bytebong.com' in config
False
>>> config['bitbucket.org']['User']
'hg'
>>> config['DEFAULT']['Compression']
'yes'
>>> topsecret = config['topsecret.server.com']
>>> topsecret['ForwardX11']
'no'
>>> topsecret['Port']
'50022'
>>> for key in config['bitbucket.org']: print(key)
...
user
compressionlevel
serveraliveinterval
compression
forwardx11
>>> config['bitbucket.org']['ForwardX11']
'yes'

2、預設設定項[DEFAULT]section 的預設引數會作用於其他Sections

3、資料型別

  • config parsers 不會猜測或自動分析識別config.ini引數的資料型別,都會按照字串型別儲存,如果需要讀取為其他資料型別,需要自定義轉換。
  • 特殊bool值:對於常見的布林值’yes’/‘no’, ‘on’/‘off’, ‘true’/‘false’ 和 ‘1’/‘0’,提供了getboolean()方法。

4、獲取引數值方法 get()

  • 使用get()方法獲取每一引數項的設定值。
  • 如果一般Sections 中引數在[DEFAULT]中也有設定,則get()到位[DEFAULT]中的引數值。

5、引數分隔符可以使用‘=’或‘:’(預設)

6、可以使用‘#’或‘;’(預設)新增備註或說明 

[Simple Values]
key=value
spaces in keys=allowed
spaces in values=allowed as well
spaces around the delimiter = obviously
you can also use : to delimit keys from values
[All Values Are Strings]
values like this: 1000000
or this: 3.14159265359
are they treated as numbers? : no
integers, floats and booleans are held as: strings
can use the API to get converted values directly: true
[Multiline Values]
chorus: I'm a lumberjack, and I'm okay
    I sleep all night and I work all day
[No Values]
key_without_value
empty string value here =
[You can use comments]
# like this
; or this
# By default only in an empty line.
# Inline comments can be harmful because they prevent users
# from using the delimiting characters as parts of values.
# That being said, this can be customized.
    [Sections Can Be Indented]
        can_values_be_as_well = True
        does_that_mean_anything_special = False
        purpose = formatting for readability
        multiline_values = are
            handled just fine as
            long as they are indented
            deeper than the first line
            of a value
        # Did I mention we can indent comments, too?

7、寫設定

常見做法:

config.write(open('example.ini', 'w'))

合理做法:

with open('example.ini', 'w') as configfile:
    config.write(configfile)

注意要點

1、ConfigParser 在get 時會自動過濾掉‘#’或‘;‘註釋的行(內容);

  • 一般情況下我們手工會把設定中的暫時不需要的用‘#‘註釋,問題在於,Configparser 在wirte的時候同file object行為一致,如果將註釋’#‘的設定經過get後,再wirte到conf,那麼’#‘的設定就會丟失。
  • 那麼就需要一個策略或規則,設定需不需要手工編輯 ?還是建立複雜的對原生文字的處理的東西,我建議是管住手,避免將一些重要的設定爆露給使用者編輯,切記行內註釋和Section內註釋。
  • 有一個相對簡單的方法是:
  • 對單獨在一行的程式碼,你可以在讀入前把"#", ";"換成其他字元如’@’,或‘^’(在其bat等其他語言中用的註釋符易於理解),使用allow_no_value選項,這樣註釋會被當成設定儲存下來,處理後你再把“#”, ";"換回來。

2、在ConfigParser write之後,設定文字如果有大寫字母’PRODUCT’會變為小寫字母’product’,並不影響設定的正確讀寫。 

以上為個人經驗,希望能給大家一個參考,也希望大家多多支援it145.com。


IT145.com E-mail:sddin#qq.com