kolatz/umbr_api

View on GitHub

Showing 17 of 20 total issues

File umbrella.py has 460 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/env python3
"""Command-line utility to access Umbrella APIs.

Examples:
    .. code:: bash
Severity: Minor
Found in umbr_api/umbrella.py - About 7 hrs to fix

    Function json_to_table has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
    Open

    def json_to_table(
        _json, exclude_col=None
    ):  # pylint: disable=too-many-branches
        """Convert json object to table."""
        if not _json:
    Severity: Minor
    Found in umbr_api/management.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

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

        if ident_response.status_code == 200:
            table = json_to_table(
                json.loads(ident_response.text)["identities"], exclude_col=exclude
            )
            print(
    Severity: Major
    Found in umbr_api/reporting.py and 2 other locations - About 3 hrs to fix
    umbr_api/reporting.py on lines 72..78
    umbr_api/reporting.py on lines 153..159

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

    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 3 locations. Consider refactoring.
    Open

        if activity_response.status_code == 200:
            table = json_to_table(
                json.loads(activity_response.text)["requests"], exclude_col=exclude
            )
            print(
    Severity: Major
    Found in umbr_api/reporting.py and 2 other locations - About 3 hrs to fix
    umbr_api/reporting.py on lines 108..114
    umbr_api/reporting.py on lines 153..159

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

    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 3 locations. Consider refactoring.
    Open

        if recent_response.status_code == 200:
            table = json_to_table(
                json.loads(recent_response.text)["requests"], exclude_col=exclude
            )
            print(
    Severity: Major
    Found in umbr_api/reporting.py and 2 other locations - About 3 hrs to fix
    umbr_api/reporting.py on lines 72..78
    umbr_api/reporting.py on lines 108..114

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

    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 add has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    def add(domain=None, url=None, key=None, bypass=False):
        """Add domain name to block list."""
        assert domain and url
        assert isinstance(domain, str)
        assert isinstance(url, str)
    Severity: Minor
    Found in umbr_api/add.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 _read_cfg has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def _read_cfg(default_value=None, filename=None, key_to_read=None):
        """Return a value from file if default value is not provided.
    
        Can use parameters if provided or read them from the default cfg file.
        """
    Severity: Minor
    Found in umbr_api/credentials.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 format_response has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    def format_response(response):
        """Format results."""
        if response.status_code == 204:
            print("OK")
        else:
    Severity: Minor
    Found in umbr_api/remove.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 isinstance(sub_value, list):
                            line.append("\n".join(sub_value))
                        else:
                            line.append(sub_value)
                else:
    Severity: Major
    Found in umbr_api/management.py - About 45 mins to fix

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

      def format_response(code, json_response, exclude, **kwargs):
          """Format results."""
          if code == 200:
              print(
                  "Page: {}\nLimit: {}\n".format(
      Severity: Minor
      Found in umbr_api/get.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

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

      def management_api(command, orgid=None, cred=None, limit=10, page=1, **kwargs):
      Severity: Minor
      Found in umbr_api/management.py - About 45 mins to fix

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

                            if isinstance(sub_value, list):
                                line.append("\n".join(sub_value))
                            else:
                                line.append(sub_value)
        Severity: Minor
        Found in umbr_api/management.py and 1 other location - About 40 mins to fix
        umbr_api/management.py on lines 95..98

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

        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

                        if isinstance(value, list):
                            line.append("\n".join(value))
                        else:
                            line.append(value)
        Severity: Minor
        Found in umbr_api/management.py and 1 other location - About 40 mins to fix
        umbr_api/management.py on lines 90..93

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

        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 get_list has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        def get_list(page=1, limit=10, key=None, exclude=None, **kwargs):
        Severity: Minor
        Found in umbr_api/get.py - About 35 mins to fix

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

          def recent(destination, cred=None, orgid=None, offset=0, **kwargs):
          Severity: Minor
          Found in umbr_api/reporting.py - About 35 mins to fix

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

            def format_response(response):
                """Format results."""
                if response.status_code == 202:
                    print("OK")
                else:
            Severity: Minor
            Found in umbr_api/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

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

            def find_columns(items_to_look_for, list_to_search_in):
                """Search entries of list items in a list, return indexes."""
                found_indexes = []  # to collect numbers of columns to remove
                for item_to_look_for in items_to_look_for:
                    # search multiple entries
            Severity: Minor
            Found in umbr_api/management.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

            Severity
            Category
            Status
            Source
            Language