sanic-org/sanic

Graceful shutdown of signal handlers

Open

#2,369 opened on Jan 12, 2022

View on GitHubContributor guide
 (5 comments) (0 reactions) (1 assignee)Python (1,515 forks)batch import
beginnerhelp wanted

Repository metrics

Stars
 (17,623 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

When signals are added, we should run some sort of a cleanup like this on shutdown to make sure any custom signals are run. This also includes a suggestion that we identify them with a name: signal-XXXXX.

async def cleanup(app, _):
    for task in asyncio.all_tasks():
        if task.get_name().startswith("signal"):
          await task

Contributor guide

Research direction
Study the existing signal handling in Sanic, particularly how signals are added and executed, then implement an async cleanup function that awaits all tasks with names starting with 'signal' during shutdown.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythonasyncio
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65