POSYDON-code/POSYDON

Add better checks on assumed input types/values to all functions

Aberta

#462 aberto em 3 de dez. de 2024

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Python (35 forks)auto 404
enhancementgood first issuehelp wanted

Métricas do repositório

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

Description

We have a lot of functions, which work currently with assumptions either only written in the doc-strings or even nowhere mentioned. All this can produce unforeseen runtime errors at any parts of the code. A more specific example in the case of None type objects is already given in issue #236 . Another common case are floats or integers to be of the correct type or range.

Guia do colaborador

Direção de pesquisa
Identifique funções sem validação de entrada e adicione verificações de tipo e intervalo. Comece examinando a base de código em busca de funções que aceitam parâmetros sem restrições explícitas de tipo ou valor, especialmente aquelas com apenas suposições em doc strings. Use dicas de tipo ou asserções em tempo de execução para impor os tipos e intervalos esperados.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Funcionalidade
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.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70