Как читать файл свойств в Python?

Мы можем использовать модуль jproperties для чтения файла свойств в Python. Файл свойств содержит пары ключ-значение в каждой строке. Знак равенства (=) служит разделителем между ключом и значением. Строка, начинающаяся с #, считается комментарием.

Установка библиотеки jproperties

Этот модуль не является частью стандартной установки. Мы можем установить модуль jproperties с использованием PIP.

# pip install jproperties

Чтение файла свойств в Python

I have created a properties file for our example: app-config.properties.

# Database Credentials
DB_HOST=localhost
DB_SCHEMA=Test
DB_User=root
DB_PWD=root@neon

# База данных Учетные данные

from jproperties import Properties

configs = Properties()

Первым шагом является импорт объекта Properties в нашу программу Python и его инстанциация.

with open('app-config.properties', 'rb') as config_file:
    configs.load(config_file)

Следующим шагом является загрузка файла свойств в объект Properties.

Рекомендуемое чтение: Python с оператором with

Теперь мы можем читать определенное свойство с помощью метода get() или через индекс. Объекты свойств очень похожи на словарь Python.

print(configs.get("DB_User"))  
Значение хранится в объекте PropertyTuple, который является именованным кортежем из двух значений - данные и мета. Объекты jproperties также поддерживают метаданные свойств, но здесь нас это не интересует. 

print(f'Database User: {configs.get("DB_User").data}')  
# PropertyTuple(data='root', meta={})

print(f'Database Password: {configs["DB_PWD"].data}')  
# Пользователь базы данных: root

# Пароль базы данных: root@neon

print(f'Properties Count: {len(configs)}')  
Мы можем использовать функцию len(), чтобы получить количество свойств. 

# Количество свойств: 4

Что, если ключ не существует?

random_value = configs.get("Random_Key")
print(random_value)  Если ключ не существует, метод get() вернет None. 

# None

try:
    random_value = configs["Random_Key"]
    print(random_value)
except KeyError as ke:
    print(f'{ke}, lookup key was "Random_Key"')

Но если мы используем индекс, то будет выброшено исключение KeyError. В этом случае лучше обработать это исключение с помощью блока try-except.
# Вывод:

# ‘Ключ не найден’, ключ поиска был “Random_Key”

Печать всех свойств

items_view = configs.items()
print(type(items_view))

for item in items_view:
    print(item)

Мы можем использовать метод items(), чтобы получить коллекцию кортежей, которая содержит ключи и соответствующие значения PropertyTuple.

<class 'collections.abc.ItemsView'>
('DB_HOST', PropertyTuple(data='localhost', meta={}))
('DB_SCHEMA', PropertyTuple(data='Test', meta={}))
('DB_User', PropertyTuple(data='root', meta={}))
('DB_PWD', PropertyTuple(data='root@neon', meta={}))

Вывод:

for item in items_view:
    print(item[0], '=', item[1].data)

Поскольку мы хотим вывести ключ=значение в качестве результата, мы можем использовать следующий код.

DB_HOST = localhost
DB_SCHEMA = Test
DB_User = root
DB_PWD = root@neon

Вывод:

Получение списка ключей из файла свойств

from jproperties import Properties

configs = Properties()

with open('app-config.properties', 'rb') as config_file:
    configs.load(config_file)

items_view = configs.items()
list_keys = []

for item in items_view:
    list_keys.append(item[0])

print(list_keys)  
Вот полная программа для чтения файла свойств и создания списка всех ключей.

# [‘DB_HOST’, ‘DB_SCHEMA’, ‘DB_User’, ‘DB_PWD’]

A properties file is the same as a dictionary. So, it’s a common practice to read the properties file into a dictionary. The steps are similar to above, except for the change in the iteration code to add the elements to a dictionary.

db_configs_dict = {}

for item in items_view:
    db_configs_dict[item[0]] = item[1].data

print(db_configs_dict)
Чтение файла свойств Python в словарь

# {‘DB_HOST’: ‘localhost’, ‘DB_SCHEMA’: ‘Test’, ‘DB_User’: ‘root’, ‘DB_PWD’: ‘root@neon’}