Import twisted stubs from sydent

Open
#12 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python

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.

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).

Dominant language
Python
Stars
4
Forks
7
PR merge metrics
No merged PRs in 30d

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.

More from matrix-org/matrix-python-common

All issues in matrix-org/matrix-python-common

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.