taichi-dev/taichi

Exception raising in Field APIs

Open

#2.846 aberto em 30 de ago. de 2021

Ver no GitHub
 (3 comments) (4 reactions) (1 assignee)C++ (2.384 forks)batch import
feature requestgood first issuewelcome contribution

Métricas do repositório

Stars
 (28.195 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

The current Field APIs, including ScalarField, MatrixField, and Structfield (after #2627) use assertions statements to check input validity, for example,

https://github.com/taichi-dev/taichi/blob/03e2923d103704048c101051d337fa31f9dbb1de/python/taichi/lang/matrix.py#L207

In software engineering practice, assertion is used to verify whether the program itself is implemented correctly regardless of user inputs, while exceptions/errors are used to check validity of the inputs. Therefore quite a few occurrences of assert statements in field.py and matrix.py are supposed to raise errors.

Contributions are greatly welcomed!

Guia do colaborador

Direção de pesquisa
Identifique declarações assert em field.py e matrix.py que validam a entrada do usuário e substitua cada uma por uma exceção apropriada (por exemplo, ValueError, TypeError, TaichiSyntaxError) para garantir robustez.
Pilha de tecnologia
python
Domain
backendapi
Tipo Issue
Bug
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.
Ativo
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.
75