traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

bpo-37331: Clarify format of socket handler messages in the documentation. (GH-14234)

This commit is contained in:
Vinay Sajip 2019-06-19 15:29:57 +01:00 committed by GitHub
parent 0150001653
commit f06b569305
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/library/logging.handlers.rst
View File

@ -488,7 +488,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
@ -499,8 +504,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()
@ -561,7 +570,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: