oh-my-posh/website/docs/segments/python.md

62 lines
2 KiB
Markdown
Raw Normal View History

2020-10-05 02:33:12 -07:00
---
id: python
title: Python
sidebar_label: Python
---
## What
Display the currently active python version and virtualenv.
Supports conda, virtualenv and pyenv (if python points to pyenv shim).
2020-10-05 02:33:12 -07:00
## Sample Configuration
```json
{
"type": "python",
"style": "powerline",
2020-10-15 23:37:43 -07:00
"powerline_symbol": "\uE0B0",
2020-10-05 02:33:12 -07:00
"foreground": "#100e23",
"background": "#906cff",
2022-03-27 01:12:47 -07:00
"template": " \uE235 {{ .Full }} "
2020-10-05 02:33:12 -07:00
}
```
## Properties
- home_enabled: `boolean` - display the segment in the HOME folder or not - defaults to `false`
2021-12-04 02:56:55 -08:00
- 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`
2022-01-22 10:46:56 -08:00
- 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`
2020-12-31 22:15:19 -08:00
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
- display_mode: `string` - determines when the segment is displayed
2021-02-03 23:38:55 -08:00
- `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)
2021-02-03 23:38:55 -08:00
- `context`: the segment is only displayed when either `environment` or `files` is active
2021-12-03 11:36:30 -08:00
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
``` template
{{ if .Error }}{{ .Error }}{{ else }}{{ if .Venv }}{{ .Venv }} {{ end }}{{ .Full }}{{ end }}
```
:::
### Properties
2021-12-03 11:36:30 -08:00
- `.Venv`: `string` - the virtual environment name (if present)
2021-12-03 11:36:30 -08:00
- `.Full`: `string` - the full version
- `.Major`: `string` - major number
- `.Minor`: `string` - minor number
- `.Patch`: `string` - patch number
- `.URL`: `string` - URL of the version info / release notes
- `.Error`: `string` - error encountered when fetching the version string
2021-12-03 11:36:30 -08:00
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates