Title: Can we allow script-block parameter values (delay-bind script blocks) for non-pipeline-binding parameters too? · Issue #6837 · PowerShell/PowerShell · GitHub
Open Graph Title: Can we allow script-block parameter values (delay-bind script blocks) for non-pipeline-binding parameters too? · Issue #6837 · PowerShell/PowerShell
X Title: Can we allow script-block parameter values (delay-bind script blocks) for non-pipeline-binding parameters too? · Issue #6837 · PowerShell/PowerShell
Description: Being able to pass script blocks ad hoc in order to calculate per-input-object parameter values is a great general-purpose feature. However, it is currently limited to parameters that are explicitly defined as pipeline-binding. A widely ...
Open Graph Description: Being able to pass script blocks ad hoc in order to calculate per-input-object parameter values is a great general-purpose feature. However, it is currently limited to parameters that are explicitl...
X Description: Being able to pass script blocks ad hoc in order to calculate per-input-object parameter values is a great general-purpose feature. However, it is currently limited to parameters that are explicitl...
Opengraph URL: https://github.com/PowerShell/PowerShell/issues/6837
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Can we allow script-block parameter values (delay-bind script blocks) for non-pipeline-binding parameters too?","articleBody":"Being able to pass script blocks ad hoc in order to calculate per-input-object parameter values is a [great general-purpose feature](https://github.com/PowerShell/PowerShell-Docs/issues/2338).\r\n\r\nHowever, it is currently _limited to parameters that are explicitly defined as pipeline-binding_.\r\n\r\nA widely used application of this technique is with `Rename-Item`'s `-NewName` parameter, where a script block is passed to calculate the new name; e.g.:\r\n\r\n```powershell\r\n# Rename all *.rtf files to *.txt files\r\nGet-Item *.rtf | Rename-Item -NewName { $_.BaseName + '.txt' } -WhatIf\r\n```\r\n\r\nHowever, the above _only_ works because `-NewName` too is defined as pipeline-binding (`ValueFromPipelineByPropertyName`, in this case).\r\n\r\nThe ability to pass a script block to _any_ parameter (other than those typed `[object]` or `[scriptblock]`) of a command that accepts pipeline input in principle - whether or not that parameter is itself pipeline-binding - would make this technique useful in a much wider array of situations.\r\n\r\nIs there a conceptual barrier to removing this restriction (overall, the cmdlet/advanced function would still have to have at least _one_ pipeline-binding parameter)?\r\n\r\nTechnically, this would be a breaking change, albeit hopefully one that falls into [Bucket 3: Unlikely Grey Area](https://github.com/PowerShell/PowerShell/blob/master/docs/dev-process/breaking-change-contract.md#bucket-3-unlikely-grey-area):\r\n\r\nWhat happens currently if you try to pass a script block to a differently typed non-pipeline-binding parameters is that an attempt is made to convert the script block to the parameter's type (unless the parameter is `[object]` or `[scriptblock]`, which would continue to be exempt). \r\nThis fails with most types, but in the case of a `[string]` parameter you currently do get the script block's _contents_ as a string value. \r\nArguably, though, users who expect script blocks type their parameters a such.\r\n\r\n\r\n\r\n------------------\r\n\r\nHere's an example with an advanced function:\r\n\r\n```powershell\r\nfunction Rename-Foo {\r\n [CmdletBinding()]\r\n param(\r\n [Parameter(Mandatory, ValueFromPipeline)]\r\n [System.IO.FileSystemInfo] $InputObject\r\n ,\r\n # WISHFUL THINKING: The `ValueFromPipelineByPropertyName` shouldn't be necessary.\r\n [Parameter(Mandatory, ValueFromPipelineByPropertyName)]\r\n [string] $NewName\r\n )\r\n\r\n process {\r\n \"Will rename $($InputObject.Name) to $NewName.\"\r\n }\r\n\r\n}\r\n\r\nPS\u003e Get-Item foo.txt, bar.txt | Rename-Foo -NewName { $_.Name + '!!' }\r\nWill rename foo.txt to foo.txt!!\r\nWill rename bar.txt to bar.txt!!\r\n```\r\n\r\n\r\nEnvironment data\r\n----------------\r\n\r\nWritten as of:\r\n\r\n```powershell\r\nPowerShell Core v6.0.2\r\n```\r\n","author":{"url":"https://github.com/mklement0","@type":"Person","name":"mklement0"},"datePublished":"2018-05-08T13:19:23.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":29},"url":"https://github.com/6837/PowerShell/issues/6837"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:b4674e2e-247f-5f30-6582-868f5e4015d0 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 85E6:C0FD1:2BFDE:3C857:6A5A3E6D |
| html-safe-nonce | b93218646317215eb8145ae6bab371caa8798513bbb30c7f3ec916e1a8a706ed |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4NUU2OkMwRkQxOjJCRkRFOjNDODU3OjZBNUEzRTZEIiwidmlzaXRvcl9pZCI6IjI4NjgxMjE5MTAxMzkwNDM0MzciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 8dc77e7ae8b69cd4405e2d1f388a23d7ff097549c6240a5e2df20b5a5ece4e2d |
| hovercard-subject-tag | issue:321183012 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PowerShell/6837/issue_layout |
| twitter:image | https://opengraph.githubassets.com/0f795e1af7ee268ab8f26dd29d5dbe324053f4af1255376ee37bea39dabea6d3/PowerShell/PowerShell/issues/6837 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/0f795e1af7ee268ab8f26dd29d5dbe324053f4af1255376ee37bea39dabea6d3/PowerShell/PowerShell/issues/6837 |
| og:image:alt | Being able to pass script blocks ad hoc in order to calculate per-input-object parameter values is a great general-purpose feature. However, it is currently limited to parameters that are explicitl... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | mklement0 |
| hostname | github.com |
| expected-hostname | github.com |
| None | 19c67ad7579d2401ff06e88a32ef45460fbb40fab3191c7f7582d5e166f326fc |
| turbo-cache-control | no-preview |
| go-import | github.com/PowerShell/PowerShell git https://github.com/PowerShell/PowerShell.git |
| octolytics-dimension-user_id | 11524380 |
| octolytics-dimension-user_login | PowerShell |
| octolytics-dimension-repository_id | 49609581 |
| octolytics-dimension-repository_nwo | PowerShell/PowerShell |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 49609581 |
| octolytics-dimension-repository_network_root_nwo | PowerShell/PowerShell |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | e618485bff22dab2ef1ffb4e34e4e6626688df69 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width