Skip to content

feature: improve channel typings, add method stubs#2022

Open
devkral wants to merge 3 commits into
django:mainfrom
devkral:feature/typings
Open

feature: improve channel typings, add method stubs#2022
devkral wants to merge 3 commits into
django:mainfrom
devkral:feature/typings

Conversation

@devkral

@devkral devkral commented Jun 27, 2023

Copy link
Copy Markdown
Contributor

Currently the layers module is untyped and BaseChannelLayer is not a real interface (lacks stub methods)

This PR adds typings and stub methods (for type hinting and getting a meaningful error in case something is missing)

@devkral

devkral commented Jan 28, 2024

Copy link
Copy Markdown
Contributor Author

ping?

@carltongibson

Copy link
Copy Markdown
Member

ping?

Yes, I'm not sure about this. It's a lot of noise for not much benefit as far as I can see.

Surely though, if we were adding types, a Protocol would be the way forward, rather than base class stub methods... 🤔

@devkral

devkral commented Jan 29, 2024

Copy link
Copy Markdown
Contributor Author

The problem my PR solves is, that it is not obvious for programmers how to write a layer backend.
Docstrings are spread around and you have to look in channels-redis too to make sense of the functions

Agreed a protocol would be maybe better later but it needs more refactory.
I will implement this

@devkral

This comment was marked as outdated.

@devkral

devkral commented Jan 29, 2024

Copy link
Copy Markdown
Contributor Author

how do you think about this?

BaseChannelLayer is now abstract, the extensions are now runtime checkable Protocols.

If you think this is good, I can document the changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants