🐛 fix(types.py): change variable name from 'name' to 'display_name' in add_new_custom_field function to improve clarity

🔧 chore(types.py): add warning when 'name' key is used in field_config to inform that it can't be changed
This commit is contained in:
Gabriel Luiz Freitas Almeida 2023-07-09 11:09:19 -03:00
commit dc80513691

View file

@ -21,7 +21,7 @@ from langflow.template.frontend_node.tools import CustomComponentNode
from langflow.interface.retrievers.base import retriever_creator from langflow.interface.retrievers.base import retriever_creator
from langflow.utils.util import get_base_classes from langflow.utils.util import get_base_classes
import warnings
from fastapi import HTTPException from fastapi import HTTPException
import traceback import traceback
@ -82,20 +82,26 @@ def add_new_custom_field(
): ):
# Check field_config if any of the keys are in it # Check field_config if any of the keys are in it
# if it is, update the value # if it is, update the value
name = field_config.pop("name", field_name) display_name = field_config.pop("display_name", field_name)
field_type = field_config.pop("field_type", field_type) field_type = field_config.pop("field_type", field_type)
field_type = process_type(field_type) field_type = process_type(field_type)
if "name" in field_config:
warnings.warn(
"The 'name' key in field_config is used to build the object and can't be changed."
)
field_config.pop("name", None)
required = field_config.pop("required", True) required = field_config.pop("required", True)
placeholder = field_config.pop("placeholder", "") placeholder = field_config.pop("placeholder", "")
new_field = TemplateField( new_field = TemplateField(
name=name, name=field_name,
field_type=field_type, field_type=field_type,
show=True, show=True,
required=required, required=required,
advanced=False, advanced=False,
placeholder=placeholder, placeholder=placeholder,
display_name=display_name,
**field_config, **field_config,
) )
template.get("template")[field_name] = new_field.to_dict() template.get("template")[field_name] = new_field.to_dict()