Method render_functional_requirement

codeplain_REST_api.py:172–224

Renders the content of a functionality based on the provided ID, corresponding sections from a Plain document, and existing files' content. Args: frid (str): The unique identifier for the functionality to be rendered. plain_source_tree (dict): A dict

(
        self,
        frid: str,
        plain_source_tree: dict,
        linked_resources: dict,
        existing_files_content: dict,
        memory_files_content: dict,
        module_name: str,
        required_modules: dict,
        include_unittests: bool,
        run_state: RunState,
    )

        return self.post_request(endpoint_url, headers, payload, None, num_retries=0, silent=True)

    def render_functional_requirement(
        self,
        frid: str,
        plain_source_tree: dict,
        linked_resources: dict,
        existing_files_content: dict,
        memory_files_content: dict,
        module_name: str,
        required_modules: dict,
        include_unittests: bool,
        run_state: RunState,
    ) -> dict[str, str]:
        """
        Renders the content of a functionality based on the provided ID,
        corresponding sections from a Plain document, and existing files' content.

        Args:
            frid (str): The unique identifier for the functionality to be rendered.
            plain_source_tree (dict): A dictionary containing the plain source tree.
            linked_resources (dict): A dictionary where the keys represent filenames of linked
                                        resources and the values are dictionaries containing
                                        the content of the linked resources and the sections
                                        they are linked to.
            existing_files_content (dict): A dictionary where the keys represent filenames
                                        and the values are the content of those files.
            memory_files_content (dict): A dictionary where the keys represent memory filenames
                                        and the values are the content of those files.
            module_name (str): The name of the module to render the functionality for.
            required_modules (dict): A dictionary where the keys represent module names
                                     and the values are lists of functionalities implemented in those modules.
            run_state (RunState): The current state of the rendering process.
        Returns:
            dict[str, str]: A dictionary where the keys are filenames and the values
                            are the rendered code for those files.

        Raises:
            ValueError: If the frid is invalid or the necessary sections cannot be found.
        """
        endpoint_url = f"{self.api_url}/render_functional_requirement"
        headers = {"X-API-Key": self.api_key, "Content-Type": "application/json"}

        payload = {
            "frid": frid,
            "plain_source_tree": plain_source_tree,
            "linked_resources": linked_resources,
            "existing_files_content": existing_files_content,
            "memory_files_content": memory_files_content,
            "module_name": module_name,
            "required_modules": required_modules,
            "include_unittests": include_unittests,
        }

        return self.post_request(endpoint_url, headers, payload, run_state)

    def fix_unittests_issue(
        self,