Shoobx/z3c.insist

View on GitHub

Showing 11 of 11 total issues

File insist.py has 586 lines of code (exceeds 250 allowed). Consider refactoring.
Open

###############################################################################
#
# Copyright 2013-15 by Shoobx, Inc.
#
###############################################################################
Severity: Major
Found in src/z3c/insist/insist.py - About 1 day to fix

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

    def simpleUpdateConfigFile():
        # There is only one choice to update the monolithic file. Load the file,
        # update the section and resave.
        cp = ConfigParser.RawConfigParser()
        cp.optionxform = str
    Severity: Major
    Found in src/z3c/insist/perftest.py and 1 other location - About 5 hrs to fix
    src/z3c/insist/perftest.py on lines 94..102

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 89.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

    def fileUpdateConfigFile():
        # We only need to update the right file.
        cp = ConfigParser.RawConfigParser()
        cp.optionxform = str
        with open(os.path.join(DATA_DIRECTORY, 'number:0.ini'), 'r') as file:
    Severity: Major
    Found in src/z3c/insist/perftest.py and 1 other location - About 5 hrs to fix
    src/z3c/insist/perftest.py on lines 65..74

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 89.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    File enforce.py has 303 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    ###############################################################################
    #
    # Copyright 2015 by Shoobx, Inc.
    #
    ###############################################################################
    Severity: Minor
    Found in src/z3c/insist/enforce.py - About 3 hrs to fix

      Function _dump has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          def _dump(self, config, add_section=True):
              """Hook for extending"""
              if add_section:
                  config.add_section(self.section)
              for fn, field in self._get_fields():
      Severity: Minor
      Found in src/z3c/insist/insist.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 dispatch_events has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          def dispatch_events(self, event_queue):
              ev =  event_queue.get(block=True)
              if not isinstance(ev, tuple):
                  return
              event, watch = ev
      Severity: Minor
      Found in src/z3c/insist/enforce.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 loadFromSection has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

          def loadFromSection(self, config, section):
              """Load object from section and return name of the loaded object
      
              After this function is completed, object with returned name should
              exist in a collection and objects data should be up to date with
      Severity: Minor
      Found in src/z3c/insist/insist.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 runOne has 31 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def runOne(self, collectionFactory, itemFactory, updateCallable, data):
              zope.component.testing.setUp(None)
              testing.setUpSerializers()
              shutil.rmtree(DATA_DIRECTORY)
              os.mkdir(DATA_DIRECTORY)
      Severity: Minor
      Found in src/z3c/insist/perftest.py - About 1 hr to fix

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

            def load(self, config):
                for fn, field in self._get_fields():
                    if self.fields is not None and fn not in self.fields:
                        continue
                    # XXX: __name__ is special for RawConfigParser
        Severity: Minor
        Found in src/z3c/insist/insist.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 _handleLocks has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            def _handleLocks(self, event):
                # The config directory can be locked by other processes. For that time
                # all event listening should be suspended. Unfortuantely, oftentimes
                # inotify events are not fired until the lock is released.
                # The good news is that inotify guarantees the file events to be
        Severity: Minor
        Found in src/z3c/insist/enforce.py - About 45 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 load has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            def load(self, config):
                self._deleted = 0
                self._added = 0
                self._reloaded = 0
        
        
        Severity: Minor
        Found in src/z3c/insist/insist.py - About 35 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