From 00d435ab07f9409d196a551050e8ed5e510d888c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 16 Mar 2025 14:29:22 +0000 Subject: [PATCH] chore: do not label modules as abstract --- .rubocop.yml | 5 +++++ lib/openai/base_model.rb | 2 -- lib/openai/base_page.rb | 2 -- lib/openai/extern.rb | 2 -- lib/openai/request_options.rb | 2 -- rbi/lib/openai/base_client.rbi | 1 + rbi/lib/openai/base_model.rbi | 13 +++++++++++-- rbi/lib/openai/base_page.rbi | 2 -- rbi/lib/openai/extern.rbi | 1 - rbi/lib/openai/pooled_net_requester.rbi | 1 + rbi/lib/openai/request_options.rbi | 2 -- rbi/lib/openai/util.rbi | 2 ++ 12 files changed, 20 insertions(+), 15 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 17e6abbd..e0a360b6 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -58,6 +58,11 @@ Layout/MultilineMethodParameterLineBreaks: Layout/SpaceInsideHashLiteralBraces: EnforcedStyle: no_space +# This option occasionally mangles identifier names +Lint/DeprecatedConstants: + Exclude: + - "**/*.rbi" + # Fairly useful in tests for pattern assertions. Lint/EmptyInPattern: Exclude: diff --git a/lib/openai/base_model.rb b/lib/openai/base_model.rb index 19722030..4ef0106e 100644 --- a/lib/openai/base_model.rb +++ b/lib/openai/base_model.rb @@ -2,8 +2,6 @@ module OpenAI # @api private - # - # @abstract module Converter # rubocop:disable Lint/UnusedMethodArgument diff --git a/lib/openai/base_page.rb b/lib/openai/base_page.rb index c7489dfe..c8a9058a 100644 --- a/lib/openai/base_page.rb +++ b/lib/openai/base_page.rb @@ -1,8 +1,6 @@ # frozen_string_literal: true module OpenAI - # @abstract - # # @example # ```ruby # if page.has_next? diff --git a/lib/openai/extern.rb b/lib/openai/extern.rb index c8e115d3..1ab41492 100644 --- a/lib/openai/extern.rb +++ b/lib/openai/extern.rb @@ -2,8 +2,6 @@ module OpenAI # @api private - # - # @abstract module Extern end end diff --git a/lib/openai/request_options.rb b/lib/openai/request_options.rb index 405cf3c3..a3245591 100644 --- a/lib/openai/request_options.rb +++ b/lib/openai/request_options.rb @@ -2,8 +2,6 @@ module OpenAI # @api private - # - # @abstract module RequestParameters # @!parse # # Options to specify HTTP behaviour for this request. diff --git a/rbi/lib/openai/base_client.rbi b/rbi/lib/openai/base_client.rbi index 6b76b254..e4208ab7 100644 --- a/rbi/lib/openai/base_client.rbi +++ b/rbi/lib/openai/base_client.rbi @@ -1,6 +1,7 @@ # typed: strong module OpenAI + # @api private class BaseClient abstract! diff --git a/rbi/lib/openai/base_model.rbi b/rbi/lib/openai/base_model.rbi index 06bae256..8840d3a8 100644 --- a/rbi/lib/openai/base_model.rbi +++ b/rbi/lib/openai/base_model.rbi @@ -3,8 +3,6 @@ module OpenAI # @api private module Converter - abstract! - Input = T.type_alias { T.any(OpenAI::Converter, T::Class[T.anything]) } # @api private @@ -78,6 +76,8 @@ module OpenAI end end + # @api private + # # When we don't know what to expect for the value. class Unknown extend OpenAI::Converter @@ -115,6 +115,8 @@ module OpenAI end end + # @api private + # # Ruby has no Boolean class; this is something for models to refer to. class BooleanModel extend OpenAI::Converter @@ -156,6 +158,8 @@ module OpenAI end end + # @api private + # # A value from among a specified list of options. OpenAPI enum values map to Ruby # values in the SDK as follows: # @@ -217,6 +221,7 @@ module OpenAI end end + # @api private class Union extend OpenAI::Converter @@ -294,6 +299,8 @@ module OpenAI end end + # @api private + # # Array of items of a given type. class ArrayOf include OpenAI::Converter @@ -359,6 +366,8 @@ module OpenAI end end + # @api private + # # Hash of items of a given type. class HashOf include OpenAI::Converter diff --git a/rbi/lib/openai/base_page.rbi b/rbi/lib/openai/base_page.rbi index ad3a2e19..c5dc2a2d 100644 --- a/rbi/lib/openai/base_page.rbi +++ b/rbi/lib/openai/base_page.rbi @@ -2,8 +2,6 @@ module OpenAI module BasePage - abstract! - Elem = type_member(:out) sig { overridable.returns(T::Boolean) } diff --git a/rbi/lib/openai/extern.rbi b/rbi/lib/openai/extern.rbi index b47bd767..e5e18a8d 100644 --- a/rbi/lib/openai/extern.rbi +++ b/rbi/lib/openai/extern.rbi @@ -3,6 +3,5 @@ module OpenAI # @api private module Extern - abstract! end end diff --git a/rbi/lib/openai/pooled_net_requester.rbi b/rbi/lib/openai/pooled_net_requester.rbi index 9297bdea..2cdf7b6b 100644 --- a/rbi/lib/openai/pooled_net_requester.rbi +++ b/rbi/lib/openai/pooled_net_requester.rbi @@ -1,6 +1,7 @@ # typed: strong module OpenAI + # @api private class PooledNetRequester RequestShape = T.type_alias do {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float} diff --git a/rbi/lib/openai/request_options.rbi b/rbi/lib/openai/request_options.rbi index efd2de36..ded742c2 100644 --- a/rbi/lib/openai/request_options.rbi +++ b/rbi/lib/openai/request_options.rbi @@ -3,8 +3,6 @@ module OpenAI # @api private module RequestParameters - abstract! - # Options to specify HTTP behaviour for this request. sig { returns(T.any(OpenAI::RequestOptions, T::Hash[Symbol, T.anything])) } def request_options diff --git a/rbi/lib/openai/util.rbi b/rbi/lib/openai/util.rbi index 22824de5..fe12b3ff 100644 --- a/rbi/lib/openai/util.rbi +++ b/rbi/lib/openai/util.rbi @@ -160,6 +160,8 @@ module OpenAI end end + # @api private + # # An adapter that satisfies the IO interface required by `::IO.copy_stream` class ReadIOAdapter # @api private