mirror of
https://github.com/csunny/DB-GPT.git
synced 2025-10-23 10:20:01 +00:00
refactor: Refactor storage system (#937)
This commit is contained in:
@@ -39,6 +39,31 @@ def PublicAPI(*args, **kwargs):
|
||||
return decorator
|
||||
|
||||
|
||||
def DeveloperAPI(*args, **kwargs):
|
||||
"""Decorator to mark a function or class as a developer API.
|
||||
|
||||
Developer APIs are low-level APIs for advanced users and may change cross major versions.
|
||||
|
||||
Examples:
|
||||
>>> from dbgpt.util.annotations import DeveloperAPI
|
||||
>>> @DeveloperAPI
|
||||
... def foo():
|
||||
... pass
|
||||
|
||||
"""
|
||||
if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
|
||||
return DeveloperAPI()(args[0])
|
||||
|
||||
def decorator(obj):
|
||||
_modify_docstring(
|
||||
obj,
|
||||
"**DeveloperAPI:** This API is for advanced users and may change cross major versions.",
|
||||
)
|
||||
return obj
|
||||
|
||||
return decorator
|
||||
|
||||
|
||||
def _modify_docstring(obj, message: str = None):
|
||||
if not message:
|
||||
return
|
||||
|
Reference in New Issue
Block a user