Files
torus-ml/docs/references/api/torus.ml.common.debugging.custom_assert.md
zeekay e037e8f7ea torus: one name for the package, and it is ours
The distribution called itself torus-ml while shipping a package directory
named concrete, so the name a user installs and the name they import disagreed
— and most of the tree already said torus.ml, which could not resolve against
src/concrete. Moved src/concrete to src/torus and pointed the include at it.

The dependency was Zama's concrete-python from their index. It is torus-fhe
from ours, which is what luxfhe/torus already ships: that frontend declares
torus-fhe and ships a torus/fhe module, so every 'from torus.fhe' in this tree
was already naming our compiler and only the dependency lagged.

Two distributions share one namespace, which is the shape the upstream this
forked from used and the reason the split works: torus-fhe gives torus.fhe,
torus-ml gives torus.ml.

Swept every other spelling — identifiers, enum members, workflow variables,
filenames, notebooks. LICENSE and NOTICE keep the upstream attribution a fork
owes; the figures carry the old name in JPEG metadata a text sweep cannot
reach.
2026-08-27 13:20:50 -07:00

2.6 KiB

module torus.ml.common.debugging.custom_assert

Provide some variants of assert.


function assert_true

assert_true(
    condition: bool,
    on_error_msg: str = '',
    error_type: Type[Exception] = <class 'AssertionError'>
)

Provide a custom assert to check that the condition is True.

Args:

  • condition (bool): the condition. If False, raise AssertionError
  • on_error_msg (str): optional message for precising the error, in case of error
  • error_type (Type[Exception]): the type of error to raise, if condition is not fulfilled. Default to AssertionError

function assert_false

assert_false(
    condition: bool,
    on_error_msg: str = '',
    error_type: Type[Exception] = <class 'AssertionError'>
)

Provide a custom assert to check that the condition is False.

Args:

  • condition (bool): the condition. If True, raise AssertionError
  • on_error_msg (str): optional message for precising the error, in case of error
  • error_type (Type[Exception]): the type of error to raise, if condition is not fulfilled. Default to AssertionError

function assert_not_reached

assert_not_reached(
    on_error_msg: str,
    error_type: Type[Exception] = <class 'AssertionError'>
)

Provide a custom assert to check that a piece of code is never reached.

Args:

  • on_error_msg (str): message for precising the error
  • error_type (Type[Exception]): the type of error to raise, if condition is not fulfilled. Default to AssertionError