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

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

Heyyy, I'd like to work on this issue. Can you assign it to me?

so, assert statements should be removed from all the repos of aboutcode-org., or only from aboutcode-org/scancode-toolkit ?

@pombredanne

Hey, I'd like to work on this issue. Can you assign this to me? And the assert statements are to be removed from all the repos or a specific one? @pombredanne

@pombredanne

Hi @pombredanne , I have started working on this issue. I will replace the assert statements with raise statements in the main code (outside test files). I'll submit a PR soon. Let me know if there are specific repos other than scancode-toolkit where this change is needed.

@pombredanne

@pombredanne I have made a PR on this https://github.com/aboutcode-org/aboutcode-toolkit/pull/574
Check and let me know for further enhacements. Do you need me to changes in other repos as well?

@pombredanne

Hi @pombredanne, I would like to work on this issue to replace the assert statements with proper raise exceptions in the main code (outside test files). Could you please assign this issue to me? Let me know if any specific guidelines or repos need to be considered. Thank you!

@TirthPanchal

@TirthPanchal re:

Heyyy, I'd like to work on this issue. Can you assign it to me?

we do not "assign" issue per se. You are welcome to work on this, but you want to sync up here with others to avoid double, duplicated work!

@Dhruv276R re:

Hey, I'd like to work on this issue. Can you assign this to me?

As explained above, we cannot "assign" work. You guys need to coordinate and collaborate to avoid stepping on each other.

And the assert statements are to be removed from all the repos or a specific one?

Rather replaced in all the repos, and only asserts that are not for tests, and only asserts that are for production code that could be ignored from a -O python run.

@Gurleen-kansray re:

Hi , I have started working on this issue. I will replace the assert statements with raise statements in the main code (outside test files). I'll submit a PR soon. Let me know if there are specific repos other than scancode-toolkit where this change is needed.

As said above, all repos, but not in test code: there we use "assert" and pytest does an awesome job assert rewriting job, so we surely do not want to change this.

@ONKARBH re:

Hi, I would like to work on this issue to replace the assert statements with proper raise exceptions in the main code (outside test files). Could you please assign this issue to me? Let me know if any specific guidelines or repos need to be considered. Thank you!

Same as above: all repos, not the tests, and you need to coordinate here with others

Hi everyone, I’d like to contribute to this issue by focusing on specific files/modules for replacing assert statements outside the test files. Please let me know how I can best coordinate with others to avoid overlap. Thank you!

@Dhruv276R

@Dhruv276R re:

I have made a PR on this https://github.com/aboutcode-org/aboutcode-toolkit/pull/574 Check and let me know for further enhacements. Do you need me to changes in other repos as well?

This is awesome, but I cannot see the PR at https://github.com/aboutcode-org/aboutcode/pulls/574 ?

@Dhruv276R

Hi @Dhruv276R, your work is great! However, the PR link seems incorrect. Can you confirm if the PR is in the aboutcode-toolkit repo and share the correct link? Thank you!

My bad: this is at aboutcode-org/aboutcode-toolkit#574

Is this issue still open?

@pombredanne

Hey @pombredanne,
I'm a GSoc 2026 applicant. Can I work on this issue? Is it open?

Hi, I’m interested in working on this issue. Is it still available?

@pombredanne

Hey @pombredanne,
I'm a GSoc 2026 applicant. Can I work on this issue?, I’m interested in working on this issue

could you please assign this to me?

@pombredanne

@pombredanne
Hi, I’m interested in working on this issue.
Could you please point me to the specific files or repositories where the assert statements need to be replaced?

Hi, I would like to work on this issue. Could you please assign it to me?

Hi, I checked the repository but I couldn't find any assert statements
in the current codebase. Could you please point me to the files where
these asserts still need to be replaced?

Hi, I would like to work on this issue. Can I take this?

@pombredanne

Hi @pombredanne,

I’d like to contribute to this issue by focusing on a specific subset of non-test production asserts to avoid overlap with existing work.

I’m planning to audit one repository/module first, replace runtime-critical assert statements with explicit exceptions, and ensure behavior remains unchanged under optimized Python runs (-O / -OO).

I’ll avoid test files and coordinate here before opening a PR if I notice overlap with existing contributions.

Thanks!

Hi! I'd like to contribute to this. I'll pick a specific repo/file that no one else has claimed and leave a note here before starting. Happy to coordinate.

Hi, I would like to work on this issue. Can I take this

@pombredanne

Hi @pombredanne, I would like to work on this issue. Could you please assign it to me?

Is this still open?

Hi! I'm interested in contributing to issue #175 as my first open-source PR.
I read the discussion and understand that the work spans multiple repositories and that contributors should coordinate to avoid overlapping changes.
Could you suggest a repository or module that still has production-code assert statements needing replacement and is not already covered by an existing PR? I'd like to take one small, well-defined part of the issue and add appropriate tests.
Thank you!

@pombredanne

Hi @pombredanne, I've opened PR aboutcode-org/container-inspector#66 replacing production assert statements with ValueError in src/container_inspector/cli.py.

Navigation Menu

Repository navigation

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

24 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

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

Description

Activity

TirthPanchal commented on Jan 12, 2025

coderhuBypassion commented on Jan 13, 2025

Dhruv276R commented on Jan 14, 2025

Gurleen-kansray commented on Jan 15, 2025

Dhruv276R commented on Jan 15, 2025

ONKARBH commented on Jan 17, 2025

pombredanne commented on Jan 17, 2025

ONKARBH commented on Jan 17, 2025

pombredanne commented on Jan 17, 2025

ONKARBH commented on Jan 17, 2025

pombredanne commented on Jan 17, 2025

Pratz2005 commented on Jan 26, 2025

24 remaining items

vignathi123-vi commented on Feb 23, 2026

va1bhav-06 commented on Feb 26, 2026

Satyasubhash01 commented on Mar 1, 2026

ParthMozarkar commented on Mar 8, 2026

sagarnaidu04 commented on Mar 16, 2026

mili609 commented on Mar 16, 2026

mili609 commented on Mar 16, 2026

tech-nitin commented on Mar 20, 2026

huda-code commented on May 7, 2026

duplicatenode commented on May 28, 2026

ankitprajapat42 commented on Jun 4, 2026

Saumyajaiswal9794 commented on Aug 17, 2026

RachitSinghh commented on Sep 29, 2026

SuryaNarayana-C-K commented on Oct 9, 2026

NathN07 commented on Oct 13, 2026

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions