Farama-Foundation/Gymnasium

[Proposal] Add strict type hinting for core.py and spaces

Open

#9 opened on Sep 11, 2022

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Python (567 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (4,712 stars)
PR merge metrics
 (Avg merge 1d 9h) (10 merged PRs in 30d)

Description

Gymnasium inherits some of the type hinting that we completed for gym However, having strict type hinting at the critical parts of the project could be an important improve

Known issues:

  • Pyright raises an issue for overwriting a variable with a property. This is an issue for variables like metadata and spec which Wrapper overwrites with a property. We could ignore this issue or change metadata and spec to be specs in Env with a hidden _metadata and _spec

Contributor guide

Research direction
Examine core.py and spaces modules to add strict type hints, handling property overwrites like metadata and spec by using underscore prefixed attributes.
Tech stack
python
Domain
backend
Issue type
Refactor
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythontype hints
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70