СДоРаз - lib.py:aw_config

except

anonymous@undisclosed.example.com (Anonymous) — Wed, 30 Oct 2024 09:51:08 +0000

30.10.2024 12:50		текущий
Строка 1:		Строка 1:
-	====== Список ======	+	====== Исключения, определённые в библиотеке ======

	^ Имя ^ Наследует от ^ Описание ^		^ Имя ^ Наследует от ^ Описание ^

func

anonymous@undisclosed.example.com (Anonymous) — Tue, 23 Jun 2026 08:57:13 +0000

03.11.2024 16:46		текущий
Строка 102:		Строка 102:
	\| ''conf_selector'' \| Идентификатор объекта конфигурации. См. [[#add_config]] \|		\| ''conf_selector'' \| Идентификатор объекта конфигурации. См. [[#add_config]] \|
	\| ''conf_obj'' \| Собственно объект конфигурации. См. [[#add_config]] \|		\| ''conf_obj'' \| Собственно объект конфигурации. См. [[#add_config]] \|
		+
		+
		+	===== del_config() =====
		+
		+	Удаляем конфигурацию из хранилища. Полезно для конфигурации с паролями, которая больше не нужна в приложении
		+
		+	<code>
		+	del_config(conf_selector)
		+	</code>
		+
		+	^ Параметр ^ Описание ^
		+	\| ''conf_selector'' \| Идентификатор добавленного ранее объекта конфигурации \|

obj

anonymous@undisclosed.example.com (Anonymous) — Tue, 23 Jun 2026 09:26:01 +0000

03.11.2024 16:46		текущий
Строка 4:		Строка 4:
	* ''ConfigFile'' - обрабатывает файл целиком и предоставляет интерфейс работы с конфигурацией.		* ''ConfigFile'' - обрабатывает файл целиком и предоставляет интерфейс работы с конфигурацией.
	* ''ConfigFileContent'' - обрабатывает секции файла, давая интерфейс доступа к элементам конфигурации.		* ''ConfigFileContent'' - обрабатывает секции файла, давая интерфейс доступа к элементам конфигурации.
-
-
-	====== Работа с файлом конфигурации ======
-
-	Конструктор объекта ''ConfigFile'' принимает путь к файлу конфигурации. Путь задаётся строкой и может быть относительным.
-
-	<code python>
-	conf_file = ConfigFile('/etc/application.conf')
-	</code>
-
-	Далее объект ''ConfigFileContent'' можно получить либо вызвав метод ''get()'', либо, что более предпочтительно, воспользовавшись менеджером контекста:
-
-	<code python>
-	with ConfigFile(config_file) as root_section:
-	port = root_section.get_value('port', int, 8080)
-	</code>
-
-	Особенно хорошо и лаконично получается при использовании хранилища конфигураций:
-	<code python>
-	with ConfigFile('/etc/application.conf') as root_section:
-	add_config(NetConfig, NetConfig(
-	port=root_section.get_value('port', int, 8080),
-	baseurl=root_section.get_value('baseurl', str)
-	))
-	</code>
-
-	Иной работы объекты класса ''ConfigFile'' не делают.
-
-
-	===== Работа с параметрами конфигурации =====
-
-	Как известно, файлы конфигурации в формате toml легко можно представить в виде словаря Python (либо JSON-объекта). Для работы с одним уровнем данного словаря и создан класс ''ConfigFileContent''. Он даёт API работы с параметрами на данном текущем уровне.


Строка 85:		Строка 53:
	with ConfigFile('/etc/application.conf') as root_section:		with ConfigFile('/etc/application.conf') as root_section:
	with root_section.get_section('section') as section_section:		with root_section.get_section('section') as section_section:
		+	param1 = section_section.get_value('parma1')
		+	</code>
		+
		+
		+	==== get_list_section() ====
		+
		+	Подобен ''get_section()'', но ожидает увидеть либо словарь, либо список словарей.
		+
		+	<code>
		+	obj.get_list_section(name, [mandatory])
		+	</code>
		+
		+	Возвращает: Массив объектов ''ConfigFileContent'' содержимого нижележащего уровня.
		+
		+	^ Параметр ^ Тип ^ Описание ^
		+	\| ''name'' \| ''str'' \| Имя секции, как оно задано в файле \|
		+	\| ''mandatory'' \| ''bool'' \| Является ли секция обязательной. Если да, и она отсутствует, то возбуждается исключение ''ConfigSectionNotFound''. В противном случае возвращается пустая секция, не содержащая параметров. //По умолчанию// ''True'' \|
		+
		+	Для работы с секциями можно применять менеджер контекста. Например для файла с содержимым:
		+	<code toml>
		+	[[section]]
		+	param = "value1"
		+
		+	[[section]]
		+	param = "value2"
		+	</code>
		+
		+	Можно применить следующий код:
		+	<code python>
		+	with ConfigFile('/etc/application.conf') as root_section:
		+	with root_sectin.get_list_section('section') as section_section:
		+	conf_ar = []
		+	for el in net_section:
		+	conf_ar.append(dict(
		+	param1 = el.get_value('parma1')
		+	))
		+
		+	</code>
		+
		+
		+	==== get_section_by_path() ====
		+
		+	Подобен ''get_section()'', но позволяет пройти по иерархии дальше чем на один уровень. Каждый уровень указывается отдельным параметром
		+
		+	<code>
		+	obj.get_section_by_path(name, ..., [mandatory=False])
		+	</code>
		+
		+	Возвращает: Объект ''ConfigFileContent'' содержимого нижележашего уровня.
		+
		+	^ Параметр ^ Тип ^ Описание ^
		+	\| ''name'' \| ''str'' \| Имя секции, как оно задано в файле. Параметр можно задавать несколько раз \|
		+	\| ''mandatory'' \| ''bool'' \| Является ли секция обязательной. Если да, и она отсутствует, то возбуждается исключение ''ConfigSectionNotFound''. В противном случае возвращается пустая секция, не содержащая параметров. //По умолчанию// ''True''. Задаётся ТОЛЬКО в формате ключ-значение \|
		+
		+	Для работы с секциями можно применять менеджер контекста. Например для файла с содержимым:
		+	<code toml>
		+	[section.section2]
		+	param1 = "value1"
		+	</code>
		+
		+	Можно применить следующий код:
		+	<code python>
		+	with ConfigFile('/etc/application.conf') as root_section:
		+	with root_section.get_section_by_path('section', 'section2') as section_section:
	param1 = section_section.get_value('parma1')		param1 = section_section.get_value('parma1')
	</code>		</code>

root

anonymous@undisclosed.example.com (Anonymous) — Wed, 24 Jun 2026 10:41:31 +0000

24.06.2026 13:38		текущий
Строка 70:		Строка 70:
	add_config(NetConfig, conf_ar)		add_config(NetConfig, conf_ar)
	</code>		</code>
		+
		+	Кроме массива можно строить словарь, если выделить некий ключевой элемент в конфигурации
		+	<code python>
		+	with ConfigFile('/etc/application.conf') as root_section:
		+	conf_ar = {}
		+	for net_section in root_sectin.get_list_section('net'):
		+	_name = net_section.get_value('name')
		+	conf_ar[_name] = NetConfig(
		+	name=_name,
		+	ip=net_section.get_value('ip')
		+	)
		+
		+	add_config(NetConfig, conf_ar)
		+	</code>
		+

	Иной работы объекты класса ''ConfigFile'' не делают.		Иной работы объекты класса ''ConfigFile'' не делают.

type_helper

anonymous@undisclosed.example.com (Anonymous) — Wed, 30 Oct 2024 07:41:07 +0000

30.10.2024 10:40		текущий
Строка 50:		Строка 50:
	Возвращает: Словарь, с ключами и значениями приведёнными к заданному типу		Возвращает: Словарь, с ключами и значениями приведёнными к заданному типу

-	^ Параметр ^ Описание ^	+	^ Параметр ^ Описание ^
	\| ''key_type'' \| Тип ключа словаря \|		\| ''key_type'' \| Тип ключа словаря \|
	\| ''el_type'' \| Тип значения словаря \|		\| ''el_type'' \| Тип значения словаря \|