kariminf/aruudy

View on GitHub
aruudy/tools/word.py

Summary

Maintainability
D
2 days
Test Coverage

File word.py has 754 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
#  pattern.py
#  Used to detect patterns from a fully vocalized word
Severity: Major
Found in aruudy/tools/word.py - About 1 day to fix

    Function getPattern has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
    Open

    def getPattern(word):
    
        tmpPattern = u''
    
        for char in word:
    Severity: Minor
    Found in aruudy/tools/word.py - About 2 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 getTemplateNoDiac has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    def getTemplateNoDiac(word):
        """This function take an Arabic word as parameter;
        it deletes its diacritics if exist; then returns the possible Templates;
        If there are many possible templates, they will be separated with + """
    
    
    Severity: Minor
    Found in aruudy/tools/word.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 getTemplateFromList has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

    def getTemplateFromList(word, template):
        """This function take an Arabic  word (diacretized)
        and some possible templates separated by a +;
        If the program succeed to choose just one, it will add a (;)
        at the end
    Severity: Minor
    Found in aruudy/tools/word.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

            elif char == u'آ':
                if tmpPattern and tmpPattern[-1]== u'C':
                    tmpPattern += u'3'
                tmpPattern += u'30'
    Severity: Minor
    Found in aruudy/tools/word.py and 1 other location - About 50 mins to fix
    aruudy/tools/word.py on lines 717..720

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

    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

            elif char == u'ا' or char == u'ى':
                if tmpPattern and tmpPattern[-1]== u'C':
                    tmpPattern += u'3'
                tmpPattern += u'0'
    Severity: Minor
    Found in aruudy/tools/word.py and 1 other location - About 50 mins to fix
    aruudy/tools/word.py on lines 712..715

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

    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