func2json 0.1.2

Convert Python functions to JSON schemas using Pydantic, Compatible with LLM Function Calling.

Func2JSON

Description

Func2JSON is a Python library designed to convert Python functions into a standardized JSON format, which is particularly useful for API integration and AI function calling in applications like OpenAI's function calling.

Installation

Install Func2JSON using pip:

pip install func2json

Usage

Import the function and use it as follows:

from func2json import execf

def example_function(param1: str, param2: int) -> str:
    """Example function that takes a string and an integer."""
    pass

json_struct = execf(example_function)
print(json_struct)

Output:

{
  "type": "function",
  "function": {
    "name": "example_function",
    "description": "Example function that takes a string and an integer.",
    "parameters": {
      "type": "object",
      "properties": {
        "param1": {
          "type": "string",
          "description": "param1 description"
        },
        "param2": {
          "type": "integer",
          "description": "param2 description"
        }
      },
      "required": ["param1", "param2"]
    }
  }
}

Features

• Converts function signature and docstring into JSON.
• Handles parameter types and descriptions.
• Supports optional parameters.
• Gracefully handles functions without annotations or docstrings.

Requirements

• Python 3.10 or higher
• Dependencies:
  • pydantic
  • docstring_parser

Contributing

Contributions are welcome!

License

Func2JSON is licensed under the MIT License.

Contact

For questions or feedback, please contact [e-mail].

Limitations

• Does not support functions with *args or **kwargs.
• Complex type annotations may be converted to strings.

FAQs

• Q: Why use Func2JSON?

  • A: To easily convert Python functions into a standardized JSON format for use in APIs and AI applications.

• Q: Does it support async functions?

  • A: Currently, only synchronous functions are supported.

Change Log

• 0.1: Initial release

---