matrix-org / matrix-org/matrix-python-common
Import twisted stubs from sydent
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
Currently we have to force mypy to allow calling untyped functions from a typed context, because we call functions from twisted that aren't typed (at least as of #11). Sydent has a bunch of twisted stubs: https://github.com/matrix-org/sydent/tree/main/stubs - we should copy them to this repo and use them instead.
However it's not entirely clear to me how to do that in a way that wouldn't duplicate code, i.e. in a way we could import them in Sydent from this library (i.e. we want to move the stubs from Sydent to here, rather than just copying them over).
Contributor guide
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 by reviewing the stubs in Sydent's stubs directory and this repository's packaging configuration. Determine how the Twisted stubs could be provided here while remaining importable by Sydent without duplicated code. Done means the shared stubs are usable from this library and Sydent, with the existing typed calls no longer requiring the current workaround.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100