Sign upLogin

OpenJij/OpenJij

View on GitHub
Star
openjij/sampler/base_sa_sample_hubo.py

Summary

Maintainability
A
2 hrs
Test Coverage
B
89%

Cyclomatic complexity is too high in function base_sample_hubo. (6)
Open

def base_sample_hubo(
    hubo: dict[tuple, float],
    vartype: Optional[str] = None,
    num_sweeps: int = 1000,
    num_reads: int = 1,
Severity: Minor
Found in openjij/sampler/base_sa_sample_hubo.py by radon

Cyclomatic Complexity

Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

Construct Effect on CC Reasoning
if +1 An if statement is a single decision.
elif +1 The elif statement adds another decision.
else +0 The else statement does not cause a new decision. The decision is at the if.
for +1 There is a decision at the start of the loop.
while +1 There is a decision at the while statement.
except +1 Each except branch adds a new conditional path of execution.
finally +0 The finally block is unconditionally executed.
with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
assert +1 The assert statement internally roughly equals a conditional statement.
Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

Source: http://radon.readthedocs.org/en/latest/intro.html

Function base_sample_hubo has 11 arguments (exceeds 4 allowed). Consider refactoring.
Open

def base_sample_hubo(
Severity: Major
Found in openjij/sampler/base_sa_sample_hubo.py - About 1 hr to fix

    Function base_sample_hubo has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def base_sample_hubo(
    hubo: dict[tuple, float],
    vartype: Optional[str] = None,
    num_sweeps: int = 1000,
    num_reads: int = 1,
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py - About 55 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

    Function "base_sample_hubo" has 11 parameters, which is greater than the 7 authorized.
    Open

        hubo: dict[tuple, float],
    vartype: Optional[str] = None,
    num_sweeps: int = 1000,
    num_reads: int = 1,
    num_threads: int = 1,
    Severity: Major
    Found in openjij/sampler/base_sa_sample_hubo.py by sonar-python

    A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

    Noncompliant Code Example

    With a maximum number of 4 parameters:

    def do_something(param1, param2, param3, param4, param5):
    ...

    Compliant Solution

    def do_something(param1, param2, param3, param4):
    ...

    Trailing whitespace
    Open

                    key_list=list(hubo.keys()),
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Expected 2 blank lines, found 1
    Open

    def base_sample_hubo(
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Separate top-level function and class definitions with two blank lines.

    Method definitions inside a class are separated by a single blank
line.

Extra blank lines may be used (sparingly) to separate groups of
related functions.  Blank lines may be omitted between a bunch of
related one-liners (e.g. a set of dummy implementations).

Use blank lines in functions, sparingly, to indicate logical
sections.

Okay: def a():\n    pass\n\n\ndef b():\n    pass
Okay: def a():\n    pass\n\n\nasync def b():\n    pass
Okay: def a():\n    pass\n\n\n# Foo\n# Bar\n\ndef b():\n    pass
Okay: default = 1\nfoo = 1
Okay: classify = 1\nfoo = 1

E301: class Foo:\n    b = 0\n    def bar():\n        pass
E302: def a():\n    pass\n\ndef b(n):\n    pass
E302: def a():\n    pass\n\nasync def b(n):\n    pass
E303: def a():\n    pass\n\n\n\ndef b(n):\n    pass
E303: def a():\n\n\n\n    pass
E304: @decorator\n\ndef a():\n    pass
E305: def a():\n    pass\na()
E306: def a():\n    def b():\n        pass\n    def c():\n        pass

    Line too long (91 > 79 characters)
    Open

        response.info["sampling_time"] = (sample_time + define_sampler_time)*10**6  # micro sec
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Trailing whitespace
    Open

            vartype=vartype,
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Blank line contains whitespace
    Open
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Trailing whitespace
    Open

        variables: list[list[Union[int, float]]],
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Too many blank lines (2)
    Open

        sampler.set_num_sweeps(num_sweeps=num_sweeps)
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Separate top-level function and class definitions with two blank lines.

    Method definitions inside a class are separated by a single blank
line.

Extra blank lines may be used (sparingly) to separate groups of
related functions.  Blank lines may be omitted between a bunch of
related one-liners (e.g. a set of dummy implementations).

Use blank lines in functions, sparingly, to indicate logical
sections.

Okay: def a():\n    pass\n\n\ndef b():\n    pass
Okay: def a():\n    pass\n\n\nasync def b():\n    pass
Okay: def a():\n    pass\n\n\n# Foo\n# Bar\n\ndef b():\n    pass
Okay: default = 1\nfoo = 1
Okay: classify = 1\nfoo = 1

E301: class Foo:\n    b = 0\n    def bar():\n        pass
E302: def a():\n    pass\n\ndef b(n):\n    pass
E302: def a():\n    pass\n\nasync def b(n):\n    pass
E303: def a():\n    pass\n\n\n\ndef b(n):\n    pass
E303: def a():\n\n\n\n    pass
E304: @decorator\n\ndef a():\n    pass
E305: def a():\n    pass\na()
E306: def a():\n    def b():\n        pass\n    def c():\n        pass

    Line too long (83 > 79 characters)
    Open

            temperature_schedule=cast_to_cxx_temperature_schedule(temperature_schedule)
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (83 > 79 characters)
    Open

            random_number_engine=cast_to_cxx_random_number_engine(random_number_engine)
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (80 > 79 characters)
    Open

        response.info["execution_time"] = (sample_time/num_reads)*10**6  # micro sec
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Trailing whitespace
    Open

            samples_like=[dict(zip(index_list, v_list)) for v_list in variables],
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Trailing whitespace
    Open

            sampler.get_samples(),
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Trailing whitespace
    Open

                    key_list=list(hubo.keys()),
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Trailing whitespace
    Open

        )
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Blank line at end of file
    Open

    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing blank lines are superfluous.

    Okay: spam(1)
W391: spam(1)\n

However the last line should end with a new line (warning W292).

    Trailing whitespace
    Open

        energies: list[float],
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Expected 2 blank lines, found 1
    Open

    def to_oj_response(
    Severity: Minor
    Found in openjij/sampler/base_sa_sample_hubo.py by pep8

    Separate top-level function and class definitions with two blank lines.

    Method definitions inside a class are separated by a single blank
line.

Extra blank lines may be used (sparingly) to separate groups of
related functions.  Blank lines may be omitted between a bunch of
related one-liners (e.g. a set of dummy implementations).

Use blank lines in functions, sparingly, to indicate logical
sections.

Okay: def a():\n    pass\n\n\ndef b():\n    pass
Okay: def a():\n    pass\n\n\nasync def b():\n    pass
Okay: def a():\n    pass\n\n\n# Foo\n# Bar\n\ndef b():\n    pass
Okay: default = 1\nfoo = 1
Okay: classify = 1\nfoo = 1

E301: class Foo:\n    b = 0\n    def bar():\n        pass
E302: def a():\n    pass\n\ndef b(n):\n    pass
E302: def a():\n    pass\n\nasync def b(n):\n    pass
E303: def a():\n    pass\n\n\n\ndef b(n):\n    pass
E303: def a():\n\n\n\n    pass
E304: @decorator\n\ndef a():\n    pass
E305: def a():\n    pass\na()
E306: def a():\n    def b():\n        pass\n    def c():\n        pass

    There are no issues that match your filters.

    Category
    Status