Migrate to use NullGitAutograderRepo

This is to support the use of the ignore repo_type

Author: woojiahao

src/git_autograder/__init__.py

@@ -6,6 +6,7 @@
     "GitAutograderWrongAnswerException",
     "GitAutograderTestLoader",
     "GitAutograderRepo",
+    "GitAutograderRepoBase",
     "GitAutograderStatus",
     "GitAutograderOutput",
     "GitAutograderBranch",
@@ -24,7 +25,8 @@
 from .exercise import GitAutograderExercise
 from .output import GitAutograderOutput
 from .remote import GitAutograderRemote
-from .repo import GitAutograderRepo
+from .repo.repo import GitAutograderRepo
+from .repo.repo_base import GitAutograderRepoBase
 from .status import GitAutograderStatus
 from .test_utils import (
     GitAutograderTestLoader,

src/git_autograder/exercise.py

@@ -16,7 +16,9 @@
 )
 from git_autograder.exercise_config import ExerciseConfig
 from git_autograder.output import GitAutograderOutput
-from git_autograder.repo import GitAutograderRepo
+from git_autograder.repo.null_repo import NullGitAutograderRepo
+from git_autograder.repo.repo import GitAutograderRepo
+from git_autograder.repo.repo_base import GitAutograderRepoBase
 from git_autograder.status import GitAutograderStatus
 
 
@@ -36,12 +38,12 @@ class GitAutograderExercise:
     :param exercise_path: Path to a given exercise folder
     :type exercise_path: Union[str, os.PathLike]
     """
+
     def __init__(
         self,
         exercise_path: str | os.PathLike,
     ) -> None:
-        """Constructor method
-        """
+        """Constructor method"""
 
         # TODO: We should not be starting the grading at the point of initializing, but
         # we're keeping this because of the exception system
@@ -63,10 +65,14 @@ def __init__(
             # The only edge cases are those where they run git init themselves, but that
             # is the purpose of handling the exception where we can display an error on
             # their end.
-            self.repo: GitAutograderRepo = GitAutograderRepo(
-                self.config.exercise_name,
-                Path(exercise_path) / self.config.exercise_repo.repo_name,
-            )
+            self.repo: GitAutograderRepoBase
+            if self.config.exercise_repo.repo_type == "ignore":
+                self.repo = NullGitAutograderRepo()
+            else:
+                self.repo = GitAutograderRepo(
+                    self.config.exercise_name,
+                    Path(exercise_path) / self.config.exercise_repo.repo_name,
+                )
         except InvalidGitRepositoryError:
             raise GitAutograderInvalidStateException("Exercise is not a Git repository")
         self.__answers_parser: Optional[GitAutograderAnswersParser] = None

src/git_autograder/exercise_config.py

@@ -8,7 +8,7 @@
 class ExerciseConfig:
     @dataclass
     class ExerciseRepoConfig:
-        repo_type: Literal["local", "remote"]
+        repo_type: Literal["local", "remote", "ignore"]
         repo_name: str
         repo_title: Optional[str]
         create_fork: Optional[bool]

src/git_autograder/repo.py

@@ -0,0 +1,39 @@
+from git import Repo
+
+from git_autograder.helpers.branch_helper import BranchHelper
+from git_autograder.helpers.commit_helper import CommitHelper
+from git_autograder.helpers.file_helper import FileHelper
+from git_autograder.helpers.remote_helper import RemoteHelper
+from git_autograder.repo.repo_base import GitAutograderRepoBase
+
+
+class NullGitAutograderRepo(GitAutograderRepoBase):
+    def repo(self) -> Repo:
+        raise AttributeError(
+            "Cannot access attribute repo on NullGitAutograderRepo. Check that your repo_type is not 'ignore'."
+        )
+
+    def branches(self) -> BranchHelper:
+        raise AttributeError(
+            "Cannot access attribute branches on NullGitAutograderRepo. Check that your repo_type is not 'ignore'."
+        )
+
+    def commits(self) -> CommitHelper:
+        raise AttributeError(
+            "Cannot access attribute commits on NullGitAutograderRepo. Check that your repo_type is not 'ignore'."
+        )
+
+    def remotes(self) -> RemoteHelper:
+        raise AttributeError(
+            "Cannot access attribute remotes on NullGitAutograderRepo. Check that your repo_type is not 'ignore'."
+        )
+
+    def files(self) -> FileHelper:
+        raise AttributeError(
+            "Cannot access attribute files on NullGitAutograderRepo. Check that your repo_type is not 'ignore'."
+        )
+
+    def __getattr__(self, name: str) -> None:
+        raise AttributeError(
+            f"Cannot access attribute {name} on NullGitAutograderRepo. Check that your repo_type is not 'ignore'."
+        )

src/git_autograder/repo/__init__.py

@@ -0,0 +1,41 @@
+import os
+
+from git import Repo
+
+from git_autograder.helpers.branch_helper import BranchHelper
+from git_autograder.helpers.commit_helper import CommitHelper
+from git_autograder.helpers.file_helper import FileHelper
+from git_autograder.helpers.remote_helper import RemoteHelper
+from git_autograder.repo.repo_base import GitAutograderRepoBase
+
+
+class GitAutograderRepo(GitAutograderRepoBase):
+    def __init__(
+        self,
+        exercise_name: str,
+        repo_path: str | os.PathLike,
+    ) -> None:
+        self.exercise_name = exercise_name
+        self.repo_path = repo_path
+
+        self._repo: Repo = Repo(self.repo_path)
+
+        self._branches: BranchHelper = BranchHelper(self._repo)
+        self._commits: CommitHelper = CommitHelper(self._repo)
+        self._remotes: RemoteHelper = RemoteHelper(self._repo)
+        self._files: FileHelper = FileHelper(self._repo)
+
+    def repo(self) -> Repo:
+        return self._repo
+
+    def branches(self) -> BranchHelper:
+        return self._branches
+
+    def commits(self) -> CommitHelper:
+        return self._commits
+
+    def remotes(self) -> RemoteHelper:
+        return self._remotes
+
+    def files(self) -> FileHelper:
+        return self._files

src/git_autograder/repo/null_repo.py

@@ -0,0 +1,25 @@
+from abc import ABC, abstractmethod
+
+from git import Repo
+
+from git_autograder.helpers.branch_helper import BranchHelper
+from git_autograder.helpers.commit_helper import CommitHelper
+from git_autograder.helpers.file_helper import FileHelper
+from git_autograder.helpers.remote_helper import RemoteHelper
+
+
+class GitAutograderRepoBase(ABC):
+    @abstractmethod
+    def repo(self) -> Repo: ...
+
+    @abstractmethod
+    def branches(self) -> BranchHelper: ...
+
+    @abstractmethod
+    def commits(self) -> CommitHelper: ...
+
+    @abstractmethod
+    def remotes(self) -> RemoteHelper: ...
+
+    @abstractmethod
+    def files(self) -> FileHelper: ...