graphql-api 1.6.5__tar.gz → 1.6.7__tar.gz

graphql_api-1.6.7/AGENTS.md

@@ -0,0 +1,46 @@
+# GraphQL-API
+
+> Compatibility note: `AGENTS.md` and `CLAUDE.md` are both supported in this repo.
+> Keep these files identical. Any change in one must be mirrored in the other.
+
+Code-first, decorator-based GraphQL framework for Python. Published on [PyPI](https://pypi.org/project/graphql-api/).
+
+## Project Structure
+
+| Directory | Description |
+|-----------|-------------|
+| `graphql_api/` | Main package source |
+| `tests/` | Test suite (34 files, pytest) |
+| `docs/` | Sphinx documentation |
+
+## Development
+
+```bash
+# Install dependencies
+uv sync
+
+# Run tests
+uv run pytest
+
+# Run linter
+uv run flake8 graphql_api tests
+```
+
+## Key Patterns
+
+- **Automatic snake_case to camelCase**: All Python field names, arguments, and dataclass/Pydantic fields are auto-converted to camelCase in GraphQL. Input arguments are converted back to snake_case. Conversion lives in `graphql_api/utils.py` (`to_camel_case()`, `to_snake_case()`)
+- `@field` marks a method as a query; `@field(mutable=True)` makes it a mutation; `AsyncGenerator` return type or `subscription=True` makes it a subscription
+- Python types auto-map: `str`→String, `int`→Int, `bool`→Boolean, `float`→Float, `UUID`→UUID scalar, `datetime`→DateTime, `Optional[T]`→nullable, `List[T]`→list, dataclasses/Pydantic models→object types, enums→enum types
+- Schema setup: `GraphQLAPI(query_type=Q, mutation_type=M, subscription_type=S)` or legacy `root_type=Root`
+
+## Releasing
+
+See the ecosystem-level `CLAUDE.md` in the parent workspace for the full release process. In short:
+
+```bash
+# Ensure CI is green on main, then:
+git tag X.Y.Z
+git push origin X.Y.Z
+```
+
+CI publishes to PyPI and creates a GitHub Release automatically.

graphql_api-1.6.7/CLAUDE.md

@@ -0,0 +1,46 @@
+# GraphQL-API
+
+> Compatibility note: `AGENTS.md` and `CLAUDE.md` are both supported in this repo.
+> Keep these files identical. Any change in one must be mirrored in the other.
+
+Code-first, decorator-based GraphQL framework for Python. Published on [PyPI](https://pypi.org/project/graphql-api/).
+
+## Project Structure
+
+| Directory | Description |
+|-----------|-------------|
+| `graphql_api/` | Main package source |
+| `tests/` | Test suite (34 files, pytest) |
+| `docs/` | Sphinx documentation |
+
+## Development
+
+```bash
+# Install dependencies
+uv sync
+
+# Run tests
+uv run pytest
+
+# Run linter
+uv run flake8 graphql_api tests
+```
+
+## Key Patterns
+
+- **Automatic snake_case to camelCase**: All Python field names, arguments, and dataclass/Pydantic fields are auto-converted to camelCase in GraphQL. Input arguments are converted back to snake_case. Conversion lives in `graphql_api/utils.py` (`to_camel_case()`, `to_snake_case()`)
+- `@field` marks a method as a query; `@field(mutable=True)` makes it a mutation; `AsyncGenerator` return type or `subscription=True` makes it a subscription
+- Python types auto-map: `str`→String, `int`→Int, `bool`→Boolean, `float`→Float, `UUID`→UUID scalar, `datetime`→DateTime, `Optional[T]`→nullable, `List[T]`→list, dataclasses/Pydantic models→object types, enums→enum types
+- Schema setup: `GraphQLAPI(query_type=Q, mutation_type=M, subscription_type=S)` or legacy `root_type=Root`
+
+## Releasing
+
+See the ecosystem-level `CLAUDE.md` in the parent workspace for the full release process. In short:
+
+```bash
+# Ensure CI is green on main, then:
+git tag X.Y.Z
+git push origin X.Y.Z
+```
+
+CI publishes to PyPI and creates a GitHub Release automatically.

{graphql_api-1.6.5 → graphql_api-1.6.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graphql-api
-Version: 1.6.5
+Version: 1.6.7
 Summary: A framework for building Python GraphQL APIs.
 Author-email: Robert Parker <rob@parob.com>
 License: MIT
@@ -28,10 +28,8 @@ Dynamic: license-file
 [![PyPI version](https://badge.fury.io/py/graphql-api.svg)](https://badge.fury.io/py/graphql-api)
 [![Python versions](https://img.shields.io/pypi/pyversions/graphql-api.svg)](https://pypi.org/project/graphql-api/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Coverage](https://gitlab.com/parob/graphql-api/badges/master/coverage.svg)](https://gitlab.com/parob/graphql-api/commits/master)
-[![Pipeline](https://gitlab.com/parob/graphql-api/badges/master/pipeline.svg)](https://gitlab.com/parob/graphql-api/commits/master)
 
-**[📚 Documentation](https://graphql-api.parob.com/)** | **[📦 PyPI](https://pypi.org/project/graphql-api/)** | **[🔧 GitHub](https://github.com/parob/graphql-api)**
+**[Documentation](https://graphql-api.parob.com/)** | **[PyPI](https://pypi.org/project/graphql-api/)** | **[GitHub](https://github.com/parob/graphql-api)**
 
 ---
 
@@ -234,9 +232,8 @@ To contribute or run the test suite locally:
 
 ```bash
 # Install dependencies
-pip install pipenv
-pipenv install --dev
+uv sync
 
 # Run tests
-pipenv run pytest
+uv run pytest
 ```

{graphql_api-1.6.5 → graphql_api-1.6.7}/README.md

@@ -3,10 +3,8 @@
 [![PyPI version](https://badge.fury.io/py/graphql-api.svg)](https://badge.fury.io/py/graphql-api)
 [![Python versions](https://img.shields.io/pypi/pyversions/graphql-api.svg)](https://pypi.org/project/graphql-api/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Coverage](https://gitlab.com/parob/graphql-api/badges/master/coverage.svg)](https://gitlab.com/parob/graphql-api/commits/master)
-[![Pipeline](https://gitlab.com/parob/graphql-api/badges/master/pipeline.svg)](https://gitlab.com/parob/graphql-api/commits/master)
 
-**[📚 Documentation](https://graphql-api.parob.com/)** | **[📦 PyPI](https://pypi.org/project/graphql-api/)** | **[🔧 GitHub](https://github.com/parob/graphql-api)**
+**[Documentation](https://graphql-api.parob.com/)** | **[PyPI](https://pypi.org/project/graphql-api/)** | **[GitHub](https://github.com/parob/graphql-api)**
 
 ---
 
@@ -209,9 +207,8 @@ To contribute or run the test suite locally:
 
 ```bash
 # Install dependencies
-pip install pipenv
-pipenv install --dev
+uv sync
 
 # Run tests
-pipenv run pytest
-```
+uv run pytest
+```

graphql_api-1.6.7/VERSION

@@ -0,0 +1 @@
+1.6.7

{graphql_api-1.6.5 → graphql_api-1.6.7}/graphql_api/pydantic.py

@@ -3,7 +3,7 @@ import typing
 
 from typing import Any, Type, cast, Optional
 
-from graphql import GraphQLField, GraphQLObjectType, GraphQLOutputType, GraphQLInputField, GraphQLInputObjectType, GraphQLInputType
+from graphql import GraphQLField, GraphQLObjectType, GraphQLOutputType, GraphQLInputField, GraphQLInputObjectType, GraphQLInputType, GraphQLNonNull
 from graphql.type.definition import is_output_type, is_input_type
 from pydantic import BaseModel
 
@@ -20,6 +20,19 @@ def type_is_pydantic_model(type_: Any) -> bool:
         return False
 
 
+def _annotation_allows_none(annotation: Any) -> bool:
+    """True if the annotation explicitly permits ``None`` (e.g. ``Optional[X]``).
+
+    Pydantic v2 distinguishes "required" (must be supplied) from
+    "non-nullable" (cannot be None). ``email: Optional[str]`` with no default
+    is required but nullable, so it must NOT become a NonNull GraphQL field.
+    """
+    if annotation is type(None):
+        return True
+    args = typing.get_args(annotation)
+    return type(None) in args
+
+
 def _get_pydantic_model_description(pydantic_model: Type[BaseModel], max_docstring_length: Optional[int] = None) -> str:
     """
     Get description for a Pydantic model, filtering out default BaseModel docstring.
@@ -72,9 +85,19 @@ def type_from_pydantic_model(
                         f"Mapped type for pydantic field '{name}' is not a valid GraphQL Input Type."
                     )
 
-                fields[to_camel_case(name)] = GraphQLInputField(
-                    cast(GraphQLInputType, graphql_type)
-                )
+                gql_type = cast(GraphQLInputType, graphql_type)
+                # Required, non-nullable Pydantic fields become NonNull GraphQL
+                # inputs so the GraphQL layer enforces the same contract.
+                # ``Optional[X]`` (no default) stays nullable: it's required to
+                # supply but allowed to be None.
+                if (
+                    field.is_required()
+                    and not _annotation_allows_none(field.annotation)
+                    and not isinstance(gql_type, GraphQLNonNull)
+                ):
+                    gql_type = GraphQLNonNull(gql_type)
+
+                fields[to_camel_case(name)] = GraphQLInputField(gql_type)
             return fields
 
         def _make_out_type(model_cls: Type[BaseModel]):
@@ -128,8 +151,19 @@ def type_from_pydantic_model(
 
                     return resolver
 
+                gql_type = cast(GraphQLOutputType, graphql_type)
+                # Required, non-nullable Pydantic fields become NonNull GraphQL
+                # outputs so the schema accurately advertises which fields are
+                # guaranteed. ``Optional[X]`` (no default) stays nullable.
+                if (
+                    field.is_required()
+                    and not _annotation_allows_none(field.annotation)
+                    and not isinstance(gql_type, GraphQLNonNull)
+                ):
+                    gql_type = GraphQLNonNull(gql_type)
+
                 fields[to_camel_case(name)] = GraphQLField(
-                    cast(GraphQLOutputType, graphql_type), resolve=create_resolver(name)
+                    gql_type, resolve=create_resolver(name)
                 )
             return fields
 

{graphql_api-1.6.5 → graphql_api-1.6.7}/graphql_api/utils.py

@@ -20,6 +20,15 @@ from graphql.type.definition import GraphQLInterfaceType, GraphQLType
 
 # From this response in Stackoverflow
 # http://stackoverflow.com/a/19053800/1072990
+def _capitalize_first(s):
+    """Capitalize only the first character, preserving the rest.
+
+    Unlike str.title(), this doesn't capitalize letters after digits.
+    e.g. "30d" stays "30d" instead of becoming "30D".
+    """
+    return s[0].upper() + s[1:] if s else s
+
+
 def to_camel_case(snake_str, title=False):
     underscore_prefix = False
     if snake_str.startswith("_"):
@@ -27,12 +36,10 @@ def to_camel_case(snake_str, title=False):
         snake_str = snake_str[1:]
 
     components = snake_str.split("_")
-    # We capitalize the first letter of each component except the first one
-    # with the 'title' method and join them together.
     if not snake_str:
         return ""
-    prefix = components[0].title() if title else components[0]
-    value = prefix + "".join(x.title() if x else "_" for x in components[1:])
+    prefix = _capitalize_first(components[0]) if title else components[0]
+    value = prefix + "".join(_capitalize_first(x) if x else "_" for x in components[1:])
     return ("_" if underscore_prefix else "") + value
 
 

{graphql_api-1.6.5 → graphql_api-1.6.7}/graphql_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graphql-api
-Version: 1.6.5
+Version: 1.6.7
 Summary: A framework for building Python GraphQL APIs.
 Author-email: Robert Parker <rob@parob.com>
 License: MIT
@@ -28,10 +28,8 @@ Dynamic: license-file
 [![PyPI version](https://badge.fury.io/py/graphql-api.svg)](https://badge.fury.io/py/graphql-api)
 [![Python versions](https://img.shields.io/pypi/pyversions/graphql-api.svg)](https://pypi.org/project/graphql-api/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Coverage](https://gitlab.com/parob/graphql-api/badges/master/coverage.svg)](https://gitlab.com/parob/graphql-api/commits/master)
-[![Pipeline](https://gitlab.com/parob/graphql-api/badges/master/pipeline.svg)](https://gitlab.com/parob/graphql-api/commits/master)
 
-**[📚 Documentation](https://graphql-api.parob.com/)** | **[📦 PyPI](https://pypi.org/project/graphql-api/)** | **[🔧 GitHub](https://github.com/parob/graphql-api)**
+**[Documentation](https://graphql-api.parob.com/)** | **[PyPI](https://pypi.org/project/graphql-api/)** | **[GitHub](https://github.com/parob/graphql-api)**
 
 ---
 
@@ -234,9 +232,8 @@ To contribute or run the test suite locally:
 
 ```bash
 # Install dependencies
-pip install pipenv
-pipenv install --dev
+uv sync
 
 # Run tests
-pipenv run pytest
+uv run pytest
 ```

{graphql_api-1.6.5 → graphql_api-1.6.7}/graphql_api.egg-info/SOURCES.txt

@@ -1,4 +1,6 @@
 .gitignore
+AGENTS.md
+CLAUDE.md
 LICENSE
 README.md
 VERSION

{graphql_api-1.6.5 → graphql_api-1.6.7}/tests/test_pydantic.py

@@ -1229,6 +1229,104 @@ class TestPydantic:
             }
         }
 
+    def test_pydantic_required_input_fields_become_nonnull(self) -> None:
+        """Required Pydantic fields on input types must be GraphQLNonNull.
+
+        Without this, the GraphQL API silently accepts ``null`` for fields the
+        Pydantic model considers required, and downstream JSON Schema (e.g.
+        graphql-mcp) loses required-ness for LLM tool calls.
+        """
+        from graphql import GraphQLNonNull, GraphQLInputObjectType
+
+        class CreateUserInput(BaseModel):
+            name: str           # required
+            email: str          # required
+            age: Optional[int] = None  # optional
+
+        class API:
+            @field(mutable=True)
+            def create_user(self, input: CreateUserInput) -> str:
+                return f"created:{input.name}"
+
+        api = GraphQLAPI(root_type=API)
+        schema = api.schema()
+
+        input_arg_type = schema.mutation_type.fields["createUser"].args["input"].type
+        # `input` itself is non-null (method arg with no default).
+        assert isinstance(input_arg_type, GraphQLNonNull)
+        input_object: GraphQLInputObjectType = input_arg_type.of_type
+        assert isinstance(input_object, GraphQLInputObjectType)
+
+        fields = input_object.fields
+        assert isinstance(fields["name"].type, GraphQLNonNull), (
+            "Required Pydantic field 'name' should map to a NonNull GraphQL type"
+        )
+        assert isinstance(fields["email"].type, GraphQLNonNull), (
+            "Required Pydantic field 'email' should map to a NonNull GraphQL type"
+        )
+        assert not isinstance(fields["age"].type, GraphQLNonNull), (
+            "Optional Pydantic field 'age' should remain nullable"
+        )
+
+    def test_pydantic_required_input_rejects_null_at_graphql_layer(self) -> None:
+        """Once required fields are NonNull, the GraphQL layer should reject
+        a mutation that omits or nulls a required input field."""
+
+        class CreateUserInput(BaseModel):
+            name: str
+            email: str
+
+        class API:
+            @field(mutable=True)
+            def create_user(self, input: CreateUserInput) -> str:
+                return f"created:{input.name}"
+
+        api = GraphQLAPI(root_type=API)
+
+        # Omitting a required field should be a GraphQL validation error,
+        # not a silent success or a runtime Pydantic error.
+        result = api.execute(
+            'mutation { createUser(input: {name: "Alice"}) }'
+        )
+        assert result.errors, "GraphQL should reject omission of required input field"
+        assert any(
+            "email" in str(err) for err in result.errors
+        ), f"Error should mention the missing 'email' field, got: {result.errors}"
+
+    def test_pydantic_required_output_fields_become_nonnull(self) -> None:
+        """Required Pydantic fields on output types must be GraphQLNonNull,
+        so the schema correctly advertises which fields are guaranteed."""
+        from graphql import GraphQLNonNull, GraphQLObjectType
+
+        class User(BaseModel):
+            id: str             # required
+            name: str           # required
+            nickname: Optional[str] = None  # optional
+
+        class API:
+            @field
+            def get_user(self) -> User:
+                return User(id="1", name="Alice")
+
+        api = GraphQLAPI(root_type=API)
+        schema = api.schema()
+
+        return_type = schema.query_type.fields["getUser"].type
+        assert isinstance(return_type, GraphQLNonNull)
+        user_type: GraphQLObjectType = return_type.of_type
+        assert isinstance(user_type, GraphQLObjectType)
+
+        fields = user_type.fields
+        assert isinstance(fields["id"].type, GraphQLNonNull), (
+            "Required Pydantic output field 'id' should map to NonNull"
+        )
+        assert isinstance(fields["name"].type, GraphQLNonNull), (
+            "Required Pydantic output field 'name' should map to NonNull"
+        )
+        assert not isinstance(fields["nickname"].type, GraphQLNonNull), (
+            "Optional Pydantic output field 'nickname' should remain nullable"
+        )
+
     def test_pydantic_input_out_type_converts_to_model(self) -> None:
         """Test that Pydantic input types have out_type that produces model instances."""
         class Item(BaseModel):

graphql_api-1.6.5/VERSION

@@ -1 +0,0 @@
-1.6.5