wikimedia/pywikibot

View on GitHub
pywikibot/site/_apisite.py

Summary

Maintainability
F
6 days
Test Coverage

File _apisite.py has 2520 lines of code (exceeds 900 allowed). Consider refactoring.
Open

"""Objects representing API interface to MediaWiki site."""
#
# (C) Pywikibot team, 2008-2024
#
# Distributed under the terms of the MIT license.
Severity: Major
Found in pywikibot/site/_apisite.py - About 5 days to fix

    Function fromDBName has a Cognitive Complexity of 26 (exceeds 10 allowed). Consider refactoring.
    Open

        def fromDBName(  # noqa: N802
            dbname: str,
            site: BaseSite | None = None
        ) -> BaseSite:
            """Create a site from a database name using the sitematrix.
    Severity: Minor
    Found in pywikibot/site/_apisite.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 editpage has 11 arguments (exceeds 7 allowed). Consider refactoring.
    Open

        def editpage(
    Severity: Major
    Found in pywikibot/site/_apisite.py - About 1 hr to fix

      Function blockuser has 10 arguments (exceeds 7 allowed). Consider refactoring.
      Open

          def blockuser(
      Severity: Major
      Found in pywikibot/site/_apisite.py - About 50 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                if family == 'wiki':
                                    family = 'wikipedia'
                                return pywikibot.Site(code, family)
        Severity: Major
        Found in pywikibot/site/_apisite.py - About 45 mins to fix

          Function deleterevs has 8 arguments (exceeds 7 allowed). Consider refactoring.
          Open

              def deleterevs(
          Severity: Major
          Found in pywikibot/site/_apisite.py - About 35 mins to fix

            Avoid too many return statements within this function.
            Open

                    return True
            Severity: Major
            Found in pywikibot/site/_apisite.py - About 30 mins to fix

              TODO found
              Open

                  # TODO: expand support to other parameters of action=parse?
              Severity: Minor
              Found in pywikibot/site/_apisite.py by fixme

              TODO found
              Open

                      # TODO: Integrate into _userinfo
              Severity: Minor
              Found in pywikibot/site/_apisite.py by fixme

              fixme found
              Open

                      # fixme: this was an identity check
              Severity: Minor
              Found in pywikibot/site/_apisite.py by fixme

              TODO found
              Open

                      # TODO: Check for talkmove-error messages
              Severity: Minor
              Found in pywikibot/site/_apisite.py by fixme

              TODO found
              Open

                      # TODO: this should include an assert that loginstatus
              Severity: Minor
              Found in pywikibot/site/_apisite.py by fixme

              TODO found
              Open

                      # TODO this only works for some WMF sites
              Severity: Minor
              Found in pywikibot/site/_apisite.py by fixme

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

                          if not self.sametitle(pageitem['title'],
                                                page.title(with_section=False)):
                              raise InconsistentTitleError(page, pageitem['title'])
              Severity: Major
              Found in pywikibot/site/_apisite.py and 2 other locations - About 45 mins to fix
              pywikibot/site/_extensions.py on lines 237..239
              pywikibot/site/_generators.py on lines 828..830

              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

              There are no issues that match your filters.

              Category
              Status