Merge pull request #8 from kilobyteno/add-default-uvicorn-config

Author: dsbilling

tests/test_konfig.py

@@ -0,0 +1,57 @@
+import logging
+
+import pytest
+
+from tunsberg.konfig import uvicorn_config
+
+
+class TestUvicornConfig:
+    def test_default_config(self):
+        log_lvl = logging.NOTSET
+        config = uvicorn_config(log_level=log_lvl)
+        assert config['version'] == 1
+        assert not config['disable_existing_loggers']
+        assert config['formatters']['default']['format'] == '%(asctime)s - %(levelname)s - %(name)s - %(message)s'
+        assert config['handlers']['file']['class'] == 'logging.FileHandler'
+        assert config['handlers']['file']['filename'] == 'uvicorn.log'
+        assert config['handlers']['file']['formatter'] == 'default'
+        assert config['handlers']['console']['class'] == 'logging.StreamHandler'
+        assert config['handlers']['console']['formatter'] == 'default'
+        assert config['loggers']['uvicorn']['handlers'] == ['file', 'console']
+        assert config['loggers']['uvicorn']['level'] == logging.getLevelName(log_lvl)
+        assert not config['loggers']['uvicorn']['propagate']
+        assert config['loggers']['uvicorn.error']['handlers'] == ['file', 'console']
+        assert config['loggers']['uvicorn.error']['level'] == logging.getLevelName(log_lvl)
+        assert not config['loggers']['uvicorn.error']['propagate']
+        assert config['loggers']['uvicorn.access']['handlers'] == ['file', 'console']
+        assert config['loggers']['uvicorn.access']['level'] == logging.getLevelName(log_lvl)
+        assert not config['loggers']['uvicorn.access']['propagate']
+
+    def test_invalid_log_level(self):
+        with pytest.raises(ValueError):
+            uvicorn_config(log_level=999)
+
+    def test_empty_log_format(self):
+        with pytest.raises(ValueError):
+            uvicorn_config(log_level=logging.NOTSET, log_format='')
+
+    def test_empty_log_file_path(self):
+        with pytest.raises(ValueError):
+            uvicorn_config(log_level=logging.NOTSET, log_file_path='')
+
+    def test_custom_log_format(self):
+        log_format = '%(asctime)s - %(levelname)s - %(name)s - %(message)s - %(filename)s - %(lineno)s'
+        config = uvicorn_config(log_level=logging.NOTSET, log_format=log_format)
+        assert config['formatters']['default']['format'] == log_format
+
+    def test_custom_log_file_path(self):
+        log_file_path = 'custom.log'
+        config = uvicorn_config(log_level=logging.NOTSET, log_file_path=log_file_path)
+        assert config['handlers']['file']['filename'] == log_file_path
+
+    def test_custom_log_level(self):
+        log_lvl = logging.INFO
+        config = uvicorn_config(log_level=log_lvl)
+        assert config['loggers']['uvicorn']['level'] == logging.getLevelName(log_lvl)
+        assert config['loggers']['uvicorn.error']['level'] == logging.getLevelName(log_lvl)
+        assert config['loggers']['uvicorn.access']['level'] == logging.getLevelName(log_lvl)

tunsberg/konfig.py

@@ -0,0 +1,67 @@
+import logging
+
+
+def uvicorn_config(
+    log_level: int = logging.DEBUG, log_file_path: str = 'uvicorn.log', log_format: str = '%(asctime)s - %(levelname)s - %(name)s - %(message)s'
+) -> dict:
+    """
+    Generate a configuration dictionary for Uvicorn logging.
+
+    :param log_level: Log level integer
+    :type log_level: int
+    :param log_file_path: Path to the log file
+    :type log_file_path: str
+    :param log_format: Log format string
+    :type log_format: str
+    :return: Configuration dictionary
+    :rtype: dict
+    """
+    # Make sure the log level is valid
+    if logging.getLevelName(log_level) is None or logging.getLevelName(log_level).__contains__('Level'):
+        raise ValueError('Invalid log level')
+
+    # Make sure log format is not empty
+    if not log_format:
+        raise ValueError('Log format cannot be empty')
+
+    # Make sure log file path is not empty
+    if not log_file_path:
+        raise ValueError('Log file path cannot be empty')
+
+    return {
+        'version': 1,
+        'disable_existing_loggers': False,
+        'formatters': {
+            'default': {
+                'format': log_format,
+            },
+        },
+        'handlers': {
+            'file': {
+                'class': 'logging.FileHandler',
+                'filename': log_file_path,
+                'formatter': 'default',
+            },
+            'console': {
+                'class': 'logging.StreamHandler',
+                'formatter': 'default',
+            },
+        },
+        'loggers': {
+            'uvicorn': {
+                'handlers': ['file', 'console'],
+                'level': logging.getLevelName(log_level),
+                'propagate': False,
+            },
+            'uvicorn.error': {
+                'handlers': ['file', 'console'],
+                'level': logging.getLevelName(log_level),
+                'propagate': False,
+            },
+            'uvicorn.access': {
+                'handlers': ['file', 'console'],
+                'level': logging.getLevelName(log_level),
+                'propagate': False,
+            },
+        },
+    }