diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-06-19 14:42:35 (GMT) |
|---|---|---|
| committer | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2019-06-19 14:42:35 (GMT) |
| commit | d7232f0e4646803f0bbaede6e1fa124156135512 (patch) | |
| tree | 5fa2aca5e75111b394887bb7bd91637d9e3afb62 /Doc/library/logging.handlers.rst | |
| parent | 95ff622028b4f5d2eefbff557eadbb08fbcd42b1 (diff) | |
| download | cpython-d7232f0e4646803f0bbaede6e1fa124156135512.zip cpython-d7232f0e4646803f0bbaede6e1fa124156135512.tar.gz cpython-d7232f0e4646803f0bbaede6e1fa124156135512.tar.bz2 | |
bpo-37331: Clarify format of socket handler messages in the documentation. (GH-14234) (GH-14235)
(cherry picked from commit f06b569305cf604f070776ea3f800ed61fdd7d61)
Diffstat (limited to 'Doc/library/logging.handlers.rst')
| -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 dee9a84..b48d50f 100644 --- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -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 @@ -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() @@ -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: |