]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] [doc] Update cookbook example and add information about queue types. (GH-94854...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 15 Jul 2022 07:19:02 +0000 (00:19 -0700)
committerGitHub <noreply@github.com>
Fri, 15 Jul 2022 07:19:02 +0000 (08:19 +0100)
(cherry picked from commit dc54193095e8ac8d73489f7ab133e016a5556256)

Doc/howto/logging-cookbook.rst
Doc/library/logging.handlers.rst

index 7f4fe3a63a70260282665e38cc14544b8f5d2b22..321c4bc510ad99054049fc2a3fc465cdf5d15ee5 100644 (file)
@@ -219,7 +219,7 @@ messages should not. Here's how you can achieve this::
    logging.basicConfig(level=logging.DEBUG,
                        format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
                        datefmt='%m-%d %H:%M',
-                       filename='/temp/myapp.log',
+                       filename='/tmp/myapp.log',
                        filemode='w')
    # define a Handler which writes INFO messages or higher to the sys.stderr
    console = logging.StreamHandler()
@@ -270,6 +270,11 @@ are sent to both destinations.
 This example uses console and file handlers, but you can use any number and
 combination of handlers you choose.
 
+Note that the above choice of log filename ``/tmp/myapp.log`` implies use of a
+standard location for temporary files on POSIX systems. On Windows, you may need to
+choose a different directory name for the log - just ensure that the directory exists
+and that you have the permissions to create and update files in it.
+
 
 Configuration server example
 ----------------------------
index 0cbe707339a7a266ec5f40cee307519192d91188..026f14153cbe1977e3a74f110feb93db0301ea22 100644 (file)
@@ -1018,6 +1018,8 @@ possible, while any potentially slow operations (such as sending an email via
    have the task tracking API, which means that you can use
    :class:`~queue.SimpleQueue` instances for *queue*.
 
+   .. note:: If you are using :mod:`multiprocessing`, you should avoid using
+      :class:`~queue.SimpleQueue` and instead use :class:`multiprocessing.Queue`.
 
    .. method:: emit(record)
 
@@ -1085,6 +1087,9 @@ possible, while any potentially slow operations (such as sending an email via
    task tracking API (though it's used if available), which means that you can
    use :class:`~queue.SimpleQueue` instances for *queue*.
 
+   .. note:: If you are using :mod:`multiprocessing`, you should avoid using
+      :class:`~queue.SimpleQueue` and instead use :class:`multiprocessing.Queue`.
+
    If ``respect_handler_level`` is ``True``, a handler's level is respected
    (compared with the level for the message) when deciding whether to pass
    messages to that handler; otherwise, the behaviour is as in previous Python