Skip to content

chore: more accurate type annotations for SDK internals #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 31, 2025
Merged

chore: more accurate type annotations for SDK internals #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions rbi/lib/openai/type/array_of.rbi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ module OpenAI
abstract!
final!

Elem = type_member(:out)

sig(:final) do
params(
type_info: T.any(
Expand All @@ -36,7 +38,7 @@ module OpenAI
# @api private
sig(:final) do
override
.params(value: T.any(T::Enumerable[T.anything], T.anything), state: OpenAI::Type::Converter::State)
.params(value: T.any(T::Enumerable[Elem], T.anything), state: OpenAI::Type::Converter::State)
.returns(T.any(T::Array[T.anything], T.anything))
end
def coerce(value, state:)
Expand All @@ -45,14 +47,14 @@ module OpenAI
# @api private
sig(:final) do
override
.params(value: T.any(T::Enumerable[T.anything], T.anything))
.params(value: T.any(T::Enumerable[Elem], T.anything))
.returns(T.any(T::Array[T.anything], T.anything))
end
def dump(value)
end

# @api private
sig(:final) { returns(T.anything) }
sig(:final) { returns(Elem) }
protected def item_type
end

Expand Down
4 changes: 3 additions & 1 deletion rbi/lib/openai/type/hash_of.rbi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ module OpenAI
abstract!
final!

Elem = type_member(:out)

sig(:final) do
params(
type_info: T.any(
Expand Down Expand Up @@ -56,7 +58,7 @@ module OpenAI
end

# @api private
sig(:final) { returns(T.anything) }
sig(:final) { returns(Elem) }
protected def item_type
end

Expand Down
8 changes: 4 additions & 4 deletions sig/openai/type/array_of.rbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module OpenAI
module Type
class ArrayOf
class ArrayOf[Elem]
include OpenAI::Type::Converter

def self.[]: (
Expand All @@ -15,13 +15,13 @@ module OpenAI
def ==: (top other) -> bool

def coerce: (
Enumerable[top] | top value,
Enumerable[Elem] | top value,
state: OpenAI::Type::Converter::state
) -> (::Array[top] | top)

def dump: (Enumerable[top] | top value) -> (::Array[top] | top)
def dump: (Enumerable[Elem] | top value) -> (::Array[top] | top)

def item_type: -> top
def item_type: -> Elem

def nilable?: -> bool

Expand Down
4 changes: 2 additions & 2 deletions sig/openai/type/hash_of.rbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module OpenAI
module Type
class HashOf
class HashOf[Elem]
include OpenAI::Type::Converter

def self.[]: (
Expand All @@ -21,7 +21,7 @@ module OpenAI

def dump: (::Hash[top, top] | top value) -> (::Hash[Symbol, top] | top)

def item_type: -> top
def item_type: -> Elem

def nilable?: -> bool

Expand Down