ssokolow/saveswap

View on GitHub

Showing 5 of 5 total issues

File saveswap.py has 253 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
A simple utility to translate among the SRAM/EEPROM/Flash dump formats for
Nintendo 64 cartridges as supported by various dumpers, emulators, and flash
Severity: Minor
Found in saveswap.py - About 2 hrs to fix

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

    def main():  # type: () -> None
        """The main entry point, compatible with setuptools entry points."""
        # If we're running on Python 2, take responsibility for preventing
        # output from causing UnicodeEncodeErrors. (Done here so it should only
        # happen when not being imported by some other program.)
    Severity: Minor
    Found in saveswap.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 process_path has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def process_path(path, swap_bytes=True, swap_words=True, pad_to=None,
    Severity: Minor
    Found in saveswap.py - About 35 mins to fix

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

      def _vary_check_swap_inputs(callback):
          """Helper to avoid duplicating stuff within test_byteswap_with_incomplete
      
          You want to be careful about this, because the number of tests run goes up
          exponentially, but with small numbers of combinations, it's very useful.
      Severity: Minor
      Found in test_saveswap.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

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

      def test_byteswap_with_incomplete(tmpdir):
          """Test that byteswap reacts properly to file sizes with remainders
      
          (ie. file sizes that are not evenly divisible by 2 or 4)
          """
      Severity: Minor
      Found in test_saveswap.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

      Severity
      Category
      Status
      Source
      Language