Deprecate passing a worker to PipelineRunner.run()

Register the worker with PipelineRunner.add_workers() before calling
run() instead. The worker argument still works but now emits a
DeprecationWarning and will be removed in a future release.

Update the runner docstrings, the run_test() helper, and all examples
(including the asyncio.gather() forms) to use the new pattern.
This commit is contained in:
Aleix Conchillo Flaqué
2026-05-21 22:38:27 -07:00
parent e8ec7c585f
commit afa880f523
327 changed files with 734 additions and 379 deletions

View File

@@ -54,7 +54,8 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
await runner.run(worker)
await runner.add_workers(worker)
await runner.run()
async def bot(runner_args: RunnerArguments):

View File

@@ -44,7 +44,8 @@ async def main():
runner = PipelineRunner(handle_sigint=False if sys.platform == "win32" else True)
await asyncio.gather(runner.run(worker), say_something())
await runner.add_workers(worker)
await asyncio.gather(runner.run(), say_something())
if __name__ == "__main__":

View File

@@ -65,7 +65,8 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
await runner.run(worker)
await runner.add_workers(worker)
await runner.run()
async def bot(runner_args: RunnerArguments):

View File

@@ -68,7 +68,8 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
await runner.run(worker)
await runner.add_workers(worker)
await runner.run()
async def bot(runner_args: RunnerArguments):

View File

@@ -57,7 +57,8 @@ async def main():
tk_root.update_idletasks()
await asyncio.sleep(0.1)
await asyncio.gather(runner.run(worker), run_tk())
await runner.add_workers(worker)
await asyncio.gather(runner.run(), run_tk())
if __name__ == "__main__":

View File

@@ -205,7 +205,8 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
# Run the pipeline
runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
await runner.run(worker)
await runner.add_workers(worker)
await runner.run()
async def bot(runner_args: RunnerArguments):

View File

@@ -157,7 +157,8 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
await worker.cancel()
runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
await runner.run(worker)
await runner.add_workers(worker)
await runner.run()
async def bot(runner_args: RunnerArguments):

View File

@@ -110,7 +110,8 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
await runner.run(worker)
await runner.add_workers(worker)
await runner.run()
async def bot(runner_args: RunnerArguments):

View File

@@ -87,7 +87,8 @@ async def main():
runner = PipelineRunner()
await runner.run(worker)
await runner.add_workers(worker)
await runner.run()
if __name__ == "__main__":

View File

@@ -160,7 +160,8 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
await runner.run(worker)
await runner.add_workers(worker)
await runner.run()
async def bot(runner_args: RunnerArguments):