rgs1/zk_shell

View on GitHub
zk_shell/copy_util.py

Summary

Maintainability
D
2 days
Test Coverage

File copy_util.py has 415 lines of code (exceeds 250 allowed). Consider refactoring.
Open

""" helpers to move files/dirs to and from ZK and also among ZK clusters """

from __future__ import print_function

from base64 import b64decode, b64encode
Severity: Minor
Found in zk_shell/copy_util.py - About 5 hrs to fix

    Function write_path has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
    Open

        def write_path(self, path_value):
            if isinstance(path_value, self.ZKPathValue):
                acl = path_value.acl
            else:
                acl = [ACLReader.from_dict(a) for a in path_value.acl]
    Severity: Minor
    Found in zk_shell/copy_util.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 copy has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

        def copy(self, dst, recursive, max_items, mirror):
            opname = "Copy" if not mirror else "Mirror"
    
            # basic sanity check
            if mirror and self.scheme == "zk" and dst.scheme == "file":
    Severity: Minor
    Found in zk_shell/copy_util.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 zk_walk has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

        def zk_walk(self, root_path, branch_path):
            """
            skip ephemeral znodes since there's no point in copying those
            """
            full_path = os.path.join(root_path, branch_path) if branch_path else root_path
    Severity: Minor
    Found in zk_shell/copy_util.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 children_of has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        def children_of(self):
            if self.asynchronous:
                offs = 1 if self.path == "/" else len(self.path) + 1
                for path, stat in StatMap(self.client, self.path, recursive=True).get():
                    if stat.ephemeralOwner == 0:
    Severity: Minor
    Found in zk_shell/copy_util.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 children_of has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        def children_of(self):
            root_path = self.path[0:-1] if self.path.endswith("/") else self.path
            for path, _, files in os.walk(root_path):
                path = path.replace(root_path, "")
                if path.startswith("/"):
    Severity: Minor
    Found in zk_shell/copy_util.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

    Avoid deeply nested control flow statements.
    Open

                            if mirror and child in dst_children:
                                dst_children.remove(child)
                            if max_items > 0 and i == max_items:
    Severity: Major
    Found in zk_shell/copy_util.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                              if max_items > 0 and i == max_items:
                                  break
                              self.set_url(os.path.join(src_url, child))
      Severity: Major
      Found in zk_shell/copy_util.py - About 45 mins to fix

        Function __init__ has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            def __init__(self, parse_result, exists, asynchronous, verbose):
        Severity: Minor
        Found in zk_shell/copy_util.py - About 35 mins to fix

          Function check_path has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              def check_path(self):
                  try:
                      retval = True if self.client.exists(self.path) else False
                  except NoAuthError:
                      raise AuthError("read", self.path)
          Severity: Minor
          Found in zk_shell/copy_util.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

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

                  if (self.path in self._tree) != self.exists:
                      error = "Path %s " % (self.path)
                      error += "doesn't exist" if self.exists else "exists"
                      raise CopyError(error)
          Severity: Minor
          Found in zk_shell/copy_util.py and 1 other location - About 50 mins to fix
          zk_shell/copy_util.py on lines 408..411

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

          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 os.path.exists(self.path) is not self.exists:
                      error = "Path %s " % (self.path)
                      error += "doesn't exist" if self.exists else "exists"
                      raise CopyError(error)
          Severity: Minor
          Found in zk_shell/copy_util.py and 1 other location - About 50 mins to fix
          zk_shell/copy_util.py on lines 504..507

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

          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