mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2024-09-20 21:47:31 -07:00
64 lines
2.1 KiB
Plaintext
64 lines
2.1 KiB
Plaintext
---
|
|
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).
|
|
|
|
## Sample Configuration
|
|
|
|
```json
|
|
{
|
|
"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`
|
|
- 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
|
|
- version_url_template: `string` - a go [text/template][go-text-template] [template][templates] that creates
|
|
the URL of the version info / release notes
|
|
|
|
## Template ([info][templates])
|
|
|
|
:::note default template
|
|
|
|
``` 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
|
|
- `.URL`: `string` - URL of the version info / release notes
|
|
- `.Error`: `string` - error encountered when fetching the version string
|
|
|
|
[go-text-template]: https://golang.org/pkg/text/template/
|
|
[templates]: /docs/configuration/templates
|