assert_equal[T: Equatable & Stringable, //](lhs: T, rhs: T, msg: String = "", *, location: Optional[SourceLocation] = None)

Asserts that the input values are equal. If it is not then an Error is raised.

Parameters:

• ​T (Equatable & Stringable): The type of the input values.

Args:

• ​lhs (T): The lhs of the equality.
• ​rhs (T): The rhs of the equality.
• ​msg (String): The message to be printed if the assertion fails.
• ​location (Optional): The location of the error (defaults to call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.

assert_equal[T: Equatable & Writable, //, __disambiguate: NoneType = None](lhs: T, rhs: T, msg: String = "", *, location: Optional[SourceLocation] = None)

Asserts that the input values are equal. If it is not then an Error is raised.

Parameters:

• ​T (Equatable & Writable): The type of the input values.
• ​__disambiguate (NoneType): A temporary dummy parameter to disambiguate the function from the other assert_equal function.

Args:

• ​lhs (T): The lhs of the equality.
• ​rhs (T): The rhs of the equality.
• ​msg (String): The message to be printed if the assertion fails.
• ​location (Optional): The location of the error (defaults to call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.

assert_equal[O1: ImmutOrigin, O2: ImmutOrigin](lhs: List[StringSlice[O1]], rhs: List[StringSlice[O2]], msg: String = "", *, location: Optional[SourceLocation] = None)

Asserts that two lists are equal.

Parameters:

• ​O1 (ImmutOrigin): The origin of lhs.
• ​O2 (ImmutOrigin): The origin of rhs.

Args:

• ​lhs (List): The left-hand side list.
• ​rhs (List): The right-hand side list.
• ​msg (String): The message to be printed if the assertion fails.
• ​location (Optional): The location of the error (defaults to call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.

assert_equal(lhs: StringSlice[lhs.origin], rhs: StringSlice[rhs.origin], msg: String = "", *, location: Optional[SourceLocation] = None)

Asserts that a StringSlice is equal to a String.

Args:

• ​lhs (StringSlice): The left-hand side value.
• ​rhs (StringSlice): The right-hand side value.
• ​msg (String): An optional custom error message.
• ​location (Optional): The source location of the assertion (defaults to caller location).

Raises:

If the values are not equal.

assert_equal[lhs_types: Variadic[Movable & Equatable & Writable], rhs_types: Variadic[Movable & Equatable & Writable]](lhs: Tuple[lhs_types], rhs: Tuple[rhs_types], msg: String = "", *, location: Optional[SourceLocation] = None)

Asserts that two tuples are equal. If not, an Error is raised.

Parameters:

• ​lhs_types (Variadic & Equatable & Writable]): The types of the elements in the left tuple.
• ​rhs_types (Variadic & Equatable & Writable]): The types of the elements in the right tuple.

Args:

• ​lhs (Tuple): The left-hand side tuple.
• ​rhs (Tuple): The right-hand side tuple.
• ​msg (String): The message to be printed if the assertion fails.
• ​location (Optional): The location of the error (defaults to call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.