biosustain/optlang

View on GitHub
versioneer.py

Summary

Maintainability
F
1 wk
Test Coverage

File versioneer.py has 1650 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# Version: 0.29

"""The Versioneer - like a rocketeer, but for versions.

The Versioneer
Severity: Major
Found in versioneer.py - About 4 days to fix

    Function get_cmdclass has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_cmdclass(cmdclass: Optional[Dict[str, Any]] = None):
        """Get the custom setuptools subclasses used by Versioneer.
    
        If the package uses a different cmdclass (e.g. one from numpy), it
        should be provide as an argument.
    Severity: Minor
    Found in versioneer.py - About 4 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 git_pieces_from_vcs has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
    Open

    def git_pieces_from_vcs(
        tag_prefix: str,
        root: str,
        verbose: bool,
        runner: Callable = run_command
    Severity: Minor
    Found in versioneer.py - About 3 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 git_versions_from_keywords has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
    Open

    def git_versions_from_keywords(
        keywords: Dict[str, str],
        tag_prefix: str,
        verbose: bool,
    ) -> Dict[str, Any]:
    Severity: Minor
    Found in versioneer.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 get_versions has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_versions(verbose: bool = False) -> Dict[str, Any]:
        """Get the project version from whatever source is available.
    
        Returns dict with two keys: 'version' and 'full'.
        """
    Severity: Minor
    Found in versioneer.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 run_command has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    def run_command(
        commands: List[str],
        args: List[str],
        cwd: Optional[str] = None,
        verbose: bool = False,
    Severity: Minor
    Found in versioneer.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 git_get_keywords has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

    def git_get_keywords(versionfile_abs: str) -> Dict[str, str]:
        """Extract version information from the given file."""
        # the code embedded in _version.py can just fetch the value of these
        # keywords. When used from setup.py, we don't want to import _version.py,
        # so we do it with a regexp instead. This function is not used from
    Severity: Minor
    Found in versioneer.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 do_vcs_install has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

    def do_vcs_install(versionfile_source: str, ipy: Optional[str]) -> None:
        """Git-specific installation logic for Versioneer.
    
        For Git, this means creating/changing .gitattributes to mark _version.py
        for export-subst keyword substitution.
    Severity: Minor
    Found in versioneer.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 render_pep440_post_branch has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

    def render_pep440_post_branch(pieces: Dict[str, Any]) -> str:
        """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] .
    
        The ".dev0" means not master branch.
    
    
    Severity: Minor
    Found in versioneer.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 render_pep440_branch has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

    def render_pep440_branch(pieces: Dict[str, Any]) -> str:
        """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] .
    
        The ".dev0" means not master branch. Note that .dev0 sorts backwards
        (a feature branch will appear "older" than the master branch).
    Severity: Minor
    Found in versioneer.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 scan_setup_py has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    def scan_setup_py() -> int:
        """Validate the contents of setup.py against Versioneer's expectations."""
        found = set()
        setters = False
        errors = 0
    Severity: Minor
    Found in versioneer.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 render has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

    def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]:
        """Render the given version pieces into the requested style."""
        if pieces["error"]:
            return {"version": "unknown",
                    "full-revisionid": pieces.get("long"),
    Severity: Minor
    Found in versioneer.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 do_setup has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

    def do_setup() -> int:
        """Do main VCS-independent setup function for installing Versioneer."""
        root = get_root()
        try:
            cfg = get_config_from_root(root)
    Severity: Minor
    Found in versioneer.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 git_pieces_from_vcs has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def git_pieces_from_vcs(
        tag_prefix: str,
        root: str,
        verbose: bool,
        runner: Callable = run_command
    Severity: Minor
    Found in versioneer.py - About 1 hr to fix

      Function render_pep440 has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

      def render_pep440(pieces: Dict[str, Any]) -> str:
          """Build up version string, with post-release "local version identifier".
      
          Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
          get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty
      Severity: Minor
      Found in versioneer.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 render_pep440_post has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

      def render_pep440_post(pieces: Dict[str, Any]) -> str:
          """TAG[.postDISTANCE[.dev0]+gHEX] .
      
          The ".dev0" means dirty. Note that .dev0 sorts backwards
          (a dirty tree will appear "older" than the corresponding clean one),
      Severity: Minor
      Found in versioneer.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 render_pep440_old has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

      def render_pep440_old(pieces: Dict[str, Any]) -> str:
          """TAG[.postDISTANCE[.dev0]] .
      
          The ".dev0" means dirty.
      
      
      Severity: Minor
      Found in versioneer.py - About 55 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 render_pep440_pre has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

      def render_pep440_pre(pieces: Dict[str, Any]) -> str:
          """TAG[.postN.devDISTANCE] -- No -dirty.
      
          Exceptions:
          1: no tags. 0.post0.devDISTANCE
      Severity: Minor
      Found in versioneer.py - About 55 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 run_command has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def run_command(
      Severity: Minor
      Found in versioneer.py - About 45 mins to fix

        Function get_config_from_root has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

        def get_config_from_root(root: str) -> VersioneerConfig:
            """Read the project setup.cfg file to determine Versioneer config."""
            # This might raise OSError (if setup.cfg is missing), or
            # configparser.NoSectionError (if it lacks a [versioneer] section), or
            # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
        Severity: Minor
        Found in versioneer.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

        Function get_root has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

        def get_root() -> str:
            """Get the project root directory.
        
            We require that all commands are run from the project root, i.e. the
            directory that contains setup.py, setup.cfg, and versioneer.py .
        Severity: Minor
        Found in versioneer.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 {"version": "0+unknown", "full-revisionid": None,
        Severity: Major
        Found in versioneer.py - About 30 mins to fix

          There are no issues that match your filters.

          Category
          Status