oh-my-posh/docs/docs/segments/python.md
Brandon Ewing 4faa73eb2d feat(python): real pyenv support
If `python` points at a pyenv shim, use `pyenv version-name` to
determine Python version and Venv information.
2022-04-21 22:48:09 +02:00

2 KiB

id title sidebar_label
python Python Python

What

Display the currently active python version and virtualenv. Supports conda, virtualenv and pyenv (if python points to pyenv shim).

Sample Configuration

{
  "type": "python",
  "style": "powerline",
  "powerline_symbol": "\uE0B0",
  "foreground": "#100e23",
  "background": "#906cff",
  "template": " \uE235 {{ .Full }} "
}

Properties

  • home_enabled: boolean - display the segment in the HOME folder or not - defaults to false
  • fetch_virtual_env: boolean - fetch the name of the virtualenv or not - defaults to true
  • display_default: boolean - show the name of the virtualenv when it's default (system, base) or not - defaults to true
  • fetch_version: boolean - fetch the python version - defaults to true
  • display_error: boolean - show the error context when failing to retrieve the version information - defaults to true
  • missing_command_text: string - text to display when the command is missing - defaults to empty
  • display_mode: string - determines when the segment is displayed
    • always: the segment is always displayed
    • files: the segment is only displayed when *.py, *.ipynb, pyproject.toml, venv.bak, venv, or .venv files are present
    • environment: the segment is only displayed when a virtual env is present (default)
    • context: the segment is only displayed when either environment or files is active

Template (info)

:::note default template

{{ if .Error }}{{ .Error }}{{ else }}{{ if .Venv }}{{ .Venv }} {{ end }}{{ .Full }}{{ end }}

:::

Properties

  • .Venv: string - the virtual environment name (if present)
  • .Full: string - the full version
  • .Major: string - major number
  • .Minor: string - minor number
  • .Patch: string - patch number
  • .Prerelease: string - prerelease info text
  • .BuildMetadata: string - build metadata
  • .Error: string - when fetching the version string errors