darkdetect

darkdetect provides theme detection for several environments:

• macOS: Supports macOS 10.14+. Note that detection of the dark menu bar and dock (available since macOS 10.10) is not supported.
• Windows: Supports Windows 10 1607+.
• Linux: Uses an experimental detection method based on the presence of a dark GTK theme.

If the package is executed on an operating system that does not support dark mode detection, it will return None for theme queries.

You can install darkdetect via PyPI using pip.

To enable the macOS listener functionality, you must install the optional macos-listener extra.

Alternatively, you can vendor a copy of the package directly into your application.

```bash
# Standard installation
pip install darkdetect

# Installation with macOS listener support
pip install darkdetect[macos-listener]
```埋

You can monitor changes to the system theme by using darkdetect.listener. This function starts a listener that calls a provided callback whenever the OS switches between Dark and Light modes.

Because darkdetect.listener is a blocking call, it is typically run in a background daemon thread to avoid freezing your main application.

The callback function receives a single string argument: either "Dark" or "Light".

Note: Enabling the macOS listener requires the darkdetect[macos-listener] installation.

import threading
import darkdetect

# Define your callback function
def my_callback(theme_name: str):
    print(f"Theme changed to: {theme_name}")

# Start the listener in a daemon thread
t = threading.Thread(target=darkdetect.listener, args=(my_callback,))
t.daemon = True
t.start()

Use darkdetect.theme() to get the current theme name as a string, or use the boolean helpers isDark() and isLight() to check the state.

Supported platforms:

• macOS 10.14+
• Windows 10 1607+
• Linux with a dark GTK theme

Note: On unsupported operating systems, the package will return None instead of a theme name.

import darkdetect

# Get theme name ('Dark' or 'Light')
print(darkdetect.theme())

# Boolean checks
print(darkdetect.isDark())
print(darkdetect.isLight())

The listener(callback) function allows you to register a callback that is triggered whenever the system theme changes. The callback must accept a single string argument representing the new theme ('dark' or 'light').

import darkdetect

def my_callback(theme: str):
    print(f"The theme changed to: {theme}")

darkdetect.listener(my_callback)

# The script must remain running to receive events
import time
time.sleep(100)

Use theme() to retrieve the current system appearance as a string. It returns either 'dark' or 'light' depending on the operating system's settings.

import darkdetect

current_theme = darkdetect.theme()
print(current_theme)  # Outputs 'dark' or 'light'

Use isLight() to get a boolean value indicating whether the system is currently using a light theme. Returns True if light, False otherwise.

import darkdetect

if darkdetect.isLight():
    print("Light mode is enabled")
else:
    print("Dark mode is enabled")

Use isDark() to get a boolean value indicating whether the system is currently using a dark theme. Returns True if dark, False otherwise.

import darkdetect

if darkdetect.isDark():
    print("Dark mode is enabled")
else:
    print("Light mode is enabled")

You can run the darkdetect package as a module from the command line to print the current system theme (e.g., 'light' or 'dark').

python -m darkdetect