brailcom/speechd

Add typehints to the Python speechd API

Open

#976 opened on Dec 6, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)C (86 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (325 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe.

Currently, the speech dispatcher Python client does not include typehints. This prevents static analysis tools such as mypy from verifying correct usage of the library from outside, as well as the internal integrity.

Describe the solution you'd like

Add typehints to all external/internal methods and structures.

Describe alternatives you've considered

The module can be excluded from statical analysis by the developer, however adding the types is the preferred solution.

Additional context

I can take this on, since it relates to a project I'm currently working on. Just wanted to check with the project whether we're of the same mind, before starting the actual work. :)

Contributor guide

Research direction
Review the Python client module in speechd. Add type hints to all functions, methods, and class attributes using the typing module. Ensure compatibility with Python 3.6+. Test with mypy.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75