Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-26 11:37:32 +00:00
Code Issues Releases Activity

fix: restore the pyenv_prefix option to python (#1668)

Browse Source 
Have restored the `pyenv_prefix` option to the python module. This is
added as a new variable that will only be shown if `pyenv` is being used
to determine the version of python that is being used.
This commit is contained in:
Thomas O'Donnell 2020-09-21 17:48:26 +02:00 committed by GitHub
parent ecd3d6e9f0
commit bb324834a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 63 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/config/README.md
View File

@ -1856,23 +1856,25 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `format` | `"via [${symbol}${version}( \\($virtualenv\\))]($style) "` | The format for the module. | | `format` | `"via [${symbol}${pyenv_prefix}${version}( \\($virtualenv\\))]($style) "` | The format for the module. |
| `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `style` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `pyenv_prefix` | `pyenv ` | Prefix before pyenv version display, only used if pyenv is used |
| `disabled` | `false` | Disables the `python` module. | | `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
| `disabled` | `false` | Disables the `python` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| ---------- | --------------- | ------------------------------------ | | ------------ | --------------- | ------------------------------------------ |
| version | `"v3.8.1"` | The version of `python` | | version | `"v3.8.1"` | The version of `python` |
| symbol | `"🐍 "` | Mirrors the value of option `symbol` | | symbol | `"🐍 "` | Mirrors the value of option `symbol` |
| style | `"yellow bold"` | Mirrors the value of option `style` | | style | `"yellow bold"` | Mirrors the value of option `style` |
| virtualenv | `"venv"` | The current `virtualenv` name | | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
| virtualenv | `"venv"` | The current `virtualenv` name |
<details> <details>
<summary>This module has some advanced configuration options.</summary> <summary>This module has some advanced configuration options.</summary>

4
src/configs/python.rs
View File

@ -5,6 +5,7 @@ use starship_module_config_derive::ModuleConfig;
#[derive(Clone, ModuleConfig)] #[derive(Clone, ModuleConfig)]
pub struct PythonConfig<'a> { pub struct PythonConfig<'a> {
pub pyenv_version_name: bool, pub pyenv_version_name: bool,
pub pyenv_prefix: &'a str,
pub python_binary: &'a str, pub python_binary: &'a str,
pub scan_for_pyfiles: bool, pub scan_for_pyfiles: bool,
pub format: &'a str, pub format: &'a str,
@ -17,9 +18,10 @@ impl<'a> RootModuleConfig<'a> for PythonConfig<'a> {
fn new() -> Self { fn new() -> Self {
PythonConfig { PythonConfig {
pyenv_version_name: false, pyenv_version_name: false,
pyenv_prefix: "pyenv ",
python_binary: "python", python_binary: "python",
scan_for_pyfiles: true, scan_for_pyfiles: true,
format: "via [$symbol$version( \\($virtualenv\\))]($style) ", format: "via [${symbol}${pyenv_prefix}${version}( \\($virtualenv\\))]($style) ",
style: "yellow bold", style: "yellow bold",
symbol: "🐍 ", symbol: "🐍 ",
disabled: false, disabled: false,

40
src/modules/python.rs
View File

@ -48,6 +48,11 @@ pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
format_python_version(&version) format_python_version(&version)
}; };
let virtual_env = get_python_virtual_env(context); let virtual_env = get_python_virtual_env(context);
let pyenv_prefix = if config.pyenv_version_name {
config.pyenv_prefix
} else {
""
};
let parsed = StringFormatter::new(config.format).and_then(|formatter| { let parsed = StringFormatter::new(config.format).and_then(|formatter| {
formatter formatter
@ -62,6 +67,7 @@ pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
.map(|variable| match variable { .map(|variable| match variable {
"version" => Some(Ok(python_version.trim())), "version" => Some(Ok(python_version.trim())),
"virtualenv" => virtual_env.as_ref().map(|e| Ok(e.trim())), "virtualenv" => virtual_env.as_ref().map(|e| Ok(e.trim())),
"pyenv_prefix" => Some(Ok(pyenv_prefix)),
_ => None, _ => None,
}) })
.parse(None) .parse(None)
@ -146,6 +152,7 @@ mod tests {
check_python2_renders(&dir, None); check_python2_renders(&dir, None);
check_python3_renders(&dir, None); check_python3_renders(&dir, None);
check_pyenv_renders(&dir, None);
dir.close() dir.close()
} }
@ -156,6 +163,7 @@ mod tests {
check_python2_renders(&dir, None); check_python2_renders(&dir, None);
check_python3_renders(&dir, None); check_python3_renders(&dir, None);
check_pyenv_renders(&dir, None);
dir.close() dir.close()
} }
@ -166,6 +174,7 @@ mod tests {
check_python2_renders(&dir, None); check_python2_renders(&dir, None);
check_python3_renders(&dir, None); check_python3_renders(&dir, None);
check_pyenv_renders(&dir, None);
dir.close() dir.close()
} }
@ -176,6 +185,7 @@ mod tests {
check_python2_renders(&dir, None); check_python2_renders(&dir, None);
check_python3_renders(&dir, None); check_python3_renders(&dir, None);
check_pyenv_renders(&dir, None);
dir.close() dir.close()
} }
@ -186,6 +196,7 @@ mod tests {
check_python2_renders(&dir, None); check_python2_renders(&dir, None);
check_python3_renders(&dir, None); check_python3_renders(&dir, None);
check_pyenv_renders(&dir, None);
dir.close() dir.close()
} }
@ -196,6 +207,7 @@ mod tests {
check_python2_renders(&dir, None); check_python2_renders(&dir, None);
check_python3_renders(&dir, None); check_python3_renders(&dir, None);
check_pyenv_renders(&dir, None);
dir.close() dir.close()
} }
@ -206,6 +218,7 @@ mod tests {
check_python2_renders(&dir, None); check_python2_renders(&dir, None);
check_python3_renders(&dir, None); check_python3_renders(&dir, None);
check_pyenv_renders(&dir, None);
dir.close() dir.close()
} }
@ -216,6 +229,7 @@ mod tests {
check_python2_renders(&dir, None); check_python2_renders(&dir, None);
check_python3_renders(&dir, None); check_python3_renders(&dir, None);
check_pyenv_renders(&dir, None);
dir.close() dir.close()
} }
@ -257,6 +271,13 @@ mod tests {
check_python3_renders(&dir, Some(config_python3)); check_python3_renders(&dir, Some(config_python3));
let config_pyenv = toml::toml! {
[python]
pyenv_version_name = true
pyenv_prefix = "test_pyenv "
scan_for_pyfiles = false
};
check_pyenv_renders(&dir, Some(config_pyenv));
dir.close() dir.close()
} }
@ -325,4 +346,23 @@ mod tests {
let expected = Some(format!("via {} ", Color::Yellow.bold().paint("🐍 v3.8.0"))); let expected = Some(format!("via {} ", Color::Yellow.bold().paint("🐍 v3.8.0")));
assert_eq!(expected, actual); assert_eq!(expected, actual);
} }
fn check_pyenv_renders(dir: &tempfile::TempDir, starship_config: Option<toml::Value>) {
let config = starship_config.unwrap_or(toml::toml! {
[python]
pyenv_version_name = true
pyenv_prefix = "test_pyenv "
});
let actual = ModuleRenderer::new("python")
.path(dir.path())
.config(config)
.collect();
let expected = Some(format!(
"via {} ",
Color::Yellow.bold().paint("🐍 test_pyenv system")
));
assert_eq!(expected, actual);
}
} }

4
src/utils.rs
View File

@ -125,6 +125,10 @@ active boot switches: -d:release\n",
stdout: String::from("0.13.5\n"), stdout: String::from("0.13.5\n"),
stderr: String::default(), stderr: String::default(),
}), }),
"pyenv version-name" => Some(CommandOutput {
stdout: String::from("system\n"),
stderr: String::default(),
}),
"python --version" => Some(CommandOutput { "python --version" => Some(CommandOutput {
stdout: String::default(), stdout: String::default(),
stderr: String::from("Python 2.7.17\n"), stderr: String::from("Python 2.7.17\n"),