diff options
| author | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2019-06-19 15:29:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-19 15:29:57 +0100 |
| commit | f06b569305cf604f070776ea3f800ed61fdd7d61 (patch) | |
| tree | 97b4a15576011d40593b988922920f1bc63d2852 | |
| parent | 015000165373f8db263ef5bc682f02d74e5782ac (diff) | |
| download | cpython-git-f06b569305cf604f070776ea3f800ed61fdd7d61.tar.gz | |
bpo-37331: Clarify format of socket handler messages in the documentation. (GH-14234)
| -rw-r--r-- | Doc/library/logging.handlers.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst index 822f82dffc..21c6a045de 100644 --- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -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: |