voluptuous-openapi 0.0.6__tar.gz → 0.0.7__tar.gz

voluptuous_openapi-0.0.7/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: voluptuous-openapi
+Version: 0.0.7
+Summary: Convert voluptuous schemas to OpenAPI Schema object
+Author-email: Denis Shulyaka <Shulyaka@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Source code, https://github.com/home-assistant-libs/voluptuous-openapi
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: voluptuous
+Dynamic: license-file
+
+# Voluptuous OpenAPI
+
+Convert Voluptuous schemas to [OpenAPI Schema object](https://spec.openapis.org/oas/v3.0.3#schema-object).
+
+```python
+schema = {}
+schema[vol.Required('name')] = vol.All(str, vol.Length(min=5))
+schema[vol.Required('age', description='Age in full years')] = vol.All(vol.Coerce(int), vol.Range(min=18))
+schema[vol.Optional('hobby', default='not specified')] = str
+schema = vol.Schema(schema)
+```
+
+becomes
+
+```json
+{
+    "type": "object",
+    "properties": {
+        "name": {
+            "type": "string",
+            "minLength": 5,
+        },
+        "age": {
+            "type": "integer",
+            "minimum": 18,
+            "description": "Age in full years",
+        },
+        "hobby": {
+            "type": "string",
+            "default": "not specified",
+        },
+    },
+    "required": ["name", "age"],
+}
+```
+
+See the tests for more examples.
+
+## Custom serializer
+
+You can pass a custom serializer to be able to process custom validators. If the serializer returns `UNSUPPORTED`, it will return to normal processing. Example:
+
+```python
+
+from voluptuous_openai import UNSUPPORTED, convert
+
+def custom_convert(value):
+    if value is my_custom_validator:
+        return {'pattern': '^[a-zA-Z0-9]$'}
+        
+    return UNSUPPORTED
+
+convert(value, custom_serializer=custom_convert)
+```

voluptuous_openapi-0.0.7/pyproject.toml

@@ -0,0 +1,18 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools>=77.0"]
+
+[project]
+name = "voluptuous-openapi"
+version = "0.0.7"
+license = "Apache-2.0"
+description = "Convert voluptuous schemas to OpenAPI Schema object"
+readme = "README.md"
+authors = [{ name = "Denis Shulyaka", email = "Shulyaka@gmail.com" }]
+requires-python = ">=3.9"
+dependencies = [
+  "voluptuous",
+]
+
+[project.urls]
+"Source code" = "https://github.com/home-assistant-libs/voluptuous-openapi"

{voluptuous_openapi-0.0.6 → voluptuous_openapi-0.0.7}/tests/test_lib.py

@@ -579,3 +579,30 @@ def test_mixed_type_list() -> None:
 
     with pytest.raises(vol.Invalid):
         validator(123)
+
+
+@pytest.mark.parametrize(
+    "required",
+    [
+        (["query"]),
+        ([]),
+    ],
+)
+def test_convert_to_voluptuous_marker_description(required: list[str]):
+    schema = convert_to_voluptuous(
+        {
+            "type": "object",
+            "properties": {
+                "query": {"type": "string", "description": "The query to search for"},
+                "max_results": {
+                    "type": "number",
+                    "description": "The maximum number of results to return",
+                },
+            },
+            "required": required,
+        }
+    )
+    assert [(key, key.description) for key in schema.schema.keys()] == [
+        ("query", "The query to search for"),
+        ("max_results", "The maximum number of results to return"),
+    ]

{voluptuous_openapi-0.0.6 → voluptuous_openapi-0.0.7}/voluptuous_openapi/__init__.py

@@ -429,11 +429,14 @@ def convert_to_voluptuous(schema: dict) -> vol.Schema:
         required_properties = set(schema.get("required", []))
         for key, value in schema.get("properties", {}).items():
             value_type = convert_to_voluptuous(value)
+            description: str | None = None
+            if isinstance(value, dict):
+                description = value.get("description")
             if key in required_properties:
                 key_type = vol.Required
             else:
                 key_type = vol.Optional
-            properties[key_type(key)] = value_type
+            properties[key_type(key, description=description)] = value_type
         if schema.get("additionalProperties") is True:
             return vol.Schema(properties, extra=vol.ALLOW_EXTRA)
         return vol.Schema(properties)

voluptuous_openapi-0.0.7/voluptuous_openapi.egg-info/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: voluptuous-openapi
+Version: 0.0.7
+Summary: Convert voluptuous schemas to OpenAPI Schema object
+Author-email: Denis Shulyaka <Shulyaka@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Source code, https://github.com/home-assistant-libs/voluptuous-openapi
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: voluptuous
+Dynamic: license-file
+
+# Voluptuous OpenAPI
+
+Convert Voluptuous schemas to [OpenAPI Schema object](https://spec.openapis.org/oas/v3.0.3#schema-object).
+
+```python
+schema = {}
+schema[vol.Required('name')] = vol.All(str, vol.Length(min=5))
+schema[vol.Required('age', description='Age in full years')] = vol.All(vol.Coerce(int), vol.Range(min=18))
+schema[vol.Optional('hobby', default='not specified')] = str
+schema = vol.Schema(schema)
+```
+
+becomes
+
+```json
+{
+    "type": "object",
+    "properties": {
+        "name": {
+            "type": "string",
+            "minLength": 5,
+        },
+        "age": {
+            "type": "integer",
+            "minimum": 18,
+            "description": "Age in full years",
+        },
+        "hobby": {
+            "type": "string",
+            "default": "not specified",
+        },
+    },
+    "required": ["name", "age"],
+}
+```
+
+See the tests for more examples.
+
+## Custom serializer
+
+You can pass a custom serializer to be able to process custom validators. If the serializer returns `UNSUPPORTED`, it will return to normal processing. Example:
+
+```python
+
+from voluptuous_openai import UNSUPPORTED, convert
+
+def custom_convert(value):
+    if value is my_custom_validator:
+        return {'pattern': '^[a-zA-Z0-9]$'}
+        
+    return UNSUPPORTED
+
+convert(value, custom_serializer=custom_convert)
+```

{voluptuous_openapi-0.0.6 → voluptuous_openapi-0.0.7}/voluptuous_openapi.egg-info/SOURCES.txt

@@ -1,8 +1,7 @@
 LICENSE
-MANIFEST.in
 README.md
+pyproject.toml
 setup.cfg
-setup.py
 tests/test_lib.py
 tests/test_validation.py
 voluptuous_openapi/__init__.py
@@ -10,5 +9,4 @@ voluptuous_openapi.egg-info/PKG-INFO
 voluptuous_openapi.egg-info/SOURCES.txt
 voluptuous_openapi.egg-info/dependency_links.txt
 voluptuous_openapi.egg-info/requires.txt
-voluptuous_openapi.egg-info/top_level.txt
-voluptuous_openapi.egg-info/zip-safe
+voluptuous_openapi.egg-info/top_level.txt

voluptuous_openapi-0.0.6/MANIFEST.in

@@ -1,2 +0,0 @@
-include tests/*.py
-include LICENSE

voluptuous_openapi-0.0.6/PKG-INFO

@@ -1,10 +0,0 @@
-Metadata-Version: 2.1
-Name: voluptuous-openapi
-Version: 0.0.6
-Summary: Convert voluptuous schemas to OpenAPI Schema object
-Home-page: https://github.com/home-assistant-libs/voluptuous-openapi
-Author: Denis Shulyaka
-Author-email: Shulyaka@gmail.com
-License: Apache License 2.0
-License-File: LICENSE
-Requires-Dist: voluptuous

voluptuous_openapi-0.0.6/setup.py

@@ -1,14 +0,0 @@
-from setuptools import setup
-
-setup(
-    name="voluptuous-openapi",
-    version="0.0.6",
-    description="Convert voluptuous schemas to OpenAPI Schema object",
-    url="https://github.com/home-assistant-libs/voluptuous-openapi",
-    author="Denis Shulyaka",
-    author_email="Shulyaka@gmail.com",
-    license="Apache License 2.0",
-    install_requires=["voluptuous"],
-    packages=["voluptuous_openapi"],
-    zip_safe=True,
-)

voluptuous_openapi-0.0.6/voluptuous_openapi.egg-info/PKG-INFO

@@ -1,10 +0,0 @@
-Metadata-Version: 2.1
-Name: voluptuous-openapi
-Version: 0.0.6
-Summary: Convert voluptuous schemas to OpenAPI Schema object
-Home-page: https://github.com/home-assistant-libs/voluptuous-openapi
-Author: Denis Shulyaka
-Author-email: Shulyaka@gmail.com
-License: Apache License 2.0
-License-File: LICENSE
-Requires-Dist: voluptuous

voluptuous_openapi-0.0.6/voluptuous_openapi.egg-info/zip-safe

@@ -1 +0,0 @@
-