Class Processor

persper/graphs/processor.py:45–375

class Processor():

    def __init__(self, repo_path):
        self.repo_path = repo_path
        self.repo = initialize_repo(repo_path)
        self.visited = set()
        self.last_processed_commit = None

    def process(self, rev=None,
                from_beginning=False, num_commits=None,
                from_last_processed=False, end_commit_sha=None,
                into_branches=False,
                max_branch_length=100,
                min_branch_date=None,
                checkpoint_interval=100,
                skip_work=False,
                verbose=True):
        """
        This function supports four ways of specifying the
        range of commits to process:

        Method 1: rev
            Pass `rev` parameter and set both
            `from_beginning` and `from_last_processed` to False.
            `rev` is the revision specifier which follows
            an extended SHA-1 syntax. Please refer to git-rev-parse
            for viable options. `rev' should only include commits
            on the master branch.

        Method 2: from_beginning & num_commits (optional)
            Set `from_beginning` to True and
            pass `num_commits` parameter. Using this
            method, the function will start from the
            very first commit on the master branch and
            process the following `num_commits` commits
            (also on the master branch).

        Method 3: from_last_processed & num_commits
            Set `from_last_processed` to True and pass
            `num_commits` parameter. Using this method, the
            function will resume processing from succeeding commit of
            `self.last_processed_commit` for `num_commits` commits.

        Method 4: from_last_processed & end_commit_sha
            Set `from_last_processed` to True and pass
            `end_commit_sha` parameter. The range of continued processing
            will be `self.last_processed_commit.hexsha..end_commit_sha`.

        Args:
            rev: A string, see above.
            num_commits: An int, see above.
            from_beginning: A boolean flag, see above.
            from_last_processed: A boolean flag, see above.
            end_commit_sha: A string, see above.
            into_branches: A boolean flag, if True, the process function
                will operate in two phases.

                In the first phase, a call commit graph is contructed