ruby-concurrency / ruby-concurrency/concurrent-ruby
Add keyword arguments to async
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 5.8k
- Forks
- 420
- Avg merge
- 20h 45m
- Merged PRs (30d)
- 4
Description
Feature request
Add support for keyword arguments when using async
From the docs
class Echo
include [Concurrent](https://ruby-concurrency.github.io/concurrent-ruby/1.2.3/Concurrent.html)::Async
def echo(msg)
print "#{msg}\n"
end
end
horn = Echo.new
horn.echo('zero') # synchronous, not thread-safe
# returns the actual return value of the method
horn.async.echo('one') # asynchronous, non-blocking, thread-safe
# returns an IVar in the :pending state
horn.await.echo('two') # synchronous, blocking, thread-safe
but if i modify it to use named arguments like so it doesn't work
class Echo
include [Concurrent](https://ruby-concurrency.github.io/concurrent-ruby/1.2.3/Concurrent.html)::Async
def echo(msg: )
print "#{msg}\n"
end
end
horn = Echo.new
horn.echo(msg: zero') # synchronous, not thread-safe
# returns the actual return value of the method
horn.async.echo(msg: 'one') # asynchronous, non-blocking, thread-safe
# returns an IVar in the :pending state
horn.await.echo(msg: 'two') # synchronous, blocking, thread-safe
#when I try to get the value
horn.await.echo(msg: 'two').value #nil
horn.await.echo(msg: 'two').reason #<ArgumentError: wrong number of arguments (given 1, expected 0)>
I appreciate any future feedback from the maintainers on this 🙏
System information
* Operating system: mac
* Ruby implementation: Ruby
* `concurrent-ruby` version: 1,2,3
* `concurrent-ruby-ext` installed: no
* `concurrent-ruby-edge` used: no
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Concurrent::Async entry point and the linked Async documentation, then reproduce the keyword-argument example on Ruby with concurrent-ruby 1.2.3. Trace the async call through the proxy and compare it with the direct call. Done means async and await calls accept the named argument and return the expected result without the reported ArgumentError.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100