[robotframework] push by [email protected] - process: updated the documentation on 2013-05-06 09:56 GMT

robotframework Mon, 06 May 2013 02:56:13 -0700

Revision: ad472477f8ee
Branch:   default
Author:   Mika Hänninen <[email protected]>
Date:     Mon May  6 02:55:56 2013
Log:      process: updated the documentation
http://code.google.com/p/robotframework/source/detail?r=ad472477f8ee


Modified:
 /doc/libraries/Process.html

=======================================
--- /doc/libraries/Process.html Thu May  2 06:48:06 2013
+++ /doc/libraries/Process.html Mon May  6 02:55:56 2013
@@ -169,7 +169,7 @@

(function(a){var r=a.fn.domManip,d="_tmplitem",q=/^[^<]*(<[\w\W]+>)[^>]*$|\{\{\! /,b={},f={},e,p={key:0,data:{}},i=0,c=0,l=[];function g(g,d,h,e){varc={data:e||(e===0||e===false)?e:d?d.data:{},_wrap:d?d._wrap:null,tmpl:null,parent:d||null,nodes:[],calls:u,nest:w,wrap:x,html:v,update:t};g&&a.extend(c,g,{nodes:[],parent:d});if(h){c.tmpl=h;c._ctnt=c._ctnt||c.tmpl(a,c);c.key=++i;(l.length?f:b)[i]=c}returnc}a.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(f,d){a.fn[f]=function(n){varg=[],i=a(n),k,h,m,l,j=this.length===1&&this[0].parentNode;e=b||{};if(j&&j.nodeType===11&&j.childNodes.length===1&&i.length===1){i[d](this[0]);g=this}else{for(h=0,m=i.length;h<m;h++){c=h;k=(h>0?this.clone(true):this).get();a(i[h])[d](k);g=g.concat(k)}c=0;g=this.pushStack(g,f,i.selector)}l=e;e=null;a.tmpl.complete(l);returng}});a.fn.extend({tmpl:function(d,c,b){returna.tmpl(this[0],d,c,b)},tmplItem:function(){returna.tmplItem(this[0])},template:function(b){returna.template(b,this[0])},domManip:function(d,m,k){if(d[0]&&a.isArray(d[0])){varg=a.makeArray(arguments),h=d[0],j=h.length,i=0,f;while(i<j&&!(f=a.data(h[i++],"tmplItem")));if(f&&c)g[2]=function(b){a.tmpl.afterManip(this,b,k)};r.apply(this,g)}elser.apply(this,arguments);c=0;!e&&a.tmpl.complete(b);returnthis}});a.extend({tmpl:function(d,h,e,c){vari,k=!c;if(k){c=p;d=a.template[d]||a.template(null,d);f={}}elseif(!d){d=c.tmpl;b[c.key]=c;c.nodes=[];c.wrapped&&n(c,c.wrapped);returna(j(c,null,c.tmpl(a,c)))}if(!d)return[];if(typeof h==="function")h=h.call(c||{});e&&e.wrapped&&n(e,e.wrapped);i=a.isArray(h)?a.map(h,function(a){returna?g(e,c,d,a):null}):[g(e,c,d,h)];returnk?a(j(c,null,i)):i},tmplItem:function(b){var c;if(b instanceofa)b=b[0];while(b&&b.nodeType===1&&!(c=a.data(b,"tmplItem"))&&(b=b.parentNode));returnc||p},template:function(c,b){if(b){if(typeof b==="string")b=o(b);else if(binstanceof a)b=b[0]||{};if(b.nodeType)b=a.data(b,"tmpl")||a.data(b,"tmpl",o(b.innerHTML));return typeofc==="string"?(a.template[c]=b):b}return c?typeofc!=="string"?a.template(null,c):a.template[c]||a.template(null,q.test(c)?c:a(c)):null},encode:function(a){return(""+a).split("&").join("&").split("<").join("<").split(">").join(">").split('"').join(""").split("'").join("'")}});a.extend(a.tmpl,{tag:{tmpl:{_default:{$2:"null"},open:"if($notnull_1){__=__.concat($item.nest($1,$2));}"},wrap:{_default:{$2:"null"},open:"$item.calls(__,$1,$2);__=[];",close:"call=$item.calls();__=call._.concat($item.wrap(call,__));"},each:{_default:{$2:"$index,$value"},open:"if($notnull_1){$.each($1a,function($2){with(this){",close:"}});}"},"if":{open:"if(($notnull_1)&& $1a){",close:"}"},"else":{_default:{$1:"true"},open:"}elseif(($notnull_1) &&$1a){"},html:{open:"if($notnull_1){__.push($1a);}"},"=":{_default:{$1:"$data"},open:"if($notnull_1){__.push($.encode($1a));}"},"!":{open:""}},complete:function(){b={}},afterManip:function(f,b,d){vare=b.nodeType===11?a.makeArray(b.childNodes):b.nodeType===1?[b]:[];d.call(f,b);m(e);c++}});functionj(e,g,f){var b,c=f?a.map(f,function(a){return typeofa==="string"?e.key?a.replace(/(<\w+)(?=[\s>])(?![^>]*_tmplitem)([^>]*)/g,"$1 "+d+'="'+e.key+'"$2'):a:j(a,e,a._ctnt)}):e;if(g)returnc;c=c.join("");c.replace(/^\s*([^<\s][^<]*)?(<[\w\W]+>)([^>]*[^>\s])?\s*$/,function(f,c,e,d){b=a(e).get();m(b);if(c)b=k(c).concat(b);if(d)b=b.concat(k(d))});returnb?b:k(c)}function k(c){varb=document.createElement("div");b.innerHTML=c;returna.makeArray(b.childNodes)}function o(b){return newFunction("jQuery","$item","var$=jQuery,call,__=[],$data=$item.data;with($data){__.push('"+a.trim(b).replace(/([\\'])/g,"\\$1").replace(/[\r\t\n]/g," ").replace(/\$\{([^\}]*)\}/g,"{{=$1}}").replace(/\{\{(\/?)(\w+|.)(?:$((?:[^\}]|\}(?!\}))*?)?$)?(?:\s+(.*?)?)?($((?:[^\}]|\}(?!\}))*?)$)?\s*\}\}/g,function(m,l,k,g,b,c,d){varj=a.tmpl.tag[k],i,e,f;if(!j)throw"Unknown template tag: "+k;i=j._default||[];if(c&&!/\w$/.test(b)){b+=c;c=""}if(b){b=h(b);d=d?","+h(d)+")":c?")":"";e=c?b.indexOf(".")>-1?b+h(c):"("+b+").call($item"+d:b;f=c?e:"(typeof("+b+")==='function'?("+b+").call($item):("+b+"))"}elsef=e=i.$1||"null";g=h(g);return"');"+j[l?"close":"open"].split("$notnull_1").join(b?"typeof("+b+")!=='undefined'&&("+b+")!=null":"true").split("$1a").join(f).split("$1").join(e).split("$2").join(g||i.$2||"")+"__.push('"})+"');}return __;")}functionn(c,b){c._wrap=j(c,true,a.isArray(b)?b:[q.test(b)?b:a(b).html()]).join("")}functionh(a){return a?a.replace(/\\'/g,"'").replace(/\\\\/g,"\\"):null}functions(b){vara=document.createElement("div");a.appendChild(b.cloneNode(true));returna.innerHTML}function m(o){varn="_"+c,k,j,l={},e,p,h;for(e=0,p=o.length;e<p;e++){if((k=o[e]).nodeType!==1)continue;j=k.getElementsByTagName("*");for(h=j.length-1;h>=0;h--)m(j[h]);m(k)}functionm(j){varp,h=j,k,e,m;if(m=j.getAttribute(d)){while(h.parentNode&&(h=h.parentNode).nodeType===1&&!(p=h.getAttribute(d)));if(p!==m){h=h.parentNode?h.nodeType===11?0:h.getAttribute(d)||0:0;if(!(e=b[m])){e=f[m];e=g(e,b[h]||f[h]);e.key=++i;b[i]=e}c&&o(m)}j.removeAttribute(d)}elseif(c&&(e=a.data(j,"tmplItem"))){o(e.key);b[e.key]=e;h=a.data(j.parentNode,"tmplItem");h=h?h.key:0}if(e){k=e;while(k&&k.key!=h){k.nodes.push(j);k=k.parent}deletee._ctnt;delete e._wrap;a.data(j,"tmplItem",e)}functiono(a){a=a+n;e=l[a]=l[a]||g(e,b[e.parent.key+n]||e.parent)}}}functionu(a,d,c,b){if(!a)returnl.pop();l.push({_:a,tmpl:d,item:this,data:c,options:b})}functionw(d,c,b){return a.tmpl(a.template(d),c,b,this)}function x(b,d){varc=b.options||{};c.wrapped=d;returna.tmpl(a.template(b.tmpl),b.data,c,b.item)}function v(d,c){varb=this._wrap;return a.map(a(a.isArray(b)?b.join(""):b).filter(d||"*"),function(a){return c?a.innerText||a.textContent:a.outerHTML||s(a)})}function t(){varb=this.nodes;a.tmpl(null,null,null,this).insertBefore(b[0]);a(b).remove()}})(jQuery);

 </script>
 <script type="text/javascript">

-libdoc = {"doc":"Robot Framework test library for runningprocesses.\nThis library utilizes Python's <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module and its <ahref=\"http://docs.python.org/2.7/library/subprocess.html#subprocess.Popen\";>Popen</a>class.\nThe library has following mainusages:\n<ul>\n<li>Starting a processes, and managing their handles,stdouts and stderrs (e.g. <a href=\"#Run Process\" class=\"name\">RunProcess</a> and <a href=\"#Start New Process\" class=\"name\">Start NewProcess</a> keywords).</li>\n<li>Stopping processes started by this library(e.g. <a href=\"#Kill All Processes\" class=\"name\">Kill All Processes</a>and <a href=\"#Terminate Process\" class=\"name\">Terminate Process</a>keywords). See <a href=\"#Stopping processes\" class=\"name\">Stoppingprocesses</a> for more information.</li>\n<li>Switching between processes(e.g. <a href=\"#Switch Active Process\" class=\"name\">Switch ActiveProcess</a> keyword).</li>\n<li>Checking process status (e.g. <ahref=\"#Process Should Be Alive\" class=\"name\">Process Should BeAlive</a> and <a href=\"#Process Should Be Dead\" class=\"name\">ProcessShould Be Dead</a> keywords).</li>\n</ul>\n<h3>Table ofcontents</h3>\n<ul>\n<li><a href=\"#Configurations\"class=\"name\">Configurations</a></li>\n<li><a href=\"#Example\"class=\"name\">Example</a></li>\n<li><a href=\"#Active process\"class=\"name\">Active process</a></li>\n<li><a href=\"#Stopping processes\"class=\"name\">Stopping processes</a></li>\n<li><ahref=\"#ExecutionResult\"class=\"name\">ExecutionResult</a></li>\n</ul>\n<h2id=\"Configurations\">Configurations</h2>\n<a href=\"#Run Process\"class=\"name\">Run Process</a> and <a href=\"#Start New Process\"class=\"name\">Start New Process</a> keywords can be given several namedarguments, which are listed below. Default values in theparenthesis.\n<ul>\n<li>cwd specifies ifprogram's directory is used as cwd (<spanclass=\"name\">False)</li>\n<li>shellspecifies if shell is used for program execution (<spanclass=\"name\">False)</li>\n<li>stdoutis a file handle for standard output</li>\n<li><spanclass=\"name\">stderr is a file handle for standarderror</li>\n<li>stdin is a file handle forstandard input</li>\n<li>alias is a name forthe process (None).</li>\n</ul>\n<h2id=\"Example\">Example</h2>\nThe following example demonstrateslibrary's main usages as stated above.\n<tableborder=\"1\">\n<tr>\n<td>* Settings*</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Library</td>\n<td>Process</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>*Test Cases*</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Example</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${handle1}=</td>\n<td><ahref=\"#Start New Process\" class=\"name\">Start NewProcess</a></td>\n<td>/path/command.sh</td>\n<td>shell=True</td>\n<td>cwd=/path</td>\n</tr>\n<tr>\n<td>${handle2}=</td>\n<td><ahref=\"#Start New Process\" class=\"name\">Start NewProcess</a></td>\n<td>${CURDIR}${/}mytool</td>\n<td>shell=True</td>\n<td></td>\n</tr>\n<tr>\n<td>${result1}=</td>\n<td><ahref=\"#Wait For Process\" class=\"name\">Wait ForProcess</a></td>\n<td>${handle1}</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td><ahref=\"#Terminate Process\" class=\"name\">TerminateProcess</a></td>\n<td>${handle2}</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td><ahref=\"#Process Should Be Dead\" class=\"name\">Process Should BeDead</a></td>\n<td>${handle2}</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>[Teardown]</td>\n<td><ahref=\"#Kill All Processes\" class=\"name\">Kill AllProcesses</a></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<h2 id=\"Activeprocess\">Active process</h2>\nThe test library keeps record which ofthe started processes is an active process. Many of the library keywordshave handle as optional argument. This meansthat if argument handle is NOT given, then theactive process is used for keyword. Active process can be switched usingkeyword <a href=\"#Switch Active Process\" class=\"name\">Switch ActiveProcess</a>.\n<h2 id=\"Stopping processes\">Stoppingprocesses</h2>\nDue restrictions set by <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module, the process stopping is NOT functioning properly on <ahref=\"http://www.jython.org\";>Jython</a> and pre-2.6 Python. In Jythonespecially we don't have the information about the PIDs of the startedprocesses therefore making the stopping of the process difficult.\n<h2id=\"ExecutionResult\">ExecutionResult</h2>\nThis object containsinformation about the process execution.\nIncluded informationis:\n<ul>\n<li>stdout standard output filehandle</li>\n<li>stderr standard error filehandle</li>\n<li>exit_code from the process,None duringexecution.</li>\n</ul>","generated":"2013-05-0216:47:48","inits":[],"keywords":[{"args":"handle=None","doc":"Returns aprocess ID of process with <spanclass=\"name\">handle.\nArgument <spanclass=\"name\">handle is optional, if <spanclass=\"name\">None then the active process is used.\nReturnvalue is a integer value.\nExamples:\n<tableborder=\"1\">\n<tr>\n<td>${pid}=</td>\n<td><a href=\"#Get Process Id\"class=\"name\">Get ProcessId</a></td>\n<td></td>\n<td></td>\n<td></td>\n<td># Gets PID of the activeprocess</td>\n</tr>\n<tr>\n<td>${handle1}=</td>\n<td><a href=\"#Start NewProcess\" class=\"name\">Start New Process</a></td>\n<td>python -c\"print 'hello'\"</td>\n<td>shell=True</td>\n<td>alias=hello</td>\n<td></td>\n</tr>\n<tr>\n<td>${pid_1}=</td>\n<td><ahref=\"#Get Process Id\" class=\"name\">Get ProcessId</a></td>\n<td>${handle1}</td>\n<td></td>\n<td></td>\n<td># Gets PID with<spanclass=\"name\">handle1</td>\n</tr>\n<tr>\n<td>${pid_2}=</td>\n<td><ahref=\"#Get Process Id\" class=\"name\">Get ProcessId</a></td>\n<td>hello</td>\n<td></td>\n<td></td>\n<td># Gets PID withalias hello</td>\n</tr>\n<tr>\n<td>Should BeEqual AsIntegers</td>\n<td>${pid_1}</td>\n<td>${pid_2}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>","name":"GetProcess Id","shortdoc":"Returns a process ID of process with`handle`."},{"args":"msg, handle=None","doc":"This keyword can be usedto communicate with the process with <spanclass=\"name\">handle.\nArgument <spanclass=\"name\">handle is optional, if <spanclass=\"name\">None then the active process isused.\nExamples:\n<table border=\"1\">\n<tr>\n<td><ahref=\"#Wait For Process\" class=\"name\">Wait ForProcess</a></td>\n<td>${handle3}</td>\n<td></td>\n</tr>\n<tr>\n<td><ahref=\"#Input To Process\" class=\"name\">Input ToProcess</a></td>\n<td>${PASSWORD}</td>\n<td>${handle3}</td>\n</tr>\n</table>","name":"InputTo Process","shortdoc":"This keyword can be used to communicate with theprocess with `handle`."},{"args":"","doc":"This keyword terminates allprocesses started by the library.","name":"Kill AllProcesses","shortdoc":"This keyword terminates all processes started by thelibrary."},{"args":"handle=None","doc":"This keyword checks if processwith handle is alive or not.\nArgumenthandle is optional, if <spanclass=\"name\">None then the active process is used.\nReturnvalue is either True (process is alive) orFalse (process hasterminated).","name":"Process Is Alive","shortdoc":"This keyword checksif process with `handle` is alive ornot."},{"args":"handle=None","doc":"Assertion keyword, which expectsthat process with handle is alive. Argumenthandle is optional, if <spanclass=\"name\">None then the active process is used.\nCheckis done using <a href=\"#Process Is Alive\" class=\"name\">Process IsAlive</a> keyword.\nRaises an error if process isdead.","name":"Process Should Be Alive","shortdoc":"Assertion keyword,which expects that process with `handle` isalive."},{"args":"handle=None","doc":"Assertion keyword, which expectsthat process with handle is dead. Argumenthandle is optional, if <spanclass=\"name\">None then the active process is used.\nCheckis done using <a href=\"#Process Is Alive\" class=\"name\">Process IsAlive</a> keyword.\nRaises an error if process isalive.","name":"Process Should Be Dead","shortdoc":"Assertion keyword,which expects that process with `handle` is dead."},{"args":"command,*args, **conf","doc":"This keyword runs a process and waits for it toterminate.\nThe command is a childprogram which is started in a new process, argsare arguments for the command and <spanclass=\"name\">conf are arguments for the <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module's <ahref=\"http://docs.python.org/2.7/library/subprocess.html#subprocess.Popen\";>Popen</a>class (see <a href=\"#Configurations\"class=\"name\">Configurations</a>).\nFinally switches back to activeprocess.","name":"Run Process","shortdoc":"This keyword runs a processand waits for it to terminate."},{"args":"command, *args,**conf","doc":"This keyword starts a new process.\nThe <spanclass=\"name\">command is a child program which is started in a newprocess, args are arguments for the <spanclass=\"name\">command and conf arearguments for the <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module's <ahref=\"http://docs.python.org/2.7/library/subprocess.html#subprocess.Popen\";>Popen</a>class (see <a href=\"#Configurations\"class=\"name\">Configurations</a>).\nReturns process index onsuccess.\nThis new process is set as an <a href=\"#Active process\"class=\"name\">active process</a>.\nExamples:\n<tableborder=\"1\">\n<tr>\n<td>$handle1}=</td>\n<td><a href=\"#Start NewProcess\" class=\"name\">Start NewProcess</a></td>\n<td>/bin/script.sh</td>\n<td></td>\n</tr>\n<tr>\n<td>$handle2}=</td>\n<td><ahref=\"#Start New Process\" class=\"name\">Start NewProcess</a></td>\n<td>totals</td>\n<td></td>\n</tr>\n</table>","name":"StartNew Process","shortdoc":"This keyword starts a newprocess."},{"args":"handle","doc":"This keyword switches active processinto process with <spanclass=\"name\">handle.\nExamples:\n<tableborder=\"1\">\n<tr>\n<td>Run Keyword And Expect Error</td>\n<td><ahref=\"#Switch Active Process\" class=\"name\">Switch ActiveProcess</a></td>\n<td></td>\n</tr>\n<tr>\n<td>Run Keyword And ExpectError</td>\n<td><a href=\"#Switch Active Process\" class=\"name\">SwitchActiveProcess</a></td>\n<td>${nonexistent_handle}</td>\n</tr>\n<tr>\n<td><ahref=\"#Switch Active Process\" class=\"name\">Switch ActiveProcess</a></td>\n<td>${handle1}</td>\n<td></td>\n</tr>\n</table>","name":"SwitchActive Process","shortdoc":"This keyword switches active process intoprocess with `handle`."},{"args":"handle=None, kill=False","doc":"Thiskeyword terminates process using either <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module's kill() or <spanclass=\"name\">terminate(), which can be selected using <spanclass=\"name\">kill argument (by default <spanclass=\"name\">terminate() is used).\nArgument <spanclass=\"name\">handle is optional, if <spanclass=\"name\">None then the active process isused.\nExamples:\n<table border=\"1\">\n<tr>\n<td><ahref=\"#Terminate Process\" class=\"name\">TerminateProcess</a></td>\n<td></td>\n<td></td>\n<td># Terminates the activeprocess</td>\n</tr>\n<tr>\n<td><a href=\"#Terminate Process\"class=\"name\">TerminateProcess</a></td>\n<td>${handle3}</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><ahref=\"#Terminate Process\" class=\"name\">TerminateProcess</a></td>\n<td>${handle3}</td>\n<td>kill=True</td>\n<td># Using killinstead of terminate</td>\n</tr>\n</table>","name":"TerminateProcess","shortdoc":"This keyword terminates process usingeither"},{"args":"handle=None","doc":"This waits for process with <spanclass=\"name\">handle to terminate.\nArgument <spanclass=\"name\">handle is optional, if <spanclass=\"name\">None then the active process is used.\nReturnsan <a href=\"#ExecutionResult\" class=\"name\">ExecutionResult</a>object.\nExamples:\n<tableborder=\"1\">\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Wait For Process\"class=\"name\">Wait ForProcess</a></td>\n<td></td>\n</tr>\n<tr>\n<td>Should Be Equal AsIntegers</td>\n<td>${output.exit_code}</td>\n<td>0</td>\n</tr>\n<tr>\n<td>ShouldMatch</td>\n<td>${output.stdout}</td>\n<td>*text inthe out*</td>\n</tr>\n<tr>\n<td>ShouldMatch</td>\n<td>${output.stderr}</td>\n<td></td>\n</tr>\n</table>","name":"WaitFor Process","shortdoc":"This waits for process with `handle` toterminate."}],"name":"Process","named_args":true,"scope":"global","version":"trunk20130226"};+libdoc = {"doc":"Robot Framework test library for runningprocesses.\nThis library utilizes Python's <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module and its <ahref=\"http://docs.python.org/2.7/library/subprocess.html#subprocess.Popen\";>Popen</a>class.\nThe library has following mainusages:\n<ul>\n<li>Starting a processes, and managing their handles,stdouts and stderrs (e.g. <a href=\"#Run Process\" class=\"name\">RunProcess</a> and <a href=\"#Start New Process\" class=\"name\">Start NewProcess</a> keywords).</li>\n<li>Stopping processes started by this library(e.g. <a href=\"#Terminate All Processes\" class=\"name\">Terminate AllProcesses</a> and <a href=\"#Terminate Process\" class=\"name\">TerminateProcess</a> keywords). See <a href=\"#Stopping processes\"class=\"name\">Stopping processes</a> for moreinformation.</li>\n<li>Switching between processes (e.g. <a href=\"#SwitchActive Process\" class=\"name\">Switch Active Process</a>keyword).</li>\n<li>Checking process status (e.g. <a href=\"#Process ShouldBe Running\" class=\"name\">Process Should Be Running</a> and <ahref=\"#Process Should Be Stopped\" class=\"name\">Process Should BeStopped</a> keywords).</li>\n</ul>\n<h3>Table ofcontents</h3>\n<ul>\n<li><a href=\"#Configurations\"class=\"name\">Configurations</a></li>\n<li><a href=\"#Example\"class=\"name\">Example</a></li>\n<li><a href=\"#Active process\"class=\"name\">Active process</a></li>\n<li><a href=\"#Stopping processes\"class=\"name\">Stopping processes</a></li>\n<li><ahref=\"#ExecutionResult\"class=\"name\">ExecutionResult</a></li>\n</ul>\n<h2id=\"Configurations\">Configurations</h2>\n<a href=\"#Run Process\"class=\"name\">Run Process</a> and <a href=\"#Start New Process\"class=\"name\">Start New Process</a> keywords can be given several namedarguments, which are listed below. Default values in theparenthesis.\n<ul>\n<li>cwd specifies ifprogram's directory is used as cwd (<spanclass=\"name\">False)</li>\n<li>shellspecifies if shell is used for program execution (<spanclass=\"name\">False)</li>\n<li>stdoutis a file handle for standard output</li>\n<li><spanclass=\"name\">stderr is a file handle for standarderror</li>\n<li>stdin is a file handle forstandard input</li>\n<li>alias is a name forthe process (None).</li>\n</ul>\n<h2id=\"Example\">Example</h2>\nThe following example demonstrateslibrary's main usages as stated above.\n<tableborder=\"1\">\n<tr>\n<td>* Settings*</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Library</td>\n<td>Process</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>*Test Cases*</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Example</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${handle1}=</td>\n<td><ahref=\"#Start New Process\" class=\"name\">Start NewProcess</a></td>\n<td>/path/command.sh</td>\n<td>shell=True</td>\n<td>cwd=/path</td>\n</tr>\n<tr>\n<td>${handle2}=</td>\n<td><ahref=\"#Start New Process\" class=\"name\">Start NewProcess</a></td>\n<td>${CURDIR}${/}mytool</td>\n<td>shell=True</td>\n<td></td>\n</tr>\n<tr>\n<td>${result1}=</td>\n<td><ahref=\"#Wait For Process\" class=\"name\">Wait ForProcess</a></td>\n<td>${handle1}</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td><ahref=\"#Terminate Process\" class=\"name\">TerminateProcess</a></td>\n<td>${handle2}</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td><spanclass=\"name\">Process Should BeDead</td>\n<td>${handle2}</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>[Teardown]</td>\n<td><spanclass=\"name\">Kill AllProcesses</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<h2id=\"Active process\">Active process</h2>\nThe test library keeps recordwhich of the started processes is an active process. Many of the librarykeywords have handle as optional argument. Thismeans that if argument handle is NOT given,then the active process is used for keyword. Active process can be switchedusing keyword <a href=\"#Switch Active Process\" class=\"name\">SwitchActive Process</a>.\n<h2 id=\"Stopping processes\">Stoppingprocesses</h2>\nDue restrictions set by <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module, the process stopping is NOT functioning properly on <ahref=\"http://www.jython.org\";>Jython</a> and pre-2.6 Python. In Jythonespecially we don't have the information about the PIDs of the startedprocesses therefore making the stopping of the process difficult.\n<h2id=\"ExecutionResult\">ExecutionResult</h2>\nThis object containsinformation about the process execution.\nIncluded informationis:\n<ul>\n<li>stdout standard output filehandle</li>\n<li>stderr standard error filehandle</li>\n<li>exit_code from the process,None duringexecution.</li>\n</ul>","generated":"2013-05-0612:55:31","inits":[],"keywords":[{"args":"handle=None","doc":"Returns aprocess ID of process with <spanclass=\"name\">handle.\nArgument <spanclass=\"name\">handle is optional, if <spanclass=\"name\">None then the active process is used.\nReturnvalue is a integer value.\nExamples:\n<tableborder=\"1\">\n<tr>\n<td>${pid}=</td>\n<td><a href=\"#Get Process Id\"class=\"name\">Get ProcessId</a></td>\n<td></td>\n<td></td>\n<td></td>\n<td># Gets PID of the activeprocess</td>\n</tr>\n<tr>\n<td>${handle1}=</td>\n<td><a href=\"#Start NewProcess\" class=\"name\">Start New Process</a></td>\n<td>python -c\"print 'hello'\"</td>\n<td>shell=True</td>\n<td>alias=hello</td>\n<td></td>\n</tr>\n<tr>\n<td>${pid_1}=</td>\n<td><ahref=\"#Get Process Id\" class=\"name\">Get ProcessId</a></td>\n<td>${handle1}</td>\n<td></td>\n<td></td>\n<td># Gets PID with<spanclass=\"name\">handle1</td>\n</tr>\n<tr>\n<td>${pid_2}=</td>\n<td><ahref=\"#Get Process Id\" class=\"name\">Get ProcessId</a></td>\n<td>hello</td>\n<td></td>\n<td></td>\n<td># Gets PID withalias hello</td>\n</tr>\n<tr>\n<td>Should BeEqual AsIntegers</td>\n<td>${pid_1}</td>\n<td>${pid_2}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>","name":"GetProcess Id","shortdoc":"Returns a process ID of process with`handle`."},{"args":"handle=None","doc":"Return the process object withhandle.\nArgument <spanclass=\"name\">handle is optional, if <spanclass=\"name\">None then the active process isused.","name":"Get Process Object","shortdoc":"Return the processobject with `handle`."},{"args":"handle=None","doc":"This keyword checksif process with handle is running ornot.\nArgument handle is optional, ifNone then the active process isused.\nReturn value is either True(process is running) or False (process hasstopped).","name":"Process Is Running","shortdoc":"This keyword checksif process with `handle` is running ornot."},{"args":"handle=None","doc":"Assertion keyword, which expectsthat process with handle is running. Argumenthandle is optional, if <spanclass=\"name\">None then the active process is used.\nCheckis done using <a href=\"#Process Is Running\" class=\"name\">Process IsRunning</a> keyword.\nRaises an error if process isstopped.","name":"Process Should Be Running","shortdoc":"Assertionkeyword, which expects that process with `handle` isrunning."},{"args":"handle=None","doc":"Assertion keyword, which expectsthat process with handle is stopped. Argumenthandle is optional, if <spanclass=\"name\">None then the active process is used.\nCheckis done using <a href=\"#Process Is Running\" class=\"name\">Process IsRunning</a> keyword.\nRaises an error if process isrunning.","name":"Process Should Be Stopped","shortdoc":"Assertionkeyword, which expects that process with `handle` isstopped."},{"args":"command, *arguments, **configuration","doc":"Thiskeyword runs a process and waits for it to terminate.\nThe <spanclass=\"name\">command is a child program which is started in a newprocess, arguments are arguments for the <spanclass=\"name\">command and configurationare arguments for the <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module's <ahref=\"http://docs.python.org/2.7/library/subprocess.html#subprocess.Popen\";>Popen</a>class (see <a href=\"#Configurations\"class=\"name\">Configurations</a>).\nFinally switches back to activeprocess.","name":"Run Process","shortdoc":"This keyword runs a processand waits for it to terminate."},{"args":"command, *arguments,**configuration","doc":"This keyword starts a new process.\nThecommand is a child program which is started ina new process, arguments are arguments for thecommand and <spanclass=\"name\">configuration are arguments for the <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module's <ahref=\"http://docs.python.org/2.7/library/subprocess.html#subprocess.Popen\";>Popen</a>class (see <a href=\"#Configurations\"class=\"name\">Configurations</a>).\nReturns process index onsuccess.\nThis new process is set as an <a href=\"#Active process\"class=\"name\">active process</a>.\nExamples:\n<tableborder=\"1\">\n<tr>\n<td>$handle1}=</td>\n<td><a href=\"#Start NewProcess\" class=\"name\">Start NewProcess</a></td>\n<td>/bin/script.sh</td>\n<td></td>\n</tr>\n<tr>\n<td>$handle2}=</td>\n<td><ahref=\"#Start New Process\" class=\"name\">Start NewProcess</a></td>\n<td>totals</td>\n<td></td>\n</tr>\n</table>","name":"StartNew Process","shortdoc":"This keyword starts a newprocess."},{"args":"handle","doc":"This keyword switches active processinto process with <spanclass=\"name\">handle.\nExamples:\n<tableborder=\"1\">\n<tr>\n<td>Run Keyword And Expect Error</td>\n<td><ahref=\"#Switch Active Process\" class=\"name\">Switch ActiveProcess</a></td>\n<td></td>\n</tr>\n<tr>\n<td>Run Keyword And ExpectError</td>\n<td><a href=\"#Switch Active Process\" class=\"name\">SwitchActiveProcess</a></td>\n<td>${nonexistent_handle}</td>\n</tr>\n<tr>\n<td><ahref=\"#Switch Active Process\" class=\"name\">Switch ActiveProcess</a></td>\n<td>${handle1}</td>\n<td></td>\n</tr>\n</table>","name":"SwitchActive Process","shortdoc":"This keyword switches active process intoprocess with `handle`."},{"args":"kill=True","doc":"This keywordterminates all processes started by the library.","name":"Terminate AllProcesses","shortdoc":"This keyword terminates all processes started by thelibrary."},{"args":"handle=None, kill=False","doc":"This keywordterminates process using either <ahref=\"http://docs.python.org/2.7/library/subprocess.html\";>subprocess</a>module's kill() or <spanclass=\"name\">terminate(), which can be selected using <spanclass=\"name\">kill argument (by default <spanclass=\"name\">terminate() is used).\nArgument <spanclass=\"name\">handle is optional, if <spanclass=\"name\">None then the active process isused.\nExamples:\n<table border=\"1\">\n<tr>\n<td><ahref=\"#Terminate Process\" class=\"name\">TerminateProcess</a></td>\n<td></td>\n<td></td>\n<td># Terminates the activeprocess</td>\n</tr>\n<tr>\n<td><a href=\"#Terminate Process\"class=\"name\">TerminateProcess</a></td>\n<td>${handle3}</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><ahref=\"#Terminate Process\" class=\"name\">TerminateProcess</a></td>\n<td>${handle3}</td>\n<td>kill=True</td>\n<td># Using killinstead of terminate</td>\n</tr>\n</table>","name":"TerminateProcess","shortdoc":"This keyword terminates process usingeither"},{"args":"handle=None","doc":"This waits for process with <spanclass=\"name\">handle to terminate.\nArgument <spanclass=\"name\">handle is optional, if <spanclass=\"name\">None then the active process is used.\nReturnsan <a href=\"#ExecutionResult\" class=\"name\">ExecutionResult</a>object.\nExamples:\n<tableborder=\"1\">\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Wait For Process\"class=\"name\">Wait ForProcess</a></td>\n<td></td>\n</tr>\n<tr>\n<td>Should Be Equal AsIntegers</td>\n<td>${output.exit_code}</td>\n<td>0</td>\n</tr>\n<tr>\n<td>ShouldMatch</td>\n<td>${output.stdout}</td>\n<td>*text inthe out*</td>\n</tr>\n<tr>\n<td>ShouldMatch</td>\n<td>${output.stderr}</td>\n<td></td>\n</tr>\n</table>","name":"WaitFor Process","shortdoc":"This waits for process with `handle` toterminate."}],"name":"Process","named_args":true,"scope":"global","version":"trunk20130226"};

 </script>
 <title></title>
 </head>

--

---You received this message because you are subscribed to the Google Groups "robotframework-commit" group.

To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/groups/opt_out.

[robotframework] push by [email protected] - process: updated the documentation on 2013-05-06 09:56 GMT

Reply via email to