git_utils.GitBranch Class Reference

Inheritance diagram for git_utils.GitBranch:

Public Member Functions
	__init__ (self, branch_name, commit_msg, upload=True, commit_queue=False, delete_when_finished=True, cc_list=None)
	__enter__ (self)
	commit_and_upload (self, use_commit_queue=False)
	__exit__ (self, exc_type, _value, _traceback)

Protected Attributes
	_branch_name
	_commit_msg
	_upload
	_commit_queue
	_patch_set
	_delete_when_finished
	_cc_list

Detailed Description

Class to manage git branches.

This class allows one to create a new branch in a repository to make changes,
then it commits the changes, switches to main branch, and deletes the
created temporary branch upon exit.

Definition at line 44 of file git_utils.py.

Constructor & Destructor Documentation

__init__()

git_utils.GitBranch.__init__	(		self,
			branch_name,
			commit_msg,
			upload = True,
			commit_queue = False,
			delete_when_finished = True,
			cc_list = None
	)

Definition at line 51 of file git_utils.py.

               delete_when_finished=True, cc_list=None):
    self._branch_name = branch_name
    self._commit_msg = commit_msg
    self._upload = upload
    self._commit_queue = commit_queue
    self._patch_set = 0
    self._delete_when_finished = delete_when_finished
    self._cc_list = cc_list
 

Member Function Documentation

__enter__()

git_utils.GitBranch.__enter__

(

self

)

Definition at line 61 of file git_utils.py.

  def __enter__(self):
    subprocess.check_call(['git', 'reset', '--hard', 'HEAD'])
    subprocess.check_call(['git', 'checkout', 'main'])
    if self._branch_name in subprocess.check_output([
        'git', 'branch']).decode('utf-8').split():
      subprocess.check_call(['git', 'branch', '-D', self._branch_name])
    subprocess.check_call(['git', 'checkout', '-b', self._branch_name,
                           '-t', 'origin/main'])
    return self
 

__exit__()

git_utils.GitBranch.__exit__	(		self,
			exc_type,
			_value,
			_traceback
	)

Definition at line 91 of file git_utils.py.

  def __exit__(self, exc_type, _value, _traceback):
    if self._upload:
      # Only upload if no error occurred.
      try:
        if exc_type is None:
          self.commit_and_upload(use_commit_queue=self._commit_queue)
      finally:
        subprocess.check_call(['git', 'checkout', 'main'])
        if self._delete_when_finished:
          subprocess.check_call(['git', 'branch', '-D', self._branch_name])
 
 

commit_and_upload()

git_utils.GitBranch.commit_and_upload	(		self,
			use_commit_queue = False
	)

Commit all changes and upload a CL, returning the issue URL.

Definition at line 71 of file git_utils.py.

  def commit_and_upload(self, use_commit_queue=False):
    """Commit all changes and upload a CL, returning the issue URL."""
    subprocess.check_call(['git', 'commit', '-a', '-m', self._commit_msg])
    upload_cmd = ['git', 'cl', 'upload', '-f', '--bypass-hooks',
                  '--bypass-watchlists']
    self._patch_set += 1
    if self._patch_set > 1:
      upload_cmd.extend(['-t', 'Patch set %d' % self._patch_set])
    if use_commit_queue:
      upload_cmd.append('--use-commit-queue')
      # Need the --send-mail flag to publish the CL and remove WIP bit.
      upload_cmd.append('--send-mail')
    if self._cc_list:
      upload_cmd.extend(['--cc=%s' % ','.join(self._cc_list)])
    subprocess.check_call(upload_cmd)
    output = subprocess.check_output([
        'git', 'cl', 'issue']).decode('utf-8').rstrip()
    return re.match('^Issue number: (?P<issue>\d+) \‍((?P<issue_url>.+)\‍)$',
                    output).group('issue_url')
 

Member Data Documentation

_branch_name

git_utils.GitBranch._branch_name

protected

Definition at line 53 of file git_utils.py.

_cc_list

git_utils.GitBranch._cc_list

protected

Definition at line 59 of file git_utils.py.

_commit_msg

git_utils.GitBranch._commit_msg

protected

Definition at line 54 of file git_utils.py.

_commit_queue

git_utils.GitBranch._commit_queue

protected

Definition at line 56 of file git_utils.py.

_delete_when_finished

git_utils.GitBranch._delete_when_finished

protected

Definition at line 58 of file git_utils.py.

_patch_set

git_utils.GitBranch._patch_set

protected

Definition at line 57 of file git_utils.py.

_upload

git_utils.GitBranch._upload

protected

Definition at line 55 of file git_utils.py.

---

The documentation for this class was generated from the following file:

• third_party/skia/infra/bots/git_utils.py