Конфигурация приложения перенесена в библиотеку
This commit is contained in:
@@ -8,5 +8,5 @@
|
||||
Пакет классов работы с параметрами конфигурации
|
||||
"""
|
||||
|
||||
from .log_debug_filter import LogDebugFilter
|
||||
from .rack_config import RackConfig
|
||||
from .environment import Environment
|
||||
from .setting_utils import SettingUtils
|
||||
|
||||
@@ -8,12 +8,13 @@
|
||||
Параметры конфигурации базы данных
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import RackConfig
|
||||
from net.xeaf.rack.utils.settings import Environment
|
||||
from net.xeaf.rack.utils.settings import SettingUtils
|
||||
|
||||
#
|
||||
# Проверка режима запуска тестов
|
||||
#
|
||||
if not RackConfig.is_test_mode():
|
||||
if not SettingUtils.is_test_mode():
|
||||
|
||||
#
|
||||
# Основная БД
|
||||
@@ -21,11 +22,11 @@ if not RackConfig.is_test_mode():
|
||||
DATABASES = {
|
||||
"default": {
|
||||
"ENGINE": "django.db.backends.postgresql",
|
||||
"HOST": RackConfig.env_str("DATABASE_HOST"),
|
||||
"PORT": RackConfig.env_str("DATABASE_PORT"),
|
||||
"NAME": RackConfig.env_str("DATABASE_NAME"),
|
||||
"USER": RackConfig.env_str("DATABASE_USERNAME"),
|
||||
"PASSWORD": RackConfig.env_str("DATABASE_PASSWORD"),
|
||||
"HOST": Environment.get_str("DATABASE_HOST"),
|
||||
"PORT": Environment.get_str("DATABASE_PORT"),
|
||||
"NAME": Environment.get_str("DATABASE_NAME"),
|
||||
"USER": Environment.get_str("DATABASE_USERNAME"),
|
||||
"PASSWORD": Environment.get_str("DATABASE_PASSWORD"),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -37,6 +38,6 @@ else:
|
||||
DATABASES = {
|
||||
"default": {
|
||||
"ENGINE": "django.db.backends.sqlite3",
|
||||
"NAME": RackConfig.env_str("TEST_DATABASE", ":memory:"),
|
||||
"NAME": Environment.get_str("TEST_DATABASE", ":memory:"),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,9 +8,9 @@
|
||||
Параметры конфигурации режима отладки
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import RackConfig
|
||||
from net.xeaf.rack.utils.settings import SettingUtils
|
||||
|
||||
#
|
||||
# Признак режима отладки
|
||||
#
|
||||
DEBUG = RackConfig.is_debug_mode()
|
||||
DEBUG = SettingUtils.is_debug_mode()
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
Параметры конфигурации Django REST Framework
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import RackConfig
|
||||
from net.xeaf.rack.utils.settings import SettingUtils
|
||||
|
||||
#
|
||||
# Настройка представления результатов вызова API
|
||||
@@ -20,7 +20,7 @@ REST_FRAMEWORK_RENDERER = (
|
||||
#
|
||||
# Только для режима отладки
|
||||
#
|
||||
if RackConfig.is_debug_mode():
|
||||
if SettingUtils.is_debug_mode():
|
||||
REST_FRAMEWORK_RENDERER += ('djangorestframework_camel_case.render.CamelCaseBrowsableAPIRenderer',)
|
||||
|
||||
#
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
Параметры конфигурации отправки электронной почты
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import RackConfig
|
||||
from net.xeaf.rack.utils.settings import Environment
|
||||
|
||||
#
|
||||
# Класс методов отправки электронной почты
|
||||
@@ -18,19 +18,19 @@ EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
|
||||
#
|
||||
# Информация об отправителе
|
||||
#
|
||||
EMAIL_FROM_NAME = RackConfig.env_str('EMAIL_FROM_NAME')
|
||||
EMAIL_FROM_ADDR = RackConfig.env_str('EMAIL_FROM_ADDR')
|
||||
EMAIL_SUBJECT_PREFIX = RackConfig.env_str('EMAIL_SUBJECT_PREFIX', '')
|
||||
EMAIL_FROM_NAME = Environment.get_str('EMAIL_FROM_NAME')
|
||||
EMAIL_FROM_ADDR = Environment.get_str('EMAIL_FROM_ADDR')
|
||||
EMAIL_SUBJECT_PREFIX = Environment.get_str('EMAIL_SUBJECT_PREFIX', '')
|
||||
|
||||
#
|
||||
# Параметры SMTP сервера
|
||||
#
|
||||
EMAIL_HOST = RackConfig.env_str('EMAIL_HOST', 'localhost')
|
||||
EMAIL_PORT = RackConfig.env_int('EMAIL_PORT', 25)
|
||||
EMAIL_HOST_USER = RackConfig.env_str('EMAIL_HOST_USER')
|
||||
EMAIL_HOST_PASSWORD = RackConfig.env_str('EMAIL_HOST_PASSWORD')
|
||||
EMAIL_USE_TLS = RackConfig.env_bool('EMAIL_USE_TLS', False)
|
||||
EMAIL_USE_SSL = RackConfig.env_bool('EMAIL_USE_SSL', False)
|
||||
EMAIL_TIMEOUT = RackConfig.env_int('EMAIL_TIMEOUT', 20)
|
||||
EMAIL_SSL_KEYFILE = RackConfig.env_str('EMAIL_SSL_KEYFILE', "")
|
||||
EMAIL_SSL_CERTFILE = RackConfig.env_str('EMAIL_SSL_CERTFILE', "")
|
||||
EMAIL_HOST = Environment.get_str('EMAIL_HOST', 'localhost')
|
||||
EMAIL_PORT = Environment.get_int('EMAIL_PORT', 25)
|
||||
EMAIL_HOST_USER = Environment.get_str('EMAIL_HOST_USER')
|
||||
EMAIL_HOST_PASSWORD = Environment.get_str('EMAIL_HOST_PASSWORD')
|
||||
EMAIL_USE_TLS = Environment.get_bool('EMAIL_USE_TLS', False)
|
||||
EMAIL_USE_SSL = Environment.get_bool('EMAIL_USE_SSL', False)
|
||||
EMAIL_TIMEOUT = Environment.get_int('EMAIL_TIMEOUT', 20)
|
||||
EMAIL_SSL_KEYFILE = Environment.get_str('EMAIL_SSL_KEYFILE', "")
|
||||
EMAIL_SSL_CERTFILE = Environment.get_str('EMAIL_SSL_CERTFILE', "")
|
||||
|
||||
@@ -8,25 +8,25 @@
|
||||
Параметры конфигурации файловой системы
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import RackConfig
|
||||
from net.xeaf.rack.utils.settings import Environment
|
||||
|
||||
#
|
||||
# Путь к статическим файлам
|
||||
#
|
||||
STATIC_URL = RackConfig.env_str('STATIC_URL', 'static/')
|
||||
STATIC_URL = Environment.get_str('STATIC_URL', 'static/')
|
||||
|
||||
#
|
||||
# Путь для сборки статических файлов
|
||||
#
|
||||
STATIC_ROOT = RackConfig.env_str_as_dir('STATIC_ROOT')
|
||||
STATIC_ROOT = Environment.get_str_as_dir('STATIC_ROOT')
|
||||
|
||||
#
|
||||
# Путь к медиафайлам
|
||||
#
|
||||
MEDIA_ROOT = RackConfig.env_str_as_dir('MEDIA_ROOT')
|
||||
THUMBNAILS_ROOT = RackConfig.env_str_as_dir('THUMBNAILS_ROOT')
|
||||
MEDIA_ROOT = Environment.get_str_as_dir('MEDIA_ROOT')
|
||||
THUMBNAILS_ROOT = Environment.get_str_as_dir('THUMBNAILS_ROOT')
|
||||
|
||||
#
|
||||
# Путь к временным файлам
|
||||
#
|
||||
FILE_UPLOAD_TEMP_DIR = RackConfig.env_str_as_dir('FILE_UPLOADS_TEMP', '/tmp')
|
||||
FILE_UPLOAD_TEMP_DIR = Environment.get_str_as_dir('FILE_UPLOADS_TEMP', '/tmp')
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
Параметры конфигурации интернационализации и локализации
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import RackConfig
|
||||
from net.xeaf.rack.utils.settings import Environment
|
||||
|
||||
#
|
||||
# Идентификаторы поддерживаемых языков
|
||||
@@ -27,12 +27,12 @@ LANGUAGES = (
|
||||
#
|
||||
# Язык по умолчанию
|
||||
#
|
||||
LANGUAGE_CODE = RackConfig.env_str('LANGUAGE')
|
||||
LANGUAGE_CODE = Environment.get_str('LANGUAGE')
|
||||
|
||||
#
|
||||
# Временная зона
|
||||
#
|
||||
TIME_ZONE = RackConfig.env_str('TIME_ZONE')
|
||||
TIME_ZONE = Environment.get_str('TIME_ZONE')
|
||||
USE_TZ = True
|
||||
|
||||
#
|
||||
|
||||
@@ -8,22 +8,22 @@
|
||||
Параметры конфигурации подключения к KeyDb (Redis)
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import RackConfig
|
||||
from net.xeaf.rack.utils.settings import Environment
|
||||
|
||||
#
|
||||
# Проверяем необходимость настройки
|
||||
#
|
||||
USE_KEYDB = RackConfig.env_bool('USE_KEYDB', True)
|
||||
USE_KEYDB = Environment.get_bool('USE_KEYDB', True)
|
||||
if USE_KEYDB:
|
||||
|
||||
#
|
||||
# Читаем параметры подключения к KeyDb (Redis)
|
||||
#
|
||||
KEYDB_HOST = RackConfig.env_str("KEYDB_HOST", "127.0.0.1")
|
||||
KEYDB_PORT = RackConfig.env_int("KEYDB_PORT", 6379)
|
||||
KEYDB_DBINDEX = RackConfig.env_int("KEYDB_DBINDEX", 1)
|
||||
KEYDB_PASSWORD = RackConfig.env_str('KEYDB_PASSWORD', "")
|
||||
KEYDB_POOL_SIZE = RackConfig.env_int('KEYDB_POOL_SIZE', 5)
|
||||
KEYDB_HOST = Environment.get_str("KEYDB_HOST", "127.0.0.1")
|
||||
KEYDB_PORT = Environment.get_int("KEYDB_PORT", 6379)
|
||||
KEYDB_DBINDEX = Environment.get_int("KEYDB_DBINDEX", 1)
|
||||
KEYDB_PASSWORD = Environment.get_str('KEYDB_PASSWORD', "")
|
||||
KEYDB_POOL_SIZE = Environment.get_int('KEYDB_POOL_SIZE', 5)
|
||||
KEYDB_LOCATION = f"redis://:{KEYDB_PASSWORD}@{KEYDB_HOST}:{KEYDB_PORT}/{KEYDB_DBINDEX}"
|
||||
|
||||
#
|
||||
|
||||
@@ -8,19 +8,20 @@
|
||||
Параметры конфигурации системы журналирования
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import LogDebugFilter
|
||||
from net.xeaf.rack.utils.settings import RackConfig
|
||||
from net.xeaf.rack.utils.settings import Environment
|
||||
from net.xeaf.rack.utils.settings import SettingUtils
|
||||
from net.xeaf.rack.utils.settings.logger import LogDebugFilter
|
||||
|
||||
#
|
||||
# Имя журнала
|
||||
#
|
||||
LOGGER_NAME = RackConfig.env_str("LOGGER_NAME", "rack")
|
||||
LOGGER_NAME = Environment.get_str("LOGGER_NAME", "rack")
|
||||
|
||||
#
|
||||
# Уровень журналирования
|
||||
#
|
||||
LOG_LEVEL = RackConfig.env_str("LOG_LEVEL")
|
||||
if RackConfig.is_debug_mode():
|
||||
LOG_LEVEL = Environment.get_str("LOG_LEVEL")
|
||||
if SettingUtils.is_debug_mode():
|
||||
LOG_LEVEL = "DEBUG"
|
||||
else:
|
||||
if LOG_LEVEL == "DEBUG":
|
||||
@@ -29,8 +30,8 @@ else:
|
||||
#
|
||||
# Файлы журналов
|
||||
#
|
||||
LOG_FILE = RackConfig.env_str_as_file("LOG_FILE")
|
||||
DEBUG_LOG_FILE = RackConfig.env_str_as_file("DEBUG_LOG_FILE")
|
||||
LOG_FILE = Environment.get_str_as_file("LOG_FILE")
|
||||
DEBUG_LOG_FILE = Environment.get_str_as_file("DEBUG_LOG_FILE")
|
||||
|
||||
#
|
||||
# Настройка журнала
|
||||
@@ -78,7 +79,7 @@ LOGGING = {
|
||||
"maxBytes": 1024 * 1024 * 10,
|
||||
"backupCount": 5,
|
||||
"formatter": "custom_format",
|
||||
"filters": [] if RackConfig.is_debug_mode() else ["strict_debug_only"],
|
||||
"filters": [] if SettingUtils.is_debug_mode() else ["strict_debug_only"],
|
||||
"encoding": "utf-8",
|
||||
},
|
||||
},
|
||||
|
||||
@@ -8,14 +8,14 @@
|
||||
Параметры конфигурации безопасности
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import RackConfig
|
||||
from net.xeaf.rack.utils.settings import Environment
|
||||
|
||||
#
|
||||
# Допустимые хосты, параметры CORS и CSRF
|
||||
#
|
||||
ALLOWED_HOSTS = RackConfig.env_str_as_list('ALLOWED_HOSTS')
|
||||
CORS_ALLOWED_ORIGINS = RackConfig.env_str_as_list('CORS_ALLOWED_ORIGINS')
|
||||
CSRF_TRUSTED_ORIGINS = RackConfig.env_str_as_list('CSRF_TRUSTED_ORIGINS')
|
||||
ALLOWED_HOSTS = Environment.get_str_as_list('ALLOWED_HOSTS')
|
||||
CORS_ALLOWED_ORIGINS = Environment.get_str_as_list('CORS_ALLOWED_ORIGINS')
|
||||
CSRF_TRUSTED_ORIGINS = Environment.get_str_as_list('CSRF_TRUSTED_ORIGINS')
|
||||
|
||||
#
|
||||
# Допустимые заголовки CORS
|
||||
@@ -34,7 +34,7 @@ CORS_ALLOW_HEADERS = (
|
||||
#
|
||||
# Ключ
|
||||
#
|
||||
SECRET_KEY = RackConfig.env_str('SECRET_KEY')
|
||||
SECRET_KEY = Environment.get_str('SECRET_KEY')
|
||||
|
||||
#
|
||||
# Валидаторы паролей
|
||||
@@ -49,10 +49,10 @@ AUTH_PASSWORD_VALIDATORS = [
|
||||
#
|
||||
# Тайм-аут сессии
|
||||
#
|
||||
SESSION_TIMEOUT = RackConfig.env_int('SESSION_TIMEOUT', 3600)
|
||||
SESSION_TIMEOUT = Environment.get_int('SESSION_TIMEOUT', 3600)
|
||||
|
||||
#
|
||||
# Модели данных аутентификации
|
||||
#
|
||||
AUTH_USER_MODEL = 'net_xeaf_rack.Account'
|
||||
AUTH_SESSION_MODEL = 'net_xeaf_rack.Session'
|
||||
AUTH_USER_MODEL = Environment.get_str("AUTH_USER_MODEL", 'net_xeaf_rack.AccountModel')
|
||||
AUTH_SESSION_MODEL = Environment.get_str("AUTH_SESSION_MODEL", 'net_xeaf_rack.SessionModel')
|
||||
|
||||
26
net/xeaf/rack/utils/settings/configs/wsgi.py
Normal file
26
net/xeaf/rack/utils/settings/configs/wsgi.py
Normal file
@@ -0,0 +1,26 @@
|
||||
# DRF Rack
|
||||
# Библиотека классов расширений для Django REST Framework
|
||||
#
|
||||
# Автор: Николай В. Анохин <n.anokhin@xeaf.net>
|
||||
# Все права защищены. Лицензия: MIT
|
||||
|
||||
"""
|
||||
Параметры конфигурации WSGI
|
||||
"""
|
||||
|
||||
from net.xeaf.rack.utils.settings import SettingUtils
|
||||
|
||||
#
|
||||
# Пути
|
||||
#
|
||||
ROOT_URLCONF = SettingUtils.get_url_root()
|
||||
|
||||
#
|
||||
# Класс приложения проекта
|
||||
#
|
||||
WSGI_APPLICATION = SettingUtils.get_wsgi_application()
|
||||
|
||||
#
|
||||
# Тип автоинкрементного поля по умолчанию
|
||||
#
|
||||
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
|
||||
@@ -5,12 +5,10 @@
|
||||
# Все права защищены. Лицензия: MIT
|
||||
|
||||
"""
|
||||
Описание класса RackConfig
|
||||
Описание класса EnvUtils
|
||||
"""
|
||||
|
||||
import os
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
import environ
|
||||
from django.core.exceptions import ImproperlyConfigured
|
||||
@@ -18,17 +16,14 @@ from environ import Env
|
||||
from environ import NoValue
|
||||
|
||||
|
||||
class RackConfig:
|
||||
class Environment:
|
||||
"""
|
||||
Содержит базовые параметры для настройки приложения
|
||||
Реализация доступа к параметрам и переменным окружения
|
||||
"""
|
||||
|
||||
__base_dir: str
|
||||
""" Путь к корневой директории приложения """
|
||||
|
||||
__debug_mode: bool
|
||||
""" Признак режима отладки приложения """
|
||||
|
||||
__is_initialized: bool
|
||||
""" Признак инициализации конфигурации """
|
||||
|
||||
@@ -38,9 +33,6 @@ class RackConfig:
|
||||
__env_prefix: str
|
||||
""" Префикс переменных окружения """
|
||||
|
||||
__config_files: dict[str, str | None] = {}
|
||||
""" Словарь файлов параметров конфигурации """
|
||||
|
||||
@classmethod
|
||||
def initialize(cls, base_dir: str, env_prefix: str = ""):
|
||||
"""
|
||||
@@ -54,56 +46,8 @@ class RackConfig:
|
||||
cls.__env = environ.Env()
|
||||
cls.__env_prefix = env_prefix
|
||||
environ.Env.read_env(os.path.join(cls.__base_dir, '.env'))
|
||||
cls._init_configuration_files()
|
||||
cls.__is_initialized = True
|
||||
|
||||
# Сразу загружаем признак режима отладки
|
||||
cls.__debug_mode = cls.env_bool('DEBUG', False)
|
||||
|
||||
@classmethod
|
||||
def get_base_dir(cls) -> str:
|
||||
"""
|
||||
Возвращает путь к корневой директории приложения
|
||||
|
||||
:return: Путь к корневой директории приложения
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__base_dir
|
||||
|
||||
@classmethod
|
||||
def get_debug_mode(cls) -> bool:
|
||||
"""
|
||||
Возвращает признак режима отладки приложения
|
||||
|
||||
:return: Признак режима отладки
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__debug_mode
|
||||
|
||||
@classmethod
|
||||
def is_test_mode(cls) -> bool:
|
||||
"""
|
||||
Возвращает признак режима тестирования приложения
|
||||
|
||||
:return: Признак режима тестирования приложения
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return 'test' in sys.argv
|
||||
|
||||
@classmethod
|
||||
def is_debug_mode(cls) -> bool:
|
||||
"""
|
||||
Возвращает признак режима отладки приложения
|
||||
|
||||
:return: Признак режима отладки
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__debug_mode
|
||||
|
||||
@classmethod
|
||||
def env(cls) -> Env:
|
||||
"""
|
||||
@@ -116,7 +60,7 @@ class RackConfig:
|
||||
return cls.__env
|
||||
|
||||
@classmethod
|
||||
def env_str(cls, name: str, default_value: str | NoValue = Env.NOTSET) -> str:
|
||||
def get_str(cls, name: str, default_value: str | NoValue = Env.NOTSET) -> str:
|
||||
"""
|
||||
Возвращает строковое значение переменной окружения
|
||||
|
||||
@@ -126,10 +70,10 @@ class RackConfig:
|
||||
:return: Значение переменной окружения
|
||||
"""
|
||||
|
||||
return cls.env().str(cls.env_name(name), default_value)
|
||||
return cls.env().str(cls._env_name(name), default_value)
|
||||
|
||||
@classmethod
|
||||
def env_int(cls, name: str, default_value: int | NoValue = Env.NOTSET) -> int:
|
||||
def get_int(cls, name: str, default_value: int | NoValue = Env.NOTSET) -> int:
|
||||
"""
|
||||
Возвращает целочисленное значение переменной окружения
|
||||
|
||||
@@ -139,10 +83,10 @@ class RackConfig:
|
||||
:return: Значение переменной окружения
|
||||
"""
|
||||
|
||||
return cls.env().int(cls.env_name(name), default_value)
|
||||
return cls.env().int(cls._env_name(name), default_value)
|
||||
|
||||
@classmethod
|
||||
def env_bool(cls, name: str, default_value: bool | NoValue = Env.NOTSET) -> bool:
|
||||
def get_bool(cls, name: str, default_value: bool | NoValue = Env.NOTSET) -> bool:
|
||||
"""
|
||||
Возвращает логическое значение переменной окружения
|
||||
|
||||
@@ -152,10 +96,10 @@ class RackConfig:
|
||||
:return: Значение переменной окружения
|
||||
"""
|
||||
|
||||
return cls.env().bool(cls.env_name(name), default_value)
|
||||
return cls.env().bool(cls._env_name(name), default_value)
|
||||
|
||||
@classmethod
|
||||
def env_str_as_dir(cls, name: str, default_value: str | NoValue = Env.NOTSET) -> str:
|
||||
def get_str_as_dir(cls, name: str, default_value: str | NoValue = Env.NOTSET) -> str:
|
||||
"""
|
||||
Возвращает значение переменной окружения в виде проверенного имени директории
|
||||
|
||||
@@ -165,13 +109,13 @@ class RackConfig:
|
||||
:return: Значение переменной окружения
|
||||
"""
|
||||
|
||||
dir_path = cls.env_str(name, default_value)
|
||||
dir_path = cls.get_str(name, default_value)
|
||||
os.makedirs(dir_path, exist_ok=True)
|
||||
|
||||
return dir_path
|
||||
|
||||
@classmethod
|
||||
def env_str_as_file(cls, name: str, default_value: str | NoValue = Env.NOTSET) -> str:
|
||||
def get_str_as_file(cls, name: str, default_value: str | NoValue = Env.NOTSET) -> str:
|
||||
"""
|
||||
Возвращает значение переменной окружения в виде проверенного имени фйала
|
||||
|
||||
@@ -181,14 +125,14 @@ class RackConfig:
|
||||
:return: Значение переменной окружения
|
||||
"""
|
||||
|
||||
file_path = cls.env_str(name, default_value)
|
||||
file_path = cls.get_str(name, default_value)
|
||||
dir_path = os.path.dirname(file_path)
|
||||
os.makedirs(dir_path, exist_ok=True)
|
||||
|
||||
return file_path
|
||||
|
||||
@classmethod
|
||||
def env_str_as_list(cls, name: str, default_value: str | NoValue = Env.NOTSET) -> list[str]:
|
||||
def get_str_as_list(cls, name: str, default_value: str | NoValue = Env.NOTSET) -> list[str]:
|
||||
"""
|
||||
Возвращает значение переменной окружения в виде списка строк
|
||||
|
||||
@@ -198,14 +142,14 @@ class RackConfig:
|
||||
:return: Значение переменной окружения
|
||||
"""
|
||||
|
||||
values = cls.env_str(name, default_value)
|
||||
values = cls.get_str(name, default_value)
|
||||
if not values:
|
||||
return []
|
||||
|
||||
return [item.strip() for item in values.split(",") if item.strip()]
|
||||
|
||||
@classmethod
|
||||
def env_name(cls, name: str) -> str:
|
||||
def _env_name(cls, name: str) -> str:
|
||||
"""
|
||||
Возвращает полное имя переменной окружения
|
||||
|
||||
@@ -216,27 +160,6 @@ class RackConfig:
|
||||
|
||||
return f"{cls.__env_prefix}{name}"
|
||||
|
||||
@classmethod
|
||||
def get_config_files(cls) -> list[str]:
|
||||
"""
|
||||
Возвращает список файлов конфигурации
|
||||
|
||||
:return: Список файлов конфигурации
|
||||
"""
|
||||
|
||||
return [file for file in cls.__config_files.values() if file is not None]
|
||||
|
||||
@classmethod
|
||||
def set_config_file(cls, name: str, full_path: str | None) -> None:
|
||||
"""
|
||||
Устанавливает полный путь к файлу конфигурации
|
||||
|
||||
:param name: Название файла конфигурации
|
||||
:param full_path: Полный путь к файлу конфигурации
|
||||
"""
|
||||
|
||||
cls.__config_files[name] = full_path
|
||||
|
||||
@classmethod
|
||||
def _check_initialization(cls) -> None:
|
||||
"""
|
||||
@@ -244,16 +167,4 @@ class RackConfig:
|
||||
"""
|
||||
|
||||
if not cls.__is_initialized:
|
||||
raise ImproperlyConfigured("DRF Rack configuration is not initialized")
|
||||
|
||||
@classmethod
|
||||
def _init_configuration_files(cls) -> None:
|
||||
"""
|
||||
Инициализирует словарь файлов параметров конфигурации
|
||||
"""
|
||||
|
||||
root = f"{os.path.dirname(__file__)}/configs"
|
||||
for file in os.listdir(root):
|
||||
if file.endswith(".py") and file != "__init__.py":
|
||||
name = Path(file).stem
|
||||
cls.__config_files[name] = f"{root}/{file}"
|
||||
raise ImproperlyConfigured(f"Class {__class__.__name__} is not initialized.")
|
||||
11
net/xeaf/rack/utils/settings/logger/__init__.py
Normal file
11
net/xeaf/rack/utils/settings/logger/__init__.py
Normal file
@@ -0,0 +1,11 @@
|
||||
# DRF Rack
|
||||
# Библиотека классов расширений для Django REST Framework
|
||||
#
|
||||
# Автор: Николай В. Анохин <n.anokhin@xeaf.net>
|
||||
# Все права защищены. Лицензия: MIT
|
||||
|
||||
"""
|
||||
Пакет классов логгера
|
||||
"""
|
||||
|
||||
from .log_debug_filter import LogDebugFilter
|
||||
238
net/xeaf/rack/utils/settings/setting_utils.py
Normal file
238
net/xeaf/rack/utils/settings/setting_utils.py
Normal file
@@ -0,0 +1,238 @@
|
||||
# DRF Rack
|
||||
# Библиотека классов расширений для Django REST Framework
|
||||
#
|
||||
# Автор: Николай В. Анохин <n.anokhin@xeaf.net>
|
||||
# Все права защищены. Лицензия: MIT
|
||||
|
||||
"""
|
||||
Описание класса SettingUtils
|
||||
"""
|
||||
|
||||
import os
|
||||
import sys
|
||||
import tomllib
|
||||
from pathlib import Path
|
||||
|
||||
from django.core.exceptions import ImproperlyConfigured
|
||||
|
||||
from .environment import Environment
|
||||
|
||||
|
||||
class SettingUtils:
|
||||
"""
|
||||
Содержит методы работа с параметрами настройки приложения
|
||||
"""
|
||||
|
||||
__base_dir: str
|
||||
""" Путь к корневой директории приложения """
|
||||
|
||||
__debug_mode: bool
|
||||
""" Признак режима отладки приложения """
|
||||
|
||||
__app_name: str
|
||||
""" Имя приложения """
|
||||
|
||||
__app_version: str
|
||||
""" Имя приложения """
|
||||
|
||||
__url_root: str
|
||||
""" Корневой URL приложения """
|
||||
|
||||
__wsgi_application: str
|
||||
""" Имя WSGI-приложения """
|
||||
|
||||
__is_initialized: bool
|
||||
""" Признак инициализации конфигурации """
|
||||
|
||||
__config_files: dict[str, str | None] = {}
|
||||
""" Словарь файлов параметров конфигурации """
|
||||
|
||||
@classmethod
|
||||
def initialize(cls, base_dir: Path, app_name: str, env_prefix: str, url_root: str, wsgi_application: str):
|
||||
"""
|
||||
Инициализирует конфигурацию приложения
|
||||
|
||||
|
||||
:param base_dir: Базовая директория приложения
|
||||
:param app_name: Имя приложения
|
||||
:param env_prefix: Префикс для переменных окружения
|
||||
:param url_root: Корневой URL приложения
|
||||
:param wsgi_application: Имя WSGI-приложения
|
||||
"""
|
||||
|
||||
cls.__base_dir = str(base_dir)
|
||||
cls.__url_root = url_root
|
||||
cls.__wsgi_application = wsgi_application
|
||||
|
||||
cls.__app_name = app_name
|
||||
cls.__app_version = cls.version_from_toml()
|
||||
|
||||
Environment.initialize(cls.__base_dir, env_prefix)
|
||||
cls.__debug_mode = Environment.get_bool('DEBUG', False)
|
||||
cls._init_configuration_files()
|
||||
|
||||
cls.__is_initialized = True
|
||||
|
||||
@classmethod
|
||||
def get_app_name(cls) -> str:
|
||||
"""
|
||||
Возвращает имя приложения
|
||||
|
||||
:return: Имя приложения
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__app_name
|
||||
|
||||
@classmethod
|
||||
def get_app_version(cls) -> str:
|
||||
"""
|
||||
Возвращает версию приложения
|
||||
|
||||
:return: Версия приложения
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__app_version
|
||||
|
||||
@classmethod
|
||||
def get_url_root(cls) -> str:
|
||||
"""
|
||||
Возвращает корневой URL приложения
|
||||
|
||||
:return: Корневой URL приложения
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__url_root
|
||||
|
||||
@classmethod
|
||||
def get_wsgi_application(cls) -> str:
|
||||
"""
|
||||
Возвращает WSGI-приложение приложения
|
||||
|
||||
:return: WSGI-приложение приложения
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__wsgi_application
|
||||
|
||||
@classmethod
|
||||
def get_base_dir(cls) -> str:
|
||||
"""
|
||||
Возвращает путь к корневой директории приложения
|
||||
|
||||
:return: Путь к корневой директории приложения
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__base_dir
|
||||
|
||||
@classmethod
|
||||
def get_debug_mode(cls) -> bool:
|
||||
"""
|
||||
Возвращает признак режима отладки приложения
|
||||
|
||||
:return: Признак режима отладки
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__debug_mode
|
||||
|
||||
@classmethod
|
||||
def is_test_mode(cls) -> bool:
|
||||
"""
|
||||
Возвращает признак режима тестирования приложения
|
||||
|
||||
:return: Признак режима тестирования приложения
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return 'test' in sys.argv
|
||||
|
||||
@classmethod
|
||||
def is_debug_mode(cls) -> bool:
|
||||
"""
|
||||
Возвращает признак режима отладки приложения
|
||||
|
||||
:return: Признак режима отладки
|
||||
"""
|
||||
|
||||
cls._check_initialization()
|
||||
return cls.__debug_mode
|
||||
|
||||
@classmethod
|
||||
def version_from_toml(cls) -> str:
|
||||
"""
|
||||
Чтение версии из файла pyproject.toml
|
||||
|
||||
:return: Номер версии
|
||||
"""
|
||||
|
||||
pyproject_path = os.path.join(cls.__base_dir, "pyproject.toml")
|
||||
with open(pyproject_path, 'rb') as f:
|
||||
data = tomllib.load(f)
|
||||
return data['project']['version']
|
||||
|
||||
@classmethod
|
||||
def get_config_files(cls) -> list[str]:
|
||||
"""
|
||||
Возвращает список файлов конфигурации
|
||||
|
||||
:return: Список файлов конфигурации
|
||||
"""
|
||||
|
||||
return [file for file in cls.__config_files.values() if file is not None]
|
||||
|
||||
@classmethod
|
||||
def set_config_file(cls, name: str, full_path: str | None) -> None:
|
||||
"""
|
||||
Устанавливает полный путь к файлу конфигурации
|
||||
|
||||
:param name: Название файла конфигурации
|
||||
:param full_path: Полный путь к файлу конфигурации
|
||||
"""
|
||||
|
||||
cls.__config_files[name] = full_path
|
||||
|
||||
@classmethod
|
||||
def get_installed_apps(cls) -> list[str]:
|
||||
"""
|
||||
Возвращает список установленных приложений
|
||||
|
||||
:return: Список установленных приложений
|
||||
"""
|
||||
|
||||
return [
|
||||
'django.contrib.admin',
|
||||
'django.contrib.admindocs',
|
||||
'django.contrib.auth',
|
||||
'django.contrib.contenttypes',
|
||||
'django.contrib.sessions',
|
||||
'django.contrib.messages',
|
||||
'django.contrib.staticfiles',
|
||||
'corsheaders',
|
||||
'rest_framework',
|
||||
'net.xeaf.rack',
|
||||
]
|
||||
|
||||
@classmethod
|
||||
def _check_initialization(cls) -> None:
|
||||
"""
|
||||
Проверяет завершение инициализации
|
||||
"""
|
||||
|
||||
if not cls.__is_initialized:
|
||||
raise ImproperlyConfigured(f"Class {__class__.__name__} is not initialized")
|
||||
|
||||
@classmethod
|
||||
def _init_configuration_files(cls) -> None:
|
||||
"""
|
||||
Инициализирует словарь файлов параметров конфигурации
|
||||
"""
|
||||
|
||||
root = f"{os.path.dirname(__file__)}/configs"
|
||||
for file in os.listdir(root):
|
||||
if file.endswith(".py") and file != "__init__.py":
|
||||
name = Path(file).stem
|
||||
cls.__config_files[name] = f"{root}/{file}"
|
||||
Reference in New Issue
Block a user