doc/api/python/imaker.api-pysrc.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>imaker.api</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="imaker-module.html">Package&nbsp;imaker</a> ::
       
    38         Module&nbsp;api
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="imaker.api-pysrc.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <h1 class="epydoc">Source Code for <a href="imaker.api-module.html">Module imaker.api</a></h1>
       
    55 <pre class="py-src">
       
    56 <a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-comment">#============================================================================ </tt> </tt>
       
    57 <a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Name        : api.py </tt> </tt>
       
    58 <a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Part of     : Helium </tt> </tt>
       
    59 <a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
       
    60 <a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-comment">#Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).</tt> </tt>
       
    61 <a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#All rights reserved.</tt> </tt>
       
    62 <a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#This component and the accompanying materials are made available</tt> </tt>
       
    63 <a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#under the terms of the License "Eclipse Public License v1.0"</tt> </tt>
       
    64 <a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#which accompanies this distribution, and is available</tt> </tt>
       
    65 <a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#at the URL "http://www.eclipse.org/legal/epl-v10.html".</tt> </tt>
       
    66 <a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
       
    67 <a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Initial Contributors:</tt> </tt>
       
    68 <a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Nokia Corporation - initial contribution.</tt> </tt>
       
    69 <a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
       
    70 <a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Contributors:</tt> </tt>
       
    71 <a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
       
    72 <a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Description:</tt> </tt>
       
    73 <a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#===============================================================================</tt> </tt>
       
    74 <a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
       
    75 <a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line"><tt class="py-docstring">""" This module is an helper to interface iMaker. """</tt> </tt>
       
    76 <a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt> </tt>
       
    77 <a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
       
    78 <a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Package pathaddition=pathaddition-module.html"><a title="pathaddition" class="py-name" href="#" onclick="return doclink('link-0', 'pathaddition', 'link-0');">pathaddition</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Method fileutils.AbstractScanner.match()=fileutils.AbstractScanner-class.html#match,Module pathaddition.match=pathaddition.match-module.html"><a title="fileutils.AbstractScanner.match
       
    79 pathaddition.match" class="py-name" href="#" onclick="return doclink('link-1', 'match', 'link-1');">match</a></tt> </tt>
       
    80 <a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Module fileutils=fileutils-module.html"><a title="fileutils" class="py-name" href="#" onclick="return doclink('link-2', 'fileutils', 'link-2');">fileutils</a></tt> </tt>
       
    81 <a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">tempfile</tt> </tt>
       
    82 <a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">subprocess</tt> </tt>
       
    83 <a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line"> </tt>
       
    84 <a name="IMakerConfigScanner"></a><div id="IMakerConfigScanner-def"><a name="L28"></a><tt class="py-lineno">28</tt> <a class="py-toggle" href="#" id="IMakerConfigScanner-toggle" onclick="return toggle('IMakerConfigScanner');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="imaker.api.IMakerConfigScanner-class.html">IMakerConfigScanner</a><tt class="py-op">(</tt><tt class="py-base-class">fileutils</tt><tt class="py-op">.</tt><tt class="py-base-class">AbstractScanner</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
    85 </div><div id="IMakerConfigScanner-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="IMakerConfigScanner-expanded"><a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">    <tt class="py-docstring">""" Specialize the abstract filescanner to support detection of the configuration. """</tt> </tt>
       
    86 <a name="IMakerConfigScanner.scan"></a><div id="IMakerConfigScanner.scan-def"><a name="L30"></a><tt class="py-lineno">30</tt> <a class="py-toggle" href="#" id="IMakerConfigScanner.scan-toggle" onclick="return toggle('IMakerConfigScanner.scan');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="imaker.api.IMakerConfigScanner-class.html#scan">scan</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
    87 </div><div id="IMakerConfigScanner.scan-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="IMakerConfigScanner.scan-expanded"><a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line">        <tt class="py-docstring">""" Implement scanning of relevant configuration. """</tt> </tt>
       
    88 <a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line">        <tt class="py-name">handle</tt> <tt class="py-op">=</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">Popen</tt><tt class="py-op">(</tt><tt class="py-string">"imaker help-config"</tt><tt class="py-op">,</tt> <tt class="py-name">shell</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">stdout</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt>  </tt>
       
    89 <a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">splitlines</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
    90 <a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line">            <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
    91 <a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Method fileutils.AbstractScanner.is_included()=fileutils.AbstractScanner-class.html#is_included,Function imaker.ant.is_included()=imaker.ant-module.html#is_included"><a title="fileutils.AbstractScanner.is_included
       
    92 imaker.ant.is_included" class="py-name" href="#" onclick="return doclink('link-3', 'is_included', 'link-3');">is_included</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> \ </tt>
       
    93 <a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line">                <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Method fileutils.AbstractScanner.is_excluded()=fileutils.AbstractScanner-class.html#is_excluded,Function imaker.ant.is_excluded()=imaker.ant-module.html#is_excluded"><a title="fileutils.AbstractScanner.is_excluded
       
    94 imaker.ant.is_excluded" class="py-name" href="#" onclick="return doclink('link-4', 'is_excluded', 'link-4');">is_excluded</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
    95 <a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line">                <tt class="py-keyword">yield</tt> <tt class="py-name">line</tt> </tt>
       
    96 <a name="L38"></a><tt class="py-lineno">38</tt>  <tt class="py-line">        <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method build.model.BOM.close()=build.model.BOM-class.html#close,Method build.model.SessionCreator.close()=build.model.SessionCreator-class.html#close,Method buildtools.AbstractOutputWriter.close()=buildtools.AbstractOutputWriter-class.html#close,Method ccm.AbstractSession.close()=ccm.AbstractSession-class.html#close,Method ccm.Session.close()=ccm.Session-class.html#close,Method ccm.SessionPool.close()=ccm.SessionPool-class.html#close,Method ccm.extra.CachedSessionProvider.close()=ccm.extra.CachedSessionProvider-class.html#close,Method ccm.extra.SessionProvider.close()=ccm.extra.SessionProvider-class.html#close,Method log2xml.LogWriter.close()=log2xml.LogWriter-class.html#close,Method preparation.PreparationBuilder.close()=preparation.PreparationBuilder-class.html#close,Method sysdef.io.FlashImageSizeWriter.close()=sysdef.io.FlashImageSizeWriter-class.html#close"><a title="build.model.BOM.close
       
    97 build.model.SessionCreator.close
       
    98 buildtools.AbstractOutputWriter.close
       
    99 ccm.AbstractSession.close
       
   100 ccm.Session.close
       
   101 ccm.SessionPool.close
       
   102 ccm.extra.CachedSessionProvider.close
       
   103 ccm.extra.SessionProvider.close
       
   104 log2xml.LogWriter.close
       
   105 preparation.PreparationBuilder.close
       
   106 sysdef.io.FlashImageSizeWriter.close" class="py-name" href="#" onclick="return doclink('link-5', 'close', 'link-5');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
   107 </div></div><a name="L39"></a><tt class="py-lineno">39</tt>  <tt class="py-line">         </tt>
       
   108 <a name="scan_configs"></a><div id="scan_configs-def"><a name="L40"></a><tt class="py-lineno">40</tt> <a class="py-toggle" href="#" id="scan_configs-toggle" onclick="return toggle('scan_configs');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="imaker.api-module.html#scan_configs">scan_configs</a><tt class="py-op">(</tt><tt class="py-param">includes</tt><tt class="py-op">,</tt> <tt class="py-param">excludes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
   109 </div><div id="scan_configs-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="scan_configs-expanded"><a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line">    <tt class="py-docstring">""" Use iMaker to scan the available buildable configurations. """</tt> </tt>
       
   110 <a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line">    <tt class="py-name">scanner</tt> <tt class="py-op">=</tt> <tt id="link-6" class="py-name" targets="Class imaker.api.IMakerConfigScanner=imaker.api.IMakerConfigScanner-class.html"><a title="imaker.api.IMakerConfigScanner" class="py-name" href="#" onclick="return doclink('link-6', 'IMakerConfigScanner', 'link-6');">IMakerConfigScanner</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
   111 <a name="L43"></a><tt class="py-lineno">43</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">inc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">includes</tt><tt class="py-op">:</tt> </tt>
       
   112 <a name="L44"></a><tt class="py-lineno">44</tt>  <tt class="py-line">        <tt class="py-name">scanner</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method fileutils.AbstractScanner.add_include()=fileutils.AbstractScanner-class.html#add_include"><a title="fileutils.AbstractScanner.add_include" class="py-name" href="#" onclick="return doclink('link-7', 'add_include', 'link-7');">add_include</a></tt><tt class="py-op">(</tt><tt class="py-name">inc</tt><tt class="py-op">)</tt> </tt>
       
   113 <a name="L45"></a><tt class="py-lineno">45</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">exc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">excludes</tt><tt class="py-op">:</tt> </tt>
       
   114 <a name="L46"></a><tt class="py-lineno">46</tt>  <tt class="py-line">        <tt class="py-name">scanner</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method fileutils.AbstractScanner.add_exclude()=fileutils.AbstractScanner-class.html#add_exclude"><a title="fileutils.AbstractScanner.add_exclude" class="py-name" href="#" onclick="return doclink('link-8', 'add_exclude', 'link-8');">add_exclude</a></tt><tt class="py-op">(</tt><tt class="py-name">exc</tt><tt class="py-op">)</tt> </tt>
       
   115 <a name="L47"></a><tt class="py-lineno">47</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">r</tt> <tt class="py-keyword">for</tt> <tt class="py-name">r</tt> <tt class="py-keyword">in</tt> <tt class="py-name">scanner</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method archive.scanners.AbldWhatScanner.scan()=archive.scanners.AbldWhatScanner-class.html#scan,Method archive.scanners.FileSystemScanner.scan()=archive.scanners.FileSystemScanner-class.html#scan,Method archive.scanners.InputFileScanner.scan()=archive.scanners.InputFileScanner-class.html#scan,Method archive.scanners.Scanner.scan()=archive.scanners.Scanner-class.html#scan,Method comments.CommentParser.scan()=comments.CommentParser-class.html#scan,Method fileutils.AbstractScanner.scan()=fileutils.AbstractScanner-class.html#scan,Method fileutils.FileScanner.scan()=fileutils.FileScanner-class.html#scan,Method imaker.api.IMakerConfigScanner.scan()=imaker.api.IMakerConfigScanner-class.html#scan"><a title="archive.scanners.AbldWhatScanner.scan
       
   116 archive.scanners.FileSystemScanner.scan
       
   117 archive.scanners.InputFileScanner.scan
       
   118 archive.scanners.Scanner.scan
       
   119 comments.CommentParser.scan
       
   120 fileutils.AbstractScanner.scan
       
   121 fileutils.FileScanner.scan
       
   122 imaker.api.IMakerConfigScanner.scan" class="py-name" href="#" onclick="return doclink('link-9', 'scan', 'link-9');">scan</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
       
   123 </div><a name="L48"></a><tt class="py-lineno">48</tt>  <tt class="py-line"> </tt>
       
   124 <a name="targets_for_config"></a><div id="targets_for_config-def"><a name="L49"></a><tt class="py-lineno">49</tt> <a class="py-toggle" href="#" id="targets_for_config-toggle" onclick="return toggle('targets_for_config');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="imaker.api-module.html#targets_for_config">targets_for_config</a><tt class="py-op">(</tt><tt class="py-param">config</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
   125 </div><div id="targets_for_config-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="targets_for_config-expanded"><a name="L50"></a><tt class="py-lineno">50</tt>  <tt class="py-line">    <tt class="py-docstring">""" Return the list of target supported by the provided configuration of iMaker. """</tt> </tt>
       
   126 <a name="L51"></a><tt class="py-lineno">51</tt>  <tt class="py-line">    <tt id="link-10" class="py-name" targets="Method buildtools.Command.cmd()=buildtools.Command-class.html#cmd"><a title="buildtools.Command.cmd" class="py-name" href="#" onclick="return doclink('link-10', 'cmd', 'link-10');">cmd</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"imaker -f %s help-target-*-list"</tt> <tt class="py-op">%</tt> <tt class="py-name">config</tt> </tt>
       
   127 <a name="L52"></a><tt class="py-lineno">52</tt>  <tt class="py-line">    <tt class="py-op">(</tt><tt class="py-name">_</tt><tt class="py-op">,</tt> <tt class="py-name">handle</tt><tt class="py-op">,</tt> <tt class="py-name">child_stderr</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">popen3</tt><tt class="py-op">(</tt><tt id="link-11" class="py-name"><a title="buildtools.Command.cmd" class="py-name" href="#" onclick="return doclink('link-11', 'cmd', 'link-10');">cmd</a></tt><tt class="py-op">)</tt> </tt>
       
   128 <a name="L53"></a><tt class="py-lineno">53</tt>  <tt class="py-line">    <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
       
   129 <a name="L54"></a><tt class="py-lineno">54</tt>  <tt class="py-line">    <tt class="py-keyword">print</tt> <tt class="py-name">child_stderr</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
   130 <a name="L55"></a><tt class="py-lineno">55</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">splitlines</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
   131 <a name="L56"></a><tt class="py-lineno">56</tt>  <tt class="py-line">        <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
   132 <a name="L57"></a><tt class="py-lineno">57</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">line</tt> <tt class="py-op">==</tt> <tt class="py-string">""</tt> <tt class="py-keyword">or</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">"Total duration"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
   133 <a name="L58"></a><tt class="py-lineno">58</tt>  <tt class="py-line">            <tt class="py-keyword">continue</tt> </tt>
       
   134 <a name="L59"></a><tt class="py-lineno">59</tt>  <tt class="py-line">        <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Method ccm.Folder.append()=ccm.Folder-class.html#append,Method ccm.Task.append()=ccm.Task-class.html#append"><a title="ccm.Folder.append
       
   135 ccm.Task.append" class="py-name" href="#" onclick="return doclink('link-12', 'append', 'link-12');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
       
   136 <a name="L60"></a><tt class="py-lineno">60</tt>  <tt class="py-line">    <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="build.model.BOM.close
       
   137 build.model.SessionCreator.close
       
   138 buildtools.AbstractOutputWriter.close
       
   139 ccm.AbstractSession.close
       
   140 ccm.Session.close
       
   141 ccm.SessionPool.close
       
   142 ccm.extra.CachedSessionProvider.close
       
   143 ccm.extra.SessionProvider.close
       
   144 log2xml.LogWriter.close
       
   145 preparation.PreparationBuilder.close
       
   146 sysdef.io.FlashImageSizeWriter.close" class="py-name" href="#" onclick="return doclink('link-13', 'close', 'link-5');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
   147 <a name="L61"></a><tt class="py-lineno">61</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
       
   148 </div><a name="L62"></a><tt class="py-lineno">62</tt>  <tt class="py-line"> </tt>
       
   149 <a name="L63"></a><tt class="py-lineno">63</tt>  <tt class="py-line"> </tt>
       
   150 <a name="get_product_dir"></a><div id="get_product_dir-def"><a name="L64"></a><tt class="py-lineno">64</tt> <a class="py-toggle" href="#" id="get_product_dir-toggle" onclick="return toggle('get_product_dir');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="imaker.api-module.html#get_product_dir">get_product_dir</a><tt class="py-op">(</tt><tt class="py-param">product</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
   151 </div><div id="get_product_dir-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="get_product_dir-expanded"><a name="L65"></a><tt class="py-lineno">65</tt>  <tt class="py-line">    <tt class="py-docstring">""" Return the PRODUCT_DIR variable from iMaker. """</tt> </tt>
       
   152 <a name="L66"></a><tt class="py-lineno">66</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-14" class="py-name" targets="Function imaker.api.get_variable()=imaker.api-module.html#get_variable"><a title="imaker.api.get_variable" class="py-name" href="#" onclick="return doclink('link-14', 'get_variable', 'link-14');">get_variable</a></tt><tt class="py-op">(</tt><tt class="py-string">"PRODUCT_DIR"</tt><tt class="py-op">,</tt> <tt id="link-15" class="py-name" targets="Variable symrec.ReleaseMetadata.product=symrec.ReleaseMetadata-class.html#product"><a title="symrec.ReleaseMetadata.product" class="py-name" href="#" onclick="return doclink('link-15', 'product', 'link-15');">product</a></tt><tt class="py-op">=</tt><tt id="link-16" class="py-name"><a title="symrec.ReleaseMetadata.product" class="py-name" href="#" onclick="return doclink('link-16', 'product', 'link-15');">product</a></tt><tt class="py-op">)</tt> </tt>
       
   153 </div><a name="L67"></a><tt class="py-lineno">67</tt>  <tt class="py-line"> </tt>
       
   154 <a name="L68"></a><tt class="py-lineno">68</tt>  <tt class="py-line">     </tt>
       
   155 <a name="get_variable"></a><div id="get_variable-def"><a name="L69"></a><tt class="py-lineno">69</tt> <a class="py-toggle" href="#" id="get_variable-toggle" onclick="return toggle('get_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="imaker.api-module.html#get_variable">get_variable</a><tt class="py-op">(</tt><tt class="py-param">variable</tt><tt class="py-op">,</tt> <tt class="py-param">target</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">product</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">config</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">default</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
   156 </div><div id="get_variable-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="get_variable-expanded"><a name="L70"></a><tt class="py-lineno">70</tt>  <tt class="py-line">    <tt class="py-docstring">""" Get variable value from iMaker. """</tt> </tt>
       
   157 <a name="L71"></a><tt class="py-lineno">71</tt>  <tt class="py-line">    <tt class="py-name">cmdline</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
       
   158 <a name="L72"></a><tt class="py-lineno">72</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt id="link-17" class="py-name"><a title="symrec.ReleaseMetadata.product" class="py-name" href="#" onclick="return doclink('link-17', 'product', 'link-15');">product</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
       
   159 <a name="L73"></a><tt class="py-lineno">73</tt>  <tt class="py-line">        <tt class="py-name">cmdline</tt> <tt class="py-op">=</tt> <tt class="py-string">"-p%s"</tt> <tt class="py-op">%</tt> <tt id="link-18" class="py-name"><a title="symrec.ReleaseMetadata.product" class="py-name" href="#" onclick="return doclink('link-18', 'product', 'link-15');">product</a></tt> </tt>
       
   160 <a name="L74"></a><tt class="py-lineno">74</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">config</tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
       
   161 <a name="L75"></a><tt class="py-lineno">75</tt>  <tt class="py-line">        <tt class="py-name">cmdline</tt> <tt class="py-op">+=</tt> <tt class="py-string">" -f %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">config</tt> </tt>
       
   162 <a name="L76"></a><tt class="py-lineno">76</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">target</tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
       
   163 <a name="L77"></a><tt class="py-lineno">77</tt>  <tt class="py-line">        <tt class="py-name">cmdline</tt> <tt class="py-op">+=</tt> <tt class="py-string">" %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">target</tt> </tt>
       
   164 <a name="L78"></a><tt class="py-lineno">78</tt>  <tt class="py-line">     </tt>
       
   165 <a name="L79"></a><tt class="py-lineno">79</tt>  <tt class="py-line">    <tt class="py-name">logdir</tt> <tt class="py-op">=</tt> <tt class="py-name">tempfile</tt><tt class="py-op">.</tt><tt class="py-name">mkdtemp</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
   166 <a name="L80"></a><tt class="py-lineno">80</tt>  <tt class="py-line">    <tt class="py-keyword">print</tt> <tt class="py-string">"imaker %s print-%s WORKDIR=%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">cmdline</tt><tt class="py-op">,</tt> <tt class="py-name">variable</tt><tt class="py-op">,</tt> <tt class="py-name">logdir</tt><tt class="py-op">)</tt> </tt>
       
   167 <a name="L81"></a><tt class="py-lineno">81</tt>  <tt class="py-line">    <tt class="py-op">(</tt><tt class="py-name">_</tt><tt class="py-op">,</tt> <tt class="py-name">handle</tt><tt class="py-op">,</tt> <tt class="py-name">child_stderr</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">popen3</tt><tt class="py-op">(</tt><tt class="py-string">"imaker %s print-%s WORKDIR=%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">cmdline</tt><tt class="py-op">,</tt> <tt class="py-name">variable</tt><tt class="py-op">,</tt> <tt class="py-name">logdir</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
       
   168 <a name="L82"></a><tt class="py-lineno">82</tt>  <tt class="py-line">    <tt class="py-keyword">print</tt> <tt class="py-name">child_stderr</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
   169 <a name="L83"></a><tt class="py-lineno">83</tt>  <tt class="py-line">    <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
       
   170 <a name="L84"></a><tt class="py-lineno">84</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">splitlines</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
   171 <a name="L85"></a><tt class="py-lineno">85</tt>  <tt class="py-line">        <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
   172 <a name="L86"></a><tt class="py-lineno">86</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">line</tt> <tt class="py-op">==</tt> <tt class="py-string">""</tt> <tt class="py-keyword">or</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">"Total duration"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
   173 <a name="L87"></a><tt class="py-lineno">87</tt>  <tt class="py-line">            <tt class="py-keyword">continue</tt> </tt>
       
   174 <a name="L88"></a><tt class="py-lineno">88</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">variable</tt> <tt class="py-keyword">in</tt> <tt class="py-name">line</tt><tt class="py-op">:</tt> </tt>
       
   175 <a name="L89"></a><tt class="py-lineno">89</tt>  <tt class="py-line">            <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="ccm.Folder.append
       
   176 ccm.Task.append" class="py-name" href="#" onclick="return doclink('link-19', 'append', 'link-12');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
       
   177 <a name="L90"></a><tt class="py-lineno">90</tt>  <tt class="py-line">    <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="build.model.BOM.close
       
   178 build.model.SessionCreator.close
       
   179 buildtools.AbstractOutputWriter.close
       
   180 ccm.AbstractSession.close
       
   181 ccm.Session.close
       
   182 ccm.SessionPool.close
       
   183 ccm.extra.CachedSessionProvider.close
       
   184 ccm.extra.SessionProvider.close
       
   185 log2xml.LogWriter.close
       
   186 preparation.PreparationBuilder.close
       
   187 sysdef.io.FlashImageSizeWriter.close" class="py-name" href="#" onclick="return doclink('link-20', 'close', 'link-5');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
       
   188 <a name="L91"></a><tt class="py-lineno">91</tt>  <tt class="py-line">    <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="fileutils.AbstractScanner.match
       
   189 pathaddition.match" class="py-name" href="#" onclick="return doclink('link-21', 'match', 'link-1');">match</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s\s*=\s*`(.*)'"</tt> <tt class="py-op">%</tt> <tt class="py-name">variable</tt><tt class="py-op">,</tt> <tt class="py-string">"\n"</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt><tt class="py-op">)</tt> </tt>
       
   190 <a name="L92"></a><tt class="py-lineno">92</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">result</tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
       
   191 <a name="L93"></a><tt class="py-lineno">93</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
       
   192 <a name="L94"></a><tt class="py-lineno">94</tt>  <tt class="py-line">    <tt class="py-keyword">assert</tt> <tt class="py-op">(</tt><tt class="py-name">result</tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
       
   193 <a name="L95"></a><tt class="py-lineno">95</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">default</tt> </tt>
       
   194 </div><a name="L96"></a><tt class="py-lineno">96</tt>  <tt class="py-line"> </tt><script type="text/javascript">
       
   195 <!--
       
   196 expandto(location.href);
       
   197 // -->
       
   198 </script>
       
   199 </pre>
       
   200 <br />
       
   201 <!-- ==================== NAVIGATION BAR ==================== -->
       
   202 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   203        bgcolor="#a0c0ff" cellspacing="0">
       
   204   <tr valign="middle">
       
   205 
       
   206   <!-- Tree link -->
       
   207       <th>&nbsp;&nbsp;&nbsp;<a
       
   208         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   209 
       
   210   <!-- Index link -->
       
   211       <th>&nbsp;&nbsp;&nbsp;<a
       
   212         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   213 
       
   214   <!-- Help link -->
       
   215       <th>&nbsp;&nbsp;&nbsp;<a
       
   216         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   217 
       
   218       <th class="navbar" width="100%"></th>
       
   219   </tr>
       
   220 </table>
       
   221 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   222   <tr>
       
   223     <td align="left" class="footer">
       
   224     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:23 2009
       
   225     </td>
       
   226     <td align="right" class="footer">
       
   227       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   228     </td>
       
   229   </tr>
       
   230 </table>
       
   231 
       
   232 <script type="text/javascript">
       
   233   <!--
       
   234   // Private objects are initially displayed (because if
       
   235   // javascript is turned off then we want them to be
       
   236   // visible); but by default, we want to hide them.  So hide
       
   237   // them unless we have a cookie that says to show them.
       
   238   checkCookie()
       
   239   // -->
       
   240 </script>
       
   241   
       
   242 </body>
       
   243 </html>