flavor.api.SkiaFlavorApi Class Reference

Inheritance diagram for flavor.api.SkiaFlavorApi:

Public Member Functions
def	get_flavor (self, vars_api, app_name)
def	setup (self, app_name)
def	step (self, name, cmd, **kwargs)
def	device_path_join (self, *args)
def	copy_directory_contents_to_device (self, host_dir, device_dir)
def	copy_directory_contents_to_host (self, device_dir, host_dir)
def	copy_file_to_device (self, host_path, device_path)
def	create_clean_host_dir (self, path)
def	create_clean_device_dir (self, path)
def	read_file_on_device (self, path, **kwargs)
def	remove_file_on_device (self, path)
def	install (self, skps=False, images=False, lotties=False, svgs=False, resources=False, texttraces=False)
def	cleanup_steps (self)

Public Attributes
	device_dirs
	host_dirs

Detailed Description

Definition at line 54 of file api.py.

Member Function Documentation

cleanup_steps()

def flavor.api.SkiaFlavorApi.cleanup_steps

(

self

)

Definition at line 122 of file api.py.

  def cleanup_steps(self):
    return self._f.cleanup_steps()
 

copy_directory_contents_to_device()

def flavor.api.SkiaFlavorApi.copy_directory_contents_to_device	(		self,
			host_dir,
			device_dir
	)

Definition at line 80 of file api.py.

  def copy_directory_contents_to_device(self, host_dir, device_dir):
    return self._f.copy_directory_contents_to_device(host_dir, device_dir)
 

copy_directory_contents_to_host()

def flavor.api.SkiaFlavorApi.copy_directory_contents_to_host	(		self,
			device_dir,
			host_dir
	)

Definition at line 83 of file api.py.

  def copy_directory_contents_to_host(self, device_dir, host_dir):
    return self._f.copy_directory_contents_to_host(device_dir, host_dir)
 

copy_file_to_device()

def flavor.api.SkiaFlavorApi.copy_file_to_device	(		self,
			host_path,
			device_path
	)

Definition at line 86 of file api.py.

  def copy_file_to_device(self, host_path, device_path):
    return self._f.copy_file_to_device(host_path, device_path)
 

create_clean_device_dir()

def flavor.api.SkiaFlavorApi.create_clean_device_dir	(		self,
			path
	)

Definition at line 92 of file api.py.

  def create_clean_device_dir(self, path):
    return self._f.create_clean_device_dir(path)
 

create_clean_host_dir()

def flavor.api.SkiaFlavorApi.create_clean_host_dir	(		self,
			path
	)

Definition at line 89 of file api.py.

  def create_clean_host_dir(self, path):
    return self._f.create_clean_host_dir(path)
 

device_path_join()

def flavor.api.SkiaFlavorApi.device_path_join	(		self,
		*	args
	)

Definition at line 77 of file api.py.

  def device_path_join(self, *args):
    return self._f.device_path_join(*args)
 

get_flavor()

def flavor.api.SkiaFlavorApi.get_flavor	(		self,
			vars_api,
			app_name
	)

Return a flavor utils object specific to the given builder.

Definition at line 55 of file api.py.

  def get_flavor(self, vars_api, app_name):
    """Return a flavor utils object specific to the given builder."""
    if is_chromebook(vars_api):
      return chromebook.ChromebookFlavor(self, app_name)
    if is_android(vars_api):
      return android.AndroidFlavor(self, app_name)
    elif is_ios(vars_api):
      return ios.iOSFlavor(self, app_name)
    elif is_valgrind(vars_api):
      return valgrind.ValgrindFlavor(self, app_name)
    else:
      return default.DefaultFlavor(self, app_name)
 

install()

def flavor.api.SkiaFlavorApi.install	(		self,
			skps = False,
			images = False,
			lotties = False,
			svgs = False,
			resources = False,
			texttraces = False
	)

Definition at line 101 of file api.py.

              resources=False, texttraces=False):
    self._f.install()
 
    if texttraces:
      self._copy_texttraces()
    # TODO(borenet): Only copy files which have changed.
    if resources:
      self.copy_directory_contents_to_device(
          self.m.path.start_dir.join('skia', 'resources'),
          self.device_dirs.resource_dir)
 
    if skps:
      self._copy_skps()
    if images:
      self._copy_images()
    if lotties:
      self._copy_lotties()
    if svgs:
      self._copy_svgs()
 

read_file_on_device()

def flavor.api.SkiaFlavorApi.read_file_on_device	(		self,
			path,
		**	kwargs
	)

Definition at line 95 of file api.py.

  def read_file_on_device(self, path, **kwargs):
    return self._f.read_file_on_device(path, **kwargs)
 

remove_file_on_device()

def flavor.api.SkiaFlavorApi.remove_file_on_device	(		self,
			path
	)

Definition at line 98 of file api.py.

  def remove_file_on_device(self, path):
    return self._f.remove_file_on_device(path)
 

setup()

def flavor.api.SkiaFlavorApi.setup	(		self,
			app_name
	)

Definition at line 68 of file api.py.

  def setup(self, app_name):
    self._f = self.get_flavor(self.m.vars, app_name)
    self.device_dirs = self._f.device_dirs
    self.host_dirs = self._f.host_dirs
    self._skia_dir = self.m.path.start_dir.join('skia')
 

step()

def flavor.api.SkiaFlavorApi.step	(		self,
			name,
			cmd,
		**	kwargs
	)

Definition at line 74 of file api.py.

  def step(self, name, cmd, **kwargs):
    return self._f.step(name, cmd, **kwargs)
 

Member Data Documentation

device_dirs

flavor.api.SkiaFlavorApi.device_dirs

Definition at line 70 of file api.py.

host_dirs

flavor.api.SkiaFlavorApi.host_dirs

Definition at line 71 of file api.py.

---

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

• third_party/skia/infra/bots/recipe_modules/flavor/api.py