add some tests closes #1

Author: comfuture

pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+python_files = test/**.py
+addopts = -ra -q --doctest-modules
+doctest_optionflags = NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL

test/conftest.py

@@ -0,0 +1,5 @@
+import os
+import sys
+
+project_path = os.path.realpath(os.path.join(os.path.dirname(__file__), ".."))
+sys.path.append(project_path)

test/test_guess_type.py

@@ -0,0 +1,77 @@
+import platform
+import packaging.version
+import typing
+
+import pytest
+from function_schema.core import guess_type
+
+
+def test_primitive():
+    """Test primitive types"""
+    assert guess_type(int) == "integer"
+    assert guess_type(str) == "string"
+    assert guess_type(float) == "number"
+    assert guess_type(bool) == "boolean"
+
+
+def test_optional():
+    """Test optional types"""
+    assert guess_type(typing.Optional[int]) == "integer"
+    assert guess_type(typing.Optional[str]) == "string"
+    assert guess_type(typing.Optional[float]) == "number"
+    assert guess_type(typing.Optional[bool]) == "boolean"
+
+
+def test_union_null():
+    """Test union types with null"""
+    assert guess_type(typing.Union[int, None]) == "integer"
+    assert guess_type(typing.Union[str, None]) == "string"
+    assert guess_type(typing.Union[float, None]) == "number"
+    assert guess_type(typing.Union[bool, None]) == "boolean"
+
+
+def test_union():
+    """Test union types"""
+    assert guess_type(typing.Union[int, str]) == ["integer", "string"]
+    assert guess_type(typing.Union[int, float]) == "number"
+    assert guess_type(typing.Union[int, bool]) == ["integer", "boolean"]
+    assert guess_type(typing.Union[bool, int]) == ["boolean", "integer"]
+    assert guess_type(typing.Union[str, float]) == ["string", "number"]
+    assert guess_type(typing.Union[str, bool]) == ["string", "boolean"]
+    assert guess_type(typing.Union[float, bool]) == ["number", "boolean"]
+    assert guess_type(typing.Union[str, float, bool]) == [
+        "string",
+        "number",
+        "boolean",
+    ]
+    assert guess_type(typing.Union[str, float, bool, None]) == [
+        "string",
+        "number",
+        "boolean",
+    ]
+
+
+def test_union_type():
+    """Test union types in Python 3.10+"""
+    current_version = packaging.version.parse(platform.python_version())
+    py_310 = packaging.version.parse("3.10")
+    if current_version < py_310:
+        pytest.skip("Union type is only available in Python 3.10+")
+
+    assert guess_type(int | str) == ["integer", "string"]
+    assert guess_type(int | float) == "number"
+    assert guess_type(int | bool) == ["integer", "boolean"]
+    assert guess_type(bool | int) == ["boolean", "integer"]
+    assert guess_type(str | float) == ["string", "number"]
+    assert guess_type(str | bool) == ["string", "boolean"]
+    assert guess_type(float | bool) == ["number", "boolean"]
+    assert guess_type(str | float | bool) == [
+        "string",
+        "number",
+        "boolean",
+    ]
+    assert guess_type(str | float | bool | None) == [
+        "string",
+        "number",
+        "boolean",
+    ]

test/test_schema.py

@@ -0,0 +1,106 @@
+import enum
+from typing import Optional, Annotated
+from function_schema.core import get_function_schema
+
+
+def test_simple_function():
+    """Test a simple function"""
+
+    def func1():
+        """My function"""
+        ...
+
+    schema = get_function_schema(func1)
+
+    assert schema["name"] == "func1", "Function name should be func1"
+    assert (
+        schema["description"] == "My function"
+    ), "Function description should be My function"
+    assert (
+        schema["parameters"]["properties"] == {}
+    ), "Function parameters should be empty"
+    assert schema["parameters"]["required"] == [], "required parameters should be empty"
+
+
+def test_function_with_args():
+    """Test a function with args"""
+
+    def func1(a: int, b: str, c: float = 1.0):
+        """My function"""
+        ...
+
+    schema = get_function_schema(func1)
+
+    assert schema["name"] == "func1", "Function name should be func1"
+    assert (
+        schema["description"] == "My function"
+    ), "Function description should be there"
+    assert (
+        schema["parameters"]["properties"]["a"]["type"] == "integer"
+    ), "parameter a should be an integer"
+    assert (
+        schema["parameters"]["properties"]["b"]["type"] == "string"
+    ), "parameter b should be a string"
+    assert (
+        schema["parameters"]["properties"]["c"]["type"] == "number"
+    ), "parameter c should be a number"
+    assert (
+        schema["parameters"]["properties"]["c"]["default"] == 1.0
+    ), "c should have a default value of 1.0"
+    assert schema["parameters"]["required"] == [
+        "a",
+        "b",
+    ], "parameters with no default value should be required"
+
+
+def test_annotated_function():
+    """Test a function with annotations"""
+
+    def func1(
+        a: Annotated[int, "An integer parameter"],
+        b: Annotated[str, "A string parameter"],
+    ):
+        """My function"""
+        ...
+
+    schema = get_function_schema(func1)
+
+    assert (
+        schema["parameters"]["properties"]["a"]["type"] == "integer"
+    ), "parameter a should be an integer"
+    assert (
+        schema["parameters"]["properties"]["a"]["description"] == "An integer parameter"
+    ), "parameter a should have a description"
+    assert (
+        schema["parameters"]["properties"]["b"]["type"] == "string"
+    ), "parameter b should be a string"
+    assert (
+        schema["parameters"]["properties"]["b"]["description"] == "A string parameter"
+    ), "parameter b should have a description"
+
+    assert schema["parameters"]["required"] == [
+        "a",
+        "b",
+    ], "parameters with no default value should be required"
+
+
+def test_annotated_function_with_enum():
+    """Test a function with annotations and enum"""
+    def func1(
+        animal: Annotated[
+            str,
+            "The animal you want to pet",
+            enum.Enum("Animal", "Cat Dog"),
+        ],
+    ):
+        """My function"""
+        ...
+
+    schema = get_function_schema(func1)
+    print(schema)
+    assert (
+        schema["parameters"]["properties"]["animal"]["type"] == "string"
+    ), "parameter animal should be a string"
+    assert (
+        schema["parameters"]["properties"]["animal"]["enum"] == ["Cat", "Dog"]
+    ), "parameter animal should have an enum"