Miscellaneous-NoMagicNumbers

Do not use magic literals

Required inputs: IR

When source code contains a magic number literal, later readers of the code may have trouble determining the origin and meaning of that number.

Use a constant definition to assign a name to the number.

Example

// AVOID:
for (int i = 0; i < 52; i++) ...

// GOOD:
const int cardGame_deckSize = 52;
for (int i = 0; i < cardGame_deckSize; i++) ...

Possible Messages

Key	Text	Severity	Disabled
magic_number	Use of magic literal.	None	False
magic_number_without_token	Use of magic literal.	None	False
possible_magic_number	Potential use of magic literal.	None	False

Options

• This rule shares the following common options: exclude_in_macros, exclude_messages_in_system_headers, excludes, extend_exclude_to_macro_invocations, includes, justification_checker, languages, post_processing, provider, report_at, severity

• The following places define options that affect this rule: Stylechecks, Analysis-GlobalOptions

allow_nonconst_variable_initialization

allow_nonconst_variable_initialization : bool = False

If set to true, allow magic numbers in the initialization of variables, even if the variable is not const. This option only applies to the initialization as part of the variable declaration, not to any later assignments.

 

allowed

allowed : set[float] = {0.0, 1.0, 2.0}

Literal values that are ok.

 

allowed_contexts

allowed_contexts : set[bauhaus.ir.PIR_Class_Name | typing.Callable[[bauhaus.ir.Node], bool]] = set()

Optional set of PIR classes or functions ((node) -> bool) for allowed contexts, e.g. Case_Label.

 

exceptions

exceptions : typing.Callable[[bauhaus.ir.Node], bool] | None = None

Optional predicate to filter out cases that should be allowed as an exception. The predicate takes a literal node and returns True if the given node is such an exception.

 

exclude_pp_literals

exclude_pp_literals : bool = True

If true, literals in conditions of #if are ignored.

 

exclude_single_uses

exclude_single_uses : bool = False

If true, report only literals used more than once.