Farama-Foundation/Gymnasium

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

Ouverte

#9 ouverte le 11 sept. 2022

Voir sur GitHubGuide contributeur
 (1 commentaire) (1 réaction) (0 personne assignée)Python (567 forks)batch import
enhancementgood first issue

Métriques du dépôt

Stars
 (4 712 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez les modules core.py et spaces pour ajouter des annotations de type strictes, en traitant les remplacements de proprietes comme metadata et spec en utilisant des attributs prefixes par un trait de soulignement.
Stack technique
python
Domaine
backend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Pythontype hints
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70