Farama-Foundation/Gymnasium

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

Aperta

#9 aperta il 11 set 2022

Vedi su GitHubGuida contributor
 (1 commento) (1 reazione) (0 assegnatari)Python (567 fork)batch import
enhancementgood first issue

Metriche repository

Star
 (4712 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina i moduli core.py e spaces per aggiungere suggerimenti di tipo rigorosi, gestendo le sovrascritture di proprietà come metadata e spec utilizzando attributi con prefisso underscore.
Tech stack
python
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Pythontype hints
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70