Skip to content

Constants

Constants that we might want to expose via the public API.

COLOR_SYSTEM module-attribute 

COLOR_SYSTEM: Final[str | None] = get_environ(
    "TEXTUAL_COLOR_SYSTEM", "auto"
)

Force color system override

DEBUG module-attribute 

DEBUG: Final[bool] = _get_environ_bool('TEXTUAL_DEBUG')

Enable debug mode.

DEVTOOLS_HOST module-attribute 

DEVTOOLS_HOST: Final[str] = get_environ(
    "TEXTUAL_DEVTOOLS_HOST", "127.0.0.1"
)

The host where textual console is running.

DEVTOOLS_PORT module-attribute 

DEVTOOLS_PORT: Final[int] = _get_environ_int(
    "TEXTUAL_DEVTOOLS_PORT", 8081
)

Constant with the port that the devtools will connect to.

DRIVER module-attribute 

DRIVER: Final[str | None] = get_environ(
    "TEXTUAL_DRIVER", None
)

Import for replacement driver.

FILTERS module-attribute 

FILTERS: Final[str] = get_environ('TEXTUAL_FILTERS', '')

A list of filters to apply to renderables.

LOG_FILE module-attribute 

LOG_FILE: Final[str | None] = get_environ(
    "TEXTUAL_LOG", None
)

A last resort log file that appends all logs, when devtools isn't working.

MAX_FPS module-attribute 

MAX_FPS: Final[int] = _get_environ_int('TEXTUAL_FPS', 60)

Maximum frames per second for updates.

PRESS module-attribute 

PRESS: Final[str] = get_environ('TEXTUAL_PRESS', '')

Keys to automatically press.

SCREENSHOT_DELAY module-attribute 

SCREENSHOT_DELAY: Final[int] = _get_environ_int(
    "TEXTUAL_SCREENSHOT", -1
)

Seconds delay before taking screenshot.

SCREENSHOT_FILENAME module-attribute 

SCREENSHOT_FILENAME: Final[str | None] = get_environ(
    "TEXTUAL_SCREENSHOT_FILENAME"
)

The filename to use for the screenshot.

SCREENSHOT_LOCATION module-attribute 

SCREENSHOT_LOCATION: Final[str | None] = get_environ(
    "TEXTUAL_SCREENSHOT_LOCATION"
)

The location where screenshots should be written.

SHOW_RETURN module-attribute 

SHOW_RETURN: Final[bool] = _get_environ_bool(
    "TEXTUAL_SHOW_RETURN"
)

Write the return value on exit.

TEXTUAL_ANIMATIONS module-attribute 

TEXTUAL_ANIMATIONS: AnimationLevel = (
    _get_textual_animations()
)

Determines whether animations run or not.