Update powershell conf to select from powershell and pwsh

[czoido]

Changelog: Feature: Updated tools.env.virtualenv:powershell conf to allow specifying the PowerShell executable (e.g., powershell.exe or pwsh) and passing additional arguments.
Changelog: Feature: Deprecate use of tools.env.virtualenv:powershell=True/False.
Docs: conan-io/docs#3947

This will change how our powershell scripts are executed from:

powershell.exe "&'C:\path\conanrunenv.ps1'" ; "&'C:\path\conanbuildenv.ps1'" ; cmd /c mycompiler0.bat

to

powershell.exe -Command "&'C:\path\conanrunenv.ps1' ; &'C:\path\conanbuildenv.ps1'" ; cmd /c mycompiler0.bat

pwsh -Command "&'C:\path\conanrunenv.ps1' ; &'C:\path\conanbuildenv.ps1'" ; cmd /c mycompiler0.bat

Depending if we select to use pwsh (version 7) or powershell.exe

Not exactly meant to close this: #17339 but related to that.

[memsharded]

We have this ticket in #17434, that the user was affected by their powershell profile changing the cwd. This could be avoided by -noProfile, but as @Todiq points out in #17434 (comment), this might break users that rely on this.

We could add yet another conf, or maybe allow users to do tools.env.virtualenv:powershell="powershell -noProfile" or any other arguments they might want to provide?

[czoido]

We have this ticket in #17434, that the user was affected by their powershell profile changing the cwd. This could be avoided by -noProfile, but as @Todiq points out in #17434 (comment), this might break users that rely on this.

We could add yet another conf, or maybe allow users to do tools.env.virtualenv:powershell="powershell -noProfile" or any other arguments they might want to provide?

I can think of two alternatives:

• Using a dict instead a str and passing the shell and arguments, so it would be like:

tools.env.virtualenv:powershell={"shell": "pwsh", "args": ["-NoProfile", "-ExecutionPolicy", "Bypass"]}

or

tools.env.virtualenv:powershell={"shell": "powershell.exe", "args": ["-NoProfile", "-ExecutionPolicy", "Bypass"]}

• Using a new conf for arguments:

tools.env.virtualenv:powershell_args=["-NoProfile", "-ExecutionPolicy", "Bypass"]

What do you think? @memsharded @AbrilRBS

[memsharded]

I'd probably go for the 1 configuration if we still support the basic string simple case, good for vast majority of users: tools.env.virtualenv:powershell=pwsh, because defining a dict in the command line is always painful with the quoting. Then I like 1 configuration to avoid explosion of confs, and if it needs some further argument or variation we can just add them to the dict.

[czoido]

I'd probably go for the 1 configuration if we still support the basic string simple case, good for vast majority of users: tools.env.virtualenv:powershell=pwsh, because defining a dict in the command line is always painful with the quoting. Then I like 1 configuration to avoid explosion of confs, and if it needs some further argument or variation we can just add them to the dict.

Let's try with the simpler version of using a string like tools.env.virtualenv:powershell="powershell.exe -noProfile" because it's true that dicts are not the best for passing in the CLI.

[AbrilRBS]

I agree - we just might want to make sure the docs mention that you're only ever supposed to use powershell.exe/pwsh.exe

[czoido]

We have to check if this is True to provide compatibility with the deprecated syntax.
The problem is that conanfile.conf.get("tools.env.virtualenv:powershell", check_type=str) does not work because it will evaluate True or False as strings and not raise any exceptions.