git_utils.NewGitCheckout Class Reference

Inheritance diagram for git_utils.NewGitCheckout:

Public Member Functions
	__init__ (self, repository, local=None)
	name (self)
	root (self)
	__enter__ (self)
Public Member Functions inherited from utils.tmp_dir
	__exit__ (self, t, v, tb)

Protected Attributes
	_checkout_root
	_repository
	_local
Protected Attributes inherited from utils.tmp_dir
	_orig_dir
	_tmp_dir

Detailed Description

Creates a new local checkout of a Git repository.

Definition at line 103 of file git_utils.py.

Constructor & Destructor Documentation

__init__()

git_utils.NewGitCheckout.__init__	(		self,
			repository,
			local = None
	)

Set parameters for this local copy of a Git repository.

Because this is a new checkout, rather than a reference to an existing
checkout on disk, it is safe to assume that the calling thread is the
only thread manipulating the checkout.

You must use the 'with' statement to create this object:

with NewGitCheckout(*args) as checkout:
  # use checkout instance
# the checkout is automatically cleaned up here

Args:
  repository: URL of the remote repository (e.g.,
      'https://skia.googlesource.com/common') or path to a local repository
      (e.g., '/path/to/repo/.git') to check out a copy of
  local: optional path to an existing copy of the remote repo on local disk.
      If provided, the initial clone is performed with the local copy as the
      upstream, then the upstream is switched to the remote repo and the
      new copy is updated from there.

Reimplemented from utils.tmp_dir.

Definition at line 106 of file git_utils.py.

  def __init__(self, repository, local=None):
    """Set parameters for this local copy of a Git repository.
 
    Because this is a new checkout, rather than a reference to an existing
    checkout on disk, it is safe to assume that the calling thread is the
    only thread manipulating the checkout.
 
    You must use the 'with' statement to create this object:
 
    with NewGitCheckout(*args) as checkout:
      # use checkout instance
    # the checkout is automatically cleaned up here
 
    Args:
      repository: URL of the remote repository (e.g.,
          'https://skia.googlesource.com/common') or path to a local repository
          (e.g., '/path/to/repo/.git') to check out a copy of
      local: optional path to an existing copy of the remote repo on local disk.
          If provided, the initial clone is performed with the local copy as the
          upstream, then the upstream is switched to the remote repo and the
          new copy is updated from there.
    """
    super(NewGitCheckout, self).__init__()
    self._checkout_root = ''
    self._repository = repository
    self._local = local
 

Member Function Documentation

__enter__()

git_utils.NewGitCheckout.__enter__

(

self

)

Check out a new local copy of the repository.

Uses the parameters that were passed into the constructor.

Reimplemented from utils.tmp_dir.

Definition at line 142 of file git_utils.py.

  def __enter__(self):
    """Check out a new local copy of the repository.
 
    Uses the parameters that were passed into the constructor.
    """
    super(NewGitCheckout, self).__enter__()
    remote = self._repository
    if self._local:
      remote = self._local
    subprocess.check_call(['git', 'clone', remote])
    repo_name = remote.split('/')[-1]
    if repo_name.endswith('.git'):
      repo_name = repo_name[:-len('.git')]
    self._checkout_root = os.path.join(os.getcwd(), repo_name)
    os.chdir(repo_name)
    if self._local:
      subprocess.check_call([
          'git', 'remote', 'set-url', 'origin', self._repository])
      subprocess.check_call(['git', 'remote', 'update'])
      subprocess.check_call(['git', 'checkout', 'main'])
      subprocess.check_call(['git', 'reset', '--hard', 'origin/main'])
    return self

name()

git_utils.NewGitCheckout.name

(

self

)

Reimplemented from utils.tmp_dir.

Definition at line 134 of file git_utils.py.

  def name(self):
    return self._checkout_root
 

root()

git_utils.NewGitCheckout.root

(

self

)

Returns the root directory containing the checked-out files.

Definition at line 138 of file git_utils.py.

  def root(self):
    """Returns the root directory containing the checked-out files."""
    return self.name
 

Member Data Documentation

_checkout_root

git_utils.NewGitCheckout._checkout_root

protected

Definition at line 129 of file git_utils.py.

_local

git_utils.NewGitCheckout._local

protected

Definition at line 131 of file git_utils.py.

_repository

git_utils.NewGitCheckout._repository

protected

Definition at line 130 of file git_utils.py.

---

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

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