macOS¶
prompt_under_name(*, name: str, reason: str) -> None
Give this program a name for macOS to ask Bluetooth permission under.
macOS asks the user before a program can use Bluetooth. A bundled application
is asked about under its own name, and does not need this. A script, a REPL
or a command line tool has no name of its own. Without one, macOS goes by the
permission of the program that started it, such as the terminal. It asks
under that program's name. If that program cannot be asked, macOS ends the
helper process instead, and
MissingUsageDescriptionError
is raised. If that program already has permission, Bluetooth works without
asking. A script started by launchd, with a Python from python.org,
Homebrew or uv, is asked about as that Python itself. Call this before
opening Bluetooth, so that your program is asked about under its own name.
The user sees name in the permission dialog and later in the system
settings, and macOS remembers the answer under it. Name it after your program,
not after this library, and do not change it: a new name asks the user again.
Does nothing on Linux and Windows.
Parameters:
-
name(str) –The program's name, as the user knows it.
-
reason(str) –Why the program needs Bluetooth, shown in the permission dialog.
Bases: RuntimeError
macOS could not ask the user about Bluetooth, and ended the helper process instead.
macOS asks about a bundled application itself, and about anything else
as whatever started it, such as the terminal. It can ask only about a
program with NSBluetoothAlwaysUsageDescription in its Info.plist.
Put the key in a bundled application's Info.plist. A script, a REPL
or a command line tool calls prompt_under_name
instead, whose reason is its usage description.
Raised by the async with block of
open_bluetooth, on macOS only.