Skip to content

Commit 56fe802

Browse files
DavidWhittinghamDavidWhittingham
committed
Added ability to activate conda
This works only if a reasonably recent version of Conda is installed
1 parent 295939e commit 56fe802

File tree

3 files changed

+151
-98
lines changed

3 files changed

+151
-98
lines changed

‎EnablePython/EnablePython.psd1

+69-69
Original file line numberDiff line numberDiff line change
@@ -8,110 +8,110 @@
88

99
@{
1010

11-
# Script module or binary module file associated with this manifest.
12-
RootModule = 'EnablePython.psm1'
11+
# Script module or binary module file associated with this manifest.
12+
RootModule = 'EnablePython.psm1'
1313

14-
# Version number of this module.
15-
ModuleVersion = '2.2.0'
14+
# Version number of this module.
15+
ModuleVersion = '2.3.0'
1616

17-
# ID used to uniquely identify this module
18-
GUID = '20232e29-56bc-4024-823b-afe3994c9365'
17+
# ID used to uniquely identify this module
18+
GUID = '20232e29-56bc-4024-823b-afe3994c9365'
1919

20-
# Author of this module
21-
Author = 'David Whittingham'
20+
# Author of this module
21+
Author = 'David Whittingham'
2222

23-
# Company or vendor of this module
24-
# CompanyName = ''
23+
# Company or vendor of this module
24+
# CompanyName = ''
2525

26-
# Copyright statement for this module
27-
Copyright = '(c) 2018 David Whittingham. All rights reserved.'
26+
# Copyright statement for this module
27+
Copyright = 'Copyright (c) 2018-2021 David Whittingham'
2828

29-
# Description of the functionality provided by this module
30-
Description = 'PowerShell advanced functions for enabling different versions of Python.'
29+
# Description of the functionality provided by this module
30+
Description = 'PowerShell advanced functions for enabling different versions of Python.'
3131

32-
# Minimum version of the Windows PowerShell engine required by this module
33-
PowerShellVersion = '3.0'
32+
# Minimum version of the Windows PowerShell engine required by this module
33+
PowerShellVersion = '3.0'
3434

35-
# Name of the Windows PowerShell host required by this module
36-
# PowerShellHostName = ''
35+
# Name of the Windows PowerShell host required by this module
36+
# PowerShellHostName = ''
3737

38-
# Minimum version of the Windows PowerShell host required by this module
39-
# PowerShellHostVersion = ''
38+
# Minimum version of the Windows PowerShell host required by this module
39+
# PowerShellHostVersion = ''
4040

41-
# Minimum version of Microsoft .NET Framework required by this module
42-
# DotNetFrameworkVersion = ''
41+
# Minimum version of Microsoft .NET Framework required by this module
42+
# DotNetFrameworkVersion = ''
4343

44-
# Minimum version of the common language runtime (CLR) required by this module
45-
# CLRVersion = ''
44+
# Minimum version of the common language runtime (CLR) required by this module
45+
# CLRVersion = ''
4646

47-
# Processor architecture (None, X86, Amd64) required by this module
48-
# ProcessorArchitecture = ''
47+
# Processor architecture (None, X86, Amd64) required by this module
48+
# ProcessorArchitecture = ''
4949

50-
# Modules that must be imported into the global environment prior to importing this module
51-
# RequiredModules = @()
50+
# Modules that must be imported into the global environment prior to importing this module
51+
# RequiredModules = @()
5252

53-
# Assemblies that must be loaded prior to importing this module
54-
# RequiredAssemblies = @()
53+
# Assemblies that must be loaded prior to importing this module
54+
# RequiredAssemblies = @()
5555

56-
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
57-
# ScriptsToProcess = @()
56+
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
57+
# ScriptsToProcess = @()
5858

59-
# Type files (.ps1xml) to be loaded when importing this module
60-
# TypesToProcess = @()
59+
# Type files (.ps1xml) to be loaded when importing this module
60+
# TypesToProcess = @()
6161

62-
# Format files (.ps1xml) to be loaded when importing this module
63-
# FormatsToProcess = @()
62+
# Format files (.ps1xml) to be loaded when importing this module
63+
# FormatsToProcess = @()
6464

65-
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
66-
# NestedModules = @()
65+
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
66+
# NestedModules = @()
6767

68-
# Functions to export from this module
69-
FunctionsToExport = @("Get-Python","Enable-Python","Disable-Python")
68+
# Functions to export from this module
69+
FunctionsToExport = @("Get-Python", "Enable-Python", "Disable-Python")
7070

71-
# Cmdlets to export from this module
72-
CmdletsToExport = @()
71+
# Cmdlets to export from this module
72+
CmdletsToExport = @()
7373

74-
# Variables to export from this module
75-
VariablesToExport = @()
74+
# Variables to export from this module
75+
VariablesToExport = @()
7676

77-
# Aliases to export from this module
78-
AliasesToExport = @()
77+
# Aliases to export from this module
78+
AliasesToExport = @()
7979

80-
# List of all modules packaged with this module
81-
# ModuleList = @()
80+
# List of all modules packaged with this module
81+
# ModuleList = @()
8282

83-
# List of all files packaged with this module
84-
# FileList = @()
83+
# List of all files packaged with this module
84+
# FileList = @()
8585

86-
# Private data to pass to the module specified in RootModule/ModuleToProcess
87-
PrivateData = @{
86+
# Private data to pass to the module specified in RootModule/ModuleToProcess
87+
PrivateData = @{
8888

89-
PSData = @{
89+
PSData = @{
9090

91-
# Tags applied to this module. These help with module discovery in online galleries.
92-
Tags = @("Python")
91+
# Tags applied to this module. These help with module discovery in online galleries.
92+
Tags = @("Python")
9393

94-
# A URL to the license for this module.
95-
LicenseUri = 'https://raw.githubusercontent.com/DavidWhittingham/ps-EnablePython/master/LICENSE'
94+
# A URL to the license for this module.
95+
LicenseUri = 'https://raw.githubusercontent.com/DavidWhittingham/ps-EnablePython/master/LICENSE'
9696

97-
# A URL to the main website for this project.
98-
ProjectUri = 'https://github.com/DavidWhittingham/ps-EnablePython'
97+
# A URL to the main website for this project.
98+
ProjectUri = 'https://github.com/DavidWhittingham/ps-EnablePython'
9999

100-
# A URL to an icon representing this module.
101-
# IconUri = ''
100+
# A URL to an icon representing this module.
101+
# IconUri = ''
102102

103-
# ReleaseNotes of this module
104-
# ReleaseNotes = ''
103+
# ReleaseNotes of this module
104+
# ReleaseNotes = ''
105105

106-
} # End of PSData hashtable
106+
} # End of PSData hashtable
107107

108-
} # End of PrivateData hashtable
108+
} # End of PrivateData hashtable
109109

110-
# HelpInfo URI of this module
111-
# HelpInfoURI = ''
110+
# HelpInfo URI of this module
111+
# HelpInfoURI = ''
112112

113-
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
114-
# DefaultCommandPrefix = ''
113+
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
114+
# DefaultCommandPrefix = ''
115115

116116
}
117117

‎EnablePython/EnablePython.psm1

+81-28
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
Set-StrictMode -Version 2.0
22

3-
$OLD_ENV_PATH = $null
4-
$OLD_ENV_PYTHONHOME = $null
5-
$OLD_ENV_PYTHONUSERBASE = $null
6-
$RESTORE_ENV_VARS = $false
7-
$RESTORE_USER_BASE = $false
3+
$ENV_VAR_BACKUP = @{}
4+
$PROMPT_FUNCTION = $null
85

96
function Disable-Python {
107
<#
@@ -33,21 +30,8 @@ from the virtualenv activate.ps1' script).
3330
deactivate
3431
}
3532

36-
if ($script:RESTORE_ENV_VARS -eq $true) {
37-
# restore the original path
38-
$Env:PATH = $script:OLD_ENV_PATH
39-
40-
# restore the original PYTHONHOME
41-
$Env:PYTHONHOME = $script:OLD_ENV_PYTHONHOME
42-
43-
if ($script:RESTORE_USER_BASE -eq $true) {
44-
# restore the original PYTHONUSERBASE
45-
$Env:PYTHONUSERBASE = $script:OLD_ENV_PYTHONUSERBASE
46-
$script:RESTORE_USER_BASE = $false
47-
}
48-
49-
$script:RESTORE_ENV_VARS = $false
50-
}
33+
disableConda
34+
restoreEnvVars
5135
}
5236
}
5337

@@ -185,32 +169,31 @@ https://github.com/DavidWhittingham/ps-EnablePython
185169

186170
$foundVersion = $pythons[0]
187171

188-
# Let EnablePython know it needs to restore the original environment variables on disabling Python
189-
$script:RESTORE_ENV_VARS = $true
190-
191172
# Save the existing path variable, then set the new path variable with the additional directories pre-pended.
192173
# Putting them at the start ensures the specified Python version will be the first one found (in case a Python
193174
# installation is already in the PATh variable).
194-
$script:OLD_ENV_PATH = $Env:PATH
195-
$Env:PATH = "$($foundVersion.InstallPath);$($foundVersion.ScriptsPath);$script:OLD_ENV_PATH"
175+
$script:ENV_VAR_BACKUP["PATH"] = $Env:PATH
176+
$Env:PATH = "$($foundVersion.InstallPath);$($foundVersion.ScriptsPath);$Env:PATH"
196177

197178
# Save the existing PYTHONHOME variable, then ensure it is cleared so that the activated Python doesn't go off
198179
# looking at an incorrect home
199-
$script:OLD_ENV_PYTHONHOME = $Env:PYTHONHOME
180+
$script:ENV_VAR_BACKUP["PYTHONHOME"] = $Env:PYTHONHOME
200181
$Env:PYTHONHOME = $PythonHome
201182

202183
# If configured to separate user base by platform, set a custom user base
203184
if ($NoPlatformUserBase -eq $false) {
204-
$script:OLD_ENV_PYTHONUSERBASE = $Env:PYTHONUSERBASE
185+
$script:ENV_VAR_BACKUP["PYTHONUSERBASE"] = $Env:PYTHONUSERBASE
205186
$Env:PYTHONUSERBASE = Join-Path -Path (Join-Path -Path $Env:APPDATA -ChildPath "EnablePython") `
206187
-ChildPath ("x86-{0}" -f $foundVersion.Platform)
207-
$script:RESTORE_USER_BASE = $true
208188
}
209189

210190
# Get the user scripts path, add it to PATH as well
211191
$userScriptsPath = & $foundVersion.Executable -E -c 'import sysconfig; print(sysconfig.get_path(""scripts"", scheme=""nt_user""))'
212192
$Env:PATH = "$userScriptsPath;$Env:Path"
213193

194+
# attempt to enable conda
195+
enableConda $foundVersion #-ErrorAction SilentlyContinue
196+
214197
Write-Information """$($foundVersion.Name)"" has been enabled." -InformationAction Continue
215198
}
216199
}
@@ -402,6 +385,67 @@ function createPep514PythonVersion([Microsoft.Win32.RegistryKey]$tagKey, [string
402385
$obj
403386
}
404387

388+
function disableConda() {
389+
if (-not(Get-Module -Name "Conda")) {
390+
# do nothing if no Conda module loaded
391+
return
392+
}
393+
394+
# Remove the Conda module that has been added
395+
Remove-Module -Name "Conda"
396+
397+
# Restore the backup prompt, with a basic prompt fallback
398+
if ($null -ne $script:PROMPT_FUNCTION) {
399+
$promptFunction = $script:PROMPT_FUNCTION
400+
}
401+
else {
402+
$promptFunction = {
403+
"PS $($executionContext.SessionState.Path.CurrentLocation)$('>' * ($nestedPromptLevel + 1)) ";
404+
}
405+
}
406+
New-Item -Path function: -Name "global:prompt" -Value $promptFunction -Force > $null
407+
$script:PROMPT_FUNCTION = $null
408+
}
409+
410+
function enableConda($pythonVersion) {
411+
$condaPath = Join-Path $pythonVersion.InstallPath "Scripts\conda.exe"
412+
413+
if (-not(Test-Path $condaPath)) {
414+
return
415+
}
416+
417+
# test is the Conda PS module exists, if so, try to activate Conda
418+
$condaPsModPath = Join-Path "$($pythonVersion.InstallPath)" "\shell\condabin\Conda.psm1"
419+
if (-not(Test-Path $condaPsModPath)) {
420+
return
421+
}
422+
423+
# Conda messes with the PS prompt, backup it up so that we can restore it later
424+
$script:PROMPT_FUNCTION = Get-Item Function:\prompt
425+
426+
# backup the current state of conda-related environment variables
427+
$script:ENV_VAR_BACKUP["CONDA_EXE"] = $Env:CONDA_EXE
428+
$script:ENV_VAR_BACKUP["_CE_M"] = $Env:_CE_M
429+
$script:ENV_VAR_BACKUP["_CE_CONDA"] = $Env:_CE_CONDA
430+
$script:ENV_VAR_BACKUP["_CONDA_ROOT"] = $Env:_CONDA_ROOT
431+
$script:ENV_VAR_BACKUP["_CONDA_EXE"] = $Env:_CONDA_EXE
432+
$script:ENV_VAR_BACKUP["CONDA_DEFAULT_ENV"] = $Env:CONDA_DEFAULT_ENV
433+
$script:ENV_VAR_BACKUP["CONDA_PREFIX"] = $Env:CONDA_PREFIX
434+
$script:ENV_VAR_BACKUP["CONDA_PROMPT_MODIFIER"] = $Env:CONDA_PROMPT_MODIFIER
435+
$script:ENV_VAR_BACKUP["CONDA_PYTHON_EXE"] = $Env:CONDA_PYTHON_EXE
436+
$script:ENV_VAR_BACKUP["CONDA_SHLVL"] = $Env:CONDA_SHLVL
437+
438+
# set environment variables for conda activation
439+
$Env:CONDA_EXE = "$condaPath"
440+
$Env:_CONDA_ROOT = "$($pythonVersion.InstallPath)"
441+
$Env:_CONDA_EXE = "$condaPath"
442+
443+
Import-Module $condaPsModPath -Global
444+
conda activate
445+
446+
Add-CondaEnvironmentToPrompt
447+
}
448+
405449
function getArcGisProPython() {
406450
$arcgisProRegKey = "Registry::HKEY_LOCAL_MACHINE\SOFTWARE\ESRI\ArcGISPro"
407451

@@ -528,6 +572,15 @@ function is64Bit {
528572
((Get-CimInstance Win32_OperatingSystem).OSArchitecture -match '64-bit')
529573
}
530574

575+
function restoreEnvVars {
576+
foreach ($nvp in $script:ENV_VAR_BACKUP.GetEnumerator()) {
577+
$varName = $nvp.Name
578+
Set-Item "env:$varName" $nvp.Value
579+
}
580+
581+
$script:ENV_VAR_BACKUP = @{}
582+
}
583+
531584
function setPythonVersionStandardMembers($pythonVersion) {
532585
$defaultProperties = @("Name", "Company", "Tag", "Version", "Platform", "Scope")
533586
$defaultDisplayPropertySet = New-Object System.Management.Automation.PSPropertySet("DefaultDisplayPropertySet", [string[]]$defaultProperties)

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 David Whittingham
3+
Copyright (c) 2016-2021 David Whittingham
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)