mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2024-12-28 04:19:41 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat(python): make parent folder fallback optional

Browse source
This commit is contained in:
rocky@HP_OMEN 2024-02-28 12:45:40 +00:00 committed by Jan De Dobbeleer
parent 8401da66e5
commit 21df976c2f
3 changed files with 36 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/segments/python.go
View file

@ -21,6 +21,7 @@ const (
// FetchVirtualEnv fetches the virtual env // FetchVirtualEnv fetches the virtual env
FetchVirtualEnv properties.Property = "fetch_virtual_env" FetchVirtualEnv properties.Property = "fetch_virtual_env"
UsePythonVersionFile properties.Property = "use_python_version_file" UsePythonVersionFile properties.Property = "use_python_version_file"
FolderNameFallback properties.Property = "folder_name_fallback"
) )
func (p *Python) Template() string { func (p *Python) Template() string {
@ -74,6 +75,7 @@ func (p *Python) loadContext() {
"CONDA_DEFAULT_ENV", "CONDA_DEFAULT_ENV",
} }
folderNameFallback := p.language.props.GetBool(FolderNameFallback, true)
defaultVenvNames := []string{ defaultVenvNames := []string{
".venv", ".venv",
"venv", "venv",
@ -87,8 +89,7 @@ func (p *Python) loadContext() {
} }
name := platform.Base(p.language.env, venv) name := platform.Base(p.language.env, venv)
if folderNameFallback && slices.Contains(defaultVenvNames, name) {
if slices.Contains(defaultVenvNames, name) {
venv = strings.TrimSuffix(venv, name) venv = strings.TrimSuffix(venv, name)
name = platform.Base(p.language.env, venv) name = platform.Base(p.language.env, venv)
} }

35
src/segments/python_test.go
View file

@ -150,14 +150,36 @@ func TestPythonPythonInContext(t *testing.T) {
func TestPythonVirtualEnvIgnoreDefaultVenvNames(t *testing.T) { func TestPythonVirtualEnvIgnoreDefaultVenvNames(t *testing.T) {
cases := []struct { cases := []struct {
Expected string
FolderNameFallback bool
VirtualEnvName string VirtualEnvName string
}{ }{
{VirtualEnvName: "/path/to/folder/.venv"}, {
{VirtualEnvName: "/path/to/folder/venv"}, Expected: "folder",
FolderNameFallback: true,
VirtualEnvName: "/path/to/folder/.venv",
},
{
Expected: "folder",
FolderNameFallback: true,
VirtualEnvName: "/path/to/folder/venv",
},
{
Expected: ".venv",
FolderNameFallback: false,
VirtualEnvName: "/path/to/folder/.venv",
},
{
Expected: "venv",
FolderNameFallback: false,
VirtualEnvName: "/path/to/folder/venv",
},
} }
for _, tc := range cases { for _, tc := range cases {
env := new(mock.MockedEnvironment) params := &mockedLanguageParams{}
env, props := getMockedLanguageEnv(params)
env.On("GOOS").Return("") env.On("GOOS").Return("")
env.On("PathSeparator").Return("/") env.On("PathSeparator").Return("/")
env.On("CommandPath", mock2.Anything).Return("") env.On("CommandPath", mock2.Anything).Return("")
@ -167,9 +189,12 @@ func TestPythonVirtualEnvIgnoreDefaultVenvNames(t *testing.T) {
env.On("Getenv", "CONDA_DEFAULT_ENV").Return("") env.On("Getenv", "CONDA_DEFAULT_ENV").Return("")
env.On("Getenv", "PYENV_VERSION").Return("") env.On("Getenv", "PYENV_VERSION").Return("")
env.On("HasParentFilePath", ".python-version").Return(&platform.FileInfo{}, errors.New("no match at root level")) env.On("HasParentFilePath", ".python-version").Return(&platform.FileInfo{}, errors.New("no match at root level"))
props[FolderNameFallback] = tc.FolderNameFallback
python := &Python{} python := &Python{}
python.Init(properties.Map{}, env) python.Init(props, env)
python.loadContext() python.loadContext()
assert.Equal(t, "folder", python.Venv) assert.Equal(t, tc.Expected, python.Venv)
} }
} }

3
website/docs/segments/python.mdx
View file

@ -9,8 +9,6 @@ sidebar_label: Python
Display the currently active python version and virtualenv. Display the currently active python version and virtualenv.
Supports conda, virtualenv and pyenv (if python points to pyenv shim). Supports conda, virtualenv and pyenv (if python points to pyenv shim).
If your virtual environment is a directory named `venv` or `.venv`, the virtual environment's name will be the parent directory.
## Sample Configuration ## Sample Configuration
import Config from "@site/src/components/Config.js"; import Config from "@site/src/components/Config.js";
@ -40,6 +38,7 @@ import Config from "@site/src/components/Config.js";
| `extensions` | `[]string` | allows to override the default list of file extensions to validate | | `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate | | `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` | | `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| `folder_name_fallback` | `boolean` | instead of `venv` or `.venv` (case sensitive), use the parent folder name as the virtual environment's name or not - defaults to `true` |
## Template ([info][templates]) ## Template ([info][templates])