Ml2 dto (#14)

* add func dto

* separated into files

src/fml_doc_gen/fml_doc_gen.py

@@ -1,6 +1,8 @@
 from typing import Callable
 from fml_doc_gen import FunctionDTO
-
+from fml_doc_gen import write_docstring_to_file
+from fml_doc_gen import read_user_function
+from fml_doc_gen import generate_template
 
 def generate_docstring_template(func: Callable, output_file: str, auto_generate: bool = False) -> str:
     """
@@ -39,98 +41,3 @@ def generate_docstring_template(func: Callable, output_file: str, auto_generate:
     """
 
     pass
-
-
-def read_user_function(func: Callable) -> FunctionDTO:
-    """
-    Reads the source code of the user-provided function and extracts its signature and existing docstring (if any).
-
-    Parameters
-    ----------
-    func : Callable
-        The user-defined function.
-
-    Returns
-    -------
-    str
-        The function signature as a string.
-
-    Examples
-    --------
-    >>> def example_func(a, b):
-    ...     return a + b
-    ...
-    >>> read_user_function(example_func)
-    'example_func(a, b)'
-    """
-
-    pass
-
-
-def generate_template(func_signature: FunctionDTO) -> str:
-    """
-    Generates a docstring template with placeholders for parameters, return values, and a brief description 
-    based on the provided function signature.
-
-    Parameters
-    ----------
-    func_signature : str
-        The signature of the user-defined function.
-
-    Returns
-    -------
-    str
-        The docstring template with placeholders.
-
-    Examples
-    --------
-    >>> func_signature = "example_func(a, b)"
-    >>> template = generate_template(func_signature)
-    >>> print(template)
-    \"\"\"Parameters
-    ----------
-    a : type
-    b : type
-
-    Returns
-    -------
-    return_type
-    \"\"\"
-    """
-
-    pass
-
-
-def write_docstring_to_file(docstring: str, output_file: str) -> None:
-    """
-    Writes the generated docstring to a specified output file.
-
-    Parameters
-    ----------
-    docstring : str
-        The docstring to be written to the file.
-    output_file : str
-        The path to the output file.
-
-    Returns
-    -------
-    None
-        This function does not return anything.
-
-    Examples
-    --------
-    >>> docstring = \"\"\"Parameters
-    ----------
-    a : int
-    b : int
-
-    Returns
-    -------
-    int
-    \"\"\"
-    >>> output_file = 'docstring_output.txt'
-    >>> write_docstring_to_file(docstring, output_file)
-    # This writes the docstring to 'docstring_output.txt'
-    """
-
-    pass

src/fml_doc_gen/generate_template.py

@@ -0,0 +1,36 @@
+from typing import Callable
+from fml_doc_gen import FunctionDTO
+
+def generate_template(func_signature: FunctionDTO) -> str:
+    """
+    Generates a docstring template with placeholders for parameters, return values, and a brief description 
+    based on the provided function signature.
+
+    Parameters
+    ----------
+    func_signature : str
+        The signature of the user-defined function.
+
+    Returns
+    -------
+    str
+        The docstring template with placeholders.
+
+    Examples
+    --------
+    >>> func_signature = "example_func(a, b)"
+    >>> template = generate_template(func_signature)
+    >>> print(template)
+    \"\"\"Parameters
+    ----------
+    a : type
+    b : type
+
+    Returns
+    -------
+    return_type
+    \"\"\"
+    """
+
+    pass
+

src/fml_doc_gen/read_user_function.py

@@ -0,0 +1,29 @@
+from typing import Callable
+from fml_doc_gen import FunctionDTO
+
+
+def read_user_function(func: Callable) -> FunctionDTO:
+    """
+    Reads the source code of the user-provided function and extracts its signature and existing docstring (if any).
+
+    Parameters
+    ----------
+    func : Callable
+        The user-defined function.
+
+    Returns
+    -------
+    str
+        The function signature as a string.
+
+    Examples
+    --------
+    >>> def example_func(a, b):
+    ...     return a + b
+    ...
+    >>> read_user_function(example_func)
+    'example_func(a, b)'
+    """
+
+    pass
+

src/fml_doc_gen/write_docstring_to_file.py

@@ -0,0 +1,34 @@
+
+def write_docstring_to_file(docstring: str, output_file: str) -> None:
+    """
+    Writes the generated docstring to a specified output file.
+
+    Parameters
+    ----------
+    docstring : str
+        The docstring to be written to the file.
+    output_file : str
+        The path to the output file.
+
+    Returns
+    -------
+    None
+        This function does not return anything.
+
+    Examples
+    --------
+    >>> docstring = \"\"\"Parameters
+    ----------
+    a : int
+    b : int
+
+    Returns
+    -------
+    int
+    \"\"\"
+    >>> output_file = 'docstring_output.txt'
+    >>> write_docstring_to_file(docstring, output_file)
+    # This writes the docstring to 'docstring_output.txt'
+    """
+
+    pass