Skip to content

restore bluetooth socket constants on Linux #15209

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

Open
tungol wants to merge 2 commits into
base: main
Choose a base branch
from
+19 −8
Open

restore bluetooth socket constants on Linux #15209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b682d4
restore bluetooth socket constants on Linux
tungol Jan 2, 2026
7c6a91c
fix allowlist and keep an `__all__` that matches github runners
tungol Jan 2, 2026
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
9 changes: 9 additions & 0 deletions stdlib/@tests/stubtest_allowlists/linux.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ fcntl.I_[A-Z0-9_]+ # Platform differences that cannot be captured by the type s
multiprocessing.popen_spawn_win32 # exists on Linux but fails to import
select.poll # Actually a function; we have a class so it can be used as a type

# Bluetooth constants which aren't on the GitHub Actions runners, see #15207
_?socket.AF_BLUETOOTH
_?socket.BDADDR_ANY
_?socket.BDADDR_LOCAL
_?socket.BTPROTO_HCI
_?socket.BTPROTO_L2CAP
_?socket.BTPROTO_RFCOMM
_?socket.BTPROTO_SCO

# These seem like they should be available on Linux, but they're not
# on GitHub Actions runners for some reason.
_?socket.IPX_TYPE
Expand Down
8 changes: 4 additions & 4 deletions stdlib/_socket.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ if sys.platform != "linux":

has_ipv6: bool

if sys.platform != "darwin" and sys.platform != "linux":
if sys.platform != "darwin":
BDADDR_ANY: Final = "00:00:00:00:00:00"
BDADDR_LOCAL: Final = "00:00:00:FF:FF:FF"

Expand Down Expand Up @@ -660,16 +660,16 @@ if sys.platform == "darwin":
PF_SYSTEM: Final[int]
SYSPROTO_CONTROL: Final[int]

if sys.platform != "darwin" and sys.platform != "linux":
if sys.platform != "darwin":
AF_BLUETOOTH: Final[int]

if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux":
if sys.platform != "win32" and sys.platform != "darwin":
# Linux and some BSD support is explicit in the docs
# Windows and macOS do not support in practice
BTPROTO_HCI: Final[int]
BTPROTO_L2CAP: Final[int]
BTPROTO_SCO: Final[int] # not in FreeBSD
if sys.platform != "darwin" and sys.platform != "linux":
if sys.platform != "darwin":
BTPROTO_RFCOMM: Final[int]

if sys.platform == "linux":
Expand Down
10 changes: 6 additions & 4 deletions stdlib/socket.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,9 +519,10 @@ if sys.platform != "win32":

__all__ += ["SO_BINDTODEVICE"]

if sys.platform != "darwin" and sys.platform != "linux":
if sys.platform != "darwin":
from _socket import BDADDR_ANY as BDADDR_ANY, BDADDR_LOCAL as BDADDR_LOCAL, BTPROTO_RFCOMM as BTPROTO_RFCOMM

if sys.platform != "darwin" and sys.platform != "linux":
Copy link

@dlech dlech Jan 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if sys.platform != "darwin" and sys.platform != "linux":

Why is Linux excluded from __all__?

They are there at runtime:

Python 3.12.3 (main, Nov  6 2025, 13:44:16) [GCC 13.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import socket
>>> [x for x in socket.__all__ if "BTPROTO" in x or "BLUETOOTH" in x or "RFCOMM" in x or "BDADDR" in x]
['AF_BLUETOOTH', 'BDADDR_ANY', 'BDADDR_LOCAL', 'BTPROTO_HCI', 'BTPROTO_L2CAP', 'BTPROTO_RFCOMM', 'BTPROTO_SCO']

Copy link
Contributor Author

@tungol tungol Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They're not present in the github actions runners. If we add them to __all__, then we need to add socket.__all__ to the stubtest allowlist. We'd rather not do that, because that would hide any problems with __all__, not just the bluetooth-related ones.

Copy link
Contributor Author

@tungol tungol Jan 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can see what I mean here: https://github.com/python/typeshed/actions/runs/20648303553/job/59289007679

if they're in __all__, then stubtest errors with something like:

error: socket.__all__ names exported from the stub do not correspond to the names exported at runtime. This is probably due to things being missing from the stub or an inaccurate `__all__` in the stub
Stub: in file /home/runner/work/typeshed/typeshed/stdlib/socket.pyi
Names exported in the stub but not at runtime: ['AF_BLUETOOTH', 'BDADDR_ANY', 'BDADDR_LOCAL', 'BTPROTO_HCI', 'BTPROTO_L2CAP', 'BTPROTO_RFCOMM', 'BTPROTO_SCO']
Runtime:
Names exported at runtime but not in the stub: []

The stubtest allowlist mechanism is pretty blunt. We lack a technical means to allowlist only these specific members of __all__, so putting socket.__all__ on the allowlist would make it too easy for other problems with __all__ to go unnoticed.

__all__ += ["BDADDR_ANY", "BDADDR_LOCAL", "BTPROTO_RFCOMM"]

if sys.platform == "darwin" and sys.version_info >= (3, 10):
Expand Down Expand Up @@ -969,9 +970,10 @@ if sys.platform != "linux":
if sys.platform != "darwin" and sys.platform != "linux":
Copy link

@dlech dlech Jan 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if sys.platform != "darwin" and sys.platform != "linux":
if sys.platform != "darwin":

__all__ += ["AF_BLUETOOTH"]

if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux":
if sys.platform != "win32" and sys.platform != "darwin":
from _socket import BTPROTO_HCI as BTPROTO_HCI, BTPROTO_L2CAP as BTPROTO_L2CAP, BTPROTO_SCO as BTPROTO_SCO

if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux":
Copy link

@dlech dlech Jan 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux":

Same here.

__all__ += ["BTPROTO_HCI", "BTPROTO_L2CAP", "BTPROTO_SCO"]

if sys.platform != "win32" and sys.platform != "darwin" and sys.platform != "linux":
Expand Down Expand Up @@ -1131,7 +1133,7 @@ class AddressFamily(IntEnum):
AF_QIPCRTR = 42
if sys.platform != "linux":
AF_LINK = 33
if sys.platform != "darwin" and sys.platform != "linux":
if sys.platform != "darwin":
AF_BLUETOOTH = 32
if sys.platform == "win32" and sys.version_info >= (3, 12):
AF_HYPERV = 34
Expand Down Expand Up @@ -1186,7 +1188,7 @@ if sys.platform == "linux":

if sys.platform != "linux":
AF_LINK: Final = AddressFamily.AF_LINK
if sys.platform != "darwin" and sys.platform != "linux":
if sys.platform != "darwin":
AF_BLUETOOTH: Final = AddressFamily.AF_BLUETOOTH
if sys.platform == "win32" and sys.version_info >= (3, 12):
AF_HYPERV: Final = AddressFamily.AF_HYPERV
Expand Down