File: handlers.rst

package info (click to toggle)
python-picologging 0.9.4-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 752 kB
  • sloc: python: 3,921; cpp: 2,430; makefile: 41; sh: 18
file content (92 lines) | stat: -rw-r--r-- 1,833 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
.. _handlers:

Handlers
========

Base Handler
------------

.. autoclass:: picologging.Handler
   :members:
   :member-order: bysource

Watched File Handler
--------------------

.. autoclass:: picologging.handlers.WatchedFileHandler
   :members:
   :member-order: bysource

Base Rotating Handler
---------------------

.. autoclass:: picologging.handlers.BaseRotatingHandler
   :members:
   :member-order: bysource

Rotating File Handler
---------------------

.. autoclass:: picologging.handlers.RotatingFileHandler
   :members:
   :member-order: bysource

Timed Rotating File Handler
---------------------------

.. autoclass:: picologging.handlers.TimedRotatingFileHandler
   :members:
   :member-order: bysource

Queue Handler
-------------

.. autoclass:: picologging.handlers.QueueHandler
   :members:
   :member-order: bysource

Queue Listener
--------------

The queue listener and queue handler can be combined for non-blocking logging, for example:

.. code-block:: python

    logger = picologging.Logger("test", picologging.DEBUG)
    stream = io.StringIO()
    stream_handler = picologging.StreamHandler(stream)
    q = queue.Queue()
    listener = QueueListener(q, stream_handler)
    listener.start()
    handler = QueueHandler(q)
    logger.addHandler(handler)
    logger.debug("test")

    listener.stop()
    assert stream.getvalue() == "test\n"


.. autoclass:: picologging.handlers.QueueListener
   :members:
   :member-order: bysource

Buffering Handler
-----------------

.. autoclass:: picologging.handlers.BufferingHandler
   :members:
   :member-order: bysource

Memory Handler
--------------

.. autoclass:: picologging.handlers.MemoryHandler
   :members:
   :member-order: bysource

Socket Handler
--------------

.. autoclass:: picologging.handlers.SocketHandler
   :members:
   :member-order: bysource