Skip to content
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

Jump to bottom

Logging: SysLogHandler.createSocket added in 3.11 but not documented #98307

Closed
CAM-Gerlach opened this issue Oct 15, 2022 · 3 comments
Closed

Logging: SysLogHandler.createSocket added in 3.11 but not documented #98307

CAM-Gerlach opened this issue Oct 15, 2022 · 3 comments
Assignees
@vsajip @CAM-Gerlach
Labels
3.11 only security fixes docs Documentation in the Doc dir

Comments

@CAM-Gerlach
Copy link
Member

Part of #95913

A createSocket() method was added to the SysLogHandler class for issue #88457 by PR #26490 to match the one in SocketHandler, but unlike the latter, the former was not documented (and also not mentioned in What's New).

@vsajip , shouldn't this be documented? If so, do you think you could help draft something describing its semantics and usage (I can help do the final writeup, but its not entirely clear to me what the precise intended behavior is, since it doesn't seem too similar internally to the other documented function, and there is no docstring). Thanks!
@CAM-Gerlach CAM-Gerlach added docs Documentation in the Doc dir 3.11 only security fixes labels Oct 15, 2022
@CAM-Gerlach CAM-Gerlach mentioned this issue Oct 15, 2022
Closed
33 tasks
@CAM-Gerlach
Copy link
Member Author

Also, I noticed logging.getLevelNamesMapping was added as well, but not mentioned in What's New. Seems like at least a brief note/reference would be worth adding, too (which I could easily do on my own as part of or separate from this, as its already documented).

@vsajip
Copy link
Member

vsajip commented Oct 16, 2022

Also, I noticed logging.getLevelNamesMapping was added as welll, but not mentioned in What's New ... which I could easily do on my own as part of or separate from this

I'd say please do it separately, as it's unrelated to the socket creation part of the issue.

vsajip added a commit to vsajip/cpython that referenced this issue Oct 16, 2022
@vsajip
pythongh-98307: Add docstring and documentation for SysLogHandler.cre…
0eb2f90 
…ateSocket
@bedevere-bot bedevere-bot mentioned this issue Oct 16, 2022
Merged
@CAM-Gerlach CAM-Gerlach mentioned this issue Oct 16, 2022
Merged
@CAM-Gerlach
Copy link
Member Author

Thanks for the quick response!

Sure; the main reason I didn't just do it separately to begin with was the PRs would conflict (at least as far as the What's New is concerned), but I just added the two What's New entries to the same PR, leaving your PR to document createSocket as a separate one (which makes a lot more sense anyway).

See #98320 for that.

vsajip added a commit that referenced this issue Oct 16, 2022
@vsajip @CAM-Gerlach
gh-98307: Add docstring and documentation for SysLogHandler.createSoc…
f6b1e40 
…ket (GH-98319)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
vsajip added a commit to vsajip/cpython that referenced this issue Oct 16, 2022
@vsajip
[3.11] pythongh-98307: Add docstring and documentation for SysLogHand…
489d3ed 
…ler.createSocket (pythonGH-98319)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit f6b1e40)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
@bedevere-bot bedevere-bot mentioned this issue Oct 16, 2022
Merged
vsajip added a commit that referenced this issue Oct 16, 2022
@vsajip @CAM-Gerlach
[3.11] gh-98307: Add docstring and documentation for SysLogHandler.cr… (
f64e26c 
GH-98325)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@vsajip vsajip closed this as completed Oct 16, 2022
carljm added a commit to carljm/cpython that referenced this issue Oct 17, 2022
@carljm
Merge branch 'main' into typewatch
cdbe93b 
* main: (31 commits)
  pythongh-95913: Move subinterpreter exper removal to 3.11 WhatsNew (pythonGH-98345)
  pythongh-95914: Add What's New item describing PEP 670 changes (python#98315)
  Remove unused arrange_output_buffer function from zlibmodule.c. (pythonGH-98358)
  pythongh-98174: Handle EPROTOTYPE under macOS in test_sendfile_fallback_close_peer_in_the_middle_of_receiving (python#98316)
  pythonGH-98327: Reduce scope of catch_warnings() in _make_subprocess_transport (python#98333)
  pythongh-93691: Compiler's code-gen passes location around instead of holding it on the global compiler state (pythonGH-98001)
  pythongh-97669: Create Tools/build/ directory (python#97963)
  pythongh-95534: Improve gzip reading speed by 10% (python#97664)
  pythongh-95913: Forward-port int/str security change to 3.11 What's New in main (python#98344)
  pythonGH-91415: Mention alphabetical sort ordering in the Sorting HOWTO (pythonGH-98336)
  pythongh-97930: Merge with importlib_resources 5.9 (pythonGH-97929)
  pythongh-85525: Remove extra row in doc (python#98337)
  pythongh-85299: Add note warning about entry point guard for asyncio example (python#93457)
  pythongh-97527: IDLE - fix buggy macosx patch (python#98313)
  pythongh-98307: Add docstring and documentation for SysLogHandler.createSocket (pythonGH-98319)
  pythongh-94808: Cover `PyFunction_GetCode`, `PyFunction_GetGlobals`, `PyFunction_GetModule` (python#98158)
  pythonGH-94597: Deprecate child watcher getters and setters (python#98215)
  pythongh-98254: Include stdlib module names in error messages for NameErrors (python#98255)
  Improve speed. Reduce auxiliary memory to 16.6% of the main array. (pythonGH-98294)
  [doc] Update logging cookbook with an example of custom handling of levels. (pythonGH-98290)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vsajip vsajip

@CAM-Gerlach CAM-Gerlach

Labels
3.11 only security fixes docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@vsajip @CAM-Gerlach