wikimedia/pywikibot

View on GitHub
scripts/category_redirect.py

Summary

Maintainability
C
1 day
Test Coverage

Function setup_soft_redirect has a Cognitive Complexity of 20 (exceeds 10 allowed). Consider refactoring.
Open

    def setup_soft_redirect(self):
        """Setup soft redirect task."""
        pywikibot.info(f'\nChecking {self.cat.categoryinfo["subcats"]}'
                       ' category redirect pages')
        self.load_record()
Severity: Minor
Found in scripts/category_redirect.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 move_contents has a Cognitive Complexity of 16 (exceeds 10 allowed). Consider refactoring.
Open

    def move_contents(self, old_cat_title: str, new_cat_title: str,
                      edit_summary: str) -> tuple[int, int]:
        """The worker function that moves pages out of oldCat into newCat."""
        old_cat = pywikibot.Category(self.site, self.catprefix + old_cat_title)
        new_cat = pywikibot.Category(self.site, self.catprefix + new_cat_title)
Severity: Minor
Found in scripts/category_redirect.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 check_soft_redirect has a Cognitive Complexity of 12 (exceeds 10 allowed). Consider refactoring.
Open

    def check_soft_redirect(self) -> None:
        """Check for soft-redirected categories."""
        cat = self.current_page
        i18n_param = {'oldcat': cat.title(as_link=True, textlink=True)}

Severity: Minor
Found in scripts/category_redirect.py - About 35 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

Avoid too many return statements within this function.
Open

            return
Severity: Major
Found in scripts/category_redirect.py - About 30 mins to fix

    Function main has a Cognitive Complexity of 11 (exceeds 10 allowed). Consider refactoring.
    Open

    def main(*args: str) -> None:
        """
        Process command line arguments and invoke bot.
    
        If args is an empty list, sys.argv is used.
    Severity: Minor
    Found in scripts/category_redirect.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

    TODO found
    Open

            # TODO: enhance and use textlib.MultiTemplateMatchBuilder
    Severity: Minor
    Found in scripts/category_redirect.py by fixme

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

            try:
                page.touch()
            except (NoCreateError, NoPageError):
                pywikibot.error(f'Page {page.title(as_link=True)} does not exist.')
            except LockedPageError:
    Severity: Major
    Found in scripts/category_redirect.py and 2 other locations - About 4 hrs to fix
    scripts/newitem.py on lines 84..92
    scripts/touch.py on lines 59..66

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

    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