fix(parsing): don't default to an empty array (#2106)

RobertCraigie · web-flow · commit 8e748bb08d9c · 2025-02-10T18:08:55.000Z
diff --git a/src/openai/lib/_parsing/_completions.py b/src/openai/lib/_parsing/_completions.py
@@ -111,7 +111,7 @@ def parse_chat_completion(
                             response_format=response_format,
                             message=message,
                         ),
-                        "tool_calls": tool_calls,
+                        "tool_calls": tool_calls if tool_calls else None,
                     },
                 },
             )
diff --git a/tests/lib/chat/test_completions.py b/tests/lib/chat/test_completions.py
@@ -65,7 +65,7 @@ def test_parse_nothing(client: OpenAI, respx_mock: MockRouter, monkeypatch: pyte
                 parsed=None,
                 refusal=None,
                 role='assistant',
-                tool_calls=[]
+                tool_calls=None
             )
         )
     ],
@@ -132,7 +132,7 @@ class Location(BaseModel):
                 parsed=Location(city='San Francisco', temperature=65.0, units='f'),
                 refusal=None,
                 role='assistant',
-                tool_calls=[]
+                tool_calls=None
             )
         )
     ],
@@ -201,7 +201,7 @@ class Location(BaseModel):
                 parsed=Location(city='San Francisco', temperature=65.0, units='f'),
                 refusal=None,
                 role='assistant',
-                tool_calls=[]
+                tool_calls=None
             )
         )
     ],
@@ -272,7 +272,7 @@ class ColorDetection(BaseModel):
         parsed=ColorDetection(color=<Color.RED: 'red'>, hex_color_code='#FF0000'),
         refusal=None,
         role='assistant',
-        tool_calls=[]
+        tool_calls=None
     )
 )
 """
@@ -321,7 +321,7 @@ class Location(BaseModel):
             parsed=Location(city='San Francisco', temperature=64.0, units='f'),
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     ),
     ParsedChoice[Location](
@@ -335,7 +335,7 @@ class Location(BaseModel):
             parsed=Location(city='San Francisco', temperature=65.0, units='f'),
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     ),
     ParsedChoice[Location](
@@ -349,7 +349,7 @@ class Location(BaseModel):
             parsed=Location(city='San Francisco', temperature=63.0, units='f'),
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     )
 ]
@@ -399,7 +399,7 @@ class CalendarEvent:
                 parsed=CalendarEvent(name='Science Fair', date='Friday', participants=['Alice', 'Bob']),
                 refusal=None,
                 role='assistant',
-                tool_calls=[]
+                tool_calls=None
             )
         )
     ],
@@ -571,7 +571,7 @@ class Location(BaseModel):
             parsed=None,
             refusal="I'm very sorry, but I can't assist with that.",
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     )
 ]
@@ -855,7 +855,7 @@ class Location(BaseModel):
                 parsed=Location(city='San Francisco', temperature=58.0, units='f'),
                 refusal=None,
                 role='assistant',
-                tool_calls=[]
+                tool_calls=None
             )
         )
     ],
@@ -930,7 +930,7 @@ class Location(BaseModel):
                 parsed=Location(city='San Francisco', temperature=65.0, units='f'),
                 refusal=None,
                 role='assistant',
-                tool_calls=[]
+                tool_calls=None
             )
         )
     ],
diff --git a/tests/lib/chat/test_completions_streaming.py b/tests/lib/chat/test_completions_streaming.py
@@ -70,7 +70,7 @@ def test_parse_nothing(client: OpenAI, respx_mock: MockRouter, monkeypatch: pyte
             parsed=None,
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     )
 ]
@@ -147,7 +147,7 @@ def on_event(stream: ChatCompletionStream[Location], event: ChatCompletionStream
                 parsed=Location(city='San Francisco', temperature=61.0, units='f'),
                 refusal=None,
                 role='assistant',
-                tool_calls=[]
+                tool_calls=None
             )
         )
     ],
@@ -324,7 +324,7 @@ class Location(BaseModel):
             parsed=Location(city='San Francisco', temperature=65.0, units='f'),
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     ),
     ParsedChoice[Location](
@@ -338,7 +338,7 @@ class Location(BaseModel):
             parsed=Location(city='San Francisco', temperature=61.0, units='f'),
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     ),
     ParsedChoice[Location](
@@ -352,7 +352,7 @@ class Location(BaseModel):
             parsed=Location(city='San Francisco', temperature=59.0, units='f'),
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     )
 ]
@@ -427,7 +427,7 @@ class Location(BaseModel):
             parsed=None,
             refusal="I'm sorry, I can't assist with that request.",
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     )
 ]
@@ -501,7 +501,7 @@ def test_content_logprobs_events(client: OpenAI, respx_mock: MockRouter, monkeyp
             parsed=None,
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     )
 ]
@@ -612,7 +612,7 @@ class Location(BaseModel):
             parsed=None,
             refusal="I'm very sorry, but I can't assist with that.",
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     )
 ]
@@ -925,7 +925,7 @@ def test_non_pydantic_response_format(client: OpenAI, respx_mock: MockRouter, mo
             parsed=None,
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     )
 ]
@@ -1040,7 +1040,7 @@ def streamer(client: OpenAI) -> Iterator[ChatCompletionChunk]:
             parsed=None,
             refusal=None,
             role='assistant',
-            tool_calls=[]
+            tool_calls=None
         )
     )
 ]

Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ def parse_chat_completion(`
`111`	`111`	`response_format=response_format,`
`112`	`112`	`message=message,`
`113`	`113`	`),`
`114`		`- "tool_calls": tool_calls,`
	`114`	`+ "tool_calls": tool_calls if tool_calls else None,`
`115`	`115`	`},`
`116`	`116`	`},`
`117`	`117`	`)`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ def test_parse_nothing(client: OpenAI, respx_mock: MockRouter, monkeypatch: pyte`
`65`	`65`	`parsed=None,`
`66`	`66`	`refusal=None,`
`67`	`67`	`role='assistant',`
`68`		`- tool_calls=[]`
	`68`	`+ tool_calls=None`
`69`	`69`	`)`
`70`	`70`	`)`
`71`	`71`	`],`
`@@ -132,7 +132,7 @@ class Location(BaseModel):`
`132`	`132`	`parsed=Location(city='San Francisco', temperature=65.0, units='f'),`
`133`	`133`	`refusal=None,`
`134`	`134`	`role='assistant',`
`135`		`- tool_calls=[]`
	`135`	`+ tool_calls=None`
`136`	`136`	`)`
`137`	`137`	`)`
`138`	`138`	`],`
`@@ -201,7 +201,7 @@ class Location(BaseModel):`
`201`	`201`	`parsed=Location(city='San Francisco', temperature=65.0, units='f'),`
`202`	`202`	`refusal=None,`
`203`	`203`	`role='assistant',`
`204`		`- tool_calls=[]`
	`204`	`+ tool_calls=None`
`205`	`205`	`)`
`206`	`206`	`)`
`207`	`207`	`],`
`@@ -272,7 +272,7 @@ class ColorDetection(BaseModel):`
`272`	`272`	`parsed=ColorDetection(color=<Color.RED: 'red'>, hex_color_code='#FF0000'),`
`273`	`273`	`refusal=None,`
`274`	`274`	`role='assistant',`
`275`		`- tool_calls=[]`
	`275`	`+ tool_calls=None`
`276`	`276`	`)`
`277`	`277`	`)`
`278`	`278`	`"""`
`@@ -321,7 +321,7 @@ class Location(BaseModel):`
`321`	`321`	`parsed=Location(city='San Francisco', temperature=64.0, units='f'),`
`322`	`322`	`refusal=None,`
`323`	`323`	`role='assistant',`
`324`		`- tool_calls=[]`
	`324`	`+ tool_calls=None`
`325`	`325`	`)`
`326`	`326`	`),`
`327`	`327`	`ParsedChoice[Location](`
`@@ -335,7 +335,7 @@ class Location(BaseModel):`
`335`	`335`	`parsed=Location(city='San Francisco', temperature=65.0, units='f'),`
`336`	`336`	`refusal=None,`
`337`	`337`	`role='assistant',`
`338`		`- tool_calls=[]`
	`338`	`+ tool_calls=None`
`339`	`339`	`)`
`340`	`340`	`),`
`341`	`341`	`ParsedChoice[Location](`
`@@ -349,7 +349,7 @@ class Location(BaseModel):`
`349`	`349`	`parsed=Location(city='San Francisco', temperature=63.0, units='f'),`
`350`	`350`	`refusal=None,`
`351`	`351`	`role='assistant',`
`352`		`- tool_calls=[]`
	`352`	`+ tool_calls=None`
`353`	`353`	`)`
`354`	`354`	`)`
`355`	`355`	`]`
`@@ -399,7 +399,7 @@ class CalendarEvent:`
`399`	`399`	`parsed=CalendarEvent(name='Science Fair', date='Friday', participants=['Alice', 'Bob']),`
`400`	`400`	`refusal=None,`
`401`	`401`	`role='assistant',`
`402`		`- tool_calls=[]`
	`402`	`+ tool_calls=None`
`403`	`403`	`)`
`404`	`404`	`)`
`405`	`405`	`],`
`@@ -571,7 +571,7 @@ class Location(BaseModel):`
`571`	`571`	`parsed=None,`
`572`	`572`	`refusal="I'm very sorry, but I can't assist with that.",`
`573`	`573`	`role='assistant',`
`574`		`- tool_calls=[]`
	`574`	`+ tool_calls=None`
`575`	`575`	`)`
`576`	`576`	`)`
`577`	`577`	`]`
`@@ -855,7 +855,7 @@ class Location(BaseModel):`
`855`	`855`	`parsed=Location(city='San Francisco', temperature=58.0, units='f'),`
`856`	`856`	`refusal=None,`
`857`	`857`	`role='assistant',`
`858`		`- tool_calls=[]`
	`858`	`+ tool_calls=None`
`859`	`859`	`)`
`860`	`860`	`)`
`861`	`861`	`],`
`@@ -930,7 +930,7 @@ class Location(BaseModel):`
`930`	`930`	`parsed=Location(city='San Francisco', temperature=65.0, units='f'),`
`931`	`931`	`refusal=None,`
`932`	`932`	`role='assistant',`
`933`		`- tool_calls=[]`
	`933`	`+ tool_calls=None`
`934`	`934`	`)`
`935`	`935`	`)`
`936`	`936`	`],`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ def test_parse_nothing(client: OpenAI, respx_mock: MockRouter, monkeypatch: pyte`
`70`	`70`	`parsed=None,`
`71`	`71`	`refusal=None,`
`72`	`72`	`role='assistant',`
`73`		`- tool_calls=[]`
	`73`	`+ tool_calls=None`
`74`	`74`	`)`
`75`	`75`	`)`
`76`	`76`	`]`
`@@ -147,7 +147,7 @@ def on_event(stream: ChatCompletionStream[Location], event: ChatCompletionStream`
`147`	`147`	`parsed=Location(city='San Francisco', temperature=61.0, units='f'),`
`148`	`148`	`refusal=None,`
`149`	`149`	`role='assistant',`
`150`		`- tool_calls=[]`
	`150`	`+ tool_calls=None`
`151`	`151`	`)`
`152`	`152`	`)`
`153`	`153`	`],`
`@@ -324,7 +324,7 @@ class Location(BaseModel):`
`324`	`324`	`parsed=Location(city='San Francisco', temperature=65.0, units='f'),`
`325`	`325`	`refusal=None,`
`326`	`326`	`role='assistant',`
`327`		`- tool_calls=[]`
	`327`	`+ tool_calls=None`
`328`	`328`	`)`
`329`	`329`	`),`
`330`	`330`	`ParsedChoice[Location](`
`@@ -338,7 +338,7 @@ class Location(BaseModel):`
`338`	`338`	`parsed=Location(city='San Francisco', temperature=61.0, units='f'),`
`339`	`339`	`refusal=None,`
`340`	`340`	`role='assistant',`
`341`		`- tool_calls=[]`
	`341`	`+ tool_calls=None`
`342`	`342`	`)`
`343`	`343`	`),`
`344`	`344`	`ParsedChoice[Location](`
`@@ -352,7 +352,7 @@ class Location(BaseModel):`
`352`	`352`	`parsed=Location(city='San Francisco', temperature=59.0, units='f'),`
`353`	`353`	`refusal=None,`
`354`	`354`	`role='assistant',`
`355`		`- tool_calls=[]`
	`355`	`+ tool_calls=None`
`356`	`356`	`)`
`357`	`357`	`)`
`358`	`358`	`]`
`@@ -427,7 +427,7 @@ class Location(BaseModel):`
`427`	`427`	`parsed=None,`
`428`	`428`	`refusal="I'm sorry, I can't assist with that request.",`
`429`	`429`	`role='assistant',`
`430`		`- tool_calls=[]`
	`430`	`+ tool_calls=None`
`431`	`431`	`)`
`432`	`432`	`)`
`433`	`433`	`]`
`@@ -501,7 +501,7 @@ def test_content_logprobs_events(client: OpenAI, respx_mock: MockRouter, monkeyp`
`501`	`501`	`parsed=None,`
`502`	`502`	`refusal=None,`
`503`	`503`	`role='assistant',`
`504`		`- tool_calls=[]`
	`504`	`+ tool_calls=None`
`505`	`505`	`)`
`506`	`506`	`)`
`507`	`507`	`]`
`@@ -612,7 +612,7 @@ class Location(BaseModel):`
`612`	`612`	`parsed=None,`
`613`	`613`	`refusal="I'm very sorry, but I can't assist with that.",`
`614`	`614`	`role='assistant',`
`615`		`- tool_calls=[]`
	`615`	`+ tool_calls=None`
`616`	`616`	`)`
`617`	`617`	`)`
`618`	`618`	`]`
`@@ -925,7 +925,7 @@ def test_non_pydantic_response_format(client: OpenAI, respx_mock: MockRouter, mo`
`925`	`925`	`parsed=None,`
`926`	`926`	`refusal=None,`
`927`	`927`	`role='assistant',`
`928`		`- tool_calls=[]`
	`928`	`+ tool_calls=None`
`929`	`929`	`)`
`930`	`930`	`)`
`931`	`931`	`]`
`@@ -1040,7 +1040,7 @@ def streamer(client: OpenAI) -> Iterator[ChatCompletionChunk]:`
`1040`	`1040`	`parsed=None,`
`1041`	`1041`	`refusal=None,`
`1042`	`1042`	`role='assistant',`
`1043`		`- tool_calls=[]`
	`1043`	`+ tool_calls=None`
`1044`	`1044`	`)`
`1045`	`1045`	`)`
`1046`	`1046`	`]`