borgbackup/borg

View on GitHub
src/borg/archiver/tar_cmds.py

Summary

Maintainability
F
3 days
Test Coverage

File tar_cmds.py has 457 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import argparse
import base64
import logging
import os
import stat
Severity: Minor
Found in src/borg/archiver/tar_cmds.py - About 7 hrs to fix

    Function _export_tar has a Cognitive Complexity of 42 (exceeds 5 allowed). Consider refactoring.
    Open

        def _export_tar(self, args, archive, tarstream):
            matcher = build_matcher(args.patterns, args.paths)
    
            progress = args.progress
            output_list = args.output_list
    Severity: Minor
    Found in src/borg/archiver/tar_cmds.py - About 6 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 _import_tar has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

        def _import_tar(self, args, repository, manifest, key, cache, tarstream):
            t0 = archive_ts_now()
            t0_monotonic = time.monotonic()
    
            archive = Archive(
    Severity: Minor
    Found in src/borg/archiver/tar_cmds.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_tar_filter has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_tar_filter(fname, decompress):
        # Note that filter is None if fname is '-'.
        if fname.endswith((".tar.gz", ".tgz")):
            filter = "gzip -d" if decompress else "gzip"
        elif fname.endswith((".tar.bz2", ".tbz")):
    Severity: Minor
    Found in src/borg/archiver/tar_cmds.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 build_parser_tar has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        def build_parser_tar(self, subparsers, common_parser, mid_common_parser):
            from ._common import process_epilog
    
            export_tar_epilog = process_epilog(
                """
    Severity: Minor
    Found in src/borg/archiver/tar_cmds.py - About 1 hr to fix

      Function _import_tar has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def _import_tar(self, args, repository, manifest, key, cache, tarstream):
      Severity: Minor
      Found in src/borg/archiver/tar_cmds.py - About 45 mins to fix

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

                if progress:
                    pi = ProgressIndicatorPercent(msg="%5.1f%% Processing: %s", step=0.1, msgid="extract")
                    pi.output("Calculating size")
                    extracted_size = sum(item.get_size() for item in archive.iter_items(filter))
                    pi.total = extracted_size
        Severity: Major
        Found in src/borg/archiver/tar_cmds.py and 1 other location - About 3 hrs to fix
        src/borg/archiver/extract_cmd.py on lines 51..57

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

        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

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

                subparser = subparsers.add_parser(
                    "import-tar",
                    parents=[common_parser],
                    add_help=False,
                    description=self.do_import_tar.__doc__,
        Severity: Major
        Found in src/borg/archiver/tar_cmds.py and 1 other location - About 1 hr to fix
        src/borg/archiver/recreate_cmd.py on lines 109..116

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

        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

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

                    elif modebits == stat.S_IFBLK:
                        tarinfo.type = tarfile.BLKTYPE
                        tarinfo.devmajor = os.major(item.rdev)
                        tarinfo.devminor = os.minor(item.rdev)
        Severity: Major
        Found in src/borg/archiver/tar_cmds.py and 1 other location - About 1 hr to fix
        src/borg/archiver/tar_cmds.py on lines 176..179

        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

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

                    elif modebits == stat.S_IFCHR:
                        tarinfo.type = tarfile.CHRTYPE
                        tarinfo.devmajor = os.major(item.rdev)
                        tarinfo.devminor = os.minor(item.rdev)
        Severity: Major
        Found in src/borg/archiver/tar_cmds.py and 1 other location - About 1 hr to fix
        src/borg/archiver/tar_cmds.py on lines 172..175

        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

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

                subparser = subparsers.add_parser(
                    "export-tar",
                    parents=[common_parser],
                    add_help=False,
                    description=self.do_export_tar.__doc__,
        Severity: Major
        Found in src/borg/archiver/tar_cmds.py and 8 other locations - About 1 hr to fix
        src/borg/archiver/check_cmd.py on lines 185..191
        src/borg/archiver/compact_cmd.py on lines 46..52
        src/borg/archiver/extract_cmd.py on lines 135..141
        src/borg/archiver/info_cmd.py on lines 76..82
        src/borg/archiver/list_cmd.py on lines 89..95
        src/borg/archiver/rename_cmd.py on lines 33..39
        src/borg/archiver/rlist_cmd.py on lines 85..91
        src/borg/archiver/serve_cmd.py on lines 42..48

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

        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 strip_components:
                        item.path = os.sep.join(orig_path.split(os.sep)[strip_components:])
        Severity: Minor
        Found in src/borg/archiver/tar_cmds.py and 1 other location - About 35 mins to fix
        src/borg/archiver/extract_cmd.py on lines 61..62

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

        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

                archive_group.add_argument(
                    "-C",
                    "--compression",
                    metavar="COMPRESSION",
                    dest="compression",
        Severity: Minor
        Found in src/borg/archiver/tar_cmds.py and 1 other location - About 35 mins to fix
        src/borg/archiver/recreate_cmd.py on lines 183..189

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

        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