Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.

This commit is contained in:
django-bot 2023-02-28 20:53:28 +01:00 committed by Mariusz Felisiak
parent 6015bab80e
commit 14459f80ee
193 changed files with 5797 additions and 4481 deletions

View file

@ -41,7 +41,7 @@ And then in a function, for example in a view, send a record to the logger::
def some_view(request):
...
if some_risky_state:
logger.warning('Platform is running at risk')
logger.warning("Platform is running at risk")
When this code is executed, a :py:class:`~logging.LogRecord` containing that
message will be sent to the logger. If you're using Django's default logging
@ -51,7 +51,7 @@ The ``WARNING`` level used in the example above is one of several
:ref:`logging severity levels <topic-logging-parts-loggers>`: ``DEBUG``,
``INFO``, ``WARNING``, ``ERROR``, ``CRITICAL``. So, another example might be::
logger.critical('Payment system is not responding')
logger.critical("Payment system is not responding")
.. important::
@ -99,8 +99,8 @@ Create a ``LOGGING`` dictionary
In your ``settings.py``::
LOGGING = {
'version': 1, # the dictConfig format version
'disable_existing_loggers': False, # retain the default loggers
"version": 1, # the dictConfig format version
"disable_existing_loggers": False, # retain the default loggers
}
It nearly always makes sense to retain and extend the default logging
@ -118,10 +118,10 @@ file ``general.log`` (at the project root):
LOGGING = {
# ...
'handlers': {
'file': {
'class': 'logging.FileHandler',
'filename': 'general.log',
"handlers": {
"file": {
"class": "logging.FileHandler",
"filename": "general.log",
},
},
}
@ -138,9 +138,9 @@ messages of all levels). Using the example above, adding:
:emphasize-lines: 4
{
'class': 'logging.FileHandler',
'filename': 'general.log',
'level': 'DEBUG',
"class": "logging.FileHandler",
"filename": "general.log",
"level": "DEBUG",
}
would define a handler configuration that only accepts records of level
@ -157,10 +157,10 @@ example:
LOGGING = {
# ...
'loggers': {
'': {
'level': 'DEBUG',
'handlers': ['file'],
"loggers": {
"": {
"level": "DEBUG",
"handlers": ["file"],
},
},
}
@ -178,7 +178,7 @@ between loggers and handlers is many-to-many.
If you execute::
logger.debug('Attempting to connect to API')
logger.debug("Attempting to connect to API")
in your code, you will find that message in the file ``general.log`` in the
root of the project.
@ -196,14 +196,14 @@ formatters named ``verbose`` and ``simple``:
LOGGING = {
# ...
'formatters': {
'verbose': {
'format': '{name} {levelname} {asctime} {module} {process:d} {thread:d} {message}',
'style': '{',
"formatters": {
"verbose": {
"format": "{name} {levelname} {asctime} {module} {process:d} {thread:d} {message}",
"style": "{",
},
'simple': {
'format': '{levelname} {message}',
'style': '{',
"simple": {
"format": "{levelname} {message}",
"style": "{",
},
},
}
@ -220,11 +220,11 @@ dictionary referring to the formatter by name, for example:
.. code-block:: python
:emphasize-lines: 5
'handlers': {
'file': {
'class': 'logging.FileHandler',
'filename': 'general.log',
'formatter': 'verbose',
"handlers": {
"file": {
"class": "logging.FileHandler",
"filename": "general.log",
"formatter": "verbose",
},
}
@ -254,10 +254,8 @@ A logger mapping named ``my_app.views`` will capture records from this logger:
LOGGING = {
# ...
'loggers': {
'my_app.views': {
...
},
"loggers": {
"my_app.views": {...},
},
}
@ -270,16 +268,14 @@ from loggers anywhere within the ``my_app`` namespace (including
LOGGING = {
# ...
'loggers': {
'my_app': {
...
},
"loggers": {
"my_app": {...},
},
}
You can also define logger namespacing explicitly::
logger = logging.getLogger('project.payment')
logger = logging.getLogger("project.payment")
and set up logger mappings accordingly.
@ -298,16 +294,16 @@ To manage this behavior, set the propagation key on the mappings you define::
LOGGING = {
# ...
'loggers': {
'my_app': {
"loggers": {
"my_app": {
# ...
},
'my_app.views': {
"my_app.views": {
# ...
},
'my_app.views.private': {
"my_app.views.private": {
# ...
'propagate': False,
"propagate": False,
},
},
}
@ -333,7 +329,7 @@ For example, you could set an environment variable ``DJANGO_LOG_LEVEL``
appropriately in your development and staging environments, and make use of it
in a logger mapping thus::
'level': os.getenv('DJANGO_LOG_LEVEL', 'WARNING')
"level": os.getenv("DJANGO_LOG_LEVEL", "WARNING")
\- so that unless the environment specifies a lower log level, this
configuration will only forward records of severity ``WARNING`` and above to