make CloneConfig a pydantic BaseModel

Author: filipchristiansen

src/gitingest/schemas/ingestion.py

@@ -2,20 +2,18 @@
 
 from __future__ import annotations
 
-from dataclasses import dataclass
 from pathlib import Path  # noqa: TC003 (typing-only-standard-library-import) needed for type checking (pydantic)
 
 from pydantic import BaseModel, Field
 
 from gitingest.config import MAX_FILE_SIZE
 
 
-@dataclass
-class CloneConfig:  # pylint: disable=too-many-instance-attributes
+class CloneConfig(BaseModel):  # pylint: disable=too-many-instance-attributes
     """Configuration for cloning a Git repository.
 
-    This class holds the necessary parameters for cloning a repository to a local path, including
-    the repository's URL, the target local path, and optional parameters for a specific commit or branch.
+    This model holds the necessary parameters for cloning a repository to a local path, including
+    the repository's URL, the target local path, and optional parameters for a specific commit, branch, or tag.
 
     Attributes
     ----------
@@ -27,13 +25,13 @@ class CloneConfig:  # pylint: disable=too-many-instance-attributes
         The specific commit hash to check out after cloning.
     branch : str | None
         The branch to clone.
-    tag: str | None
+    tag : str | None
         The tag to clone.
     subpath : str
         The subpath to clone from the repository (default: ``"/"``).
-    blob: bool
+    blob : bool
         Whether the repository is a blob (default: ``False``).
-    include_submodules: bool
+    include_submodules : bool
         Whether to clone submodules (default: ``False``).
 
     """
@@ -43,9 +41,9 @@ class CloneConfig:  # pylint: disable=too-many-instance-attributes
     commit: str | None = None
     branch: str | None = None
     tag: str | None = None
-    subpath: str = "/"
-    blob: bool = False
-    include_submodules: bool = False
+    subpath: str = Field(default="/")
+    blob: bool = Field(default=False)
+    include_submodules: bool = Field(default=False)
 
 
 class IngestionQuery(BaseModel):  # pylint: disable=too-many-instance-attributes
@@ -75,7 +73,7 @@ class IngestionQuery(BaseModel):  # pylint: disable=too-many-instance-attributes
         The branch of the repository.
     commit : str | None
         The commit of the repository.
-    tag: str | None
+    tag : str | None
         The tag of the repository.
     max_file_size : int
         The maximum file size to ingest (default: 10 MB).
@@ -95,15 +93,15 @@ class IngestionQuery(BaseModel):  # pylint: disable=too-many-instance-attributes
     url: str | None = None
     slug: str
     id: str
-    subpath: str = "/"
+    subpath: str = Field(default="/")
     type: str | None = None
     branch: str | None = None
     commit: str | None = None
     tag: str | None = None
     max_file_size: int = Field(default=MAX_FILE_SIZE)
-    ignore_patterns: set[str] = set()  # TODO: ignore_patterns and include_patterns have the same type
+    ignore_patterns: set[str] = Field(default_factory=set)  # TODO: ssame type for ignore_* and include_* patterns
     include_patterns: set[str] | None = None
-    include_submodules: bool = False
+    include_submodules: bool = Field(default=False)
 
     def extract_clone_config(self) -> CloneConfig:
         """Extract the relevant fields for the CloneConfig object.
@@ -133,16 +131,3 @@ def extract_clone_config(self) -> CloneConfig:
             blob=self.type == "blob",
             include_submodules=self.include_submodules,
         )
-
-    def ensure_url(self) -> None:
-        """Raise if the parsed query has no URL (invalid user input).
-
-        Raises
-        ------
-        ValueError
-            If the parsed query has no URL (invalid user input).
-
-        """
-        if not self.url:
-            msg = "The 'url' parameter is required."
-            raise ValueError(msg)