datalad/datalad-container

View on GitHub

Showing 28 of 30 total issues

Function __call__ has a Cognitive Complexity of 56 (exceeds 5 allowed). Consider refactoring.
Open

    def __call__(name, url=None, dataset=None, call_fmt=None, image=None,
                 update=False, extra_input=None):
        if not name:
            raise InsufficientArgumentsError("`name` argument is required")

Severity: Minor
Found in datalad_container/containers_add.py - About 1 day 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 process has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
Open

    def process(self, match):
        """Produce the next token and bit of text.

        Interprets the ANSI code (which may be a color code or some other
        code), changing the lexer state and producing a new token. If it's not
Severity: Minor
Found in docs/utils/pygments_ansi_color.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 __call__ has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

    def __call__(cmd, container_name=None, dataset=None,
                 inputs=None, outputs=None, message=None, expand=None,
                 explicit=False, sidecar=None):
        from unittest.mock import \
            patch  # delayed, since takes long (~600ms for yoh)
Severity: Minor
Found in datalad_container/containers_run.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 find_container_ has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

def find_container_(ds, container_name=None):
    """Find the container in dataset `ds` specified by `container_name`.

    Parameters
    ----------
Severity: Minor
Found in datalad_container/find_container.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 __call__ has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    def __call__(dataset=None, recursive=False, contains=None):
        ds = require_dataset(dataset, check_installed=True,
                             purpose='list containers')
        refds = ds.path

Severity: Minor
Found in datalad_container/containers_list.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 color_tokens has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

def color_tokens(fg_colors, bg_colors):
    """Return color tokens for a given set of colors.

    Pygments doesn't have a generic "color" token; instead everything is
    contextual (e.g. "comment" or "variable"). That doesn't make sense for us,
Severity: Minor
Found in docs/utils/pygments_ansi_color.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 __call__ has 8 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def __call__(cmd, container_name=None, dataset=None,
Severity: Major
Found in datalad_container/containers_run.py - About 1 hr to fix

    Function _get_subdataset_container has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def _get_subdataset_container(ds, container_name):
        """Try to get subdataset container matching `container_name`.
    
        This is the primary function tried by find_container_() when the container
        name looks like it is from a subdataset (i.e. has a slash).
    Severity: Minor
    Found in datalad_container/find_container.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

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

                try:
                    cmd_kwargs = dict(
                        # point to the python installation that runs *this* code
                        # we know that it would have things like the docker
                        # adaptor installed with this extension package
    Severity: Minor
    Found in datalad_container/containers_run.py and 1 other location - About 50 mins to fix
    datalad_container/containers_run.py on lines 159..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 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

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

                try:
                    xi_kwargs = dict(
                        img_dspath=image_dspath,
                        img_dirpath=op.dirname(image_path) or ".",
                    )
    Severity: Minor
    Found in datalad_container/containers_run.py and 1 other location - About 50 mins to fix
    datalad_container/containers_run.py on lines 130..152

    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

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

        def __call__(name, url=None, dataset=None, call_fmt=None, image=None,
    Severity: Minor
    Found in datalad_container/containers_add.py - About 45 mins to fix

      Function save has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

      def save(image, path):
          """Save and extract a docker image to a directory.
      
          Parameters
          ----------
      Severity: Minor
      Found in datalad_container/adapters/docker.py - About 45 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 deeply nested control flow statements.
      Open

                                  if fg_color:
                                      self.fg_color = fg_color
                                  elif bg_color:
                                      self.bg_color = bg_color
                                  elif value == 1:
      Severity: Major
      Found in docs/utils/pygments_ansi_color.py - About 45 mins to fix

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

                    def safe_extract(tar, path=".", members=None, *, numeric_owner=False):
        Severity: Minor
        Found in datalad_container/adapters/docker.py - About 35 mins to fix

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

              def __call__(name, dataset=None, remove_image=False):
                  ds = require_dataset(dataset, check_installed=True,
                                       purpose='remove a container')
          
                  res = get_status_dict(
          Severity: Minor
          Found in datalad_container/containers_remove.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 _ensure_datalad_remote has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

          def _ensure_datalad_remote(repo):
              """Initialize and enable datalad special remote if it isn't already."""
              dl_remote = None
              for info in repo.get_special_remotes().values():
                  if info.get("externaltype") == "datalad":
          Severity: Minor
          Found in datalad_container/containers_add.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

          Consider possible security implications associated with subprocess module.
          Open

          import subprocess as sp

          subprocess call - check for execution of untrusted input.
          Open

              sp.check_call(cmd)

          subprocess call - check for execution of untrusted input.
          Open

              out = sp.check_output(
                  ["docker", "images", "--all", "--quiet", "--no-trunc"])

          Starting a process with a partial executable path
          Open

                  sp.check_call(["docker", "save", "-o", stream.name, image])
          Severity
          Category
          Status
          Source
          Language