Nekmo/django-code-generator

View on GitHub
django_code_generator/templatetags/code_generator_tags.py

Summary

Maintainability
B
4 hrs
Test Coverage

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

def indent_items(items, spaces, backslash=False, quote=False):
    """Prints elements of a list separated by commas. If the line length exceeds :const:`MAX_LENGTH` it
    breaks to another line. The new line is indented. The first line is not indented.

    :param items: items to print.
Severity: Minor
Found in django_code_generator/templatetags/code_generator_tags.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 format_indent_line has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

def format_indent_line(items, spaces, indent, backslash, is_last):
Severity: Minor
Found in django_code_generator/templatetags/code_generator_tags.py - About 35 mins to fix

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

    @register.filter(is_safe=True)
    def add_to_items(items, suffix):
        """Add a suffix to the elements of a listing. For example, add "Serializer" to
        each item in the list.
    
    
    Severity: Major
    Found in django_code_generator/templatetags/code_generator_tags.py and 2 other locations - About 1 hr to fix
    django_code_generator/templatetags/code_generator_tags.py on lines 81..86
    django_code_generator/templatetags/code_generator_tags.py on lines 89..94

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

    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 3 locations. Consider refactoring.
    Open

    @register.filter(is_safe=True)
    def suffix_to_items(items, suffix):
        """Add a suffix to the elements of a listing. For example, add "Serializer" to
        each item in the list.
        """
    Severity: Major
    Found in django_code_generator/templatetags/code_generator_tags.py and 2 other locations - About 1 hr to fix
    django_code_generator/templatetags/code_generator_tags.py on lines 69..78
    django_code_generator/templatetags/code_generator_tags.py on lines 81..86

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

    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 3 locations. Consider refactoring.
    Open

    @register.filter(is_safe=True)
    def prefix_to_items(items, prefix):
        """Add a prefix to the elements of a listing. For example, add "Base" to
        each item in the list.
        """
    Severity: Major
    Found in django_code_generator/templatetags/code_generator_tags.py and 2 other locations - About 1 hr to fix
    django_code_generator/templatetags/code_generator_tags.py on lines 69..78
    django_code_generator/templatetags/code_generator_tags.py on lines 89..94

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

    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