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.

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

Some server class attributes are missing in socketserver docs #128319

Open
stephen-hansen opened this issue Dec 28, 2024 · 0 comments
Open

Some server class attributes are missing in socketserver docs #128319

stephen-hansen opened this issue Dec 28, 2024 · 0 comments
Labels
docs Documentation in the Doc dir

Comments

@stephen-hansen
Copy link
Contributor

stephen-hansen commented Dec 28, 2024

Documentation

While working with socketserver recently I noticed that the allow_reuse_port class attribute is not documented but the allow_reuse_address attribute is.

cpython/Lib/socketserver.py

Lines 185 to 198 in f9a5a3a

Class variables that may be overridden by derived classes or
instances:
- timeout
- address_family
- socket_type
- allow_reuse_address
- allow_reuse_port
Instance variables:
- RequestHandlerClass
- socket

In addition there's a couple of places we could clean up right now, for instance address_family is still grouped with the per-instance attributes rather than the class attributes, request_queue_size is only applicable to TCP, and there's another missing undocumented class attribute for specifying max packet size that is only applicable to UDP.

Linked PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
Status: Todo
Development

No branches or pull requests

1 participant