add `Django Logging' recipe. (#187)

lucas-six · web-flow · commit 6ac550f48248 · 2022-08-26T22:50:44.000+08:00
diff --git a/Pipfile b/Pipfile
@@ -22,6 +22,7 @@ flake8-django = "*"
 django-types = "*"
 types-psycopg2 = "*"
 types-redis = "*"
+colorlog = "*"
 
 [requires]
 python_version = "3.9"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -170,6 +170,7 @@
   - [Django - Quick Start](https://leven-cn.github.io/python-cookbook/recipes/web/django_quickstart)
   - [Django DB - PostgreSQL](https://leven-cn.github.io/python-cookbook/recipes/web/django_db_postgresql)
   - [Django Cache - Redis](https://leven-cn.github.io/python-cookbook/recipes/web/django_cache_redis)
+  - [Django Logging](https://leven-cn.github.io/python-cookbook/recipes/web/django_logging)
 - PostgreSQL
   - [PostgreSQL - Setup](https://leven-cn.github.io/python-cookbook/recipes/web/postgresql_setup)
   - [PostgreSQL CLI - Usage](https://leven-cn.github.io/python-cookbook/recipes/web/postgresql_usage)
diff --git a/django_project/django_project/settings.py b/django_project/django_project/settings.py
@@ -135,7 +135,8 @@
 
 
 # Cache
-# https://docs.djangoproject.com/en/3.2/ref/settings/#caches
+# https://docs.djangoproject.com/en/4.1/ref/settings/#caches
+# https://docs.djangoproject.com/en/4.1/topics/cache/
 
 CACHES = {
     'default': {
@@ -177,3 +178,96 @@
         },
     },
 }
+
+
+# Logging
+# https://docs.djangoproject.com/en/4.1/topics/logging/
+
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': True,
+    'formatters': {
+        'debug': {
+            'format': '[%(levelname)s] [%(asctime)s] [%(filename)s:%(lineno)d] %(message)s',
+        },
+        'info': {
+            'format': '[%(levelname)s] [%(asctime)s] %(message)s',
+        },
+        'color_debug': {
+            'format': '%(log_color)s[%(asctime)s] [%(filename)s:%(lineno)d] %(message)s',
+            'class': 'colorlog.ColoredFormatter',
+            'log_colors': {
+                'DEBUG': 'cyan white',
+                'INFO': 'green',
+                'WARNING': 'yellow',
+                'ERROR': 'red',
+                'CRITICAL': 'bold_red',
+            },
+        },
+        'color': {
+            'format': '%(log_color)s[%(asctime)s] %(message)s',
+            'class': 'colorlog.ColoredFormatter',
+            'log_colors': {
+                'DEBUG': 'cyan white',
+                'INFO': 'green',
+                'WARNING': 'yellow',
+                'ERROR': 'red',
+                'CRITICAL': 'bold_red',
+            },
+        },
+        'standard': {
+            'format': '[%(levelname)s] [%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]'
+            '[%(message)s]'
+        },
+        'collect': {
+            'format': '%(message)s',
+        },
+    },
+    'filters': {
+        'require_debug_true': {
+            '()': 'django.utils.log.RequireDebugTrue',
+        },
+        'require_debug_false': {
+            '()': 'django.utils.log.RequireDebugFalse',
+        },
+    },
+    'handlers': {
+        'console': {
+            'level': 'INFO',
+            'filters': ['require_debug_false'],
+            'class': 'logging.StreamHandler',
+            'formatter': 'color',
+        },
+        'console_debug': {
+            'level': 'DEBUG',
+            'filters': ['require_debug_true'],
+            'class': 'logging.StreamHandler',
+            'formatter': 'color_debug',
+        },
+    },
+    'loggers': {
+        'django': {
+            'handlers': ['console'],
+            'propagate': True,
+        },
+        'django.request': {
+            'handlers': ['console'],
+            'level': 'ERROR',
+            'propagate': False,
+        },
+        '': {
+            'handlers': ['console_debug'],
+            'level': 'DEBUG',
+        },
+        'requests': {
+            'handlers': ['console'],
+            'level': 'INFO',
+            'propagate': False,
+        },
+        'elasticsearch': {
+            'handlers': ['console'],
+            'level': 'INFO',
+            'propagate': False,
+        },
+    },
+}
diff --git a/django_project/example_app/views.py b/django_project/example_app/views.py
@@ -1,3 +1,4 @@
+import logging
 from collections import OrderedDict
 
 from django.core.cache import cache
@@ -8,6 +9,8 @@
 CACHE_KEY = 'example'
 CACHE_TIMEOUT = 10
 
+logger = logging.getLogger()
+
 
 def index(request: HttpRequest) -> HttpResponse:
     return HttpResponse('Hello, world.')
@@ -39,15 +42,19 @@ def use_cache(request: HttpRequest) -> HttpResponse:
     assert cache.get(CACHE_KEY) == {'a': 1, 'b': 2, 'c': None}
 
     # default value
+    default_value = 'default value'
     assert cache.get('non-exists-key') is None
-    assert cache.get('non-exists-key', 'default value') == 'default value'
+    logger.warning('non-exists-key')
+    assert cache.get('non-exists-key', default_value) == default_value
+    logger.debug(f'cache get: {default_value}')
 
     # get_or_set
     assert cache.get_or_set(CACHE_KEY, 2, CACHE_TIMEOUT) == {'a': 1, 'b': 2, 'c': None}
     assert cache.get_or_set('non-exists-key', 2, CACHE_TIMEOUT) == 2
 
     # delete
     cache.delete(CACHE_KEY)
+    logger.error('cache deleted')
 
     cache.set('num', 1)
     assert cache.incr('num') == 2
@@ -60,4 +67,6 @@ def use_cache(request: HttpRequest) -> HttpResponse:
     assert cache.get_many(['a', 'b', 'c']) == OrderedDict({'a': 1, 'b': 2, 'c': None})
     cache.delete_many(['a', 'b', 'c'])
 
+    logger.info('finished')
+
     return HttpResponse('ok')
diff --git a/pyproject.toml b/pyproject.toml
@@ -43,6 +43,7 @@ test = [
     "flake8-django",
     "django-types",
     "types-redis",
+    "colorlog",
 ]
 doc = [
 ]
diff --git a/recipes/core/python_project.md b/recipes/core/python_project.md
@@ -5,7 +5,8 @@
 ```bash
 pipenv --python 3.9
 
-pipenv install --dev black isort mypy 'flake8>=4.0' pyupgrade 'pytest>=7.1' 'coverage>=6.4' 'pytest-cov>=3.0' flake8-django 'django-stubs[compatible-mypy]>=1.12' types-redis
+pipenv install --dev black isort mypy 'flake8>=4.0' pyupgrade 'pytest>=7.1' 'coverage>=6.4' 'pytest-cov>=3.0' \
+    flake8-django 'django-stubs[compatible-mypy]>=1.12' types-redis
 ```
 
 ## `pyproject.toml`
@@ -41,7 +42,6 @@ dependencies = [
     "django ~= 3.2",
     "psycopg2 >= 2.8",
     "redis >= 4.0",
-    "django-redis",
 
     "requests >=2.6",
     "configparser; python_version == '2.7'",
diff --git a/recipes/web/django_cache_redis.md b/recipes/web/django_cache_redis.md
@@ -2,9 +2,9 @@
 
 ## Dependencies
 
-- PostgreSQL *11+*.
-See [PostgreSQL - Setup](https://leven-cn.github.io/python-cookbook/recipes/web/postgresql_setup)
-and [PostgreSQL CLI - Usage](https://leven-cn.github.io/python-cookbook/recipes/web/postgresql_usage).
+- Redis *5.0+*.
+See [Redis - Setup](https://leven-cn.github.io/python-cookbook/recipes/web/redis_setup)
+and [Redis CLI - Basic Usage](https://leven-cn.github.io/python-cookbook/recipes/web/redis_usage_basic).
 
 ```toml
 # pyproject.toml
@@ -36,6 +36,7 @@ pipenv install django-redis
 
 # Cache
 # https://docs.djangoproject.com/en/4.1/ref/settings/#caches
+# https://docs.djangoproject.com/en/4.1/topics/cache/
 
 CACHES = {
     'default': {
@@ -46,11 +47,14 @@ CACHES = {
 
 ### Django 4.0+
 
+#### Standalone Mode
+
 ```python
 # settings.py
 
 # Cache
 # https://docs.djangoproject.com/en/4.1/ref/settings/#caches
+# https://docs.djangoproject.com/en/4.1/topics/cache/
 #
 # LOCATION:
 #   - redis://localhost:6379/0
@@ -80,11 +84,14 @@ CACHES = {
 }
 ```
 
+#### Replication Mode
+
 ```python
 # settings.py
 
 # Cache
 # https://docs.djangoproject.com/en/4.1/ref/settings/#caches
+# https://docs.djangoproject.com/en/4.1/topics/cache/
 #
 # LOCATION:
 #   - redis://localhost:6379/0
@@ -125,6 +132,7 @@ CACHES = {
 
 # Cache
 # https://docs.djangoproject.com/en/3.2/ref/settings/#caches
+# https://docs.djangoproject.com/en/3.2/topics/cache/
 
 CACHES = {
     'default': {
diff --git a/recipes/web/django_logging.md b/recipes/web/django_logging.md

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ test = [`
`43`	`43`	`"flake8-django",`
`44`	`44`	`"django-types",`
`45`	`45`	`"types-redis",`
	`46`	`+ "colorlog",`
`46`	`47`	`]`
`47`	`48`	`doc = [`
`48`	`49`	`]`