thundergolfer/mAIcroft

View on GitHub
maicroft/words/most_used_words.py

Summary

Maintainability
D
2 days
Test Coverage

Function main has a Cognitive Complexity of 39 (exceeds 5 allowed). Consider refactoring.
Open

def main():
    # parse the command-line options and arguments
    user, target, options = parse_cmd_line()

    # Check for package updates
Severity: Minor
Found in maicroft/words/most_used_words.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

File most_used_words.py has 289 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
    Credit to the Reddit Analysis project by Randal S. Olson.
"""

import os
Severity: Minor
Found in maicroft/words/most_used_words.py - About 2 hrs to fix

    Function tokenize has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    def tokenize(text):
        """Return individual tokens from a block of text."""
        def normalized_tokens(token):
            """Yield lower-case tokens from the given token."""
            for sub in TOKEN_RE.findall(token):
    Severity: Minor
    Found in maicroft/words/most_used_words.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 parse_text has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

    def parse_text(text, count_word_freqs, max_threshold, is_markdown=True):
        """Parse the passed in text and add words that are not common.
    
        :param count_word_freqs: if False, only count a word once per text block
            (title, selftext, comment body) rather than incrementing the total for
    Severity: Minor
    Found in maicroft/words/most_used_words.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 parse_cmd_line has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    def parse_cmd_line():
        """Command-line argument parsing."""
    
        usage = ("usage: %prog [options] USERNAME TARGET\n\n"
                 "USERNAME sets your Reddit username for the bot\n"
    Severity: Minor
    Found in maicroft/words/most_used_words.py - About 45 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 process_subreddit has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def process_subreddit(subreddit, period, limit, count_word_freqs, max_threshold):
    Severity: Minor
    Found in maicroft/words/most_used_words.py - About 35 mins to fix

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

                  if popular_words[singular] > 0:
                      # combine the count into the most-used form of the word
                      if popular_words[singular] > count:
                          popular_words[singular] += popular_words[word]
                          del popular_words[word]
      Severity: Major
      Found in maicroft/words/most_used_words.py and 1 other location - About 5 hrs to fix
      maicroft/words/most_used_words.py on lines 349..357

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

      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

                  if popular_words[singular] > 0:
      
                      # combine the count into the most-used form of the word
                      if popular_words[singular] > count:
                          popular_words[singular] += popular_words[word]
      Severity: Major
      Found in maicroft/words/most_used_words.py and 1 other location - About 5 hrs to fix
      maicroft/words/most_used_words.py on lines 363..370

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

      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