(original) (raw)

changeset: 71015:6baa90fa2b6d user: Vinay Sajip <vinay_sajip@yahoo.co.uk> date: Mon Jun 27 15:40:06 2011 +0100 files: Doc/library/logging.handlers.rst Lib/logging/handlers.py Lib/test/test_logging.py description: Closes #12419: Added ident to SysLogHandler. diff -r 328fb2bbcd56 -r 6baa90fa2b6d Doc/library/logging.handlers.rst --- a/Doc/library/logging.handlers.rst Mon Jun 27 09:19:02 2011 -0500 +++ b/Doc/library/logging.handlers.rst Mon Jun 27 15:40:06 2011 +0100 @@ -452,6 +452,15 @@ behaviour) but can be set to ``False`` on a ``SysLogHandler`` instance in order for that instance to *not* append the NUL terminator. + .. versionchanged:: 3.3 + (See: :issue:`12419`.) In earlier versions, there was no facility for + an "ident" or "tag" prefix to identify the source of the message. This + can now be specified using a class-level attribute, defaulting to + ``""`` to preserve existing behaviour, but which can be overridden on + a ``SysLogHandler`` instance in order for that instance to prepend + the ident to every message handled. Note that the provided ident must + be text, not bytes, and is prepended to the message exactly as is. + .. method:: encodePriority(facility, priority) Encodes the facility and priority into an integer. You can pass in strings diff -r 328fb2bbcd56 -r 6baa90fa2b6d Lib/logging/handlers.py --- a/Lib/logging/handlers.py Mon Jun 27 09:19:02 2011 -0500 +++ b/Lib/logging/handlers.py Mon Jun 27 15:40:06 2011 +0100 @@ -769,6 +769,7 @@ """ return self.priority_map.get(levelName, "warning") + ident = '' # prepended to all messages append_nul = True # some old syslog daemons expect a NUL terminator def emit(self, record): @@ -779,6 +780,8 @@ exception information is present, it is NOT sent to the server. """ msg = self.format(record) + if self.ident: + msg = self.ident + msg if self.append_nul: msg += '\000' """ diff -r 328fb2bbcd56 -r 6baa90fa2b6d Lib/test/test_logging.py --- a/Lib/test/test_logging.py Mon Jun 27 09:19:02 2011 -0500 +++ b/Lib/test/test_logging.py Mon Jun 27 15:40:06 2011 +0100 @@ -1482,6 +1482,11 @@ logger.error("sp\xe4m") self.handled.wait() self.assertEqual(self.log_output, b'<11>\xef\xbb\xbfsp\xc3\xa4m') + self.handled.clear() + self.sl_hdlr.ident = "h\xe4m-" + logger.error("sp\xe4m") + self.handled.wait() + self.assertEqual(self.log_output, b'<11>\xef\xbb\xbfh\xc3\xa4m-sp\xc3\xa4m') @unittest.skipUnless(threading, 'Threading required for this test.') </vinay_sajip@yahoo.co.uk>