Skip to content

Commit

Permalink
bpo-37331: Clarify format of socket handler messages in the documenta…
Browse files Browse the repository at this point in the history
…tion. (GH-14234) (GH-14235)

(cherry picked from commit f06b569)
  • Loading branch information
miss-islington authored and vsajip committed Jun 19, 2019
1 parent 95ff622 commit d7232f0
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions Doc/library/logging.handlers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,12 @@ sends logging output to a network socket. The base class uses a TCP socket.
.. method:: makePickle(record)

Pickles the record's attribute dictionary in binary format with a length
prefix, and returns it ready for transmission across the socket.
prefix, and returns it ready for transmission across the socket. The
details of this operation are equivalent to::

data = pickle.dumps(record_attr_dict, 1)
datalen = struct.pack('>L', len(data))
return datalen + data

Note that pickles aren't completely secure. If you are concerned about
security, you may want to override this method to implement a more secure
Expand All @@ -481,8 +486,12 @@ sends logging output to a network socket. The base class uses a TCP socket.

.. method:: send(packet)

Send a pickled string *packet* to the socket. This function allows for
partial sends which can happen when the network is busy.
Send a pickled byte-string *packet* to the socket. The format of the sent
byte-string is as described in the documentation for
:meth:`~SocketHandler.makePickle`.

This function allows for partial sends, which can happen when the network
is busy.


.. method:: createSocket()
Expand Down Expand Up @@ -543,7 +552,8 @@ over UDP sockets.

.. method:: send(s)

Send a pickled string to a socket.
Send a pickled byte-string to a socket. The format of the sent byte-string
is as described in the documentation for :meth:`SocketHandler.makePickle`.


.. _syslog-handler:
Expand Down

0 comments on commit d7232f0

Please sign in to comment.