taichi-dev/taichi

Exception raising in Field APIs

Open

#2,846 opened on Aug 30, 2021

View on GitHub
 (3 comments) (4 reactions) (1 assignee)C++ (2,384 forks)batch import
feature requestgood first issuewelcome contribution

Repository metrics

Stars
 (28,195 stars)
PR merge metrics
 (No merged PRs in 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!

Contributor guide

Research direction
Identify assert statements in field.py and matrix.py that validate user input, then replace each with an appropriate exception (e.g., ValueError, TypeError, TaichiSyntaxError) to ensure robustness.
Tech stack
python
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75