File size: 1,805 Bytes
443d045 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
import warnings
def simple_deprecated_notice(term: str) -> str:
return f"`{term}` parameter is deprecated, and it has no effect"
def use_in_launch(term: str) -> str:
return f"`{term}` is deprecated in `Interface()`, please use it within `launch()` instead."
DEPRECATION_MESSAGE = {
"optional": simple_deprecated_notice("optional"),
"keep_filename": simple_deprecated_notice("keep_filename"),
"numeric": simple_deprecated_notice("numeric"),
"verbose": simple_deprecated_notice("verbose"),
"allow_screenshot": simple_deprecated_notice("allow_screenshot"),
"layout": simple_deprecated_notice("layout"),
"show_input": simple_deprecated_notice("show_input"),
"show_output": simple_deprecated_notice("show_output"),
"capture_session": simple_deprecated_notice("capture_session"),
"api_mode": simple_deprecated_notice("api_mode"),
"show_tips": use_in_launch("show_tips"),
"encrypt": use_in_launch("encrypt"),
"enable_queue": use_in_launch("enable_queue"),
"server_name": use_in_launch("server_name"),
"server_port": use_in_launch("server_port"),
"width": use_in_launch("width"),
"height": use_in_launch("height"),
"plot": "The 'plot' parameter has been deprecated. Use the new Plot component instead",
"type": "The 'type' parameter has been deprecated. Use the Number component instead.",
}
def check_deprecated_parameters(cls: str, **kwargs) -> None:
for key, value in DEPRECATION_MESSAGE.items():
if key in kwargs:
kwargs.pop(key)
# Interestingly, using DeprecationWarning causes warning to not appear.
warnings.warn(value)
if len(kwargs) != 0:
warnings.warn(
f"You have unused kwarg parameters in {cls}, please remove them: {kwargs}"
)
|