taichi-dev/taichi

Exception raising in Field APIs

Open

#2846 aperta il 30 ago 2021

Vedi su GitHub
 (3 commenti) (4 reazioni) (1 assegnatario)C++ (2384 fork)batch import
feature requestgood first issuewelcome contribution

Metriche repository

Star
 (28.195 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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!

Guida contributor

Direzione di ricerca
Identifica le istruzioni assert in field.py e matrix.py che convalidano l'input dell'utente, quindi sostituisci ciascuna con un'eccezione appropriata (ad es. ValueError, TypeError, TaichiSyntaxError) per garantire robustezza.
Tech stack
python
Dominio
backendapi
Tipo issue
Bug
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75