schemathesis 3.13.0__py3-none-any.whl → 4.4.2__py3-none-any.whl

schemathesis/specs/openapi/converter.py

@@ -1,27 +1,89 @@
-from copy import deepcopy
-from itertools import chain
-from typing import Any, Callable, Dict, List
+from __future__ import annotations
 
-from ...utils import traverse_schema
+from typing import Any, Callable, overload
+
+from schemathesis.core.jsonschema.bundler import BUNDLE_STORAGE_KEY
+from schemathesis.core.jsonschema.types import JsonSchema
+from schemathesis.core.transforms import deepclone
+from schemathesis.specs.openapi.patterns import update_quantifier
+
+
+@overload
+def to_json_schema(
+    schema: dict[str, Any],
+    nullable_keyword: str,
+    is_response_schema: bool = False,
+    update_quantifiers: bool = True,
+    clone: bool = True,
+) -> dict[str, Any]: ...  # pragma: no cover
+
+
+@overload
+def to_json_schema(
+    schema: bool,
+    nullable_keyword: str,
+    is_response_schema: bool = False,
+    update_quantifiers: bool = True,
+    clone: bool = True,
+) -> bool: ...  # pragma: no cover
 
 
 def to_json_schema(
-    schema: Dict[str, Any], *, nullable_name: str, copy: bool = True, is_response_schema: bool = False
-) -> Dict[str, Any]:
-    """Convert Open API parameters to JSON Schema.
-
-    NOTE. This function is applied to all keywords (including nested) during a schema resolving, thus it is not recursive.
-    See a recursive version below.
-    """
-    if copy:
-        schema = deepcopy(schema)
-    if schema.get(nullable_name) is True:
-        del schema[nullable_name]
+    schema: dict[str, Any] | bool,
+    nullable_keyword: str,
+    is_response_schema: bool = False,
+    update_quantifiers: bool = True,
+    clone: bool = True,
+) -> dict[str, Any] | bool:
+    if isinstance(schema, bool):
+        return schema
+    if clone:
+        schema = deepclone(schema)
+    return _to_json_schema(
+        schema,
+        nullable_keyword=nullable_keyword,
+        is_response_schema=is_response_schema,
+        update_quantifiers=update_quantifiers,
+    )
+
+
+def _to_json_schema(
+    schema: JsonSchema,
+    *,
+    nullable_keyword: str,
+    is_response_schema: bool = False,
+    update_quantifiers: bool = True,
+) -> JsonSchema:
+    if isinstance(schema, bool):
+        return schema
+
+    if schema.get(nullable_keyword) is True:
+        del schema[nullable_keyword]
+        bundled = schema.pop(BUNDLE_STORAGE_KEY, None)
         schema = {"anyOf": [schema, {"type": "null"}]}
+        if bundled:
+            schema[BUNDLE_STORAGE_KEY] = bundled
     schema_type = schema.get("type")
     if schema_type == "file":
         schema["type"] = "string"
         schema["format"] = "binary"
+    if update_quantifiers:
+        update_pattern_in_schema(schema)
+    # Sometimes `required` is incorrectly has a boolean value
+    properties = schema.get("properties")
+    if isinstance(properties, dict):
+        for name, subschema in properties.items():
+            if not isinstance(subschema, dict):
+                continue
+            is_required = subschema.get("required")
+            if is_required is True:
+                schema.setdefault("required", []).append(name)
+                del subschema["required"]
+            elif is_required is False:
+                if "required" in schema and name in schema["required"]:
+                    schema["required"].remove(name)
+                del subschema["required"]
+
     if schema_type == "object":
         if is_response_schema:
             # Write-only properties should not occur in responses
@@ -29,43 +91,120 @@ def to_json_schema(
         else:
             # Read-only properties should not occur in requests
             rewrite_properties(schema, is_read_only)
+
+    ensure_required_properties(schema)
+
+    for keyword, value in schema.items():
+        if keyword in IN_VALUE and isinstance(value, dict):
+            schema[keyword] = _to_json_schema(
+                value,
+                nullable_keyword=nullable_keyword,
+                is_response_schema=is_response_schema,
+                update_quantifiers=update_quantifiers,
+            )
+        elif keyword in IN_ITEM and isinstance(value, list):
+            for idx, subschema in enumerate(value):
+                value[idx] = _to_json_schema(
+                    subschema,
+                    nullable_keyword=nullable_keyword,
+                    is_response_schema=is_response_schema,
+                    update_quantifiers=update_quantifiers,
+                )
+        elif keyword in IN_CHILD and isinstance(value, dict):
+            for name, subschema in value.items():
+                value[name] = _to_json_schema(
+                    subschema,
+                    nullable_keyword=nullable_keyword,
+                    is_response_schema=is_response_schema,
+                    update_quantifiers=update_quantifiers,
+                )
+
     return schema
 
 
-def rewrite_properties(schema: Dict[str, Any], predicate: Callable[[Dict[str, Any]], bool]) -> None:
+def ensure_required_properties(schema: dict[str, Any]) -> None:
+    if schema.get("additionalProperties") is not False:
+        return
+
+    required = schema.get("required")
+    if not required or not isinstance(required, list):
+        return
+
+    properties = schema.setdefault("properties", {})
+
+    # Add missing required properties as empty schemas
+    for name in required:
+        if name not in properties:
+            properties[name] = {}
+
+
+IN_VALUE = frozenset(
+    (
+        "additionalProperties",
+        "contains",
+        "contentSchema",
+        "else",
+        "if",
+        "items",
+        "not",
+        "propertyNames",
+        "then",
+        "unevaluatedItems",
+        "unevaluatedProperties",
+    )
+)
+IN_ITEM = frozenset(
+    (
+        "allOf",
+        "anyOf",
+        "oneOf",
+    )
+)
+IN_CHILD = frozenset(
+    (
+        "prefixItems",
+        "$defs",
+        "definitions",
+        "dependentSchemas",
+        "patternProperties",
+        "properties",
+        BUNDLE_STORAGE_KEY,
+    )
+)
+
+
+def update_pattern_in_schema(schema: dict[str, Any]) -> None:
+    pattern = schema.get("pattern")
+    min_length = schema.get("minLength")
+    max_length = schema.get("maxLength")
+    if pattern and (min_length or max_length):
+        new_pattern = update_quantifier(pattern, min_length, max_length)
+        if new_pattern != pattern:
+            schema.pop("minLength", None)
+            schema.pop("maxLength", None)
+            schema["pattern"] = new_pattern
+
+
+def rewrite_properties(schema: dict[str, Any], predicate: Callable[[dict[str, Any]], bool]) -> None:
     required = schema.get("required", [])
-    forbidden = []
     for name, subschema in list(schema.get("properties", {}).items()):
         if predicate(subschema):
             if name in required:
                 required.remove(name)
-            del schema["properties"][name]
-            forbidden.append(name)
-    if forbidden:
-        forbid_properties(schema, forbidden)
+            schema["properties"][name] = {"not": {}}
     if not schema.get("required"):
         schema.pop("required", None)
     if not schema.get("properties"):
         schema.pop("properties", None)
 
 
-def forbid_properties(schema: Dict[str, Any], forbidden: List[str]) -> None:
-    """Explicitly forbid properties via the `not` keyword."""
-    not_schema = schema.setdefault("not", {})
-    already_forbidden = not_schema.setdefault("required", [])
-    already_forbidden.extend(forbidden)
-    not_schema["required"] = list(set(chain(already_forbidden, forbidden)))
-
-
-def is_write_only(schema: Dict[str, Any]) -> bool:
+def is_write_only(schema: dict[str, Any] | bool) -> bool:
+    if isinstance(schema, bool):
+        return False
     return schema.get("writeOnly", False) or schema.get("x-writeOnly", False)
 
 
-def is_read_only(schema: Dict[str, Any]) -> bool:
+def is_read_only(schema: dict[str, Any] | bool) -> bool:
+    if isinstance(schema, bool):
+        return False
     return schema.get("readOnly", False)
-
-
-def to_json_schema_recursive(
-    schema: Dict[str, Any], nullable_name: str, is_response_schema: bool = False
-) -> Dict[str, Any]:
-    return traverse_schema(schema, to_json_schema, nullable_name=nullable_name, is_response_schema=is_response_schema)