eric6/Documentation/Source/eric6.Utilities.__init__.html

changeset 7776
4a8edf69dd64
parent 7728
a233627a5e25
child 7849
70e464748aaa
--- a/eric6/Documentation/Source/eric6.Utilities.__init__.html	Sun Oct 11 17:54:52 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Utilities.__init__.html	Sun Oct 11 17:56:02 2020 +0200
@@ -324,6 +324,10 @@
 <td>Return a relative version of a path.</td>
 </tr>
 <tr>
+<td><a href="#rxIndex">rxIndex</a></td>
+<td>Function to get the index (start position) of a regular expression match within some text.</td>
+</tr>
+<tr>
 <td><a href="#samefilepath">samefilepath</a></td>
 <td>Function to compare two paths.</td>
 </tr>
@@ -1662,15 +1666,21 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
-key of the requested environment entry (string)
+key of the requested environment entry
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating the presence of the requested entry (boolean)
+flag indicating the presence of the requested entry
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -2062,19 +2072,25 @@
 </p>
 <dl>
 
-<dt><i>s</i></dt>
+<dt><i>s</i> (str)</dt>
 <dd>
-string to be parsed (string)
+string to be parsed
 </dd>
-<dt><i>rx</i></dt>
+<dt><i>rx</i> (re.Pattern)</dt>
 <dd>
-regex defining the parse pattern (QRegExp)
+regular expression object defining the parse pattern
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-list of parsed data (list of strings)
+list of parsed data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -2302,6 +2318,40 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="rxIndex" ID="rxIndex"></a>
+<h2>rxIndex</h2>
+<b>rxIndex</b>(<i>rx, txt</i>)
+
+<p>
+    Function to get the index (start position) of a regular expression match
+    within some text.
+</p>
+<dl>
+
+<dt><i>rx</i> (re.Pattern)</dt>
+<dd>
+regular expression object as created by re.compile()
+</dd>
+<dt><i>txt</i> (str)</dt>
+<dd>
+text to be scanned
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+start position of the match or -1 indicating no match was found
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="samefilepath" ID="samefilepath"></a>
 <h2>samefilepath</h2>
 <b>samefilepath</b>(<i>f1, f2</i>)

eric ide

mercurial