passiveincome-commonpackage 1.0.0__tar.gz

passiveincome_commonpackage-1.0.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: passiveincome-commonpackage
+Version: 1.0.0
+Summary: Общий пакет для Python-приложений
+Author-email: Salim <salim.buskunov.2000@gmail.com>
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pydantic-settings>=2.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+
+# PassiveIncome.CommonPackage
+Общий пакет для Python-приложений
+
+Пакет предоставляет готовые фнукциональности для создания Python-приложений:
+1. Конфигурирование.
+2. Логирование.

passiveincome_commonpackage-1.0.0/README.md

@@ -0,0 +1,6 @@
+# PassiveIncome.CommonPackage
+Общий пакет для Python-приложений
+
+Пакет предоставляет готовые фнукциональности для создания Python-приложений:
+1. Конфигурирование.
+2. Логирование.

passiveincome_commonpackage-1.0.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools >= 77.0.3", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "passiveincome-commonpackage"
+version = "1.0.0"
+authors = [
+  { name="Salim", email="salim.buskunov.2000@gmail.com" },
+]
+description = "Общий пакет для Python-приложений"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "pydantic>=2.0",
+    "pydantic-settings>=2.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2",
+    "pytest>=8.0",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["common_package*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

passiveincome_commonpackage-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

passiveincome_commonpackage-1.0.0/src/common_package/__init__.py

@@ -0,0 +1,10 @@
+from common_package.config import AppSettings, SENSITIVE_KEYWORDS, key_masking
+from common_package.logging import LoggingSettings, configure_logging
+
+__all__ = [
+	"AppSettings",
+	"LoggingSettings",
+	"SENSITIVE_KEYWORDS",
+	"configure_logging",
+	"key_masking",
+]

passiveincome_commonpackage-1.0.0/src/common_package/config/__init__.py

@@ -0,0 +1,4 @@
+from common_package.config.config import AppSettings, SENSITIVE_KEYWORDS
+from common_package.config.utils import key_masking
+
+__all__ = ["AppSettings", "SENSITIVE_KEYWORDS", "key_masking"]

passiveincome_commonpackage-1.0.0/src/common_package/config/config.py

@@ -0,0 +1,26 @@
+from pydantic_settings import BaseSettings
+from .utils import key_masking
+from typing import Any, Final
+
+
+SENSITIVE_KEYWORDS: Final[tuple[str, ...]] = (
+    "password",
+    "passwd",
+    "pwd",
+    "secret",
+    "token",
+    "key",
+    "credential",
+    "auth",
+    "session",
+    "cookie",
+    "salt",
+    "hash",
+)
+
+class AppSettings(BaseSettings):
+    ...
+
+    def safe_dump(self) -> dict[str, Any]:
+        """Замаскированный конфиг."""
+        return key_masking(self.model_dump(), SENSITIVE_KEYWORDS)

passiveincome_commonpackage-1.0.0/src/common_package/config/utils.py

@@ -0,0 +1,42 @@
+from typing import Any, Iterable
+
+from typing import Any, Iterable
+
+def key_masking(
+    data: dict[str, Any],
+    key_words: Iterable[str],
+    mask: str = "***",
+) -> dict[str, Any]:
+    """Рекурсивно маскирует значения по совпадению ключей.
+
+    Ключ считается чувствительным, если любое из `key_words`
+    встречается в нём как подстрока (без учёта регистра).
+    Обходит вложенные dict и list, исходные данные не мутирует.
+
+    Args:
+        data: исходный словарь.
+        key_words: список подстрок для поиска в ключах.
+        mask: чем заменять значение.
+
+    Returns:
+        Новый словарь с замаскированными значениями.
+    """
+    needles = {w.lower() for w in key_words}
+
+    def _is_sensitive(key: str) -> bool:
+        low = key.lower()
+        return any(n in low for n in needles)
+
+    def _walk(value: Any) -> Any:
+        if isinstance(value, dict):
+            return {
+                k: (mask if _is_sensitive(k) else _walk(v))
+                for k, v in value.items()
+            }
+        if isinstance(value, list):
+            return [_walk(item) for item in value]
+        if isinstance(value, tuple):
+            return tuple(_walk(item) for item in value)
+        return value
+
+    return _walk(data)

passiveincome_commonpackage-1.0.0/src/common_package/logging/__init__.py

@@ -0,0 +1,4 @@
+from common_package.logging.logger import configure_logging
+from common_package.logging.settings import LoggingSettings
+
+__all__ = ["LoggingSettings", "configure_logging"]

passiveincome_commonpackage-1.0.0/src/common_package/logging/logger.py

@@ -0,0 +1,50 @@
+"""Helpers for configuring application logging."""
+
+import logging
+from logging.handlers import RotatingFileHandler
+
+from common_package.logging.settings import LoggingSettings
+
+
+def configure_logging(settings: LoggingSettings) -> None:
+	"""Configure the root logger using the supplied settings."""
+	formatter = logging.Formatter(
+		fmt=settings.format,
+		datefmt=settings.date_format,
+	)
+	handlers: list[logging.Handler] = []
+
+	if settings.stream:
+		handlers.append(logging.StreamHandler())
+
+	if settings.file_path is not None:
+		if settings.max_bytes > 0:
+			file_handler: logging.Handler = RotatingFileHandler(
+				settings.file_path,
+				mode=settings.file_mode,
+				maxBytes=settings.max_bytes,
+				backupCount=settings.backup_count,
+				encoding=settings.file_encoding,
+			)
+		else:
+			file_handler = logging.FileHandler(
+				settings.file_path,
+				mode=settings.file_mode,
+				encoding=settings.file_encoding,
+			)
+		handlers.append(file_handler)
+
+	if not handlers:
+		handlers.append(logging.NullHandler())
+
+	for handler in handlers:
+		handler.setFormatter(formatter)
+
+	root_logger = logging.getLogger()
+	for handler in root_logger.handlers[:]:
+		root_logger.removeHandler(handler)
+		handler.close()
+
+	root_logger.setLevel(settings.level)
+	for handler in handlers:
+		root_logger.addHandler(handler)

passiveincome_commonpackage-1.0.0/src/common_package/logging/settings.py

@@ -0,0 +1,25 @@
+"""Settings for configuring application logging."""
+
+from typing import Literal
+
+from pydantic import Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class LoggingSettings(BaseSettings):
+	"""Environment-variable-backed logging configuration."""
+
+	model_config = SettingsConfigDict(
+		env_prefix="LOGGING_",
+		extra="ignore",
+	)
+
+	level: Literal["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"] = "INFO"
+	format: str = "%(asctime)s %(levelname)s [%(name)s] %(message)s"
+	date_format: str = "%Y-%m-%d %H:%M:%S"
+	stream: bool = True
+	file_path: str | None = None
+	file_mode: Literal["a", "w"] = "a"
+	file_encoding: str = "utf-8"
+	max_bytes: int = Field(default=0, ge=0)
+	backup_count: int = Field(default=0, ge=0)

passiveincome_commonpackage-1.0.0/src/passiveincome_commonpackage.egg-info/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: passiveincome-commonpackage
+Version: 1.0.0
+Summary: Общий пакет для Python-приложений
+Author-email: Salim <salim.buskunov.2000@gmail.com>
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pydantic-settings>=2.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+
+# PassiveIncome.CommonPackage
+Общий пакет для Python-приложений
+
+Пакет предоставляет готовые фнукциональности для создания Python-приложений:
+1. Конфигурирование.
+2. Логирование.

passiveincome_commonpackage-1.0.0/src/passiveincome_commonpackage.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+pyproject.toml
+src/common_package/__init__.py
+src/common_package/config/__init__.py
+src/common_package/config/config.py
+src/common_package/config/utils.py
+src/common_package/logging/__init__.py
+src/common_package/logging/logger.py
+src/common_package/logging/settings.py
+src/passiveincome_commonpackage.egg-info/PKG-INFO
+src/passiveincome_commonpackage.egg-info/SOURCES.txt
+src/passiveincome_commonpackage.egg-info/dependency_links.txt
+src/passiveincome_commonpackage.egg-info/requires.txt
+src/passiveincome_commonpackage.egg-info/top_level.txt
+tests/test_config.py
+tests/test_logging.py

passiveincome_commonpackage-1.0.0/src/passiveincome_commonpackage.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

passiveincome_commonpackage-1.0.0/src/passiveincome_commonpackage.egg-info/requires.txt

@@ -0,0 +1,6 @@
+pydantic>=2.0
+pydantic-settings>=2.0
+
+[dev]
+build>=1.2
+pytest>=8.0

passiveincome_commonpackage-1.0.0/src/passiveincome_commonpackage.egg-info/top_level.txt

@@ -0,0 +1 @@
+common_package

passiveincome_commonpackage-1.0.0/tests/test_config.py

@@ -0,0 +1,84 @@
+import pytest
+from pydantic import ValidationError
+
+from common_package.config import AppSettings, key_masking
+
+
+def test_key_masking_recurses_and_does_not_mutate_input() -> None:
+	data = {
+		"username": "alice",
+		"api_token": "token-value",
+		"profile": {"PASSWORD": "password-value", "label": "public"},
+		"items": [{"access_key": "key-value", "count": 2}],
+	}
+
+	result = key_masking(data, ("token", "password", "key"))
+
+	assert result == {
+		"username": "alice",
+		"api_token": "***",
+		"profile": {"PASSWORD": "***", "label": "public"},
+		"items": [{"access_key": "***", "count": 2}],
+	}
+	assert data["api_token"] == "token-value"
+	assert data["profile"]["PASSWORD"] == "password-value"
+
+
+def test_key_masking_preserves_tuple_and_supports_custom_mask() -> None:
+	result = key_masking(
+		{"session": "private", "values": (1, {"secret": "hidden"})},
+		("session", "secret"),
+		mask="[redacted]",
+	)
+
+	assert result == {
+		"session": "[redacted]",
+		"values": (1, {"secret": "[redacted]"}),
+	}
+
+
+def test_app_settings_safe_dump_masks_sensitive_fields() -> None:
+	class ExampleSettings(AppSettings):
+		api_token: str = "token-value"
+		database: dict[str, str] = {
+			"password": "password-value",
+			"host": "localhost",
+		}
+		public_name: str = "example"
+
+	settings = ExampleSettings()
+
+	assert settings.safe_dump() == {
+		"api_token": "***",
+		"database": {"password": "***", "host": "localhost"},
+		"public_name": "example",
+	}
+
+
+def test_logging_settings_are_loaded_from_environment(monkeypatch: pytest.MonkeyPatch) -> None:
+	monkeypatch.setenv("LOGGING_LEVEL", "DEBUG")
+	monkeypatch.setenv("LOGGING_STREAM", "false")
+	monkeypatch.setenv("LOGGING_MAX_BYTES", "1024")
+
+	from common_package.logging import LoggingSettings
+
+	settings = LoggingSettings()
+
+	assert settings.level == "DEBUG"
+	assert settings.stream is False
+	assert settings.max_bytes == 1024
+
+
+@pytest.mark.parametrize(
+	"values",
+	[
+		{"level": "TRACE"},
+		{"max_bytes": -1},
+		{"backup_count": -1},
+	],
+)
+def test_logging_settings_reject_invalid_values(values: dict[str, object]) -> None:
+	from common_package.logging import LoggingSettings
+
+	with pytest.raises(ValidationError):
+		LoggingSettings(**values)

passiveincome_commonpackage-1.0.0/tests/test_logging.py

@@ -0,0 +1,80 @@
+import logging
+from logging.handlers import RotatingFileHandler
+
+import pytest
+
+import common_package.logging.logger as logging_module
+from common_package.logging import LoggingSettings, configure_logging
+
+
+@pytest.fixture
+def isolated_root_logger(monkeypatch: pytest.MonkeyPatch) -> logging.Logger:
+	root_logger = logging.Logger("isolated-root")
+	get_logger = logging.getLogger
+
+	def get_test_logger(name: str | None = None) -> logging.Logger:
+		if name is None:
+			return root_logger
+		return get_logger(name)
+
+	monkeypatch.setattr(logging_module.logging, "getLogger", get_test_logger)
+	return root_logger
+
+
+def test_configure_logging_writes_formatted_file(
+	isolated_root_logger: logging.Logger,
+	tmp_path,
+) -> None:
+	log_path = tmp_path / "application.log"
+	settings = LoggingSettings(
+		level="DEBUG",
+		stream=False,
+		file_path=str(log_path),
+		format="%(levelname)s:%(name)s:%(message)s",
+	)
+
+	configure_logging(settings)
+	isolated_root_logger.debug("configured")
+
+	assert isolated_root_logger.level == logging.DEBUG
+	assert log_path.read_text(encoding="utf-8").strip() == "DEBUG:isolated-root:configured"
+	assert len(isolated_root_logger.handlers) == 1
+	assert isinstance(isolated_root_logger.handlers[0], logging.FileHandler)
+	assert isolated_root_logger.handlers[0].formatter is not None
+
+
+def test_configure_logging_uses_rotating_file_handler(
+	isolated_root_logger: logging.Logger,
+	tmp_path,
+) -> None:
+	settings = LoggingSettings(
+		stream=False,
+		file_path=str(tmp_path / "rotating.log"),
+		max_bytes=128,
+		backup_count=3,
+	)
+
+	configure_logging(settings)
+
+	assert len(isolated_root_logger.handlers) == 1
+	assert isinstance(isolated_root_logger.handlers[0], RotatingFileHandler)
+	assert isolated_root_logger.handlers[0].maxBytes == 128
+	assert isolated_root_logger.handlers[0].backupCount == 3
+
+
+def test_configure_logging_adds_stream_handler_when_enabled(
+	isolated_root_logger: logging.Logger,
+) -> None:
+	configure_logging(LoggingSettings(stream=True))
+
+	assert len(isolated_root_logger.handlers) == 1
+	assert isinstance(isolated_root_logger.handlers[0], logging.StreamHandler)
+
+
+def test_configure_logging_uses_null_handler_when_outputs_disabled(
+	isolated_root_logger: logging.Logger,
+) -> None:
+	configure_logging(LoggingSettings(stream=False))
+
+	assert len(isolated_root_logger.handlers) == 1
+	assert isinstance(isolated_root_logger.handlers[0], logging.NullHandler)