chore: make internal types pretty print

Author: stainless-app[bot]

lib/openai/internal.rb

@@ -3,6 +3,10 @@
 module OpenAI
   # @api private
   module Internal
-    OMIT = Object.new.freeze
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{OpenAI::Internal}::OMIT>" }
+      end
+        .freeze
   end
 end

lib/openai/internal/cursor_page.rb

@@ -30,11 +30,10 @@ class CursorPage
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super
-        model = req.fetch(:model)
 
         case page_data
         in {data: Array | nil => data}
-          @data = data&.map { OpenAI::Internal::Type::Converter.coerce(model, _1) }
+          @data = data&.map { OpenAI::Internal::Type::Converter.coerce(@model, _1) }
         else
         end
 
@@ -69,17 +68,23 @@ def auto_paging_each(&blk)
         unless block_given?
           raise ArgumentError.new("A block must be given to ##{__method__}")
         end
+
         page = self
         loop do
-          page.data&.each { blk.call(_1) }
+          page.data&.each(&blk)
+
           break unless page.next_page?
           page = page.next_page
         end
       end
 
+      # @api private
+      #
       # @return [String]
       def inspect
-        "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} has_more=#{has_more.inspect}>"
+        model = OpenAI::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} has_more=#{has_more.inspect}>"
       end
     end
   end

lib/openai/internal/page.rb

@@ -30,11 +30,10 @@ class Page
       # @param page_data [Array<Object>]
       def initialize(client:, req:, headers:, page_data:)
         super
-        model = req.fetch(:model)
 
         case page_data
         in {data: Array | nil => data}
-          @data = data&.map { OpenAI::Internal::Type::Converter.coerce(model, _1) }
+          @data = data&.map { OpenAI::Internal::Type::Converter.coerce(@model, _1) }
         else
         end
 
@@ -63,17 +62,23 @@ def auto_paging_each(&blk)
         unless block_given?
           raise ArgumentError.new("A block must be given to ##{__method__}")
         end
+
         page = self
         loop do
-          page.data&.each { blk.call(_1) }
+          page.data&.each(&blk)
+
           break unless page.next_page?
           page = page.next_page
         end
       end
 
+      # @api private
+      #
       # @return [String]
       def inspect
-        "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} object=#{object.inspect}>"
+        model = OpenAI::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} object=#{object.inspect}>"
       end
     end
   end

lib/openai/internal/transport/base_client.rb

@@ -460,6 +460,8 @@ def request(req)
           end
         end
 
+        # @api private
+        #
         # @return [String]
         def inspect
           # rubocop:disable Layout/LineLength

lib/openai/internal/type/array_of.rb

@@ -13,6 +13,8 @@ module Type
       class ArrayOf
         include OpenAI::Internal::Type::Converter
 
+        private_class_method :new
+
         # @param type_info [Hash{Symbol=>Object}, Proc, OpenAI::Internal::Type::Converter, Class]
         #
         # @param spec [Hash{Symbol=>Object}] .
@@ -120,7 +122,18 @@ def dump(value, state:)
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = OpenAI::Internal::Type::Converter.type_info(type_info || spec)
-          @nilable = spec[:nil?]
+          @nilable = spec.fetch(:nil?, false)
+        end
+
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          # rubocop:disable Layout/LineLength
+          "#{self.class}[#{[OpenAI::Internal::Type::Converter.inspect(item_type, depth: depth.succ), nilable? ? 'nil' : nil].compact.join(' | ')}]"
+          # rubocop:enable Layout/LineLength
         end
       end
     end

lib/openai/internal/type/base_model.rb

@@ -63,7 +63,7 @@ def fields
 
             setter = "#{name_sym}="
             api_name = info.fetch(:api_name, name_sym)
-            nilable = info[:nil?]
+            nilable = info.fetch(:nil?, false)
             const = required && !nilable ? info.fetch(:const, OpenAI::Internal::OMIT) : OpenAI::Internal::OMIT
 
             [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym)
@@ -361,14 +361,42 @@ def initialize(data = {})
           end
         end
 
+        class << self
+          # @api private
+          #
+          # @param depth [Integer]
+          #
+          # @return [String]
+          def inspect(depth: 0)
+            return super() if depth.positive?
+
+            depth = depth.succ
+            deferred = fields.transform_values do |field|
+              type, required, nilable = field.fetch_values(:type, :required, :nilable)
+              -> do
+                [
+                  OpenAI::Internal::Type::Converter.inspect(type, depth: depth),
+                  !required || nilable ? "nil" : nil
+                ].compact.join(" | ")
+              end
+                .tap { _1.define_singleton_method(:inspect) { call } }
+            end
+
+            "#{name}[#{deferred.inspect}]"
+          end
+        end
+
+        # @api private
+        #
         # @return [String]
         def inspect
-          rows = self.class.known_fields.keys.map do
-            "#{_1}=#{@data.key?(_1) ? public_send(_1) : ''}"
+          rows = @data.map do
+            "#{_1}=#{self.class.known_fields.key?(_1) ? public_send(_1).inspect : ''}"
           rescue OpenAI::Errors::ConversionError
-            "#{_1}=#{@data.fetch(_1)}"
+            "#{_1}=#{_2.inspect}"
           end
-          "#<#{self.class.name}:0x#{object_id.to_s(16)} #{rows.join(' ')}>"
+
+          "#<#{self.class}:0x#{object_id.to_s(16)} #{rows.join(' ')}>"
         end
       end
     end

lib/openai/internal/type/base_page.rb

@@ -36,6 +36,7 @@ def to_enum = super(:auto_paging_each)
         def initialize(client:, req:, headers:, page_data:)
           @client = client
           @req = req
+          @model = req.fetch(:model)
           super()
         end
 

lib/openai/internal/type/base_stream.rb

@@ -67,6 +67,15 @@ def initialize(model:, url:, status:, response:, stream:)
 
           ObjectSpace.define_finalizer(self, OpenAI::Internal::Type::BaseStream.defer_closing(@stream))
         end
+
+        # @api private
+        #
+        # @return [String]
+        def inspect
+          model = OpenAI::Internal::Type::Converter.inspect(@model, depth: 1)
+
+          "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+        end
       end
     end
   end

lib/openai/internal/type/boolean.rb

@@ -11,6 +11,8 @@ module Type
       class Boolean
         extend OpenAI::Internal::Type::Converter
 
+        private_class_method :new
+
         # @param other [Object]
         #
         # @return [Boolean]

lib/openai/internal/type/converter.rb

@@ -49,6 +49,15 @@ def dump(value, state:)
           end
         end
 
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          super()
+        end
+
         # rubocop:enable Lint/UnusedMethodArgument
 
         class << self
@@ -240,6 +249,21 @@ def dump(target, value, state: {can_retry: true})
               OpenAI::Internal::Type::Unknown.dump(value, state: state)
             end
           end
+
+          # @api private
+          #
+          # @param target [Object]
+          # @param depth [Integer]
+          #
+          # @return [String]
+          def inspect(target, depth:)
+            case target
+            in OpenAI::Internal::Type::Converter
+              target.inspect(depth: depth.succ)
+            else
+              target.inspect
+            end
+          end
         end
       end
     end