Review User API Type Hints

Open
#794 38 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
api, developer-experience

Research direction

Start by reviewing the public APIs named in the issue, especially reactpy.component and use_state, and reproduce the reported Pylance type-hint errors. Determine the intended accepted inputs and return types for each case. Done means the affected annotations match the supported API behavior and the reported type-checking errors are resolved.

Written by the indexing model from the issue text.

Description

priority-3-low type-refactor
Current Situation

ReactPy can generate type hinting errors generated (from Pylance).

For example, the fact that reactpy.component can ingest a ComponentType, but can only return a Component. Or the fact that use_state can be set to None initially and changed later.

Proposed Actions

Review user API type hints and fix where needed.

Dominant language
Python
Stars
8.1k
Forks
332
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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 reactive-python/reactpy

All issues in reactive-python/reactpy

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.