crossbario / crossbario/autobahn-python

`async def` for all callbacks

Open
#1,171 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement websocket
Dominant language
Python
Stars
2.5k
Forks
768
PR merge metrics
No merged PRs in 30d

Description

(Originally reported in #autobahn by ashleyk) some of the callback methods in WebSocket protocols don't allow async def -- for example, onClose. Autobahn should use txaio.as_future around all "subclass notification" callbacks (and add an errback to log any errors).

Note that this still won't "delay" the actual close but will allow for symmetry when doing Python3 (i.e. "all the callbacks can be async def).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the WebSocket protocol callback methods, using onClose as the first entry point. Review every subclass-notification callback for txaio.as_future support and error logging via an errback; done means callbacks consistently accept async def without delaying the actual close.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
networking
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.