Fix object variables by barbieri · Pull Request #266 · profusion/sgqlc

barbieri · 2026-02-06T17:27:41Z

Fixes issue reported in Endpoint throws TypeError of JSON encoding, using mutation with input types. #264
uniform Content-Type and Content-Length headers
add AI AGENTS.md

Set of guidelines for AI agents to help with SGQLC tasks.

…oints This ensures "; charset=utf-8" is sent in the type, while all endpoints provides the length (ensure the value is a string).

coveralls · 2026-02-06T17:29:47Z

Pull Request Test Coverage Report for Build 21763540462

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 100.0%

Totals
Change from base Build 21751223884:	0.0%
Covered Lines:	1695
Relevant Lines:	1695

💛 - Coveralls

Copilot

Pull request overview

This PR addresses #264 by ensuring sgqlc.types.Input instances can be passed as GraphQL variables without raising JSON serialization errors, while also standardizing request headers and adding contributor guidance for AI-assisted work.

Changes:

Add a custom JSONEncoder to serialize Input values via __json_data__, and use it for POST payloads (and websocket messages).
Standardize Content-Type (incl. charset) and Content-Length headers for POST requests.
Add/adjust endpoint tests to cover Input serialization and TypeError behavior for unsupported objects; add AGENTS.md.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`sgqlc/endpoint/base.py`	Introduces `JSONEncoder` to serialize `Input` objects.
`sgqlc/endpoint/http.py`	Uses `JSONEncoder` for POST body; standardizes `Content-Length`.
`sgqlc/endpoint/requests.py`	Uses `JSONEncoder` for POST body; standardizes `Content-Length`.
`sgqlc/endpoint/httpx.py`	Switches to manual JSON encoding for POST using `JSONEncoder`; standardizes headers.
`sgqlc/endpoint/websocket.py`	Uses `JSONEncoder` when sending websocket init/query frames.
`tests/test-endpoint-http.py`	Updates variable assertions to accommodate `Input` serialization; adds new `Input`/bogus-type tests.
`tests/test-endpoint-requests.py`	Same as above for Requests endpoint.
`tests/test-endpoint-httpx.py`	Updates POST header expectation; adds `Input`/bogus-type tests.
`tests/test-endpoint-websocket.py`	Adds websocket test coverage for `Input` variables serialization and bogus types.
`AGENTS.md`	Adds repo guidance for AI agents, tooling, and testing expectations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-06T17:34:10Z

+    >>> from sgqlc.types import Input
+    >>> class MyInput(Input):
+    ...     a_field = str
+    ...
+    >>> value = MyInput(a_field='test')


The doctest example defines MyInput(Input) without an explicit schema and with a very generic type name. Since the project runs --doctest-modules, this is likely to collide with existing doctests (e.g. sgqlc.types already defines MyInput) and can fail with “schema already has MyInput”, plus it pollutes global_schema for subsequent tests. Use a unique input name and/or bind the example type to a fresh Schema() via __schema__ (and remove any existing type from that schema) so the doctest is isolated.

Suggested change

>>> from sgqlc.types import Input

>>> class MyInput(Input):

... a_field = str

...

>>> value = MyInput(a_field='test')

>>> from sgqlc.types import Input, Schema

>>> example_schema = Schema()

>>> class JSONEncoderExampleInput(Input):

... __schema__ = example_schema

... a_field = str

...

>>> value = JSONEncoderExampleInput(a_field='test')

Copilot · 2026-02-06T17:34:11Z

+from .base import BaseEndpoint, JSONEncoder, add_query_to_url



This file now uses JSONEncoder for POST serialization, but the GET path (get_http_get_request()) still calls json.dumps(variables) without cls=JSONEncoder, so Input variables will still fail with TypeError for method='GET'. Please update GET serialization to use the same encoder.

Copilot · 2026-02-06T17:34:11Z

+from .base import BaseEndpoint, JSONEncoder, add_query_to_url



This file now uses JSONEncoder for POST serialization, but the GET path (get_http_get_request()) still calls json.dumps(variables) without cls=JSONEncoder, so Input variables will still fail with TypeError for method='GET'. Please update GET serialization to use the same encoder.

Copilot · 2026-02-06T17:34:11Z

+    # Convert Input types to their JSON representation for comparison
+    expected = {}
+    for k, v in variables.items():
+        if hasattr(v, '__json_data__'):
+            expected[k] = v.__json_data__
+        else:
+            expected[k] = v


check_request_variables() only converts Input instances at the top level of the variables dict. If variables contain nested Input objects (inside dicts/lists), this helper will assert against the wrong expected value even if serialization is correct. Consider deriving expected via a round-trip using the same JSONEncoder (or a recursive conversion) so comparisons match real serialization semantics.

Suggested change

# Convert Input types to their JSON representation for comparison

expected = {}

for k, v in variables.items():

if hasattr(v, '__json_data__'):

expected[k] = v.__json_data__

else:

expected[k] = v

# Convert Input types (including nested ones) to their JSON representation for comparison

def _convert_inputs_to_json_data(value):

# If the object knows how to represent itself as JSON data, use that

if hasattr(value, '__json_data__'):

return value.__json_data__

# Recurse into mappings

if isinstance(value, dict):

return {k: _convert_inputs_to_json_data(v) for k, v in value.items()}

# Recurse into sequences

if isinstance(value, (list, tuple)):

return [_convert_inputs_to_json_data(v) for v in value]

# Primitive or unknown types are returned as-is

return value

expected = _convert_inputs_to_json_data(variables)

Copilot · 2026-02-06T17:34:12Z

+    # Convert Input types to their JSON representation for comparison
+    expected = {}
+    for k, v in variables.items():
+        if hasattr(v, '__json_data__'):
+            expected[k] = v.__json_data__


check_request_variables() only converts Input instances at the top level of the variables dict. If variables contain nested Input objects (inside dicts/lists), this helper will assert against the wrong expected value even if serialization is correct. Consider deriving expected via a round-trip using the same JSONEncoder (or a recursive conversion) so comparisons match real serialization semantics.

Copilot · 2026-02-06T17:34:12Z

+    # Convert Input types to their JSON representation for comparison
+    expected = {}
+    for k, v in variables.items():
+        if hasattr(v, '__json_data__'):
+            expected[k] = v.__json_data__


check_request_variables() only converts Input instances at the top level of the variables dict. If variables contain nested Input objects (inside dicts/lists), this helper will assert against the wrong expected value even if serialization is correct. Consider deriving expected via a round-trip using the same JSONEncoder (or a recursive conversion) so comparisons match real serialization semantics.

Copilot · 2026-02-06T17:34:12Z

+def test_variables_with_input_type(respx_mock):
+    'Test if variables with sgqlc.types.Input are properly serialized'
+    from sgqlc.types import Input
+


There is test coverage for POST requests with Input variables, but no equivalent test for method='GET'. Since GET uses a different serialization path, adding a GET variant here would prevent regressions and would catch cases where GET still uses plain json.dumps() without the custom encoder.

Copilot · 2026-02-06T17:34:12Z

+        post_data = json.dumps(
+            {
                'query': query,
                'variables': variables,
                'operationName': operation_name,


POST serialization now uses JSONEncoder, but get_http_get_request() still does json.dumps(variables) without cls=JSONEncoder. As a result, HTTPXEndpoint(..., method='GET') will still raise TypeError when variables contain sgqlc.types.Input. Please update the GET serialization path to use the same encoder for consistent behavior across methods.

great catch 🤖

`json.dumps()` on such type raises `TypeError`, we must use a custom encoder to use `__json_data__` for such cases. AI: this PR was partially made with GitHub Copilot Closes: #264

barbieri added 2 commits February 6, 2026 14:25

add AGENTS.md

7a9b0a9

Set of guidelines for AI agents to help with SGQLC tasks.

make HTTP headers Content-Length and Content-Type uniform across endp…

5a69c61

…oints This ensures "; charset=utf-8" is sent in the type, while all endpoints provides the length (ensure the value is a string).

barbieri requested a review from Copilot February 6, 2026 17:27

Copilot started reviewing on behalf of barbieri February 6, 2026 17:28 View session

Copilot AI reviewed Feb 6, 2026

View reviewed changes

allow variables values to be instance of sgqlc.types.Input

d8475c9

`json.dumps()` on such type raises `TypeError`, we must use a custom encoder to use `__json_data__` for such cases. AI: this PR was partially made with GitHub Copilot Closes: #264

barbieri force-pushed the fix-object-variables branch from 829b52a to d8475c9 Compare February 6, 2026 19:41

barbieri merged commit d8475c9 into master Feb 6, 2026
6 checks passed

barbieri deleted the fix-object-variables branch February 6, 2026 19:50

Navigation Menu

Uh oh!

Fix object variables - #266

Fix object variables#266
barbieri merged 3 commits into
masterfrom
fix-object-variables

barbieri commented Feb 6, 2026

Uh oh!

coveralls commented Feb 6, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

barbieri Feb 6, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		from .base import BaseEndpoint, JSONEncoder, add_query_to_url

-    # Convert Input types to their JSON representation for comparison
-    expected = {}
-    for k, v in variables.items():
-        if hasattr(v, '__json_data__'):
-            expected[k] = v.__json_data__
-        else:
-            expected[k] = v
+    # Convert Input types (including nested ones) to their JSON representation for comparison
+    def _convert_inputs_to_json_data(value):
+        # If the object knows how to represent itself as JSON data, use that
+        if hasattr(value, '__json_data__'):
+            return value.__json_data__
+        # Recurse into mappings
+        if isinstance(value, dict):
+            return {k: _convert_inputs_to_json_data(v) for k, v in value.items()}
+        # Recurse into sequences
+        if isinstance(value, (list, tuple)):
+            return [_convert_inputs_to_json_data(v) for v in value]
+        # Primitive or unknown types are returned as-is
+        return value
+    expected = _convert_inputs_to_json_data(variables)

Uh oh!

Conversation

barbieri commented Feb 6, 2026

Uh oh!

coveralls commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 21763540462

Details

💛 - Coveralls

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

barbieri Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coveralls commented Feb 6, 2026 •

edited

Loading