Sign upLogin

uccser/cs-field-guide

View on GitHub
Star
csfieldguide/utils/TranslatableModelLoader.py

Summary

Maintainability
B
4 hrs
Test Coverage

Function get_yaml_translations has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
Open

    def get_yaml_translations(self, filename, field_map=None, required_slugs=[], required_fields=[]):
        """Get a dictionary of translations for the given filename.

        Yaml files must be structured
Severity: Minor
Found in csfieldguide/utils/TranslatableModelLoader.py - About 4 hrs 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 get_markdown_translations has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    def get_markdown_translations(self, filename, required=True, **kwargs):
        """Get dictionary of translations of the requested markdown file.

        Args:
            filename: (str) path to yaml file from the working directory of the loader
Severity: Minor
Found in csfieldguide/utils/TranslatableModelLoader.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

There are no issues that match your filters.

Category
Status