Skip to content

gh-99127: Allow some features of syslog to the main interpreter only #99128

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
corona10 merged 23 commits into from
Nov 29, 2022
Merged

gh-99127: Allow some features of syslog to the main interpreter only #99128

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
ced41bc
gh-99127: Port syslog module to use module state.
corona10 Nov 5, 2022
8beb461
Address code review
corona10 Nov 5, 2022
d8acc8b
Remove logic to check the openlog status while calling syslog.syslog
corona10 Nov 5, 2022
11d9228
Do not call openlog while calling syslog
corona10 Nov 5, 2022
e7408a8
Fix test_audit
corona10 Nov 5, 2022
69ac18a
nit
corona10 Nov 6, 2022
3a784f6
Address code review
corona10 Nov 6, 2022
f5cf63a
nit
corona10 Nov 6, 2022
fc85827
Address code review
corona10 Nov 11, 2022
f40d953
Add test
corona10 Nov 11, 2022
35bbac2
nit
corona10 Nov 11, 2022
525a32b
Address code review
corona10 Nov 12, 2022
741baf0
Update NEWS.d
corona10 Nov 12, 2022
779a3d2
nit
corona10 Nov 12, 2022
557578f
Revert some logic
corona10 Nov 12, 2022
01334e8
nit
corona10 Nov 12, 2022
4ad2b8f
Address code review
corona10 Nov 14, 2022
696196d
Update Lib/test/test_syslog.py
corona10 Nov 16, 2022
5eeade5
Address code review
corona10 Nov 16, 2022
fb81c1e
Address code review
corona10 Nov 17, 2022
140366b
Update documentations
corona10 Nov 17, 2022
c961709
Address code review
corona10 Nov 17, 2022
e8dce88
Apply suggestions from code review
corona10 Nov 18, 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
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
  • Loading branch information
@corona10 @ericsnowcurrently
corona10 and ericsnowcurrently authored Nov 18, 2022
commit e8dce888766f52834b1d6fc5b943a58bdf7482af
21 changes: 15 additions & 6 deletions Doc/library/syslog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,11 @@ The module defines the following functions:
implementation to call ``openlog()``.

.. versionchanged:: 3.12
Subinterpreters are allowed to call only if the main interpreter already called :func:`openlog`.
If not, it will raise :exc:`RuntimeError`.
This function is restricted in subinterpreters.
(Only code that runs in multiple interpreters is affected and
the restriction is not relevant for most users.)
:func:`openlog` must be called in the main interpreter before :func:`syslog` may be used
in a subinterpreter. Otherwise it will raise :exc:`RuntimeError`.


.. function:: openlog([ident[, logoption[, facility]]])
Expand All @@ -65,8 +68,11 @@ The module defines the following functions:
required.

.. versionchanged:: 3.12
Only the main interpreter is allowed to call. It will raise :exc:`RuntimeError`
if subinterpreters call :func:`openlog`.
This function is restricted in subinterpreters.
(Only code that runs in multiple interpreters is affected and
the restriction is not relevant for most users.)
This may only be called in the main interpreter.
It will raise :exc:`RuntimeError` if called in a subinterpreter.


.. function:: closelog()
Expand All @@ -81,8 +87,11 @@ The module defines the following functions:
.. audit-event:: syslog.closelog "" syslog.closelog

.. versionchanged:: 3.12
Only the main interpreter is allowed to call. It will raise :exc:`RuntimeError`
if subinterpreters call :func:`closelog`.
This function is restricted in subinterpreters.
(Only code that runs in multiple interpreters is affected and
the restriction is not relevant for most users.)
This may only be called in the main interpreter.
It will raise :exc:`RuntimeError` if called in a subinterpreter.


.. function:: setlogmask(maskpri)
Expand Down
9 changes: 7 additions & 2 deletions Doc/whatsnew/3.12.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,8 +649,13 @@ Changes in the Python API
:class:`bytes` type is accepted for bytes strings.
(Contributed by Victor Stinner in :gh:`98393`.)

* :func:`syslog.openlog` and :func:`syslog.closelog` are only available from the main interpreter not subinterpreter.
:func:`syslog.syslog` is only available to subinterpreters if :func:`syslog.openlog` was already called from the main interpreter.
* :func:`syslog.openlog` and :func:`syslog.closelog` now fail if used in subinterpreters.
:func:`syslog.syslog` may still be used in subinterpreters,
but now only if :func:`syslog.openlog` has already been called in the main interpreter.
These new restrictions do not apply to the main interpreter,
so only a very small set of users might be affected.
This change helps with interpreter isolation. Furthermore, :mod:`syslog` is a wrapper
around process-global resources, which are best managed from the main interpreter.
(Contributed by Dong-hee Na in :gh:`99127`.)


Expand Down