EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Public Member Functions

PackageFile Class Reference

Public Member Functions

def __init__
def GetZipFile
def __str__
 Get file name.
def Unpack
 Extract the file.
def UnpackFile
 Extract the file.
def Extract
 Extract the file.
def Remove
 Remove the file.
def Pack
 Pack the files under Top directory, the directory shown in the zipFile start from BaseDir, BaseDir should be the parent directory of the Top directory, for example, Pack(Workspace, Workspace) will pack files under Dir1, and the path in the zipfile will start from Workspace.
def PackFiles
 Pack the file.
def PackFile
 Pack the file.
def PackData
 Write data to the packed file.
def Close
 Close file.

Detailed Description

Definition at line 42 of file PackageFile.py.


Constructor & Destructor Documentation

def __init__ (   self,
  FileName,
  Mode = "r" 
)

Definition at line 43 of file PackageFile.py.


Member Function Documentation

def __str__ (   self)

Get file name.

Definition at line 67 of file PackageFile.py.

def Close (   self)

Close file.

Definition at line 245 of file PackageFile.py.

def Extract (   self,
  Which,
  ToDest 
)

Extract the file.

Parameters:
Which,:the source path
To,:the destination path

Definition at line 101 of file PackageFile.py.

def GetZipFile (   self)

Definition at line 62 of file PackageFile.py.

def Pack (   self,
  Top,
  BaseDir 
)

Pack the files under Top directory, the directory shown in the zipFile start from BaseDir, BaseDir should be the parent directory of the Top directory, for example, Pack(Workspace, Workspace) will pack files under Dir1, and the path in the zipfile will start from Workspace.

Parameters:
Top,:the top directory
BaseDir,:the base directory

Definition at line 167 of file PackageFile.py.

def PackData (   self,
  Data,
  ArcName 
)

Write data to the packed file.

Parameters:
Data,:data to write
ArcName,:the Arc Name

Definition at line 235 of file PackageFile.py.

def PackFile (   self,
  File,
  ArcName = None 
)

Pack the file.

Parameters:
File,:the files to pack
ArcName,:the Arc Name

Definition at line 213 of file PackageFile.py.

def PackFiles (   self,
  Files 
)

Pack the file.

Parameters:
Files,:the files to pack

Definition at line 204 of file PackageFile.py.

def Remove (   self,
  Files 
)

Remove the file.

Parameters:
Files,:the removed files

Definition at line 135 of file PackageFile.py.

def Unpack (   self,
  ToDest 
)

Extract the file.

Parameters:
To,:the destination file

Definition at line 74 of file PackageFile.py.

def UnpackFile (   self,
  File,
  ToFile 
)

Extract the file.

Parameters:
File,:the extracted file
ToFile,:the destination file

Definition at line 86 of file PackageFile.py.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines