<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#get-the-mobase-stubs">1. Get the <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code> stubs</a></li>
<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#configure-visual-studio-code-for-mobase">2. Configure Visual Studio Code for <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code></a></li>
<liclass="toctree-l3"><aclass="reference internal"href="../setup-tools.html#configure-mypy-to-find-the-mobase-stubs">3. Configure <codeclass="docutils literal notranslate"><spanclass="pre">mypy</span></code> to find the <codeclass="docutils literal notranslate"><spanclass="pre">mobase</span></code> stubs</a></li>
</ul>
</li>
<liclass="toctree-l2"><aclass="reference internal"href="../setup-tools.html#testing-the-setup">Testing the setup</a></li>
</ul>
</li>
<liclass="toctree-l1"><aclass="reference internal"href="../plugin-types.html">Type of Plugins</a><ul>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#why-is-mo2-throwing-an-exception-when-i-try-to-create-a-type-inheriting-one-of-mo2-class">1. Why is MO2 throwing an exception when I try to create a type inheriting one of MO2 class?</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#how-can-i-be-sure-to-implement-all-the-required-methods-when-creating-a-plugin">2. How can I be sure to implement all the required methods when creating a plugin?</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../faq.html#why-are-my-isinstance-x-qobject-and-isinstance-y-qwidget-not-working">3. Why are my <codeclass="docutils literal notranslate"><spanclass="pre">isinstance(x,</span><spanclass="pre">QObject)</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">isinstance(y,</span><spanclass="pre">QWidget)</span></code> not working?</a></li>
<h1>FileTreeEntry<aclass="headerlink"href="#filetreeentry"title="Permalink to this headline">¶</a></h1>
<dlclass="class">
<dtid="mobase.FileTreeEntry">
<emclass="property">class </em><codeclass="sig-prename descclassname">mobase.</code><codeclass="sig-name descname">FileTreeEntry</code><aclass="headerlink"href="#mobase.FileTreeEntry"title="Permalink to this definition">¶</a></dt>
<td><p>Retrieve the “last” extension of this entry.</p></td>
</tr>
</tbody>
</table>
<pclass="rubric">Attributes Documentation</p>
<dlclass="attribute">
<dtid="mobase.FileTreeEntry.DIRECTORY">
<codeclass="sig-name descname">DIRECTORY</code><emclass="property">: FileTreeEntry.FileTypes</em><emclass="property"> = Ellipsis</em><aclass="headerlink"href="#mobase.FileTreeEntry.DIRECTORY"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="mobase.FileTreeEntry.FILE">
<codeclass="sig-name descname">FILE</code><emclass="property">: FileTreeEntry.FileTypes</em><emclass="property"> = Ellipsis</em><aclass="headerlink"href="#mobase.FileTreeEntry.FILE"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="mobase.FileTreeEntry.FILE_OR_DIRECTORY">
<codeclass="sig-name descname">FILE_OR_DIRECTORY</code><emclass="property">: FileTreeEntry.FileTypes</em><emclass="property"> = Ellipsis</em><aclass="headerlink"href="#mobase.FileTreeEntry.FILE_OR_DIRECTORY"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<pclass="rubric">Methods Documentation</p>
<dlclass="method">
<dtid="mobase.FileTreeEntry.detach">
<codeclass="sig-name descname">detach</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.detach"title="Permalink to this definition">¶</a></dt>
<dd><p>Detach this entry from its parent tree.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>True if the entry was removed correctly, False otherwize.</p>
<codeclass="sig-name descname">fileType</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.fileType"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>The filetype of this entry.</p>
<codeclass="sig-name descname">hasSuffix</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwds</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.hasSuffix"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper for @overload to raise when called.</p>
</dd></dl>
<dlclass="method">
<dtid="mobase.FileTreeEntry.isDir">
<codeclass="sig-name descname">isDir</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.isDir"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>True if this entry is a directory, False otherwise.</p>
<codeclass="sig-name descname">isFile</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.isFile"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>True if this entry is a file, False otherwise.</p>
<codeclass="sig-name descname">moveTo</code><spanclass="sig-paren">(</span><emclass="sig-param">tree</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.moveTo"title="Permalink to this definition">¶</a></dt>
<dd><p>Move this entry to the given tree.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>tree</strong>– The tree to move this entry to.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if the entry was moved correctly, False otherwize.</p>
<codeclass="sig-name descname">name</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.name"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>The name of this entry.</p>
<codeclass="sig-name descname">parent</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.parent"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>The parent tree containing this entry, or a <cite>None</cite> if this entry is the root</p>
<codeclass="sig-name descname">path</code><spanclass="sig-paren">(</span><emclass="sig-param">sep='\\'</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.path"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve the path from this entry up to the root of the tree.</p>
<p>This method propagate up the tree so is not constant complexity as
the full path is never stored.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>sep</strong>– The type of separator to use to create the path.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The path from this entry to the root, including the name of this entry.</p>
<codeclass="sig-name descname">pathFrom</code><spanclass="sig-paren">(</span><emclass="sig-param">tree</em>, <emclass="sig-param">sep='\\'</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.pathFrom"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve the path from the given tree to this entry.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>tree</strong>– The tree to reach, must be a parent of this entry.</p></li>
<li><p><strong>sep</strong>– The type of separator to use to create the path.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The path from the given tree to this entry, including the name of this entry, or</p>
</dd>
</dl>
<p>an empty string if the given tree is not a parent of this entry.</p>
<codeclass="sig-name descname">suffix</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#mobase.FileTreeEntry.suffix"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve the “last” extension of this entry.</p>
<p>The “last” extension is everything after the last dot in the file name.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>The last extension of this entry, or an empty string if the file has no extension</p>
