Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3.7] bpo-37331: Clarify format of socket handler messages in the documentation. (GH-14234) #14236

Merged
merged 1 commit into from
Jun 19, 2019
Merged

[3.7] bpo-37331: Clarify format of socket handler messages in the documentation. (GH-14234) #14236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions Doc/library/logging.handlers.rst
View file
Open in desktop
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