Merge pull request #14 from comfuture/feature-check

Feature check

Author: comfuture

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Set up uv

function_schema/core.py

@@ -11,63 +11,19 @@
     get_origin,
 )
 
-from .types import FunctionSchema
-from .utils import is_py310_atleast
+from .types import FunctionSchema, Doc
+from .utils import unwrap_doc
 
-if is_py310_atleast():
-    from types import UnionType
-else:
-    UnionType = Union  # type: ignore
 
 try:
-    from typing import Doc
+    from types import UnionType
 except ImportError:
-    try:
-        from typing_extensions import Doc
-    except ImportError:
-
-        class Doc:
-            def __init__(self, documentation: str, /):
-                self.documentation = documentation
+    UnionType = Union  # type: ignore
 
 
 __all__ = ("get_function_schema", "guess_type", "Doc", "Annotated")
 
 
-def is_doc_meta(
-    obj: Annotated[Any, Doc("The object to be checked.")],
-) -> Annotated[
-    bool, Doc("True if the object is a documentation object, False otherwise.")
-]:
-    """
-    Check if the given object is a documentation object.
-
-    Example:
-    >>> is_doc_meta(Doc("This is a documentation object"))
-    True
-    """
-    return getattr(obj, "__class__") == Doc and hasattr(obj, "documentation")
-
-
-def unwrap_doc(
-    obj: Annotated[
-        Union[Doc, str], Doc("The object to get the documentation string from.")
-    ],
-) -> Annotated[str, Doc("The documentation string.")]:
-    """
-    Get the documentation string from the given object.
-
-    Example:
-    >>> unwrap_doc(Doc("This is a documentation object"))
-    'This is a documentation object'
-    >>> unwrap_doc("This is a documentation string")
-    'This is a documentation string'
-    """
-    if is_doc_meta(obj):
-        return obj.documentation
-    return str(obj)
-
-
 def get_function_schema(
     func: Annotated[Callable, Doc("The function to get the schema for")],
     format: Annotated[
@@ -175,7 +131,8 @@ def get_function_schema(
         }
 
         if enum_ is not None:
-            schema["properties"][name]["enum"] = [t for t in enum_ if t is not None]
+            schema["properties"][name]["enum"] = [
+                t for t in enum_ if t is not None]
 
         if default_value is not inspect._empty:
             schema["properties"][name]["default"] = default_value
@@ -205,7 +162,8 @@ def get_function_schema(
 def guess_type(
     T: Annotated[type, Doc("The type to guess the JSON schema type for")],
 ) -> Annotated[
-    Union[str, list[str]], Doc("str | list of str that representing JSON schema type")
+    Union[str, list[str]], Doc(
+        "str | list of str that representing JSON schema type")
 ]:
     """Guesses the JSON schema type for the given python type."""
 

function_schema/types.py

@@ -8,6 +8,17 @@
     except ImportError:
         from typing import Optional as NotRequired
 
+try:
+    from typing import Doc
+except ImportError:
+    try:
+        from typing_extensions import Doc
+    except ImportError:
+
+        class Doc:
+            def __init__(self, documentation: str, /):
+                self.documentation = documentation
+
 
 class ParamSchema(TypedDict):
     """

function_schema/utils.py

@@ -1,6 +1,46 @@
-import platform
+from typing import Annotated, Any, Union
+from .types import Doc
 
 
-def is_py310_atleast():
-    version_tuple = tuple(map(int, platform.python_version_tuple()))
-    return version_tuple >= (3, 10)
+def is_support_uniontype():
+    """Check if current python version supports UnionType or not"""
+    try:
+        from types import UnionType  # noqa
+    except ImportError:
+        return False
+    return True
+
+
+def is_doc_meta(
+    obj: Annotated[Any, Doc("The object to be checked.")],
+) -> Annotated[
+    bool, Doc("True if the object is a documentation object, False otherwise.")
+]:
+    """
+    Check if the given object is a documentation object.
+
+    Example:
+    >>> is_doc_meta(Doc("This is a documentation object"))
+    True
+    """
+    return getattr(obj, "__class__") == Doc and hasattr(obj, "documentation")
+
+
+def unwrap_doc(
+    obj: Annotated[
+        Union[Doc, str], Doc(
+            "The object to get the documentation string from.")
+    ],
+) -> Annotated[str, Doc("The documentation string.")]:
+    """
+    Get the documentation string from the given object.
+
+    Example:
+    >>> unwrap_doc(Doc("This is a documentation object"))
+    'This is a documentation object'
+    >>> unwrap_doc("This is a documentation string")
+    'This is a documentation string'
+    """
+    if is_doc_meta(obj):
+        return obj.documentation
+    return str(obj)

test/test_guess_type.py

@@ -3,7 +3,7 @@
 import pytest
 
 from function_schema.core import guess_type
-from function_schema.utils import is_py310_atleast
+from function_schema.utils import is_support_uniontype
 
 
 def test_primitive():
@@ -68,7 +68,7 @@ def test_union():
 
 
 @pytest.mark.skipif(
-    not is_py310_atleast(), reason="Union type is only available in Python 3.10+"
+    not is_support_uniontype(), reason="Union type is only available in Python 3.10+"
 )
 def test_union_type():
     """Test union types in Python 3.10+"""