Added the ability for users to use config files with V3

[EpicLiem]

I added the ability for people to add a config file using --config. There are some conflicts with a few new commits, so I still need to resolve them. Link this pr to issue #981.

[EpicLiem]

Api key can be included in config, so we don't require it.

[acheong08]

Need checks to see if it's included in at least 1 option?

[danparizher]

Some formatting things to consider in comments

[joshuabrink]

Wouldn't a more dry solution not require a config class variable and rather expand save and load functions, to work with config like:

    def save(self, file: str, *keys: str) -> None:
        """
        Save the Chatbot configuration to a JSON file
        """
        with open(file, "w", encoding="utf-8") as f:
            json.dump(
                {
                    key: self.__dict__[key]
                    for key in self.__get_filtered_class_keys(*keys)
                },
                f,
                indent=2,
            )

    def load(self, file: str, *keys: str) -> None:
        """
        Load the Chatbot configuration from a JSON file
        """
        with open(file, encoding="utf-8") as f:
            loaded_config = json.load(f)

            self.__dict__.update(
                {
                    key: loaded_config[key]
                    for key in self.__get_filtered_class_keys(*keys)
                }
            )

    def __get_filtered_class_keys(self, *keys: str) -> list:
        """
        Get filtered class keys from the given keys. 
        """
        class_keys = self.__dict__.keys() - {"session"}
        if not keys:
            return class_keys

        # Check if all passed keys are valid
        if invalid_keys := set(keys) - {"not"} - class_keys:
            raise ValueError(
                f"Invalid keys: {invalid_keys}",
            )

        # Remove the passed keys from the class keys.
        if keys[0] is "not":
            given_keys = keys[1:]
            return [key for key in class_keys if key not in given_keys]
        else:
            # Only return specified keys that are in class_keys
            return [key for key in keys if key in class_keys]

This would allow for commands like:

• !load chat.json top_p temperature to only load top_p and temperature from a config file
• !save chat.json not top_p temperature to save all fields except top_p and temperature to a config file
• And simplify implementation with cli:

    if config:       
        chatbot = ChatbotCLI(args.api_key)
        try:
            chatbot.load(config)
        except:
            print(f"Error: {args.config} could not be loaded")
            sys.exit()
    else:
        chatbot = ChatbotCLI(
            api_key=args.api_key,
            system_prompt=args.base_prompt,
            proxy=args.proxy,
            temperature=args.temperature,
            top_p=args.top_p,
            reply_count=args.reply_count,
        )

[EpicLiem]

Wouldn't a more dry solution not require a config class variable and rather expand save and load functions, to work with config like:

    def save(self, file: str, *keys: str) -> None:
        """
        Save the Chatbot configuration to a JSON file
        """
        with open(file, "w", encoding="utf-8") as f:
            json.dump(
                {
                    key: self.__dict__[key]
                    for key in self.__get_filtered_class_keys(*keys)
                },
                f,
                indent=2,
            )

    def load(self, file: str, *keys: str) -> None:
        """
        Load the Chatbot configuration from a JSON file
        """
        with open(file, encoding="utf-8") as f:
            loaded_config = json.load(f)

            self.__dict__.update(
                {
                    key: loaded_config[key]
                    for key in self.__get_filtered_class_keys(*keys)
                }
            )

    def __get_filtered_class_keys(self, *keys: str) -> list:
        """
        Get filtered class keys from the given keys. 
        """
        class_keys = self.__dict__.keys() - {"session"}
        if not keys:
            return class_keys

        # Check if all passed keys are valid
        if invalid_keys := set(keys) - {"not"} - class_keys:
            raise ValueError(
                f"Invalid keys: {invalid_keys}",
            )

        # Remove the passed keys from the class keys.
        if keys[0] is "not":
            given_keys = keys[1:]
            return [key for key in class_keys if key not in given_keys]
        else:
            # Only return specified keys that are in class_keys
            return [key for key in keys if key in class_keys]

This would allow for commands like:

* `!load chat.json top_p temperature` to only load `top_p` and `temperature` from a config file

* `!save chat.json not top_p temperature` to save all fields except `top_p` and `temperature` to a config file

* And simplify implementation with cli:

    if config:       
        chatbot = ChatbotCLI(args.api_key)
        try:
            chatbot.load(config)
        except:
            print(f"Error: {args.config} could not be loaded")
            sys.exit()
    else:
        chatbot = ChatbotCLI(
            api_key=args.api_key,
            system_prompt=args.base_prompt,
            proxy=args.proxy,
            temperature=args.temperature,
            top_p=args.top_p,
            reply_count=args.reply_count,
        )

I'll refactor my code to use this approach

[EpicLiem]

Does anyone know why the PR isn't updating? I added a commit to the branch, and it appears there, but they're not appearing here.

[EpicLiem]

It seems I needed to add another commit, and now it updated the pr.

[danparizher]

Accidentally left a Markdown artifact in here 😅

Suggested change

	system_prompt = config.get("system_prompt")```
	system_prompt = config.get("system_prompt")

[acheong08]

Conflicts

[acheong08]

.

[EpicLiem]

@acheong08 The custom submit key breaks things if a submit key isn't given because it then tries to reference the key_binding var when it's never defined. Should I fix that in this pr?

[acheong08]

@acheong08 The custom submit key breaks things if a submit key isn't given because it then tries to reference the key_binding var when it's never defined. Should I fix that in this pr?

Would be appreciated