Suggestion: add `runPool` functionality to lgi
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 491
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
I often use lgi inside various very linear scripts where idea of main loop is plain unacceptable. However, today I ran into problem: I need to run few actions in parallel, while keeping overall flow of script linear.
Here's my solution together with a simple test:
local lgi = require 'lgi'
local Gio = lgi.Gio
-- Run taskcnt instances of func as async tasks and wait until all
-- of them finish. Function is called with task ID and
-- additional arguments you passed to this call.
local function runPool(func, taskcnt, ...)
local args = {...}
local result, err = true
local app = Gio.Application.new(nil, {})
-- Use protected call for proper error handling
local function runner(...)
local r, e = xpcall(func, debug.traceback, ...)
-- Report first error
if not r and result then
result, err = r, e
end
app:release()
end
function app:on_activate()
for i=1, taskcnt do
app:hold()
Gio.Async.start(runner)(i, table.unpack(args))
end
end
app:run()
return result, err
end
local function doTest(round)
assert(runPool(function(number, arg)
local len = math.random(1, 6)
print(('Waiting %d seconds in thread %d (round %d)'):format(len, number, arg))
local proc = assert(Gio.Subprocess.new({'sleep', len}, 'NONE'))
proc:async_wait()
print(('Finished waiting %d seconds in thread %d (round %d)'):format(len, number, arg))
end, 4, round))
end
for i=1,3 do
print(('Testing round %d start'):format(i))
doTest(i)
print(('Testing round %d end'):format(i))
end
runPool seems VERY useful for anyone wanting to add parallelism into their scripts using lgi. I suggest integrating it into lgi possibly as Gio.Async.pool.
Known limitations:
- Require tweaking to work in Lua 5.1
-
- Error handling will not work as you can't yield across
xpcallthere yet
- Error handling will not work as you can't yield across
-
- Use
unpackinstead oftable.unpack(this seems to be already solved in lgi by usinglocal unpack = unpack or table.unpack)
- Use
- Reports only first error. Seems reasonable overall, but changes to this behavior can be done if you think they should be.
Contributor guide
No contributing guide indexed for this repository
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 embedded runPool example and inspect lgi's existing Gio.Async.start and Gio.Application lifecycle usage. Determine how a pool API should fit the binding, including Lua 5.1 compatibility and first-error handling. Done means an agreed API is integrated and the supplied parallel-task scenario has a simple test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100