Skip to content

gh-98307: Add docstring and documentation for SysLogHandler.createSocket (GH-98319) #98319

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

Merged
vsajip merged 5 commits into from
Oct 16, 2022
Merged

gh-98307: Add docstring and documentation for SysLogHandler.createSocket (GH-98319) #98319

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0eb2f90
gh-98307: Add docstring and documentation for SysLogHandler.createSocket
vsajip Oct 16, 2022
d02a81a
Add NEWS entry.
vsajip Oct 16, 2022
483bea7
Improved phrasing
vsajip Oct 16, 2022
cee3a76
Improved phrasing and annotation added
vsajip Oct 16, 2022
bf52ab1
Remove trailing whitespace.
vsajip Oct 16, 2022
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
Next Next commit
gh-98307: Add docstring and documentation for SysLogHandler.createSocket
  • Loading branch information
@vsajip
vsajip committed Oct 16, 2022
commit 0eb2f90d01b2caef10d3d78798e252d378f728c4
7 changes: 7 additions & 0 deletions Doc/library/logging.handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,6 +650,13 @@ supports sending logging messages to a remote or local Unix syslog.

Closes the socket to the remote host.

.. method:: createSocket()

Tries to create a socket and, if it's not a datagram socket, connect it
to the other end. This method is called during handler initialization,
but it's not regarded as an error if the other end isn't listening at
this point - the method will be called again when emitting an event, if
there is no socket at that point.

.. method:: emit(record)
Comment thread
vsajip marked this conversation as resolved.
Outdated

Expand Down
9 changes: 8 additions & 1 deletion Lib/logging/handlers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -891,14 +891,21 @@ def _connect_unixsocket(self, address):
raise

def createSocket(self):
"""
Try to create a socket and, if it's not a datagram socket, connect it
to the other end. This method is called during handler initialization,
but it's not regarded as an error if the other end isn't listening at
this point - the method will be called again when emitting an event, if
there is no socket at that point.
Comment thread
vsajip marked this conversation as resolved.
Outdated
"""
address = self.address
socktype = self.socktype

if isinstance(address, str):
self.unixsocket = True
# Syslog server may be unavailable during handler initialisation.
# C's openlog() function also ignores connection errors.
# Moreover, we ignore these errors while logging, so it not worse
# Moreover, we ignore these errors while logging, so it's not worse
# to ignore it also here.
try:
self._connect_unixsocket(address)
Expand Down