Sign upLogin

zincware/MDSuite

View on GitHub
Star
mdsuite/file_io/extxyz_files.py

Summary

Maintainability
A
2 hrs
Test Coverage

Function _get_box_l has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

def _get_box_l(header: str) -> list:
    """
    Get the box lengths from the Lattice property in the header.

    Parameters
Severity: Minor
Found in mdsuite/file_io/extxyz_files.py - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function _get_property_to_column_idx_dict has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

def _get_property_to_column_idx_dict(
    header: str, var_names: dict
) -> typing.Tuple[int, typing.Dict[str, typing.List[int]]]:
    """
    Get the property summary from the header data.
Severity: Minor
Found in mdsuite/file_io/extxyz_files.py - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function _get_time has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

def _get_time(header: str) -> float:
    """
    Retrieve the time value from a header line.
    Can be used to infer the sampling step by calling on consecutive config headers.
Severity: Minor
Found in mdsuite/file_io/extxyz_files.py - About 25 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

There are no issues that match your filters.

Category
Status