Skip to content
Back to top
View this page
Edit this page

# xonsh.prompt.env

Prompt formatter for virtualenv and others

xonsh.prompt.env.env_name() → str

  Build env_name based on different sources. Respect order of precedence.

  Name from VIRTUAL_ENV_PROMPT will be used as-is. Names from other sources are surrounded with `{env_prefix}` and `{env_postfix}` fields.

xonsh.prompt.env.find_env_name() → str | None

  Find current environment name from available sources.

  If `$VIRTUAL_ENV` is set, it is determined from the prompt setting in `<venv>/pyvenv.cfg` or from the folder name of the environment.

  Otherwise - if it is set - from `$CONDA_DEFAULT_ENV`.

xonsh.prompt.env.vte_new_tab_cwd() → None

  This prints an escape sequence that tells VTE terminals the hostname and pwd. This should not be needed in most cases, but sometimes is for certain Linux terminals that do not read the PWD from the environment on startup. Note that this does not return a string, it simply prints and flushes the escape sequence to stdout directly.