--- a/src/eric7/Documentation/Source/eric7.EricNetwork.EricTldExtractor.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricNetwork.EricTldExtractor.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricNetwork.EricTldExtractor</h1>
-
<p>
Module implementing the TLD Extractor.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>_TLDExtractor</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EricTldExtractor">EricTldExtractor</a></td>
<td>Class implementing the TLD Extractor.</td>
@@ -29,20 +27,19 @@
<td>Class implementing the host parts helper.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#instance">instance</a></td>
<td>Global function to get a reference to the TLD extractor and create it, if it hasn't been yet.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="EricTldExtractor" ID="EricTldExtractor"></a>
<h2>EricTldExtractor</h2>
-
<p>
Class implementing the TLD Extractor.
</p>
@@ -50,22 +47,21 @@
Note: The module function instance() should be used to get a reference
to a global object to avoid overhead.
</p>
+
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#EricTldExtractor.__init__">EricTldExtractor</a></td>
<td>Constructor</td>
@@ -135,19 +131,20 @@
<td>Public method to get the top level domain for a host.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricTldExtractor.__init__" ID="EricTldExtractor.__init__"></a>
<h4>EricTldExtractor (Constructor)</h4>
<b>EricTldExtractor</b>(<i>withPrivate=False, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>withPrivate</i> (bool)</dt>
@@ -162,10 +159,10 @@
<a NAME="EricTldExtractor.__defaultDataSearchPaths" ID="EricTldExtractor.__defaultDataSearchPaths"></a>
<h4>EricTldExtractor.__defaultDataSearchPaths</h4>
<b>__defaultDataSearchPaths</b>(<i></i>)
-
<p>
Private method to get the default search paths for the TLD data file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -181,10 +178,10 @@
<a NAME="EricTldExtractor.__domainHelper" ID="EricTldExtractor.__domainHelper"></a>
<h4>EricTldExtractor.__domainHelper</h4>
<b>__domainHelper</b>(<i>host, tldPart</i>)
-
<p>
Private method to get the domain name without TLD.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -211,17 +208,17 @@
<a NAME="EricTldExtractor.__loadData" ID="EricTldExtractor.__loadData"></a>
<h4>EricTldExtractor.__loadData</h4>
<b>__loadData</b>(<i></i>)
-
<p>
Private method to load the TLD data.
</p>
+
<a NAME="EricTldExtractor.__normalizedHost" ID="EricTldExtractor.__normalizedHost"></a>
<h4>EricTldExtractor.__normalizedHost</h4>
<b>__normalizedHost</b>(<i>host</i>)
-
<p>
Private method to get the normalized host for a host address.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -244,10 +241,10 @@
<a NAME="EricTldExtractor.__parseData" ID="EricTldExtractor.__parseData"></a>
<h4>EricTldExtractor.__parseData</h4>
<b>__parseData</b>(<i>dataFile, loadPrivateDomains=False</i>)
-
<p>
Private method to parse TLD data.
</p>
+
<dl>
<dt><i>dataFile</i> (str)</dt>
@@ -274,10 +271,10 @@
<a NAME="EricTldExtractor.__registrableDomainHelper" ID="EricTldExtractor.__registrableDomainHelper"></a>
<h4>EricTldExtractor.__registrableDomainHelper</h4>
<b>__registrableDomainHelper</b>(<i>domainPart, tldPart</i>)
-
<p>
Private method to get the registrable domain (i.e. domain plus TLD).
</p>
+
<dl>
<dt><i>domainPart</i> (str)</dt>
@@ -304,11 +301,11 @@
<a NAME="EricTldExtractor.__subdomainHelper" ID="EricTldExtractor.__subdomainHelper"></a>
<h4>EricTldExtractor.__subdomainHelper</h4>
<b>__subdomainHelper</b>(<i>host, registrablePart</i>)
-
<p>
Private method to get the subdomain of a host address (i.e. domain part
without the registrable domain name).
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -335,10 +332,10 @@
<a NAME="EricTldExtractor.dataSearchPaths" ID="EricTldExtractor.dataSearchPaths"></a>
<h4>EricTldExtractor.dataSearchPaths</h4>
<b>dataSearchPaths</b>(<i></i>)
-
<p>
Public method to get the search paths for the TLD data file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -354,10 +351,10 @@
<a NAME="EricTldExtractor.domain" ID="EricTldExtractor.domain"></a>
<h4>EricTldExtractor.domain</h4>
<b>domain</b>(<i>host</i>)
-
<p>
Public method to get the domain for a host.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -380,10 +377,10 @@
<a NAME="EricTldExtractor.getTldDownloadUrl" ID="EricTldExtractor.getTldDownloadUrl"></a>
<h4>EricTldExtractor.getTldDownloadUrl</h4>
<b>getTldDownloadUrl</b>(<i></i>)
-
<p>
Public method to get the TLD data file download URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -399,10 +396,10 @@
<a NAME="EricTldExtractor.isDataLoaded" ID="EricTldExtractor.isDataLoaded"></a>
<h4>EricTldExtractor.isDataLoaded</h4>
<b>isDataLoaded</b>(<i></i>)
-
<p>
Public method to check, if the TLD data ia already loaded.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -418,10 +415,10 @@
<a NAME="EricTldExtractor.registrableDomain" ID="EricTldExtractor.registrableDomain"></a>
<h4>EricTldExtractor.registrableDomain</h4>
<b>registrableDomain</b>(<i>host</i>)
-
<p>
Public method to get the registrable domain for a host.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -444,10 +441,10 @@
<a NAME="EricTldExtractor.setDataSearchPaths" ID="EricTldExtractor.setDataSearchPaths"></a>
<h4>EricTldExtractor.setDataSearchPaths</h4>
<b>setDataSearchPaths</b>(<i>searchPaths=None</i>)
-
<p>
Public method to set the search paths for the TLD data file.
</p>
+
<dl>
<dt><i>searchPaths</i> (list of str)</dt>
@@ -459,10 +456,10 @@
<a NAME="EricTldExtractor.splitParts" ID="EricTldExtractor.splitParts"></a>
<h4>EricTldExtractor.splitParts</h4>
<b>splitParts</b>(<i>host</i>)
-
<p>
Public method to split a host address into its parts.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -485,10 +482,10 @@
<a NAME="EricTldExtractor.subdomain" ID="EricTldExtractor.subdomain"></a>
<h4>EricTldExtractor.subdomain</h4>
<b>subdomain</b>(<i>host</i>)
-
<p>
Public method to get the subdomain for a host.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -511,10 +508,10 @@
<a NAME="EricTldExtractor.tld" ID="EricTldExtractor.tld"></a>
<h4>EricTldExtractor.tld</h4>
<b>tld</b>(<i>host</i>)
-
<p>
Public method to get the top level domain for a host.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -539,44 +536,48 @@
<hr />
<a NAME="EricTldHostParts" ID="EricTldHostParts"></a>
<h2>EricTldHostParts</h2>
-
<p>
Class implementing the host parts helper.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
+<table>
+<tr><td>domain</td></tr>
+<tr><td>host</td></tr>
+<tr><td>registrableDomain</td></tr>
+<tr><td>subdomain</td></tr>
+<tr><td>tld</td></tr>
+</table>
-<table>
-<tr><td>domain</td></tr><tr><td>host</td></tr><tr><td>registrableDomain</td></tr><tr><td>subdomain</td></tr><tr><td>tld</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="instance" ID="instance"></a>
<h2>instance</h2>
<b>instance</b>(<i>withPrivate=False</i>)
-
<p>
Global function to get a reference to the TLD extractor and create it, if
it hasn't been yet.
</p>
+
<dl>
<dt><i>withPrivate</i> (bool)</dt>
@@ -598,4 +599,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
