swimlane/swimlane-python

View on GitHub
swimlane/core/resources/record.py

Summary

Maintainability
D
1 day
Test Coverage

File record.py has 355 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import copy
from functools import total_ordering
import time
import pendulum
import six
Severity: Minor
Found in swimlane/core/resources/record.py - About 4 hrs to fix

    Record has 24 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Record(APIResource):
        """A single Swimlane Record instance
    
        Attributes:
            id (str): Full Record ID
    Severity: Minor
    Found in swimlane/core/resources/record.py - About 2 hrs to fix

      Function execute_task has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
      Open

          def execute_task(self, task_name, timeout=int(20)):
              job_info = swimlane.core.adapters.task.TaskAdapter(self.app._swimlane).execute(task_name, self._raw)
              timeout_start = pendulum.now()
              while pendulum.now() < timeout_start.add(seconds=timeout):
                  status = self.app._swimlane.helpers.check_bulk_job_status(job_info.text)
      Severity: Minor
      Found in swimlane/core/resources/record.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 remove_restriction has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          def remove_restriction(self, *usergroups):
              """Remove UserGroup(s) from list of accounts with access to record
      
              .. versionadded:: 2.16.1
      
      
      Severity: Minor
      Found in swimlane/core/resources/record.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 patch has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          def patch(self):
              """Patch record on Swimlane server
      
              Raises
                  ValueError: If record.is_new, or if comments or attachments are attempted to be patched
      Severity: Minor
      Found in swimlane/core/resources/record.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

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

          def add_restriction(self, *usergroups):
              """Add UserGroup(s) to list of accounts with access to record
      
              .. versionadded:: 2.16.1
      
      
      Severity: Minor
      Found in swimlane/core/resources/record.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

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

              for key, value in six.iteritems(copy_raw['values']):
                  if value is not None:
                      values_dict[key] = value
      Severity: Major
      Found in swimlane/core/resources/record.py and 1 other location - About 1 hr to fix
      swimlane/core/resources/record.py on lines 486..488

      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 42.

      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

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

          for key, value in six.iteritems(copy_raw['values']):
              if value is not None:
                  values_dict[key] = value
      Severity: Major
      Found in swimlane/core/resources/record.py and 1 other location - About 1 hr to fix
      swimlane/core/resources/record.py on lines 206..208

      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 42.

      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

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

              if not isinstance(other, self.__class__):
                  raise TypeError("Comparisons not supported between instances of '{}' and '{}'".format(
                      other.__class__.__name__,
                      self.__class__.__name__
      Severity: Minor
      Found in swimlane/core/resources/record.py and 1 other location - About 55 mins to fix
      swimlane/core/resources/app.py on lines 76..79

      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 37.

      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

      There are no issues that match your filters.

      Category
      Status