Skip to content

Commit f5dd63a

Browse files
committed
Update API documentation for version 0.9.0
1 parent 278d326 commit f5dd63a

17 files changed

+11612
-3126
lines changed

docs/scrapfly/api_config.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
6161
<div class="desc"></div>
6262
<h3>Subclasses</h3>
6363
<ul class="hlist">
64+
<li><a title="scrapfly.browser_config.BrowserConfig" href="browser_config.html#scrapfly.browser_config.BrowserConfig">BrowserConfig</a></li>
6465
<li><a title="scrapfly.crawler.crawler_config.CrawlerConfig" href="crawler/crawler_config.html#scrapfly.crawler.crawler_config.CrawlerConfig">CrawlerConfig</a></li>
6566
<li><a title="scrapfly.extraction_config.ExtractionConfig" href="extraction_config.html#scrapfly.extraction_config.ExtractionConfig">ExtractionConfig</a></li>
6667
<li><a title="scrapfly.scrape_config.ScrapeConfig" href="scrape_config.html#scrapfly.scrape_config.ScrapeConfig">ScrapeConfig</a></li>

docs/scrapfly/api_response.html

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -598,16 +598,11 @@ <h3>Inherited members</h3>
598598
pass
599599

600600
try:
601-
from compression import zstd as _zstd # noqa: F401 - Python 3.14+ native zstd
602-
if &#39;zstd&#39; not in self.SUPPORTED_COMPRESSION:
601+
from urllib3.response import HAS_ZSTD
602+
if HAS_ZSTD and &#39;zstd&#39; not in self.SUPPORTED_COMPRESSION:
603603
self.SUPPORTED_COMPRESSION.append(&#39;zstd&#39;)
604604
except ImportError:
605-
try:
606-
import zstandard # noqa: F401 - aligned with urllib3 for transparent decompression
607-
if &#39;zstd&#39; not in self.SUPPORTED_COMPRESSION:
608-
self.SUPPORTED_COMPRESSION.append(&#39;zstd&#39;)
609-
except ImportError:
610-
pass
605+
pass
611606

612607
self.content_encoding: str = &#39;, &#39;.join(self.SUPPORTED_COMPRESSION)
613608
self._signing_secret: Optional[Tuple[str]] = None
@@ -856,7 +851,7 @@ <h3>Methods</h3>
856851
&#39;result&#39;: {
857852
&#39;request_headers&#39;: {},
858853
&#39;status&#39;: &#39;DONE&#39;,
859-
&#39;success&#39;: 200 &gt;= self.response.status_code &lt; 300,
854+
&#39;success&#39;: 200 &lt;= self.response.status_code &lt; 300,
860855
&#39;response_headers&#39;: self.response.headers,
861856
&#39;status_code&#39;: self.response.status_code,
862857
&#39;reason&#39;: self.response.reason,
@@ -924,7 +919,7 @@ <h3>Methods</h3>
924919
&#34;&#34;&#34;
925920
Success means Scrapfly api reply correctly to the call, but the scrape can be unsuccessful if the upstream reply with error status code
926921
&#34;&#34;&#34;
927-
return 200 &gt;= self.response.status_code &lt;= 299
922+
return 200 &lt;= self.response.status_code &lt;= 299
928923

929924
@property
930925
def scrape_success(self) -&gt; bool:
@@ -941,7 +936,7 @@ <h3>Methods</h3>
941936
return None
942937

943938
if self.scrape_success is False:
944-
return self.scrape_result[&#39;error&#39;]
939+
return self.scrape_result.get(&#39;error&#39;)
945940

946941
@property
947942
def upstream_status_code(self) -&gt; Optional[int]:
@@ -1236,7 +1231,7 @@ <h3>Instance variables</h3>
12361231
return None
12371232

12381233
if self.scrape_success is False:
1239-
return self.scrape_result[&#39;error&#39;]</code></pre>
1234+
return self.scrape_result.get(&#39;error&#39;)</code></pre>
12401235
</details>
12411236
<div class="desc"></div>
12421237
</dd>
@@ -1320,7 +1315,7 @@ <h3>Instance variables</h3>
13201315
&#34;&#34;&#34;
13211316
Success means Scrapfly api reply correctly to the call, but the scrape can be unsuccessful if the upstream reply with error status code
13221317
&#34;&#34;&#34;
1323-
return 200 &gt;= self.response.status_code &lt;= 299</code></pre>
1318+
return 200 &lt;= self.response.status_code &lt;= 299</code></pre>
13241319
</details>
13251320
<div class="desc"><p>Success means Scrapfly api reply correctly to the call, but the scrape can be unsuccessful if the upstream reply with error status code</p></div>
13261321
</dd>

docs/scrapfly/browser_config.html

Lines changed: 542 additions & 0 deletions
Large diffs are not rendered by default.

docs/scrapfly/client.html

Lines changed: 826 additions & 16 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)