Shoobx/pjpersist

View on GitHub
src/pjpersist/serialize.py

Summary

Maintainability
F
5 days
Test Coverage

File serialize.py has 505 lines of code (exceeds 250 allowed). Consider refactoring.
Open

##############################################################################
#
# Copyright (c) 2011 Zope Foundation and Contributors.
# Copyright (c) 2014 Shoobx, Inc.
# All Rights Reserved.
Severity: Major
Found in src/pjpersist/serialize.py - About 1 day to fix

    Function get_object has a Cognitive Complexity of 44 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_object(self, state, obj):
            # stateIsDict and state_py_type: optimization to avoid X lookups
            # the code was:
            # if isinstance(state, dict) and state.get('_py_type') == 'DBREF':
            # this methods gets called a gazillion times, so being fast is crucial
    Severity: Minor
    Found in src/pjpersist/serialize.py - About 6 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 get_state has a Cognitive Complexity of 35 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_state(self, obj, pobj=None):
            objectType = type(obj)
            __traceback_info__ = obj, objectType, pobj
            if objectType in interfaces.PJ_NATIVE_TYPES:
                # If we have a native type, we'll just use it as the state.
    Severity: Minor
    Found in src/pjpersist/serialize.py - About 5 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 resolve has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

        def resolve(self, dbref):
            __traceback_info__ = dbref
            # 1. Try to optimize on whether there's just one class stored in one
            #    table, that can save us one DB query
            if dbref.table in TABLE_KLASS_MAP:
    Severity: Minor
    Found in src/pjpersist/serialize.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 get_non_persistent_state has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_non_persistent_state(self, obj):
            objectId = id(obj)
            objectType = type(obj)
            __traceback_info__ = obj, objectType, objectId
            # XXX: Look at the pickle library how to properly handle all types and
    Severity: Minor
    Found in src/pjpersist/serialize.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 store has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

        def store(self, obj, ref_only=False, id=None):
            __traceback_info__ = (obj, ref_only)
    
            # If it is the first time that this type of object is stored, getting
            # the table name has the side affect of telling the class whether it
    Severity: Minor
    Found in src/pjpersist/serialize.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 simple_resolve has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        def simple_resolve(self, path):
            path = path.replace('_dot_', '.')
            path = path[1:] if path.startswith('u_') else path
            # We try to look up the klass from a cache. The important part here is
            # that we also cache lookup failures as None, since they actually
    Severity: Minor
    Found in src/pjpersist/serialize.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 get_non_persistent_object has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_non_persistent_object(self, state, obj):
            if '_py_constant' in state:
                return self.simple_resolve(state['_py_constant'])
    
            # this method must NOT change the passed in state dict
    Severity: Minor
    Found in src/pjpersist/serialize.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

    Avoid too many return statements within this function.
    Open

                return [self.get_state(value, pobj) for value in obj]
    Severity: Major
    Found in src/pjpersist/serialize.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

                          return datetime.datetime.strptime(
      Severity: Major
      Found in src/pjpersist/serialize.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                    return {'_py_type': 'datetime.time',
        Severity: Major
        Found in src/pjpersist/serialize.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                              return datetime.datetime.strptime(
          Severity: Major
          Found in src/pjpersist/serialize.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                        return {'_py_type': 'datetime.datetime',
            Severity: Major
            Found in src/pjpersist/serialize.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                          return self.get_non_persistent_object(state, obj)
              Severity: Major
              Found in src/pjpersist/serialize.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                            return {'_py_type': 'type',
                Severity: Major
                Found in src/pjpersist/serialize.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                                  return self.get_persistent_state(obj)
                  Severity: Major
                  Found in src/pjpersist/serialize.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                    return dict(data)
                    Severity: Major
                    Found in src/pjpersist/serialize.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                                  return sub_obj
                      Severity: Major
                      Found in src/pjpersist/serialize.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                    return {'_py_type': 'datetime.date',
                        Severity: Major
                        Found in src/pjpersist/serialize.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                          return {DICT_NON_STRING_KEY_MARKER: data}
                          Severity: Major
                          Found in src/pjpersist/serialize.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                                return datetime.datetime.strptime(
                            Severity: Major
                            Found in src/pjpersist/serialize.py - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                              return serializer.read(state)
                              Severity: Major
                              Found in src/pjpersist/serialize.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                        return state
                                Severity: Major
                                Found in src/pjpersist/serialize.py - About 30 mins to fix

                                  Avoid too many return statements within this function.
                                  Open

                                                  return klass(sub_obj)
                                  Severity: Major
                                  Found in src/pjpersist/serialize.py - About 30 mins to fix

                                    Avoid too many return statements within this function.
                                    Open

                                                return sub_obj
                                    Severity: Major
                                    Found in src/pjpersist/serialize.py - About 30 mins to fix

                                      Avoid too many return statements within this function.
                                      Open

                                                  return self.get_state(list(obj))
                                      Severity: Major
                                      Found in src/pjpersist/serialize.py - About 30 mins to fix

                                        Avoid too many return statements within this function.
                                        Open

                                                return res
                                        Severity: Major
                                        Found in src/pjpersist/serialize.py - About 30 mins to fix

                                          Avoid too many return statements within this function.
                                          Open

                                                              return datetime.datetime.strptime(
                                          Severity: Major
                                          Found in src/pjpersist/serialize.py - About 30 mins to fix

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

                                                    if getattr(obj, interfaces.SUB_OBJECT_ATTR_NAME, False):
                                                        if obj._p_jar is None:
                                                            if pobj is not None and \
                                                                    getattr(pobj, '_p_jar', None) is not None:
                                                                obj._p_jar = pobj._p_jar
                                            Severity: Major
                                            Found in src/pjpersist/serialize.py and 1 other location - About 2 hrs to fix
                                            src/pjpersist/serialize.py on lines 121..125

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

                                            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

                                            def link_to_parent(obj, pobj):
                                                if obj._p_jar is None:
                                                    if pobj is not None and  getattr(pobj, '_p_jar', None) is not None:
                                                        obj._p_jar = pobj._p_jar
                                                    setattr(obj, interfaces.DOC_OBJECT_ATTR_NAME, pobj)
                                            Severity: Major
                                            Found in src/pjpersist/serialize.py and 1 other location - About 2 hrs to fix
                                            src/pjpersist/serialize.py on lines 375..380

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

                                            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 self.preferPersistent:
                                                            sub_obj = PersistentDict(sub_obj)
                                                            setattr(sub_obj, interfaces.DOC_OBJECT_ATTR_NAME, obj)
                                                            sub_obj._p_jar = self._jar
                                            Severity: Minor
                                            Found in src/pjpersist/serialize.py and 1 other location - About 45 mins to fix
                                            src/pjpersist/serialize.py on lines 701..704

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

                                            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 self.preferPersistent:
                                                            sub_obj = PersistentList(sub_obj)
                                                            setattr(sub_obj, interfaces.DOC_OBJECT_ATTR_NAME, obj)
                                                            sub_obj._p_jar = self._jar
                                            Severity: Minor
                                            Found in src/pjpersist/serialize.py and 1 other location - About 45 mins to fix
                                            src/pjpersist/serialize.py on lines 732..735

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

                                            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 objectType == datetime.datetime:
                                                        return {'_py_type': 'datetime.datetime',
                                                                'value': obj.strftime(FMT_DATETIME).zfill(FMT_DATETIME_LENGTH)}
                                            Severity: Minor
                                            Found in src/pjpersist/serialize.py and 1 other location - About 35 mins to fix
                                            src/pjpersist/serialize.py on lines 350..352

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

                                            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 objectType == datetime.date:
                                                        return {'_py_type': 'datetime.date',
                                                                'value': obj.strftime(FMT_DATE).zfill(FMT_DATE_LENGTH)}
                                            Severity: Minor
                                            Found in src/pjpersist/serialize.py and 1 other location - About 35 mins to fix
                                            src/pjpersist/serialize.py on lines 356..358

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

                                            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