AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
upload.VersionControlSystem Class Reference
Inheritance diagram for upload.VersionControlSystem:
Inheritance graph
[legend]
Collaboration diagram for upload.VersionControlSystem:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, options)
 
def GenerateDiff (self, args)
 
def GetUnknownFiles (self)
 
def CheckForUnknownFiles (self)
 
def GetBaseFile (self, filename)
 
def GetBaseFiles (self, diff)
 
def UploadBaseFiles (self, issue, rpc_server, patch_list, patchset, options, files)
 
def IsImage (self, filename)
 
def __init__ (self, options)
 
def GenerateDiff (self, args)
 
def GetUnknownFiles (self)
 
def CheckForUnknownFiles (self)
 
def GetBaseFile (self, filename)
 
def GetBaseFiles (self, diff)
 
def UploadBaseFiles (self, issue, rpc_server, patch_list, patchset, options, files)
 
def IsImage (self, filename)
 

Public Attributes

 options
 

Detailed Description

Abstract base class providing an interface to the VCS.

Constructor & Destructor Documentation

◆ __init__() [1/2]

def upload.VersionControlSystem.__init__ (   self,
  options 
)
Constructor.

Args:
  options: Command line options.

◆ __init__() [2/2]

def upload.VersionControlSystem.__init__ (   self,
  options 
)
Constructor.

Args:
  options: Command line options.

Member Function Documentation

◆ CheckForUnknownFiles() [1/2]

def upload.VersionControlSystem.CheckForUnknownFiles (   self)
Show an "are you sure?" prompt if there are unknown files.

◆ CheckForUnknownFiles() [2/2]

def upload.VersionControlSystem.CheckForUnknownFiles (   self)
Show an "are you sure?" prompt if there are unknown files.

◆ GenerateDiff() [1/2]

def upload.VersionControlSystem.GenerateDiff (   self,
  args 
)
Return the current diff as a string.

Args:
  args: Extra arguments to pass to the diff command.

◆ GenerateDiff() [2/2]

def upload.VersionControlSystem.GenerateDiff (   self,
  args 
)
Return the current diff as a string.

Args:
  args: Extra arguments to pass to the diff command.

◆ GetBaseFile() [1/2]

def upload.VersionControlSystem.GetBaseFile (   self,
  filename 
)
Get the content of the upstream version of a file.

Returns:
  A tuple (base_content, new_content, is_binary, status)
base_content: The contents of the base file.
new_content: For text files, this is empty.  For binary files, this is
  the contents of the new file, since the diff output won't contain
  information to reconstruct the current file.
is_binary: True iff the file is binary.
status: The status of the file.

◆ GetBaseFile() [2/2]

def upload.VersionControlSystem.GetBaseFile (   self,
  filename 
)
Get the content of the upstream version of a file.

Returns:
  A tuple (base_content, new_content, is_binary, status)
base_content: The contents of the base file.
new_content: For text files, this is empty.  For binary files, this is
  the contents of the new file, since the diff output won't contain
  information to reconstruct the current file.
is_binary: True iff the file is binary.
status: The status of the file.

◆ GetBaseFiles() [1/2]

def upload.VersionControlSystem.GetBaseFiles (   self,
  diff 
)
Helper that calls GetBase file for each file in the patch.

Returns:
  A dictionary that maps from filename to GetBaseFile's tuple.  Filenames
  are retrieved based on lines that start with "Index:" or
  "Property changes on:".

◆ GetBaseFiles() [2/2]

def upload.VersionControlSystem.GetBaseFiles (   self,
  diff 
)
Helper that calls GetBase file for each file in the patch.

Returns:
  A dictionary that maps from filename to GetBaseFile's tuple.  Filenames
  are retrieved based on lines that start with "Index:" or
  "Property changes on:".

◆ GetUnknownFiles() [1/2]

def upload.VersionControlSystem.GetUnknownFiles (   self)
Return a list of files unknown to the VCS.

◆ GetUnknownFiles() [2/2]

def upload.VersionControlSystem.GetUnknownFiles (   self)
Return a list of files unknown to the VCS.

◆ IsImage() [1/2]

def upload.VersionControlSystem.IsImage (   self,
  filename 
)
Returns true if the filename has an image extension.

◆ IsImage() [2/2]

def upload.VersionControlSystem.IsImage (   self,
  filename 
)
Returns true if the filename has an image extension.

◆ UploadBaseFiles() [1/2]

def upload.VersionControlSystem.UploadBaseFiles (   self,
  issue,
  rpc_server,
  patch_list,
  patchset,
  options,
  files 
)
Uploads the base files (and if necessary, the current ones as well).

◆ UploadBaseFiles() [2/2]

def upload.VersionControlSystem.UploadBaseFiles (   self,
  issue,
  rpc_server,
  patch_list,
  patchset,
  options,
  files 
)
Uploads the base files (and if necessary, the current ones as well).

Member Data Documentation

◆ options

upload.VersionControlSystem.options

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0