adsabs/biblib-service

View on GitHub
biblib/views/operations_view.py

Summary

Maintainability
F
1 wk
Test Coverage

Function post has a Cognitive Complexity of 57 (exceeds 5 allowed). Consider refactoring.
Open

    def post(self, library):
        """
        HTTP POST request that conducts operations at the library level.

        :param library: primary library ID
Severity: Minor
Found in biblib/views/operations_view.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

File operations_view.py has 310 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
Operations view
"""
from biblib.views import USER_ID_KEYWORD
from biblib.utils import err, get_post_data
Severity: Minor
Found in biblib/views/operations_view.py - About 3 hrs to fix

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

        def setops_libraries(cls, library_id, document_data, operation='union'):
            """
            Takes the union of two or more libraries
            :param library_id: the primary library ID
            :param document_data: dict containing the list 'libraries' that holds the secondary library IDs
    Severity: Minor
    Found in biblib/views/operations_view.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

    Avoid too many return statements within this function.
    Open

                    return err(NO_PERMISSION_ERROR)
    Severity: Major
    Found in biblib/views/operations_view.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

                          return err(NO_PERMISSION_ERROR)
      Severity: Major
      Found in biblib/views/operations_view.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                    return library_dict, 200
        Severity: Major
        Found in biblib/views/operations_view.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                          return err(WRONG_TYPE_ERROR)
          Severity: Major
          Found in biblib/views/operations_view.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                        return library_dict, 200
            Severity: Major
            Found in biblib/views/operations_view.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                          return library_dict, 200
              Severity: Major
              Found in biblib/views/operations_view.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                    return err(BAD_LIBRARY_ID_ERROR)
                Severity: Major
                Found in biblib/views/operations_view.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                              return library_dict, 200
                  Severity: Major
                  Found in biblib/views/operations_view.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                    return err(DUPLICATE_LIBRARY_NAME_ERROR)
                    Severity: Major
                    Found in biblib/views/operations_view.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                                      return err(WRONG_TYPE_ERROR)
                      Severity: Major
                      Found in biblib/views/operations_view.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                        return err(DUPLICATE_LIBRARY_NAME_ERROR)
                        Severity: Major
                        Found in biblib/views/operations_view.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                      return library_dict, 200
                          Severity: Major
                          Found in biblib/views/operations_view.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                            return err(TOO_MANY_LIBRARIES_SPECIFIED_ERROR)
                            Severity: Major
                            Found in biblib/views/operations_view.py - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                              return err(DUPLICATE_LIBRARY_NAME_ERROR)
                              Severity: Major
                              Found in biblib/views/operations_view.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                                return err(NO_LIBRARY_SPECIFIED_ERROR)
                                Severity: Major
                                Found in biblib/views/operations_view.py - About 30 mins to fix

                                  Avoid too many return statements within this function.
                                  Open

                                              return {}, 400
                                  Severity: Major
                                  Found in biblib/views/operations_view.py - About 30 mins to fix

                                    Avoid too many return statements within this function.
                                    Open

                                                    return err(WRONG_TYPE_ERROR)
                                    Severity: Major
                                    Found in biblib/views/operations_view.py - About 30 mins to fix

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

                                              if action == 'union':
                                                  bib_union = self.setops_libraries(
                                                      library_id=library_uuid,
                                                      document_data=data,
                                                      operation='union'
                                      Severity: Major
                                      Found in biblib/views/operations_view.py and 1 other location - About 2 days to fix
                                      biblib/views/operations_view.py on lines 291..318

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

                                      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 action == 'intersection':
                                                  bib_intersect = self.setops_libraries(
                                                      library_id=library_uuid,
                                                      document_data=data,
                                                      operation='intersection'
                                      Severity: Major
                                      Found in biblib/views/operations_view.py and 1 other location - About 2 days to fix
                                      biblib/views/operations_view.py on lines 259..289

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

                                      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

                                                  current_app.logger.info('Successfully took the difference of {0} (ID {2}) - (minus) {1} (ID {3})'
                                                          .format(lib_names[0], ', '.join(lib_names[1:]), library, ', '.join(data['libraries'])))
                                      Severity: Major
                                      Found in biblib/views/operations_view.py and 1 other location - About 1 hr to fix
                                      biblib/views/operations_view.py on lines 331..332

                                      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

                                                      data['description'] = 'Records that are in {0} (ID {2}) but not in {1} (ID {3})' \
                                                          .format(lib_names[0], ', '.join(lib_names[1:]), library, ', '.join(data['libraries']))
                                      Severity: Major
                                      Found in biblib/views/operations_view.py and 1 other location - About 1 hr to fix
                                      biblib/views/operations_view.py on lines 326..327

                                      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

                                      There are no issues that match your filters.

                                      Category
                                      Status