Sign upLogin

stellar/xdrgen

View on GitHub
Star
lib/xdrgen/generators/python.rb

Summary

Maintainability
F
5 days
Test Coverage

Method render_union has a Cognitive Complexity of 76 (exceeds 5 allowed). Consider refactoring.
Open

      def render_union(union, render_import_in_func = false)
        union_name = name union
        union_name_underscore = union_name.underscore
        @init_out.puts "from .#{union_name_underscore} import #{union_name}"
Severity: Minor
Found in lib/xdrgen/generators/python.rb - 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 python.rb has 597 lines of code (exceeds 250 allowed). Consider refactoring.
Open

module Xdrgen
  module Generators
    class Python < Xdrgen::Generators::Base
      MAX_SIZE = (2 ** 32) - 1
      CIRCLE_IMPORT_UNION = %w[SCVal SCSpecTypeDef]
Severity: Major
Found in lib/xdrgen/generators/python.rb - About 1 day to fix

    Method render_union has 132 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def render_union(union, render_import_in_func = false)
        union_name = name union
        union_name_underscore = union_name.underscore
        @init_out.puts "from .#{union_name_underscore} import #{union_name}"
    Severity: Major
    Found in lib/xdrgen/generators/python.rb - About 5 hrs to fix

      Method render_struct has 80 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

            def render_struct(struct)
        struct_name = name struct
        struct_name_underscore = struct_name.underscore
        @init_out.puts "from .#{struct_name_underscore} import #{struct_name}"
      Severity: Major
      Found in lib/xdrgen/generators/python.rb - About 3 hrs to fix

        Class Python has 24 methods (exceeds 20 allowed). Consider refactoring.
        Open

            class Python < Xdrgen::Generators::Base
      MAX_SIZE = (2 ** 32) - 1
      CIRCLE_IMPORT_UNION = %w[SCVal SCSpecTypeDef]

      def generate
        Severity: Minor
        Found in lib/xdrgen/generators/python.rb - About 2 hrs to fix

          Method encode_member has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
          Open

                def encode_member(member, out, is_union_member = false)
        case member.declaration
        when AST::Declarations::Void
          out.puts "return"
        end
          Severity: Minor
          Found in lib/xdrgen/generators/python.rb - 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

          Method render_typedef has 39 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

                def render_typedef(typedef)
        typedef_name = typedef.name.camelize
        typedef_name_underscore = typedef.name.underscore

        @init_out.puts "from .#{typedef_name_underscore} import #{typedef_name}"
          Severity: Minor
          Found in lib/xdrgen/generators/python.rb - About 1 hr to fix

            Method encode_member has 32 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                  def encode_member(member, out, is_union_member = false)
        case member.declaration
        when AST::Declarations::Void
          out.puts "return"
        end
            Severity: Minor
            Found in lib/xdrgen/generators/python.rb - About 1 hr to fix

              Method type_string has 30 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                    def type_string(type)
        case type
        when AST::Typespecs::Bool
          "bool"
        when AST::Typespecs::Double
              Severity: Minor
              Found in lib/xdrgen/generators/python.rb - About 1 hr to fix

                Method decode_type has 28 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                      def decode_type(decl)
        case decl.type
        when AST::Typespecs::Int
          "Integer.unpack(unpacker)"
        when AST::Typespecs::UnsignedInt
                Severity: Minor
                Found in lib/xdrgen/generators/python.rb - About 1 hr to fix

                  Method decode_member has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                  Open

                        def decode_member(member, out)
        case member.declaration
        when AST::Declarations::Void;
          out.puts "return"
        end
                  Severity: Minor
                  Found in lib/xdrgen/generators/python.rb - 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

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

                                  if c.value.is_a?(AST::Identifier)
                  out.puts "if #{union_discriminant_name_underscore} == #{type_string union.discriminant.type}.#{c.value.name}:"
                else
                  out.puts "if #{union_discriminant_name_underscore} == #{c.value.value}:"
                  Severity: Minor
                  Found in lib/xdrgen/generators/python.rb and 1 other location - About 35 mins to fix
                  lib/xdrgen/generators/python.rb on lines 229..232

                  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 c.value.is_a?(AST::Identifier)
                  out.puts "if self.#{union_discriminant_name_underscore} == #{type_string union.discriminant.type}.#{c.value.name}:"
                else
                  out.puts "if self.#{union_discriminant_name_underscore} == #{c.value.value}:"
                  Severity: Minor
                  Found in lib/xdrgen/generators/python.rb and 1 other location - About 35 mins to fix
                  lib/xdrgen/generators/python.rb on lines 253..256

                  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

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

                            out.puts <<~HEREDOC
            def __hash__(self):
                return hash((#{attribute_names.map { |m| 'self.' + m }.join(", ")},))
            def __eq__(self, other: object):
                if not isinstance(other, self.__class__):
                  Severity: Minor
                  Found in lib/xdrgen/generators/python.rb and 1 other location - About 25 mins to fix
                  lib/xdrgen/generators/python.rb on lines 383..388

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

                  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

                            out.puts <<~HEREDOC
            def __hash__(self):
                return hash((#{attribute_names.map { |m| 'self.' + m }.join(", ")},))
            def __eq__(self, other: object):
                if not isinstance(other, self.__class__):
                  Severity: Minor
                  Found in lib/xdrgen/generators/python.rb and 1 other location - About 25 mins to fix
                  lib/xdrgen/generators/python.rb on lines 290..295

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

                  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