oh-my-posh/docs/docs/segment-python.md

41 lines
1.3 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.
2020-10-05 02:33:12 -07:00
Supports conda, virtualenv and pyenv.
## 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",
"properties": {
2020-10-16 08:12:34 -07:00
"prefix": " \uE235 "
2020-10-05 02:33:12 -07:00
}
}
```
## Properties
2020-10-16 11:07:38 -07:00
- display_virtual_env: `boolean` - show 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`
- display_version: `boolean` - display 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`
2021-01-22 09:44:40 -08:00
files are present (default)
2021-02-03 23:38:55 -08:00
- `environment`: the segment is only displayed when a virtual env is present
- `context`: the segment is only displayed when either `environment` or `files` is active