Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Adding PS* aliases for Where|Foreach magic methods #25511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daxian-dbw merged 4 commits into from
May 6, 2025
Merged

Adding PS* aliases for Where|Foreach magic methods #25511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
06e052f
Adding PS* aliases for Where|Foreach magic methods
powercode May 5, 2025
5257495
Update src/System.Management.Automation/engine/runtime/Binding/Binder…
powercode May 5, 2025
913ae93
inlining costants for Where/Foreach
powercode May 5, 2025
98f4ebd
Updating comment when calling foreach/where on emptyEnumerator
powercode May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6455,7 +6455,9 @@ private static List<CompletionResult> CompleteCommentParameterValue(CompletionCo
new List<Tuple<string, string>>
{
new Tuple<string, string>("Where", "Where({ expression } [, mode [, numberToReturn]])"),
new Tuple<string, string>("ForEach", "ForEach(expression [, arguments...])")
new Tuple<string, string>("ForEach", "ForEach(expression [, arguments...])"),
new Tuple<string, string>("PSWhere", "PSWhere({ expression } [, mode [, numberToReturn]])"),
new Tuple<string, string>("PSForEach", "PSForEach(expression [, arguments...])"),
};

// List of DSC collection-value variables
Expand Down
23 changes: 17 additions & 6 deletions src/System.Management.Automation/engine/runtime/Binding/Binders.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

using System.Buffers;
using System.Collections;
using System.Collections.Concurrent;
using System.Collections.Generic;
Expand Down Expand Up @@ -6533,6 +6534,14 @@ public override DynamicMetaObject FallbackInvoke(DynamicMetaObject target, Dynam

internal sealed class PSInvokeMemberBinder : InvokeMemberBinder
{
private static readonly SearchValues<string> s_whereSearchValues = SearchValues.Create(
["Where", "PSWhere"],
StringComparison.OrdinalIgnoreCase);

private static readonly SearchValues<string> s_foreachSearchValues = SearchValues.Create(
["ForEach", "PSForEach"],
StringComparison.OrdinalIgnoreCase);

internal enum MethodInvocationType
{
Ordinary,
Expand Down Expand Up @@ -6681,12 +6690,14 @@ public override DynamicMetaObject FallbackInvokeMember(DynamicMetaObject target,
.WriteToDebugLog(this);
BindingRestrictions argRestrictions = args.Aggregate(BindingRestrictions.Empty, static (current, arg) => current.Merge(arg.PSGetMethodArgumentRestriction()));

if (string.Equals(Name, "Where", StringComparison.OrdinalIgnoreCase))
// We need to pass the empty enumerator to the ForEach/Where operators, so that they can return an empty collection.
// The ForEach/Where operators will not be able to call the script block if the enumerator is empty.
if (s_whereSearchValues.Contains(Name))
{
return InvokeWhereOnCollection(emptyEnumerator, args, argRestrictions).WriteToDebugLog(this);
}

if (string.Equals(Name, "ForEach", StringComparison.OrdinalIgnoreCase))
if (s_foreachSearchValues.Contains(Name))
{
return InvokeForEachOnCollection(emptyEnumerator, args, argRestrictions).WriteToDebugLog(this);
}
Expand Down Expand Up @@ -6866,12 +6877,12 @@ public override DynamicMetaObject FallbackInvokeMember(DynamicMetaObject target,
if (!_static && !_nonEnumerating && target.Value != AutomationNull.Value)
{
// Invoking Where and ForEach operators on collections.
if (string.Equals(Name, "Where", StringComparison.OrdinalIgnoreCase))
if (s_whereSearchValues.Contains(Name))
{
return InvokeWhereOnCollection(target, args, restrictions).WriteToDebugLog(this);
}

if (string.Equals(Name, "ForEach", StringComparison.OrdinalIgnoreCase))
if (s_foreachSearchValues.Contains(Name))
{
return InvokeForEachOnCollection(target, args, restrictions).WriteToDebugLog(this);
}
Expand Down Expand Up @@ -7490,7 +7501,7 @@ internal static object InvokeAdaptedMember(object obj, string methodName, object
// As a last resort, we invoke 'Where' and 'ForEach' operators on singletons like
// ([pscustomobject]@{ foo = 'bar' }).Foreach({$_})
// ([pscustomobject]@{ foo = 'bar' }).Where({1})
if (string.Equals(methodName, "Where", StringComparison.OrdinalIgnoreCase))
if (s_whereSearchValues.Contains(methodName))
{
var enumerator = (new object[] { obj }).GetEnumerator();
switch (args.Length)
Expand All @@ -7506,7 +7517,7 @@ internal static object InvokeAdaptedMember(object obj, string methodName, object
}
}

if (string.Equals(methodName, "Foreach", StringComparison.OrdinalIgnoreCase))
if (s_foreachSearchValues.Contains(methodName))
{
var enumerator = (new object[] { obj }).GetEnumerator();
object[] argsToPass;
Expand Down
10 changes: 10 additions & 0 deletions test/powershell/engine/ETS/Adapter.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,11 @@ Describe "Adapter Tests" -tags "CI" {

# TODO: dynamic method calls
}

It "Can use PSForEach as an alias for the Foreach magic method" {
$x = 5
$x.PSForEach({$_}) | Should -Be 5
}
}

Context "Where Magic Method Adapter Tests" {
Expand Down Expand Up @@ -240,6 +245,11 @@ Describe "Adapter Tests" -tags "CI" {
} -PassThru -Force
$x.Where(5) | Should -Be 10
}

It "Can use PSWhere as an alias for the Where magic method" {
$x = 5
$x.PSWhere{$true} | Should -Be 5
}
}
}

Expand Down
Loading