aboutcode-org / aboutcode-org/aboutcode

Replace and rewrite "assert" statements in non-test code

Open
#175 48 comments 0 reactions 0 assignees View on GitHub
easy good first issue
Dominant language
Batchfile
Stars
302
Forks
249
Avg merge
1d 9h
Merged PRs (30d)
2

Description

See https://www.reddit.com/r/learnpython/comments/zd217y/is_using_assert_considered_good_practice/

> assert statements should only be used for debugging purposes. They are removed when not running in debug mode (i.e. when invoking the Python command with the -O or -OO options).

> Instead use a raise statement to throw a proper, informative runtime exception, if you need to. That would definitely be best practice when there'd otherwise be no sensible return value for the function.

We are using a few asserts in our main code. See https://github.com/search?q=org%3Aaboutcode-org+NOT+path%3A*test*++"assert"++language%3APython&type=code

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.