File util.py has 736 lines of code (exceeds 250 allowed). Consider refactoring. Open
"""Helper functions and classes"""
__author__ = "Stephan Sokolow (deitarion/SSokolow)"
__license__ = "GNU GPL 2.0 or later"
Cyclomatic complexity is too high in method __new__. (17) Open
def __new__(cls, x: int = None, y: int = None,
width: int = None, height: int = None,
x2: int = None, y2: int = None):
# -- Check for a valid combination of arguments --- Read upRead up
- Exclude checks
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. |
Cyclomatic complexity is too high in function fmt_table. (12) Open
def fmt_table(rows: Union[Dict, Iterable[List]],
headers: Sequence[str],
group_by: int = None,
) -> str:
"""Format a collection as a textual table.- Read upRead up
- Exclude checks
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. |
Cyclomatic complexity is too high in method _update. (9) Open
def _update(self):
"""Check input values and regenerate internal caches
This is internal code shared by :meth:`set_monitors` and
:meth:`set_panels`.- Read upRead up
- Exclude checks
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. |
Cyclomatic complexity is too high in method _trim_strut. (9) Open
def _trim_strut(self, strut: Tuple[Edge, Rectangle]) -> Rectangle:
"""Trim a strut rectangle to just the monitor it applies to
This is internal code used by :meth:`_update` but split out to manage
complexity and improve testability.- Read upRead up
- Exclude checks
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. |
Rectangle has 21 functions (exceeds 20 allowed). Consider refactoring. Open
class Rectangle(_Rectangle):
"""A representation of a rectangle with some useful methods
Fundamentally, this is a named tuple of the form ``(x, y, width, height)``
with some extra methods and properties to make it more useful.Function _trim_strut has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring. Open
def _trim_strut(self, strut: Tuple[Edge, Rectangle]) -> Rectangle:
"""Trim a strut rectangle to just the monitor it applies to
This is internal code used by :meth:`_update` but split out to manage
complexity and improve testability.- Read upRead up
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 fmt_table has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring. Open
def fmt_table(rows: Union[Dict, Iterable[List]],
headers: Sequence[str],
group_by: int = None,
) -> str:
"""Format a collection as a textual table.- Read upRead up
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
Cyclomatic complexity is too high in method moved_into. (6) Open
def moved_into(self, other: 'Rectangle') -> 'Rectangle':
"""Attempt to return a new :class:`Rectangle` of the same width and
height that does not exceed the bounds of `other`.
If ``self`` is wider/taller than ``other``, line up the left/top edge- Read upRead up
- Exclude checks
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. |
Function __new__ has 13 arguments (exceeds 4 allowed). Consider refactoring. Open
def __new__(cls, left=0, right=0, top=0, bottom=0, # pylint: disable=R0913Function __new__ has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring. Open
def __new__(cls, x: int = None, y: int = None,
width: int = None, height: int = None,
x2: int = None, y2: int = None):
# -- Check for a valid combination of arguments --- Read upRead up
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 _update has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring. Open
def _update(self):
"""Check input values and regenerate internal caches
This is internal code shared by :meth:`set_monitors` and
:meth:`set_panels`.- Read upRead up
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 __new__ has 6 arguments (exceeds 4 allowed). Consider refactoring. Open
def __new__(cls, x: int = None, y: int = None,TODO found Open
# TODO: Re-add log.debug() calls in strategic places- Exclude checks
TODO found Open
def fmt_row(row, pad=' ', indent=0, min_width=0): # TODO: Type signature- Exclude checks
TODO found Open
# TODO: Narrow down the type signature- Exclude checks
TODO found Open
# TODO: Automated tests- Exclude checks
FIXME found Open
# FIXME: Replace */** with a dict so I can be strict here- Exclude checks
TODO found Open
# TODO: Think of a more efficient way to do this- Exclude checks
TODO found Open
# TODO: Rework Rectangle so y can be omitted as long as height- Exclude checks
TODO found Open
# TODO: Rework Rectangle so x can be omitted as long as width- Exclude checks
TODO found Open
# TODO: Subscribe to changes to panel geometry in the code which calls this- Exclude checks
TODO found Open
# TODO: Subscribe to monitor hotplugging in the code which calls this- Exclude checks
TODO found Open
# TODO: Test for off-by-one bugs- Exclude checks