Detection¶

All detection functions¶

Detection function	Icon	Associated symbol
`is_aarch64()`	📱	`AARCH64`
`is_aix()`	➿	`AIX`
`is_alacritty()`	🔳	`ALACRITTY`
`is_almalinux()`		`ALMALINUX`
`is_alpine()`	🏔️	`ALPINE`
`is_altlinux()`	Δ	`ALTLINUX`
`is_amzn()`	⤻	`AMZN`
`is_android()`	🤖	`ANDROID`
`is_any_agent()`	🧠	`ALL_AGENTS`
`is_any_architecture()`	🏛️	`ALL_ARCHITECTURES`
`is_any_arm()`	📱	`ALL_ARM`
`is_any_ci()`	♺	`ALL_CI`
`is_any_mips()`	🔲	`ALL_MIPS`
`is_any_platform()`	⚙️	`ALL_PLATFORMS`
`is_any_shell()`	🐚	`ALL_SHELLS`
`is_any_sparc()`	☀️	`ALL_SPARC`
`is_any_terminal()`	💻	`ALL_TERMINALS`
`is_any_trait()`	⁕	`ALL_TRAITS`
`is_any_windows()`	🪟	`ALL_WINDOWS`
`is_apple_terminal()`	🍏	`APPLE_TERMINAL`
`is_arch()`	🎗️	`ARCH`
`is_arch_32_bit()`	³²	`ARCH_32_BIT`
`is_arch_64_bit()`	⁶⁴	`ARCH_64_BIT`
`is_arm()`	📱	`ARM`
`is_armv5tel()`	📱	`ARMV5TEL`
`is_armv6l()`	📱	`ARMV6L`
`is_armv7l()`	📱	`ARMV7L`
`is_armv8l()`	📱	`ARMV8L`
`is_artix()`	⟁	`ARTIX`
`is_ash()`	🪶	`ASH`
`is_azure_pipelines()`	═	`AZURE_PIPELINES`
`is_bamboo()`	⟲	`BAMBOO`
`is_bash()`	＃	`BASH`
`is_big_endian()`	⬆️	`BIG_ENDIAN`
`is_bourne_shells()`	💲	`BOURNE_SHELLS`
`is_bsd()`	Ⓑ	`BSD`
`is_bsd_not_macos()`	🅱️	`BSD_WITHOUT_MACOS`
`is_buildkite()`	🪁	`BUILDKITE`
`is_buildroot()`	⛑️	`BUILDROOT`
`is_c_shells()`	🅲	`C_SHELLS`
`is_cachyos()`	⌬	`CACHYOS`
`is_centos()`	💠	`CENTOS`
`is_chromeos()`	🧿	`CHROMEOS`
`is_circle_ci()`	⪾	`CIRCLE_CI`
`is_cirrus_ci()`	≋	`CIRRUS_CI`
`is_claude_code()`	✴️	`CLAUDE_CODE`
`is_clearlinux()`	✳️	`CLEARLINUX`
`is_cline()`	👾	`CLINE`
`is_cloudlinux()`	꩜	`CLOUDLINUX`
`is_cmd()`	▶	`CMD`
`is_codebuild()`	ᚙ	`CODEBUILD`
`is_codex()`	📕	`CODEX`
`is_contour()`	◰	`CONTOUR`
`is_copilot_cli()`	✈️	`COPILOT_CLI`
`is_crush()`	💘	`CRUSH`
`is_crux()`	✜	`CRUX`
`is_csh()`	𝐂	`CSH`
`is_cursor()`	➤	`CURSOR`
`is_cygwin()`	Ͼ	`CYGWIN`
`is_dash()`	💨	`DASH`
`is_debian()`	🌀	`DEBIAN`
`is_dragonfly_bsd()`	🪰	`DRAGONFLY_BSD`
`is_endeavouros()`	🚀	`ENDEAVOUROS`
`is_exherbo()`	🐽	`EXHERBO`
`is_fedora()`	🎩	`FEDORA`
`is_fish()`	🐟	`FISH`
`is_foot()`	🦶	`FOOT`
`is_freebsd()`	😈	`FREEBSD`
`is_gemini_cli()`	♊	`GEMINI_CLI`
`is_generic_linux()`	🥚	`GENERIC_LINUX`
`is_gentoo()`	🗜️	`GENTOO`
`is_ghostty()`	👻	`GHOSTTY`
`is_github_ci()`	🐙	`GITHUB_CI`
`is_gitlab_ci()`	🦊	`GITLAB_CI`
`is_gnome_terminal()`	𝐆	`GNOME_TERMINAL`
`is_gnu_screen()`	📺	`GNU_SCREEN`
`is_gpu_terminals()`	🎮	`GPU_TERMINALS`
`is_guix()`	🐃	`GUIX`
`is_haiku()`	🍂	`HAIKU`
`is_hermetic_build()`	🥫	`HERMETIC_BUILD`
`is_heroku_ci()`	⥁	`HEROKU_CI`
`is_hurd()`	🦬	`HURD`
`is_hyper()`	⬡	`HYPER`
`is_i386()`	𝗶	`I386`
`is_i586()`	𝗶	`I586`
`is_i686()`	𝗶	`I686`
`is_ibm_mainframe()`	🏢	`IBM_MAINFRAME`
`is_ibm_powerkvm()`	🤹	`IBM_POWERKVM`
`is_illumos()`	🔥	`ILLUMOS`
`is_iterm2()`	⬛	`ITERM2`
`is_kali()`	🔱	`KALI`
`is_kitty()`	🐱	`KITTY`
`is_konsole()`	💎	`KONSOLE`
`is_ksh()`	𝐊	`KSH`
`is_kvmibm()`	🤹	`KVMIBM`
`is_linux()`	🐧	`LINUX`
`is_linux_layers()`	≚	`LINUX_LAYERS`
`is_linux_like()`	🐣	`LINUX_LIKE`
`is_linuxmint()`	🌿	`LINUXMINT`
`is_little_endian()`	⬇️	`LITTLE_ENDIAN`
`is_loongarch()`	🐉	`LOONGARCH`
`is_loongarch64()`	🐉	`LOONGARCH64`
`is_macos()`	🍎	`MACOS`
`is_mageia()`	⍥	`MAGEIA`
`is_mandriva()`	💫	`MANDRIVA`
`is_manjaro()`	▲	`MANJARO`
`is_midnightbsd()`	🌘	`MIDNIGHTBSD`
`is_mips()`	🔲	`MIPS`
`is_mips64()`	🔲	`MIPS64`
`is_mips64el()`	🔲	`MIPS64EL`
`is_mipsel()`	🔲	`MIPSEL`
`is_multiplexers()`	⧉	`MULTIPLEXERS`
`is_native_terminals()`	▦	`NATIVE_TERMINALS`
`is_netbsd()`	🚩	`NETBSD`
`is_nixos()`	❄️	`NIXOS`
`is_nobara()`		`NOBARA`
`is_nushell()`	𝜈	`NUSHELL`
`is_nutyx()`	🃏	`NUTYX`
`is_openbsd()`	🐡	`OPENBSD`
`is_opensuse()`	🦎	`OPENSUSE`
`is_openwrt()`	📶	`OPENWRT`
`is_oracle()`	🦴	`ORACLE`
`is_os400()`	🟦	`OS400`
`is_other_posix()`	🅟	`OTHER_POSIX`
`is_other_shells()`	◇	`OTHER_SHELLS`
`is_parallels()`	∥	`PARALLELS`
`is_pi()`	π	`PI`
`is_pidora()`	🍓	`PIDORA`
`is_pikaos()`	🐹	`PIKAOS`
`is_powerpc()`	⚡	`POWERPC`
`is_powershell()`	🔷	`POWERSHELL`
`is_ppc()`	⚡	`PPC`
`is_ppc64()`	⚡	`PPC64`
`is_ppc64le()`	⚡	`PPC64LE`
`is_raspbian()`	🍓	`RASPBIAN`
`is_rhel()`	🎩	`RHEL`
`is_rio()`	🏞️	`RIO`
`is_riscv()`	Ⅴ	`RISCV`
`is_riscv32()`	Ⅴ	`RISCV32`
`is_riscv64()`	Ⅴ	`RISCV64`
`is_rocky()`	⛰️	`ROCKY`
`is_s390x()`	🏢	`S390X`
`is_scientific()`	⚛️	`SCIENTIFIC`
`is_sh()`	𝐒	`SH`
`is_slackware()`	🚬	`SLACKWARE`
`is_sles()`	🦎	`SLES`
`is_slitaz()`	🕷️	`SLITAZ`
`is_solaris()`	🌞	`SOLARIS`
`is_solus()`		`SOLUS`
`is_sourcemage()`	🧙	`SOURCEMAGE`
`is_sparc()`	☀️	`SPARC`
`is_sparc64()`	☀️	`SPARC64`
`is_sunos()`	🌅	`SUNOS`
`is_system_v()`	𝐕	`SYSTEM_V`
`is_tabby()`	🐈	`TABBY`
`is_tcsh()`	𝐓	`TCSH`
`is_teamcity()`	🏙️	`TEAMCITY`
`is_tilix()`	🔀	`TILIX`
`is_tmux()`	📟	`TMUX`
`is_travis_ci()`	👷	`TRAVIS_CI`
`is_tuxedo()`	🤵	`TUXEDO`
`is_ubuntu()`	🎯	`UBUNTU`
`is_ultramarine()`	🌊	`ULTRAMARINE`
`is_unix()`	⨷	`UNIX`
`is_unix_layers()`	≛	`UNIX_LAYERS`
`is_unix_not_macos()`	⨂	`UNIX_WITHOUT_MACOS`
`is_unknown()`	❓	`UNKNOWN`
`is_unknown_agent()`	❓	`UNKNOWN_AGENT`
`is_unknown_architecture()`	❓	`UNKNOWN_ARCHITECTURE`
`is_unknown_ci()`	❓	`UNKNOWN_CI`
`is_unknown_platform()`	❓	`UNKNOWN_PLATFORM`
`is_unknown_shell()`	❓	`UNKNOWN_SHELL`
`is_unknown_terminal()`	❓	`UNKNOWN_TERMINAL`
`is_void()`	∅	`VOID`
`is_vscode_terminal()`	🔵	`VSCODE_TERMINAL`
`is_wasm32()`	🌐	`WASM32`
`is_wasm64()`	🌐	`WASM64`
`is_web_terminals()`	⬢	`WEB_TERMINALS`
`is_webassembly()`	🌐	`WEBASSEMBLY`
`is_webos()`	🌴	`WEBOS`
`is_wezterm()`	🔡	`WEZTERM`
`is_windows()`	🪟	`WINDOWS`
`is_windows_shells()`	⌨️	`WINDOWS_SHELLS`
`is_windows_terminal()`	⊡	`WINDOWS_TERMINAL`
`is_wsl1()`	⊞	`WSL1`
`is_wsl2()`	⊞	`WSL2`
`is_x86()`	𝘅	`X86`
`is_x86_64()`	🖥️	`X86_64`
`is_xenserver()`	Ⓧ	`XENSERVER`
`is_xonsh()`	🐍	`XONSH`
`is_xterm()`	𝐗	`XTERM`
`is_zellij()`	🪵	`ZELLIJ`
`is_zsh()`	ℤ	`ZSH`

Trait detection functions¶

extra_platforms.is_aarch64()[source]¶

Return True if current architecture is AARCH64.

Caution

platform.machine() returns different values depending on the OS:

Linux: aarch64
macOS: arm64
Windows: ARM64

Return type:: bool

extra_platforms.is_aix()[source]¶

Return True if current platform is AIX.

Return type:: bool

extra_platforms.is_alacritty()[source]¶

Return True if current terminal is ALACRITTY.

Return type:: bool

extra_platforms.is_almalinux()[source]¶

Return True if current platform is ALMALINUX.

Return type:: bool

extra_platforms.is_alpine()[source]¶

Return True if current platform is ALPINE.

Return type:: bool

extra_platforms.is_altlinux()[source]¶

Return True if current platform is ALTLINUX.

Return type:: bool

extra_platforms.is_amzn()[source]¶

Return True if current platform is AMZN.

Return type:: bool

extra_platforms.is_android()[source]¶

Return True if current platform is ANDROID.

Return type:: bool

extra_platforms.is_apple_terminal()[source]¶

Return True in APPLE_TERMINAL.

Return type:: bool

extra_platforms.is_arch()[source]¶

Return True if current platform is ARCH.

Return type:: bool

extra_platforms.is_arm()[source]¶

Return True if current architecture is ARM.

Hint

This is a fallback detection for generic ARM architecture. It will return True for any ARM architecture not specifically covered by the more precise variants: is_aarch64(), is_armv5tel(), is_armv6l(), is_armv7l() or is_armv8l().

Return type:: bool

extra_platforms.is_armv5tel()[source]¶

Return True if the architecture is ARMV5TEL.

Return type:: bool

extra_platforms.is_armv6l()[source]¶

Return True if the architecture is ARMV6L.

Return type:: bool

extra_platforms.is_armv7l()[source]¶

Return True if the architecture is ARMV7L.

Return type:: bool

extra_platforms.is_armv8l()[source]¶

Return True if the architecture is ARMV8L.

Return type:: bool

extra_platforms.is_artix()[source]¶

Return True if current platform is ARTIX.

Return type:: bool

extra_platforms.is_ash()[source]¶

Return True if current shell is ASH.

Hint

Detected via the SHELL environment variable path, as Almquist Shell does not set its own version variable.

Note

BusyBox’s built-in shell is an ASH derivative, which its sh and ash applets both run (see extra_platforms._process_tree). On BusyBox-based systems (ALPINE, OPENWRT), /bin/sh and /bin/ash both link to BusyBox, so either one, as $SHELL or running, is detected as ASH.

Return type:: bool

extra_platforms.is_azure_pipelines()[source]¶

Return True if current CI is AZURE_PIPELINES.

Return type:: bool

extra_platforms.is_bamboo()[source]¶

Return True if current CI is BAMBOO.

Return type:: bool

extra_platforms.is_bash()[source]¶

Return True if current shell is BASH.

Hint

Detected via the BASH_VERSION environment variable (set by Bash on startup), or via the SHELL path as a fallback.

Attention

GitHub’s ubuntu-slim runner is a stripped-down environments, running as a WSL2 container on top of Windows. It uses Bash as the default shell, but does not set neither BASH_VERSION nor SHELL. In that case we fall back to walking the parent process tree via /proc to find it.

Return type:: bool

extra_platforms.is_buildkite()[source]¶

Return True if current CI is BUILDKITE.

See also

Environment variables reference: <https://buildkite.com/docs/pipelines/environment-variables>.

Return type:: bool

extra_platforms.is_buildroot()[source]¶

Return True if current platform is BUILDROOT.

Return type:: bool

extra_platforms.is_cachyos()[source]¶

Return True if current platform is CACHYOS.

Return type:: bool

extra_platforms.is_centos()[source]¶

Return True if current platform is CENTOS.

Return type:: bool

extra_platforms.is_chromeos()[source]¶

Return True if current platform is CHROMEOS.

Matches ChromeOS itself, whose os-release file sets ID=chromeos (the environment targeted by Chromebrew), as well as open-source ChromiumOS builds and their derivatives like FydeOS and openFyde, which set ID=chromiumos. Accepting both IDs was the practice of Google’s own flashrom tester.

Also matches the Crostini Linux development environment. Crostini being a Debian-based container, its os-release file reports Debian. So the /dev/.cros_milestone file exposed by the ChromeOS host is used as the detection marker instead, a practice shared with LXD, Incus and the Dart SDK.

Caution

Within Crostini, both this function and is_debian() return True, the same way WSL sessions match both is_wsl2() and the distribution it hosts. In that situation, current_platform() prefers the container’s own distribution.

Return type:: bool

extra_platforms.is_circle_ci()[source]¶

Return True if current CI is CIRCLE_CI.

See also

Environment variables reference: <https://circleci.com/docs/reference/variables/#built-in-environment-variables>.

Return type:: bool

extra_platforms.is_cirrus_ci()[source]¶

Return True if current CI is CIRRUS_CI.

Return type:: bool

extra_platforms.is_claude_code()[source]¶

Return True if current agent is CLAUDE_CODE.

See also

Claude Code sets the CLAUDECODE environment variable when running.

Return type:: bool

extra_platforms.is_clearlinux()[source]¶

Return True if current platform is CLEARLINUX.

Note

Clear Linux OS sets ID=clear-linux-os in its os-release file. Being a stateless distribution, it ships that file at /usr/lib/os-release rather than /etc/os-release, relying on the fallback path mandated by the os-release specification.

Return type:: bool

extra_platforms.is_cline()[source]¶

Return True if current agent is CLINE.

See also

Cline sets the CLINE_ACTIVE environment variable when running.

Return type:: bool

extra_platforms.is_cloudlinux()[source]¶

Return True if the platform is CLOUDLINUX.

Return type:: bool

extra_platforms.is_cmd()[source]¶

Return True if current shell is CMD.

Hint

Detected on Windows via cmd.exe in the parent process tree, or when the PROMPT environment variable is set and PSModulePath is not (to exclude PowerShell).

Return type:: bool

extra_platforms.is_codebuild()[source]¶

Return True if current CI is CODEBUILD.

See also

Environment variables reference: <https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html>.

Return type:: bool

extra_platforms.is_codex()[source]¶

Return True if current agent is CODEX.

See also

Codex sets the CODEX_CI environment variable when running. The name says CI, but the variable is one entry of the UNIFIED_EXEC_ENV array Codex applies to every process it spawns, in codex-rs/core/src/unified_exec/process_manager.rs.

Return type:: bool

extra_platforms.is_contour()[source]¶

Return True if current terminal is CONTOUR.

Return type:: bool

extra_platforms.is_copilot_cli()[source]¶

Return True if current agent is COPILOT_CLI.

See also

GitHub Copilot CLI sets the COPILOT_CLI environment variable in its subprocesses, so git hooks can detect it.

Return type:: bool

extra_platforms.is_crush()[source]¶

Return True if current agent is CRUSH.

See also

Crush sets the CRUSH environment variable on every shell it spawns, next to AGENT=crush and AI_AGENT=crush, from CrushEnvMarkers() in internal/shell/shell.go. The bash tool and the hook runner both apply them.

Return type:: bool

extra_platforms.is_crux()[source]¶

Return True if current platform is CRUX.

Return type:: bool

extra_platforms.is_csh()[source]¶

Return True if current shell is CSH.

Hint

Detected via the SHELL environment variable path.

Return type:: bool

extra_platforms.is_cursor()[source]¶

Return True if current agent is CURSOR.

See also

Cursor sets the CURSOR_AGENT environment variable when running.

Return type:: bool

extra_platforms.is_cygwin()[source]¶

Return True if current platform is CYGWIN.

Return type:: bool

extra_platforms.is_dash()[source]¶

Return True if current shell is DASH.

Hint

Detected via the SHELL environment variable path, as Dash does not set its own version variable.

Return type:: bool

extra_platforms.is_debian()[source]¶

Return True if current platform is DEBIAN.

Return type:: bool

extra_platforms.is_dragonfly_bsd()[source]¶

Return True if the platform is DRAGONFLY_BSD.

Return type:: bool

extra_platforms.is_endeavouros()[source]¶

Return True if the platform is ENDEAVOUROS.

Return type:: bool

extra_platforms.is_exherbo()[source]¶

Return True if current platform is EXHERBO.

Return type:: bool

extra_platforms.is_fedora()[source]¶

Return True if current platform is FEDORA.

Return type:: bool

extra_platforms.is_fish()[source]¶

Return True if current shell is FISH.

Hint

Detected via the FISH_VERSION environment variable (set by Fish on startup), or via the SHELL path as a fallback.

Return type:: bool

extra_platforms.is_foot()[source]¶

Return True if current terminal is FOOT.

Return type:: bool

extra_platforms.is_freebsd()[source]¶

Return True if current platform is FREEBSD.

Return type:: bool

extra_platforms.is_gemini_cli()[source]¶

Return True if current agent is GEMINI_CLI.

See also

Gemini CLI sets the GEMINI_CLI environment variable in the subprocesses it spawns, so scripts can detect it.

Return type:: bool

extra_platforms.is_generic_linux()[source]¶

Return True if the platform is GENERIC_LINUX.

Matches when running on a Linux kernel whose distribution no other platform identifies: a distribution with an os-release ID no platform recognizes yet, or a minimal container or build chroot shipping no /etc/os-release and reaching no systemd-hostnamed. This keeps an unrecognized distribution in the LINUX group, and in every group built on it.

Note

A distribution identified by another marker is no generic Linux, like SLITAZ from its /etc/slitaz-release file. CHROMEOS counts only through its own os-release ID: its Crostini marker also shows inside a container, whose own distribution stays unidentified.

Return type:: bool

extra_platforms.is_gentoo()[source]¶

Return True if current platform is GENTOO.

Return type:: bool

extra_platforms.is_ghostty()[source]¶

Return True if current terminal is GHOSTTY.

Return type:: bool

extra_platforms.is_github_ci()[source]¶

Return True if current CI is GITHUB_CI.

Return type:: bool

extra_platforms.is_gitlab_ci()[source]¶

Return True if current CI is GITLAB_CI.

See also

Environment variables reference: <https://docs.gitlab.com/ci/variables/predefined_variables/#predefined-variables>.

Return type:: bool

extra_platforms.is_gnome_terminal()[source]¶

Return True in GNOME_TERMINAL.

Return type:: bool

extra_platforms.is_gnu_screen()[source]¶

Return True if the terminal is GNU_SCREEN.

Return type:: bool

extra_platforms.is_guix()[source]¶

Return True if current platform is GUIX.

Return type:: bool

extra_platforms.is_haiku()[source]¶

Return True if current platform is HAIKU.

Return type:: bool

extra_platforms.is_hermetic_build()[source]¶

Return True if current CI is HERMETIC_BUILD.

Note

Keys on HOME=/homeless-shelter: a non-existent home directory the build daemon assigns so a package build cannot read or write a real home. The value originated in Nix (2003) and was inherited verbatim by GNU Guix, so this matches both, plus Nix-ecosystem wrappers that reuse the sandbox (like devbox). It does not catch hermetic builders that isolate HOME differently, such as Bazel, Buck2 or Spack.

Todo

Grow extra signals to recognize the other hermetic builders above, should users ask for it. Only the /homeless-shelter signal is checked for now.

See also

The Guix build environment, which documents the sentinel: <https://guix.gnu.org/manual/en/html_node/Build-Environment-Setup.html>.

Return type:: bool

extra_platforms.is_heroku_ci()[source]¶

Return True if current CI is HEROKU_CI.

See also

Environment variables reference: <https://devcenter.heroku.com/articles/heroku-ci#immutable-environment-variables>.

Return type:: bool

extra_platforms.is_hurd()[source]¶

Return True if current platform is HURD.

Caution

sys.platform can returns GNU or gnu0, see: <https://github.com/kdeldycke/extra-platforms/issues/308>

Return type:: bool

extra_platforms.is_hyper()[source]¶

Return True if current terminal is HYPER.

Return type:: bool

extra_platforms.is_i386()[source]¶

Return True if current architecture is I386.

Return type:: bool

extra_platforms.is_i586()[source]¶

Return True if current architecture is I586.

Return type:: bool

extra_platforms.is_i686()[source]¶

Return True if current architecture is I686.

Return type:: bool

extra_platforms.is_ibm_powerkvm()[source]¶

Return True if the platform is IBM_POWERKVM.

Return type:: bool

extra_platforms.is_illumos()[source]¶

Return True if current platform is ILLUMOS.

Hint

Illumos is a Unix OS derived from OpenSolaris. It shares sys.platform == 'sunos5' with Solaris, but can be distinguished by checking platform.uname().version which contains “illumos” on Illumos-based systems (like OpenIndiana, SmartOS, OmniOS).

Note

Gates on sys.platform before reading platform.uname() so the function returns immediately on non-SunOS hosts. This matters on Windows, where platform.uname() shells out via platform._syscmd_ver() to populate its version field.

Return type:: bool

extra_platforms.is_iterm2()[source]¶

Return True if current terminal is ITERM2.

Return type:: bool

extra_platforms.is_kali()[source]¶

Return True if current platform is KALI.

Return type:: bool

extra_platforms.is_kitty()[source]¶

Return True if current terminal is KITTY.

Return type:: bool

extra_platforms.is_konsole()[source]¶

Return True if current terminal is KONSOLE.

Return type:: bool

extra_platforms.is_ksh()[source]¶

Return True if current shell is KSH.

Hint

Detected via the KSH_VERSION environment variable (set by Korn shell on startup), or via the SHELL path as a fallback.

Return type:: bool

extra_platforms.is_kvmibm()[source]¶

Return True if current platform is KVMIBM.

Return type:: bool

extra_platforms.is_linuxmint()[source]¶

Return True if current platform is LINUXMINT.

Return type:: bool

extra_platforms.is_loongarch64()[source]¶

Return True on LOONGARCH64.

Return type:: bool

extra_platforms.is_macos()[source]¶

Return True if current platform is MACOS.

Note

Uses sys.platform rather than platform.platform(). The former is a constant baked in by CPython at compile time (always "darwin" on macOS), while the latter performs runtime introspection and, on Windows, shells out via platform._syscmd_ver() to invoke cmd /c ver. Calling platform.platform() here would therefore spawn a subprocess on every non-macOS host, and break test suites that globally patch subprocess.run(). Since sys.platform == "darwin" is unambiguous for macOS (unlike Solaris vs. SunOS, which both report "sunos5" and genuinely need platform.platform() to be told apart), there is no reason to pay that cost here.

Return type:: bool

extra_platforms.is_mageia()[source]¶

Return True if current platform is MAGEIA.

Return type:: bool

extra_platforms.is_mandriva()[source]¶

Return True if current platform is MANDRIVA.

Return type:: bool

extra_platforms.is_manjaro()[source]¶

Return True if current platform is MANJARO.

Return type:: bool

extra_platforms.is_midnightbsd()[source]¶

Return True if the platform is MIDNIGHTBSD.

Return type:: bool

extra_platforms.is_mips()[source]¶

Return True if current architecture is MIPS.

Return type:: bool

extra_platforms.is_mips64()[source]¶

Return True if the architecture is MIPS64.

Return type:: bool

extra_platforms.is_mips64el()[source]¶

Return True if the architecture is MIPS64EL.

Return type:: bool

extra_platforms.is_mipsel()[source]¶

Return True if the architecture is MIPSEL.

Return type:: bool

extra_platforms.is_netbsd()[source]¶

Return True if current platform is NETBSD.

Return type:: bool

extra_platforms.is_nixos()[source]¶

Return True if current platform is NIXOS.

Return type:: bool

extra_platforms.is_nobara()[source]¶

Return True if current platform is NOBARA.

Return type:: bool

extra_platforms.is_nushell()[source]¶

Return True if current shell is NUSHELL.

Hint

Detected via the NU_VERSION environment variable (set by Nushell on startup), or via the SHELL path as a fallback.

Return type:: bool

extra_platforms.is_nutyx()[source]¶

Return True if current platform is NUTYX.

Return type:: bool

extra_platforms.is_openbsd()[source]¶

Return True if current platform is OPENBSD.

Return type:: bool

extra_platforms.is_opensuse()[source]¶

Return True if current platform is OPENSUSE.

Note

Matches the main opensuse ID as well as any opensuse-* release channel (Tumbleweed, Leap, Slowroll, MicroOS, …), per the granularity policy documented in the platform_data module. The raw channel ID remains available through Platform.info().

Return type:: bool

extra_platforms.is_openwrt()[source]¶

Return True if current platform is OPENWRT.

Return type:: bool

extra_platforms.is_oracle()[source]¶

Return True if current platform is ORACLE.

Note

Oracle Linux sets ID=ol in its os-release file. The platform keeps the more explicit oracle ID, mirroring the naming of the distro library.

Return type:: bool

extra_platforms.is_os400()[source]¶

Return True if current platform is OS400.

Note

Detects IBM i (formerly OS/400), whose AIX-compatible PASE runtime hosts Python. Python 3.9+ on IBM i reports sys.platform as os400 rather than aix (as older versions did), so PASE is distinguished from AIX despite their binary compatibility.

Note

OS400 is grouped under UNIX_LAYERS (beside CYGWIN), not SYSTEM_V where its AIX kin lives. IBM i’s native OS is not Unix: its only Unix surface is the PASE runtime that os400 runs in. The Wikipedia Unix taxonomy that these platform families track classes PASE as a Unix compatibility layer (a peer of Cygwin on Windows), so the trait sits there rather than with its System V binary kin.

Return type:: bool

extra_platforms.is_parallels()[source]¶

Return True if current platform is PARALLELS.

Return type:: bool

extra_platforms.is_pi()[source]¶

Return True if current agent is PI.

See also

Pi sets the PI_CODING_AGENT environment variable at startup, next to a generic AI_AGENT=pi marker, in packages/coding-agent/src/cli.ts. Child processes inherit both, but neither is set when Pi is embedded through its SDK.

Return type:: bool

extra_platforms.is_pidora()[source]¶

Return True if current platform is PIDORA.

Return type:: bool

extra_platforms.is_pikaos()[source]¶

Return True if current platform is PIKAOS.

Note

PikaOS, an Ubuntu-based gaming distribution, sets ID=pika (not pikaos) in its os-release file. Its ID_LIKE=debian field is ignored, so this stays distinct from is_debian().

Return type:: bool

extra_platforms.is_powershell()[source]¶

Return True if current shell is POWERSHELL.

Note

PowerShell is cross-platform and available on Linux and macOS. Detection covers all platforms via PSModulePath, SHELL path, and parent process tree.

Attention

PSModulePath can leak into non-PowerShell child processes via two vectors:

Process-level inheritance (all platforms): PowerShell modifies PSModulePath at startup, and all non-PowerShell children inherit it.
System-wide registry variable (Windows only): PSModulePath is a persistent machine-level environment variable visible to all processes.

This is the case for all GitHub Ubuntu runners, where PSModulePath leaks from Azure infrastructure. This leads to multiple shell detections, which is arbitraged by current_shell(), which deprioritizes PowerShell when other shells are detected.

Return type:: bool

extra_platforms.is_ppc()[source]¶

Return True if current architecture is PPC.

Return type:: bool

extra_platforms.is_ppc64()[source]¶

Return True if current architecture is PPC64.

Return type:: bool

extra_platforms.is_ppc64le()[source]¶

Return True if the architecture is PPC64LE.

Return type:: bool

extra_platforms.is_raspbian()[source]¶

Return True if current platform is RASPBIAN.

Return type:: bool

extra_platforms.is_rhel()[source]¶

Return True if current platform is RHEL.

Return type:: bool

extra_platforms.is_rio()[source]¶

Return True if current terminal is RIO.

Return type:: bool

extra_platforms.is_riscv32()[source]¶

Return True if the architecture is RISCV32.

Return type:: bool

extra_platforms.is_riscv64()[source]¶

Return True if the architecture is RISCV64.

Return type:: bool

extra_platforms.is_rocky()[source]¶

Return True if current platform is ROCKY.

Return type:: bool

extra_platforms.is_s390x()[source]¶

Return True if current architecture is S390X.

Return type:: bool

extra_platforms.is_scientific()[source]¶

Return True if the platform is SCIENTIFIC.

Return type:: bool

extra_platforms.is_sh()[source]¶

Return True if current shell is SH.

Hint

Detected via the SHELL environment variable path, after symlink resolution. Only matches when the resolved shell binary is literally sh, not when /bin/sh is a symlink to another shell (like bash or dash).

Note

On most modern systems, /bin/sh is a symlink to a concrete shell (bash, dash, etc.). In that case, is_sh() returns False and the concrete shell’s detection function returns True instead. To test whether the environment provides a Bourne-compatible interface regardless of the underlying implementation, use is_bourne_shells() instead.

Important

SH is treated as a low-specificity fallback by current_shell() (like GENERIC_LINUX for platforms): when both SH and a more specific shell are detected, current_shell() returns the specific shell.

Return type:: bool

extra_platforms.is_slackware()[source]¶

Return True if current platform is SLACKWARE.

Return type:: bool

extra_platforms.is_sles()[source]¶

Return True if current platform is SLES.

Return type:: bool

extra_platforms.is_slitaz()[source]¶

Return True if current platform is SLITAZ.

Note

SliTaz does not ship any os-release file: its slitaz-base-files package only provides /etc/slitaz-release, whose existence is used as the detection marker. The standard os-release check is still performed first, in case future releases adopt the specification.

Return type:: bool

extra_platforms.is_solaris()[source]¶

Return True if current platform is SOLARIS.

Hint

An illumos distribution reports Solaris-2.11 from platform.platform(), because it inherits the SunOS 5.11 release string from OpenSolaris. That prefix alone therefore cannot tell Oracle Solaris from its fork, and is_illumos() has to exclude it, or both match at once and current_platform() raises. Measured on OpenIndiana Hipster 2026.04.

Note

Gates on sys.platform being "sunos5" before invoking platform.platform(), which on Windows would shell out via platform._syscmd_ver(). Solaris and SunOS share the same sys.platform value, so platform.platform() is still needed to tell them apart, but only when we already know we’re on a SunOS-based host.

Return type:: bool

extra_platforms.is_solus()[source]¶

Return True if current platform is SOLUS.

Return type:: bool

extra_platforms.is_sourcemage()[source]¶

Return True if the platform is SOURCEMAGE.

Return type:: bool

extra_platforms.is_sparc()[source]¶

Return True if current architecture is SPARC.

Return type:: bool

extra_platforms.is_sparc64()[source]¶

Return True if the architecture is SPARC64.

Return type:: bool

extra_platforms.is_sunos()[source]¶

Return True if current platform is SUNOS.

Note

See is_solaris() for the rationale behind the sys.platform guard.

Return type:: bool

extra_platforms.is_tabby()[source]¶

Return True if current terminal is TABBY.

Return type:: bool

extra_platforms.is_tcsh()[source]¶

Return True if current shell is TCSH.

Hint

Detected via the SHELL environment variable path.

Return type:: bool

extra_platforms.is_teamcity()[source]¶

Return True if current CI is TEAMCITY.

Return type:: bool

extra_platforms.is_tilix()[source]¶

Return True if current terminal is TILIX.

Return type:: bool

extra_platforms.is_tmux()[source]¶

Return True if current terminal is TMUX.

Return type:: bool

extra_platforms.is_travis_ci()[source]¶

Return True if current CI is TRAVIS_CI.

Return type:: bool

extra_platforms.is_tuxedo()[source]¶

Return True if current platform is TUXEDO.

Return type:: bool

extra_platforms.is_ubuntu()[source]¶

Return True if current platform is UBUNTU.

Return type:: bool

extra_platforms.is_ultramarine()[source]¶

Return True if the platform is ULTRAMARINE.

Return type:: bool

extra_platforms.is_unknown_agent()[source]¶

Return True if the agent is UNKNOWN_AGENT.

Return type:: bool

extra_platforms.is_unknown_architecture()[source]¶

Return True if the architecture is unknown.

See UNKNOWN_ARCHITECTURE.

Return type:: bool

extra_platforms.is_unknown_ci()[source]¶

Return True if current CI is UNKNOWN_CI.

Return type:: bool

extra_platforms.is_unknown_platform()[source]¶

Return True if the platform is unknown.

See UNKNOWN_PLATFORM.

Return type:: bool

extra_platforms.is_unknown_shell()[source]¶

Return True if the shell is UNKNOWN_SHELL.

Return type:: bool

extra_platforms.is_unknown_terminal()[source]¶

Return True if the terminal is unknown.

See UNKNOWN_TERMINAL.

Return type:: bool

extra_platforms.is_void()[source]¶

Return True if current platform is VOID.

Return type:: bool

extra_platforms.is_vscode_terminal()[source]¶

Return True in VSCODE_TERMINAL.

Return type:: bool

extra_platforms.is_wasm32()[source]¶

Return True if current architecture is WASM32.

Hint

WebAssembly detection is based on Emscripten’s platform identifier.

Return type:: bool

extra_platforms.is_wasm64()[source]¶

Return True if current architecture is WASM64.

Hint

WebAssembly detection is based on Emscripten’s platform identifier.

Return type:: bool

extra_platforms.is_webos()[source]¶

Return True if current platform is WEBOS.

Note

webOS TV, the edition LG ships on its TVs, sets ID=starfish in its os-release file: starfish is the name of LG’s TV build. The platform keeps the more explicit webos ID. Captured on an LG OLED77B46LA TV, running webOS TV 10.3.2 (firmware 33.31.75).

Todo

Also match the ID of webOS Open Source Edition, once an os-release file captured on it confirms that ID. LG manages both editions, so they share this platform. Its Yocto layer sets DISTRO = "webos" in meta-webos/conf/distro/webos.conf, which suggests ID=webos.

Return type:: bool

extra_platforms.is_wezterm()[source]¶

Return True if current terminal is WEZTERM.

Return type:: bool

extra_platforms.is_windows()[source]¶

Return True if current platform is WINDOWS.

Return type:: bool

extra_platforms.is_windows_terminal()[source]¶

Return True in WINDOWS_TERMINAL.

Return type:: bool

extra_platforms.is_wsl1()[source]¶

Return True if current platform is WSL1.

Caution

The only difference between WSL1 and WSL2 is the case of the kernel release version:

WSL 1:
```
$ uname -r
4.4.0-22572-Microsoft
```

WSL 2:

$ uname -r
5.10.102.1-microsoft-standard-WSL2

Note

Gates on sys.platform being "linux" before invoking platform.release(). WSL is by definition a Linux subsystem, so on any other host the answer is trivially False. The guard also avoids a platform._syscmd_ver() subprocess on Windows, where platform.release() is implemented as a cmd /c ver shell-out.

Return type:: bool

extra_platforms.is_wsl2()[source]¶

Return True if current platform is WSL2.

Note

See is_wsl1() for the rationale behind the sys.platform guard.

Return type:: bool

extra_platforms.is_x86_64()[source]¶

Return True if current architecture is X86_64.

Caution

Windows returns AMD64 in uppercase, so we normalize to lowercase.

Hint

Solaris and illumos answer i86pc, which names the machine family rather than the ISA, the same way sun4u and sun4v do for is_sparc64(). Both keep that string on 64-bit hardware, and neither ships a 32-bit kernel any more. Measured on OpenIndiana Hipster 2026.04.

Return type:: bool

extra_platforms.is_xenserver()[source]¶

Return True if current platform is XENSERVER.

Return type:: bool

extra_platforms.is_xonsh()[source]¶

Return True if current shell is XONSH.

Hint

Detected via the XONSH_VERSION environment variable (set by Xonsh on startup), or via the SHELL path as a fallback.

Note

Xonsh runs as a Python script rather than a standalone binary, so the parent process tree shows python rather than xonsh. When neither XONSH_VERSION nor SHELL identifies it, the tree walk inspects interpreter arguments for the xonsh launcher (see interpreter).

Return type:: bool

extra_platforms.is_xterm()[source]¶

Return True if current terminal is XTERM.

Note

We check for XTERM_VERSION rather than TERM=xterm because many headless environments, like GitHub Actions ubuntu-slim runners, set TERM=xterm for termcap/terminfo compatibility without actually running xterm.

Return type:: bool

extra_platforms.is_zellij()[source]¶

Return True if current terminal is ZELLIJ.

Return type:: bool

extra_platforms.is_zsh()[source]¶

Return True if current shell is ZSH.

Hint

Detected via the ZSH_VERSION environment variable (set by Zsh on startup), or via the SHELL path as a fallback.

Return type:: bool

Group detection functions¶

Contrary to individual trait detection functions like is_ubuntu() or is_x86_64(), group detection functions check for membership in a collection of traits.

These functions are generated for each group and test whether at least one trait from the group matches the current system. Each one runs the detection functions of its own members and stops at the first match: is_linux() never runs a shell or terminal heuristic.

extra_platforms.is_any_agent()[source]¶

Return True if at least one member of the ALL_AGENTS group matches the current environment.

Return type:: bool

extra_platforms.is_any_architecture()[source]¶

Return True if at least one member of the ALL_ARCHITECTURES group matches the current environment.

Return type:: bool

extra_platforms.is_any_arm()[source]¶

Return True if at least one member of the ALL_ARM group matches the current environment.

Return type:: bool

extra_platforms.is_any_ci()[source]¶

Return True if at least one member of the ALL_CI group matches the current environment.

Return type:: bool

extra_platforms.is_any_mips()[source]¶

Return True if at least one member of the ALL_MIPS group matches the current environment.

Return type:: bool

extra_platforms.is_any_platform()[source]¶

Return True if at least one member of the ALL_PLATFORMS group matches the current environment.

Return type:: bool

extra_platforms.is_any_shell()[source]¶

Return True if at least one member of the ALL_SHELLS group matches the current environment.

Return type:: bool

extra_platforms.is_any_sparc()[source]¶

Return True if at least one member of the ALL_SPARC group matches the current environment.

Return type:: bool

extra_platforms.is_any_terminal()[source]¶

Return True if at least one member of the ALL_TERMINALS group matches the current environment.

Return type:: bool

extra_platforms.is_any_trait()[source]¶

Return True if at least one member of the ALL_TRAITS group matches the current environment.

Return type:: bool

extra_platforms.is_any_windows()[source]¶

Return True if at least one member of the ALL_WINDOWS group matches the current environment.

Return type:: bool

extra_platforms.is_arch_32_bit()[source]¶

Return True if at least one member of the ARCH_32_BIT group matches the current environment.

Return type:: bool

extra_platforms.is_arch_64_bit()[source]¶

Return True if at least one member of the ARCH_64_BIT group matches the current environment.

Return type:: bool

extra_platforms.is_big_endian()[source]¶

Return True if at least one member of the BIG_ENDIAN group matches the current environment.

Return type:: bool

extra_platforms.is_bourne_shells()[source]¶

Return True if at least one member of the BOURNE_SHELLS group matches the current environment.

Return type:: bool

extra_platforms.is_bsd()[source]¶

Return True if at least one member of the BSD group matches the current environment.

Return type:: bool

extra_platforms.is_bsd_not_macos()[source]¶

Return True if at least one member of the BSD_WITHOUT_MACOS group matches the current environment.

Return type:: bool

extra_platforms.is_c_shells()[source]¶

Return True if at least one member of the C_SHELLS group matches the current environment.

Return type:: bool

extra_platforms.is_gpu_terminals()[source]¶

Return True if at least one member of the GPU_TERMINALS group matches the current environment.

Return type:: bool

extra_platforms.is_ibm_mainframe()[source]¶

Return True if at least one member of the IBM_MAINFRAME group matches the current environment.

Return type:: bool

extra_platforms.is_linux()[source]¶

Return True if at least one member of the LINUX group matches the current environment.

Return type:: bool

extra_platforms.is_linux_layers()[source]¶

Return True if at least one member of the LINUX_LAYERS group matches the current environment.

Return type:: bool

extra_platforms.is_linux_like()[source]¶

Return True if at least one member of the LINUX_LIKE group matches the current environment.

Return type:: bool

extra_platforms.is_little_endian()[source]¶

Return True if at least one member of the LITTLE_ENDIAN group matches the current environment.

Return type:: bool

extra_platforms.is_loongarch()[source]¶

Return True if at least one member of the LOONGARCH group matches the current environment.

Return type:: bool

extra_platforms.is_multiplexers()[source]¶

Return True if at least one member of the MULTIPLEXERS group matches the current environment.

Return type:: bool

extra_platforms.is_native_terminals()[source]¶

Return True if at least one member of the NATIVE_TERMINALS group matches the current environment.

Return type:: bool

extra_platforms.is_other_posix()[source]¶

Return True if at least one member of the OTHER_POSIX group matches the current environment.

Return type:: bool

extra_platforms.is_other_shells()[source]¶

Return True if at least one member of the OTHER_SHELLS group matches the current environment.

Return type:: bool

extra_platforms.is_powerpc()[source]¶

Return True if at least one member of the POWERPC group matches the current environment.

Return type:: bool

extra_platforms.is_riscv()[source]¶

Return True if at least one member of the RISCV group matches the current environment.

Return type:: bool

extra_platforms.is_system_v()[source]¶

Return True if at least one member of the SYSTEM_V group matches the current environment.

Return type:: bool

extra_platforms.is_unix()[source]¶

Return True if at least one member of the UNIX group matches the current environment.

Return type:: bool

extra_platforms.is_unix_layers()[source]¶

Return True if at least one member of the UNIX_LAYERS group matches the current environment.

Return type:: bool

extra_platforms.is_unix_not_macos()[source]¶

Return True if at least one member of the UNIX_WITHOUT_MACOS group matches the current environment.

Return type:: bool

extra_platforms.is_unknown()[source]¶

Return True if at least one member of the UNKNOWN group matches the current environment.

Return type:: bool

extra_platforms.is_web_terminals()[source]¶

Return True if at least one member of the WEB_TERMINALS group matches the current environment.

Return type:: bool

extra_platforms.is_webassembly()[source]¶

Return True if at least one member of the WEBASSEMBLY group matches the current environment.

Return type:: bool

extra_platforms.is_windows_shells()[source]¶

Return True if at least one member of the WINDOWS_SHELLS group matches the current environment.

Return type:: bool

extra_platforms.is_x86()[source]¶

Return True if at least one member of the X86 group matches the current environment.

Return type:: bool

Current trait functions¶

current_traits() returns all detectable traits (multiple per type are possible). The individual current_*() functions return the single primary trait per type, after disambiguation. machine_architecture() returns the architecture of the machine, which can differ from current_architecture(): see Interpreter and machine.

extra_platforms.current_traits()[source]¶

Returns all traits matching the current environment.

This includes Architecture, Platform, Shell, Terminal, CI systems, and Agent environments.

Caution

Never returns UNKNOWN traits.

Raises SystemError if the current environment is not recognized at all.

Important

This function returns all detectable traits, not the disambiguated primary trait per category. Multiple shells, platforms, or other traits may appear in the result (for example, both BASH and POWERSHELL on GitHub Ubuntu runners where PSModulePath leaks from Azure).

Use the individual current_*() functions (current_shell(), current_platform(), etc.) to get the single best match per trait type.

Attention

At this point it is too late to worry about caching. This function has no choice but to evaluate all detection heuristics.

Return type:: frozenset[Trait]

extra_platforms.current_architecture(strict=False)[source]¶

Return the Architecture the Python interpreter runs as.

This is the architecture the detection functions, the groups and the pytest decorators all follow. A 32-bit Python on a 64-bit ARM kernel is ARMV8L, and in ARCH_32_BIT. The architecture of the machine itself comes from machine_architecture().

Returns UNKNOWN_ARCHITECTURE if not running inside a recognized architecture. To raise an error instead, set strict to True.

Important

Always raises an error if multiple architectures match.

Warning

An architecture is always expected to be detected. An unrecognized result logs a WARNING and likely indicates a missing detection heuristic that should be reported.

Todo

Also rename the machine of a 32-bit interpreter on a 64-bit PowerPC, SPARC, MIPS or RISC-V kernel, once a measured host gives the name its kernel reports to a 32-bit process. Only ARM and x86 get a name for now.

Return type:: Architecture

extra_platforms.machine_architecture(strict=False)[source]¶

Return the Architecture of the machine.

This is the architecture the operating system reports, from platform.machine(). It differs from current_architecture() only on a 64-bit ARM or x86 machine, for an interpreter that is narrower or emulated:

a 32-bit Python on a 64-bit Linux kernel, like the one of LG’s webOS TVs,
a 32-bit Python on 64-bit Windows,
an x64 Python emulated on Windows for ARM.

Everywhere else, it returns current_architecture(), with the same strict behavior.

Caution

The machine architecture is what the kernel runs, not what the system can load. A 64-bit kernel with a 32-bit userland, like the one of LG’s webOS TVs, runs a static 64-bit binary, but lacks the loader and libraries that a dynamically linked one needs.

Todo

Read the CPU under Rosetta 2 on macOS, where platform.machine reports the translated architecture, once a measured host shows how.

Return type:: Architecture

extra_platforms.current_platform(strict=False)[source]¶

Return the best matching Platform, always.

Returns UNKNOWN_PLATFORM if not running inside a recognized platform. To raise an error instead, set strict to True.

Note

When sys.platform is linux, the result is never UNKNOWN_PLATFORM. A distribution that no platform recognizes gives GENERIC_LINUX, and logs a warning that asks for a report. In strict mode, an unrecognized os-release ID raises an error instead.

Important

If multiple platforms match the current environment, this function will try to select the best, informative one. Raises an error if we can’t decide on a single, appropriate platform.

Warning

A platform is always expected to be detected. An unrecognized result logs a WARNING and likely indicates a missing detection heuristic that should be reported.

Return type:: Platform

extra_platforms.current_shell(strict=False)[source]¶

Returns the Shell matching the current environment.

Uses a tiered disambiguation strategy with cached signals shared with _detect_shell():

Shell-specific environment variables (strongest: the Python process is the shell).
Parent process tree, read from /proc on Linux or ps on macOS, the BSDs and illumos (strong: the shell is an ancestor process actively running). When shells nest, the nearest ancestor wins.
SHELL environment variable resolved through symlinks (weak: configured login shell, may differ from the active shell).

SH is treated as a low-specificity fallback (like GENERIC_LINUX for platforms): on modern systems /bin/sh is almost always a symlink to a concrete shell, so SH is stripped when a more specific shell is also detected.

Returns UNKNOWN_SHELL if not running inside a recognized shell. To raise an error instead, set strict to True.

Important

If both POWERSHELL and another shell are detected (because PSModulePath leaks into child processes), the other shell is preferred.

Note

This returns the single primary shell, after disambiguation. current_traits() may include additional shells that are detectable but not primary (like POWERSHELL on GitHub Ubuntu runners).

Warning

A shell is always expected to be detected. An unrecognized result logs a WARNING and likely indicates a missing detection heuristic that should be reported.

Return type:: Shell

extra_platforms.current_shell_path()[source]¶

Returns the executable path of the current shell, or None.

Resolution order:

The actual running shell binary, taken from the nearest ancestor in the parent process tree that matches current_shell() (read from /proc on Linux, ps on macOS, the BSDs and illumos). This is the true interpreter, even when SHELL is unset or points elsewhere.
The SHELL environment variable (the configured login shell), as a fallback, when it names the same shell as current_shell().

Returns None when neither is available: no recognized shell, a stripped environment without SHELL, or a SHELL naming another shell.

Note

On some BSDs, ps reports only the bare argv[0] rather than a full path. The non-absolute name is discarded, so this falls back to SHELL there. illumos and Solaris get the path from procfs instead (see extra_platforms._process_tree).

See also

Comparable to shellingham’s detect_shell(), which returns the shell name paired with its path. Here the name is current_shell() and the path is this function.

Return type:: str | None

extra_platforms.current_terminal(strict=False)[source]¶

Returns the Terminal matching the current environment.

Returns UNKNOWN_TERMINAL if not running inside a recognized terminal. To raise an error instead, set strict to True.

Important

If multiple terminals match (like TMUX inside KITTY), multiplexers are filtered out first to report the terminal emulator hosting the session. If multiple non-multiplexer terminals still match, a RuntimeError is raised.

Note

Unlike architectures, platforms, and shells, a terminal is not always present. Headless environments (CI runners, cron jobs, Docker containers, SSH non-interactive commands) have no terminal emulator attached.

If the TERM environment variable names a terminal type, an unrecognized terminal logs at WARNING level, as it suggests a terminal emulator is present but not recognized. Otherwise, it logs at INFO level: TERM is unset, or declares a dumb terminal (see _DUMB_TERMS). An SSH session also logs at INFO: its emulator runs on the client, out of reach of any heuristic on the remote end.

Return type:: Terminal

extra_platforms.current_ci(strict=False)[source]¶

Returns the CI system matching the current environment.

Returns UNKNOWN_CI if not running inside a recognized CI system. To raise an error instead, set strict to True.

Important

Always raises an error if multiple CI systems match.

Note

Unlike architectures, platforms, and shells, a CI system is not always present. Local development environments have no CI system running.

If the CI environment variable is set, an unrecognized CI system logs at WARNING level, as it suggests a CI system is present but not recognized. Otherwise, it logs at INFO level.

Return type:: CI

extra_platforms.current_agent(strict=False)[source]¶

Returns the Agent matching the current environment.

Returns UNKNOWN_AGENT if not running inside a recognized agent. To raise an error instead, set strict to True.

Important

Always raises an error if multiple agents match.

Note

Unlike architectures, platforms, and shells, an agent is not always present. Local development without AI agents has no agent running.

If any variable of _AGENT_PRESENCE_ENV_VARS is set, an unrecognized agent logs at WARNING level, as it suggests an AI agent is present but not recognized. Otherwise, it logs at INFO level.

Return type:: Agent

Cache management¶

extra_platforms.invalidate_caches()[source]¶

Invalidate every cached detection result.

Inspired by platform.invalidate_caches(), which is also called here on Python 3.14 and newer.

Return type:: None