Sign upLogin

DeveloperCAP/MLCAT

View on GitHub
Star
lib/input/mbox/keyword_digest.py

Summary

Maintainability
F
3 days
Test Coverage

Function generate_keyword_digest has a Cognitive Complexity of 119 (exceeds 5 allowed). Consider refactoring.
Open

def generate_keyword_digest(mbox_filename, output_filename, author_uid_filename, json_filename, top_n = None, console_output=True):
    """
    From the .MBOX file, this function extracts the email content is extracted using two predefined classes
    available in the Python Standard Library: Mailbox and Message. Feature vectors are created for all the authors
    by obtaining meaningful words from the mail content, after removing the stop words, using NLTK libraries.
Severity: Minor
Found in lib/input/mbox/keyword_digest.py - About 2 days 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_message_body has a Cognitive Complexity of 35 (exceeds 5 allowed). Consider refactoring.
Open

def get_message_body(message):
    """
    Gets the message body of the message passed as a parameter.

    :param message: The message whose body is to be extracted.
Severity: Minor
Found in lib/input/mbox/keyword_digest.py - About 5 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 generate_keyword_digest has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

def generate_keyword_digest(mbox_filename, output_filename, author_uid_filename, json_filename, top_n = None, console_output=True):
Severity: Minor
Found in lib/input/mbox/keyword_digest.py - About 45 mins to fix

    Avoid deeply nested control flow statements.
    Open

                            if console_output:
                            print("\n-----\n")
                        else:
                            out_file.write("\n-----\n")
        else:
    Severity: Major
    Found in lib/input/mbox/keyword_digest.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                              if console_output:
                            print("\n-----\n")
                        else:
                            out_file.write("\n-----\n")
            # with open("author_top_index.json", 'w') as json_file:
      Severity: Major
      Found in lib/input/mbox/keyword_digest.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                if not console_output:
                            out_file.write(author_email + "\n")
                            author_features = list()
                            for i in indices:
                                author_features.append(feature_names[i])
        Severity: Major
        Found in lib/input/mbox/keyword_digest.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                                  if not console_output:
                            out_file.write(author_email + "\n")
                            author_features = list()
                            for i in indices:
                                author_features.append(feature_names[i])
          Severity: Major
          Found in lib/input/mbox/keyword_digest.py - About 45 mins to fix

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

                        msg_tokens = [x.lower() for x in re.sub('\W+', ' ', msg_body).split() if 2 < len(x) < 30]
            Severity: Major
            Found in lib/input/mbox/keyword_digest.py and 1 other location - About 1 hr to fix
            lib/input/mbox/keyword_clustering.py on lines 139..139

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

            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

                        msg_tokens = [wnl.lemmatize(x) for x in msg_tokens if not x.isdigit() and x not in from_addr]
            Severity: Major
            Found in lib/input/mbox/keyword_digest.py and 1 other location - About 1 hr to fix
            lib/input/mbox/keyword_clustering.py on lines 143..143

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

            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 num in range(len(keywords_list)):
            keywords_list[num] = " ".join(keywords_list[num])
            Severity: Minor
            Found in lib/input/mbox/keyword_digest.py and 1 other location - About 55 mins to fix
            lib/input/mbox/keyword_clustering.py on lines 152..153

            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