Princeton-CDH/derrida-django

View on GitHub
derrida/books/models.py

Summary

Maintainability
F
5 days
Test Coverage

File models.py has 655 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import json
import string

from django.contrib.contenttypes.fields import GenericRelation
from django.core.exceptions import ValidationError
Severity: Major
Found in derrida/books/models.py - About 1 day to fix

    Function as_zotero_item has a Cognitive Complexity of 32 (exceeds 5 allowed). Consider refactoring.
    Open

        def as_zotero_item(self, library):
            '''Serialize the instance as an item suitable for export to a Zotero
            library. Requires a :class:`pyzotero.zotero.Zotero` instance for API
            calls to retrieve item type templates and creator types.'''
            # get the item template/creator types based on item type
    Severity: Minor
    Found in derrida/books/models.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

    Instance has 24 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Instance(Notable):
        '''A single instance of a :class:`Work` - i.e., a specific copy or edition
        or translation.  Can also include books that appear as sections
        of a collected works.'''
    
    
    Severity: Minor
    Found in derrida/books/models.py - About 2 hrs to fix

      Function generate_safe_slug has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          def generate_safe_slug(self):
              '''Generate a unique slug.  Checks for duplicates and calculates
              an appropriate copy letter if needed.
      
              :rtype str: String in the format `lastname-title-of-work-year-copy`
      Severity: Minor
      Found in derrida/books/models.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 primary_language has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          def primary_language(self):
              '''Primary :class:`Language` for this work instance.  Use only
              language or primary language for the instance if available; falls
              back to only or primary language for the associated work.'''
      
      
      Severity: Minor
      Found in derrida/books/models.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

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

      class WorkLanguage(Notable):
          '''Through-model for work-language relationship, to allow designating
          one language as primary or adding notes.'''
          #: :class:`Language`
          language = models.ForeignKey(Language)
      Severity: Major
      Found in derrida/books/models.py and 1 other location - About 4 hrs to fix
      derrida/books/models.py on lines 730..746

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

      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

      class InstanceLanguage(Notable):
          '''Through-model for instance-language relationship, to allow designating
          one language as primary or adding notes.'''
          #: :class:`Language`
          language = models.ForeignKey(Language)
      Severity: Major
      Found in derrida/books/models.py and 1 other location - About 4 hrs to fix
      derrida/books/models.py on lines 711..727

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

      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

      class InstanceCount(models.Model):
          '''Mix-in for models related to books; adds book count property and link to
          associated books'''
          class Meta:
              abstract = True
      Severity: Major
      Found in derrida/books/models.py and 1 other location - About 4 hrs to fix
      derrida/books/models.py on lines 22..40

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

      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

      class WorkCount(models.Model):
          '''Mix-in for models related to works; adds work count property and link to
          associated works'''
          class Meta:
              abstract = True
      Severity: Major
      Found in derrida/books/models.py and 1 other location - About 4 hrs to fix
      derrida/books/models.py on lines 46..64

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

      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

          def __str__(self):
              dates = ''
              if self.dates:
                  dates = ' (%s)' % self.dates
              return '%s - %s%s' % (self.person, self.book, dates)
      Severity: Major
      Found in derrida/books/models.py and 2 other locations - About 1 hr to fix
      derrida/people/models.py on lines 92..96
      derrida/books/models.py on lines 763..767

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

      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

          def __str__(self):
              dates = ''
              if self.dates:
                  dates = ' (%s)' % self.dates
              return '%s / %s%s' % (self.instance, self.institution, dates)
      Severity: Major
      Found in derrida/books/models.py and 2 other locations - About 1 hr to fix
      derrida/people/models.py on lines 92..96
      derrida/books/models.py on lines 802..806

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

      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