Python: Як би ви зберегли простий файл налаштувань / конфігурації?


101

Я не хвилює , якщо це JSON, pickle, YAMLабо будь-який інший .

Усі інші реалізовані нами реалізації не сумісні з пересилами, тому якщо у мене є файл конфігурації, додайте новий код у код, а потім завантажте цей конфігураційний файл, він просто вийде з ладу.

Чи є простий спосіб це зробити?


1
Я вважаю, що використання .iniподібного формату configparserмодуля повинно робити те, що ви хочете.
Bakuriu

14
будь-який шанс вибрати свою відповідь як правильну?
Грем Стюарт,

Відповіді:


187

Файли конфігурації в python

Існує кілька способів зробити це залежно від необхідного формату файлу.

ConfigParser [формат .ini]

Я б використовував стандартний підхід до configparser, якщо не було вагомих причин використовувати інший формат.

Напишіть файл так:

# python 2.x
# from ConfigParser import SafeConfigParser
# config = SafeConfigParser()

# python 3.x
from configparser import ConfigParser
config = ConfigParser()

config.read('config.ini')
config.add_section('main')
config.set('main', 'key1', 'value1')
config.set('main', 'key2', 'value2')
config.set('main', 'key3', 'value3')

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

Формат файлу дуже простий із розділами, виділеними у квадратні дужки:

[main]
key1 = value1
key2 = value2
key3 = value3

Значення можна витягти з файлу так:

# python 2.x
# from ConfigParser import SafeConfigParser
# config = SafeConfigParser()

# python 3.x
from configparser import ConfigParser
config = ConfigParser()

config.read('config.ini')

print config.get('main', 'key1') # -> "value1"
print config.get('main', 'key2') # -> "value2"
print config.get('main', 'key3') # -> "value3"

# getfloat() raises an exception if the value is not a float
a_float = config.getfloat('main', 'a_float')

# getint() and getboolean() also do this for their respective types
an_int = config.getint('main', 'an_int')

JSON [.json формат]

Дані JSON можуть бути дуже складними і мають ту перевагу, що є дуже портативними.

Запис даних у файл:

import json

config = {'key1': 'value1', 'key2': 'value2'}

with open('config.json', 'w') as f:
    json.dump(config, f)

Зчитування даних із файлу:

import json

with open('config.json', 'r') as f:
    config = json.load(f)

#edit the data
config['key3'] = 'value3'

#write it back to the file
with open('config.json', 'w') as f:
    json.dump(config, f)

ЯМЛ

Основний приклад YAML наведено у цій відповіді . Більш детальну інформацію можна знайти на веб-сайті pyYAML .


8
в python 3 from configparser import ConfigParser config = ConfigParser()
користувач3148949

12

Основний приклад ConfigParser

Файл можна завантажити та використовувати таким чином:

#!/usr/bin/env python

import ConfigParser
import io

# Load the configuration file
with open("config.yml") as f:
    sample_config = f.read()
config = ConfigParser.RawConfigParser(allow_no_value=True)
config.readfp(io.BytesIO(sample_config))

# List all contents
print("List all contents")
for section in config.sections():
    print("Section: %s" % section)
    for options in config.options(section):
        print("x %s:::%s:::%s" % (options,
                                  config.get(section, options),
                                  str(type(options))))

# Print some contents
print("\nPrint some contents")
print(config.get('other', 'use_anonymous'))  # Just get the value
print(config.getboolean('other', 'use_anonymous'))  # You know the datatype?

який виводить

List all contents
Section: mysql
x host:::localhost:::<type 'str'>
x user:::root:::<type 'str'>
x passwd:::my secret password:::<type 'str'>
x db:::write-math:::<type 'str'>
Section: other
x preprocessing_queue:::["preprocessing.scale_and_center",
"preprocessing.dot_reduction",
"preprocessing.connect_lines"]:::<type 'str'>
x use_anonymous:::yes:::<type 'str'>

Print some contents
yes
True

Як бачите, ви можете використовувати стандартний формат даних, який легко читати і записувати. Такі методи, як getboolean та getint, дозволяють отримати тип даних замість простого рядка.

Конфігурація запису

import os
configfile_name = "config.yaml"

# Check if there is already a configurtion file
if not os.path.isfile(configfile_name):
    # Create the configuration file as it doesn't exist yet
    cfgfile = open(configfile_name, 'w')

    # Add content to the file
    Config = ConfigParser.ConfigParser()
    Config.add_section('mysql')
    Config.set('mysql', 'host', 'localhost')
    Config.set('mysql', 'user', 'root')
    Config.set('mysql', 'passwd', 'my secret password')
    Config.set('mysql', 'db', 'write-math')
    Config.add_section('other')
    Config.set('other',
               'preprocessing_queue',
               ['preprocessing.scale_and_center',
                'preprocessing.dot_reduction',
                'preprocessing.connect_lines'])
    Config.set('other', 'use_anonymous', True)
    Config.write(cfgfile)
    cfgfile.close()

призводить до

[mysql]
host = localhost
user = root
passwd = my secret password
db = write-math

[other]
preprocessing_queue = ['preprocessing.scale_and_center', 'preprocessing.dot_reduction', 'preprocessing.connect_lines']
use_anonymous = True

Базовий приклад XML

Здається, взагалі не використовується для файлів конфігурації спільнотою Python. Однак синтаксичний аналіз / запис XML є простим, і існує безліч можливостей зробити це за допомогою Python. Один є BeautifulSoup:

from BeautifulSoup import BeautifulSoup

with open("config.xml") as f:
    content = f.read()

y = BeautifulSoup(content)
print(y.mysql.host.contents[0])
for tag in y.other.preprocessing_queue:
    print(tag)

де config.xml може виглядати так

<config>
    <mysql>
        <host>localhost</host>
        <user>root</user>
        <passwd>my secret password</passwd>
        <db>write-math</db>
    </mysql>
    <other>
        <preprocessing_queue>
            <li>preprocessing.scale_and_center</li>
            <li>preprocessing.dot_reduction</li>
            <li>preprocessing.connect_lines</li>
        </preprocessing_queue>
        <use_anonymous value="true" />
    </other>
</config>

Хороший код / ​​приклади. Незначний коментар - у вашому прикладі YAML використовується не формат YAML, а формат INI.
Ерік Крамер

Слід зазначити, що принаймні версія програми ConfigParser python 2 при читанні мовчки перетворює збережений список у рядок. Тобто. CP.set ('section', 'option', [1,2,3]) після збереження та читання конфігурації буде CP.get ('section', 'option') => '1, 2, 3'
Gnudiff

10

Якщо ви хочете використовувати щось на зразок INI-файлу для зберігання налаштувань, подумайте про використання configparser, який завантажує пари ключових значень з текстового файлу і може легко записати назад у файл.

Файл INI має формат:

[Section]
key = value
key with spaces = somevalue

2

Збережіть і завантажте словник. У вас будуть довільні ключі, значення та довільна кількість пар ключів, значень.


чи можу я використовувати рефакторинг з цим?
Лоре

1

Спробуйте скористатися ReadSettings :

from readsettings import ReadSettings
data = ReadSettings("settings.json") # Load or create any json, yml, yaml or toml file
data["name"] = "value" # Set "name" to "value"
data["name"] # Returns: "value"

-2

спробуйте використовувати cfg4py :

  1. Ієрархічний дизайн, підтримка різноманітних середовищ, тому ніколи не псуйте налаштування розробника з налаштуваннями виробничого сайту.
  2. Заповнення коду. Cfg4py перетворить ваш yaml у клас python, тоді заповнення коду буде доступним під час введення коду.
  3. набагато більше..

ЗАМОВЛЕННЯ: Я автор цього модуля

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.