ForestAdmin/django-forest

View on GitHub
django_forest/resources/utils/smart_field.py

Summary

Maintainability
C
1 day
Test Coverage
A
100%

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

    def _handle_smart_field_for_relation(self, queryset, relation_field, collection_name, params, many):
        if many:
            for item in queryset:
                if getattr(item, relation_field["field"], None) is not None:
                    self.handle_smart_fields(
Severity: Minor
Found in django_forest/resources/utils/smart_field.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 _handle_smart_field_for_relation has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def _handle_smart_field_for_relation(self, queryset, relation_field, collection_name, params, many):
Severity: Minor
Found in django_forest/resources/utils/smart_field.py - About 35 mins to fix

    Function handle_smart_fields has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def handle_smart_fields(self, queryset, resource, params=None, many=False, follow_relations=True):
    Severity: Minor
    Found in django_forest/resources/utils/smart_field.py - About 35 mins to fix

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

          def handle_smart_fields(self, queryset, resource, params=None, many=False, follow_relations=True):
              collection = Schema.get_collection(resource)
      
              # Rather than calculate and then filter out smart fields, we want to ignore them entirely
              smart_fields = self._get_smart_fields_for_request(collection, params)
      Severity: Minor
      Found in django_forest/resources/utils/smart_field.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

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

                  if isinstance(method, str):
                      instance = getattr(Collection._registry[resource], method)(instance, value)
                  elif callable(method):
                      instance = method(instance, value)
      Severity: Major
      Found in django_forest/resources/utils/smart_field.py and 1 other location - About 2 hrs to fix
      django_forest/resources/utils/queryset/filters/utils.py on lines 82..85

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

      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

              if many:
                  for item in queryset:
                      if getattr(item, relation_field["field"], None) is not None:
                          self.handle_smart_fields(
                              getattr(item, relation_field["field"]), collection_name, params, False, False
      Severity: Major
      Found in django_forest/resources/utils/smart_field.py and 1 other location - About 1 hr to fix
      django_forest/resources/utils/smart_field.py on lines 73..76

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

      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

                  for item in queryset:
                      if getattr(item, relation_field["field"], None) is not None:
                          self.handle_smart_fields(
                              getattr(item, relation_field["field"]), collection_name, params, False, False
      Severity: Major
      Found in django_forest/resources/utils/smart_field.py and 1 other location - About 1 hr to fix
      django_forest/resources/utils/smart_field.py on lines 72..81

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

      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