Farama-Foundation/Gymnasium

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

Aberta

#9 aberto em 11 de set. de 2022

Ver no GitHubGuia do colaborador
 (1 comentário) (1 reação) (0 responsável)Python (567 forks)batch import
enhancementgood first issue

Métricas do repositório

Stars
 (4.712 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Examine os módulos core.py e spaces para adicionar dicas de tipo estritas, lidando com substituições de propriedades como metadata e spec usando atributos com prefixo sublinhado.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Pythontype hints
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70