diff -r 7685cec9fd3c -r f2ddfa555b0f doc/api/python/ats3.parsers.PkgFileParser-class.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/api/python/ats3.parsers.PkgFileParser-class.html Fri Sep 11 11:54:49 2009 +0100 @@ -0,0 +1,388 @@ + + + + + ats3.parsers.PkgFileParser + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Package ats3 :: + Module parsers :: + Class PkgFileParser + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class PkgFileParser

source code

+
+object --+
+         |
+        PkgFileParser
+
+ +
+
+
Parses .pkg files. Returns a list of:
+
    +
  1. src path of the file
  2. +
  3. dst path on the phone
  4. +
  5. type of the file
  6. +
+
+
+

for every file in the pkg file



+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + platform=None)
+ x.__init__(...) initializes x; see x.__class__.__doc__ for signature
+ source code + +
+ +
+   + + + + + + +
get_pkg_files(self, + location=None, + with_full_path=True)
+ Returns list of PKG files on the given location.
+ source code + +
+ +
+   + + + + + + +
get_data_files(self, + location=[], + drive="", + exclude="")
+ Returns data files, source and destination of the files to be installed +on the phone +e.g.
+ source code + +
+ +
+   + + + + + + +
__map_pkg_path(self, + pkg_line, + pkg_file_path)
+ Parse package file to get the src and dst paths" for installing files
+ source code + +
+ +
+   + + + + + + +
__read_pkg_file(self, + pkg_files)
+ Reads contents of PKG file
+ source code + +
+ +
+

Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __str__ +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + platform=None) +
(Constructor) +

+
source code  +
+ + x.__init__(...) initializes x; see x.__class__.__doc__ for signature +
+
Overrides: + object.__init__ +
(inherited documentation)
+ +
+
+
+ +
+ +
+ + +
+

get_pkg_files(self, + location=None, + with_full_path=True) +

+
source code  +
+ +
+
+Returns list of PKG files on the given location. If True, full path is returned 
+otherwise only filenames. Default is set to True
+
+Assume at location "c:bdiles", two pkg file '1.pkg' and '2.pkg', then the funtion
+can be called as:
+1. get_pkg_files("c:bdiles")        - will return a list of pkg files with full paths. 
+                                          like ['c:bdiles.pkg', 'c:bdiles.pkg']
+2. get_pkg_files("c:bdiles", False) - will return a list of pkg files only. 
+                                          like ['1.pkg', '2.pkg']
+
+
+
+
+
+
+ +
+ +
+ + +
+

get_data_files(self, + location=[], + drive="", + exclude="") +

+
source code  +
+ +
+
+Returns data files, source and destination of the files to be installed 
+on the phone 
+e.g. location = tsrc    estComponent\group
+
+Function can be called in any of the following ways:
+1. get_data_files("c:bcbc.pkg")                 - only data files' paths are returnd 
+                                                      as they are mention in the pkg file
+2. get_data_files("c:bcbc.pkg", "x:")           - Proper data files' paths are returnd 
+                                                      with drive letter included 
+3. get_data_files("c:bcbc.pkg", "x:", "\.dll")  - Data files' paths are returnd with 
+                                                      drive letter included but the dll 
+                                                      files will be excluded if found in 
+                                                      the pkg file
+
+if pkg file is not given, the function will try to find the file(s) on the given location with extension ".pkg"
+
+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + +