docs: change docstring style for some methods
This commit is contained in:
Karim shoair
@@ -89,19 +89,18 @@ class DynamicSession(SyncSession, DynamicSessionMixin):
|
|||||||
"""Opens up the browser and do your request based on your chosen options.
|
"""Opens up the browser and do your request based on your chosen options.
|
||||||
|
|
||||||
:param url: The Target url.
|
:param url: The Target url.
|
||||||
:param kwargs: Additional keyword arguments including:
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
||||||
- google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
||||||
- timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
||||||
- wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
||||||
- page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
||||||
- extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
:param disable_resources: Drop requests for unnecessary resources for a speed boost.
|
||||||
- disable_resources: Drop requests for unnecessary resources for a speed boost.
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
||||||
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
||||||
- wait_selector: Wait for a specific CSS selector to be in a specific state.
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
||||||
- wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
||||||
- network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
||||||
- load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
||||||
- selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
|
||||||
:return: A `Response` object.
|
:return: A `Response` object.
|
||||||
"""
|
"""
|
||||||
params = _validate(kwargs, self, PlaywrightConfig)
|
params = _validate(kwargs, self, PlaywrightConfig)
|
||||||
@@ -219,19 +218,18 @@ class AsyncDynamicSession(AsyncSession, DynamicSessionMixin):
|
|||||||
"""Opens up the browser and do your request based on your chosen options.
|
"""Opens up the browser and do your request based on your chosen options.
|
||||||
|
|
||||||
:param url: The Target url.
|
:param url: The Target url.
|
||||||
:param kwargs: Additional keyword arguments including:
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
||||||
- google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
||||||
- timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
||||||
- wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
||||||
- page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
||||||
- extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
:param disable_resources: Drop requests for unnecessary resources for a speed boost.
|
||||||
- disable_resources: Drop requests for unnecessary resources for a speed boost.
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
||||||
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
||||||
- wait_selector: Wait for a specific CSS selector to be in a specific state.
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
||||||
- wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
||||||
- network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
||||||
- load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
||||||
- selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
|
||||||
:return: A `Response` object.
|
:return: A `Response` object.
|
||||||
"""
|
"""
|
||||||
params = _validate(kwargs, self, PlaywrightConfig)
|
params = _validate(kwargs, self, PlaywrightConfig)
|
||||||
|
|||||||
@@ -175,20 +175,19 @@ class StealthySession(SyncSession, StealthySessionMixin):
|
|||||||
"""Opens up the browser and do your request based on your chosen options.
|
"""Opens up the browser and do your request based on your chosen options.
|
||||||
|
|
||||||
:param url: The Target url.
|
:param url: The Target url.
|
||||||
:param kwargs: Additional keyword arguments including:
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
||||||
- google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
||||||
- timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
||||||
- wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
||||||
- page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
||||||
- extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
:param disable_resources: Drop requests for unnecessary resources for a speed boost.
|
||||||
- disable_resources: Drop requests for unnecessary resources for a speed boost.
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
||||||
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
||||||
- wait_selector: Wait for a specific CSS selector to be in a specific state.
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
||||||
- wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
||||||
- network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
||||||
- load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
:param solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you.
|
||||||
- solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you.
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
||||||
- selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
|
||||||
:return: A `Response` object.
|
:return: A `Response` object.
|
||||||
"""
|
"""
|
||||||
params = _validate(kwargs, self, StealthConfig)
|
params = _validate(kwargs, self, StealthConfig)
|
||||||
@@ -388,20 +387,19 @@ class AsyncStealthySession(AsyncSession, StealthySessionMixin):
|
|||||||
"""Opens up the browser and do your request based on your chosen options.
|
"""Opens up the browser and do your request based on your chosen options.
|
||||||
|
|
||||||
:param url: The Target url.
|
:param url: The Target url.
|
||||||
:param kwargs: Additional keyword arguments including:
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
||||||
- google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
||||||
- timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
||||||
- wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
||||||
- page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
||||||
- extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
:param disable_resources: Drop requests for unnecessary resources for a speed boost.
|
||||||
- disable_resources: Drop requests for unnecessary resources for a speed boost.
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
||||||
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
||||||
- wait_selector: Wait for a specific CSS selector to be in a specific state.
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
||||||
- wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
||||||
- network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
||||||
- load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
:param solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you.
|
||||||
- solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you.
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
||||||
- selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
|
||||||
:return: A `Response` object.
|
:return: A `Response` object.
|
||||||
"""
|
"""
|
||||||
params = _validate(kwargs, self, StealthConfig)
|
params = _validate(kwargs, self, StealthConfig)
|
||||||
|
|||||||
@@ -12,31 +12,30 @@ class DynamicFetcher(BaseFetcher):
|
|||||||
"""Opens up a browser and do your request based on your chosen options below.
|
"""Opens up a browser and do your request based on your chosen options below.
|
||||||
|
|
||||||
:param url: Target url.
|
:param url: Target url.
|
||||||
:param kwargs: Browser session configuration options including:
|
:param headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
||||||
- headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
:param disable_resources: Drop requests of unnecessary resources for a speed boost.
|
||||||
- disable_resources: Drop requests of unnecessary resources for a speed boost.
|
:param useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
|
||||||
- useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
|
:param cookies: Set cookies for the next request.
|
||||||
- cookies: Set cookies for the next request.
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
||||||
- network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
||||||
- load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
||||||
- timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the Response object.
|
||||||
- wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the Response object.
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
||||||
- page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
||||||
- wait_selector: Wait for a specific CSS selector to be in a specific state.
|
:param init_script: An absolute path to a JavaScript file to be executed on page creation with this request.
|
||||||
- init_script: An absolute path to a JavaScript file to be executed on page creation with this request.
|
:param locale: Set the locale for the browser if wanted. The default value is `en-US`.
|
||||||
- locale: Set the locale for the browser if wanted. The default value is `en-US`.
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
||||||
- wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
:param stealth: Enables stealth mode, check the documentation to see what stealth mode does currently.
|
||||||
- stealth: Enables stealth mode, check the documentation to see what stealth mode does currently.
|
:param real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it.
|
||||||
- real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it.
|
:param hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
|
||||||
- hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
|
:param disable_webgl: Disables WebGL and WebGL 2.0 support entirely.
|
||||||
- disable_webgl: Disables WebGL and WebGL 2.0 support entirely.
|
:param cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
|
||||||
- cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
||||||
- google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
:param extra_headers: A dictionary of extra headers to add to the request.
|
||||||
- extra_headers: A dictionary of extra headers to add to the request.
|
:param proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
||||||
- proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
:param extra_flags: A list of additional browser flags to pass to the browser on launch.
|
||||||
- extra_flags: A list of additional browser flags to pass to the browser on launch.
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
||||||
- selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
:param additional_args: Additional arguments to be passed to Playwright's context as additional settings.
|
||||||
- additional_args: Additional arguments to be passed to Playwright's context as additional settings.
|
|
||||||
:return: A `Response` object.
|
:return: A `Response` object.
|
||||||
"""
|
"""
|
||||||
selector_config = kwargs.get("selector_config", {}) or kwargs.get(
|
selector_config = kwargs.get("selector_config", {}) or kwargs.get(
|
||||||
@@ -55,31 +54,30 @@ class DynamicFetcher(BaseFetcher):
|
|||||||
"""Opens up a browser and do your request based on your chosen options below.
|
"""Opens up a browser and do your request based on your chosen options below.
|
||||||
|
|
||||||
:param url: Target url.
|
:param url: Target url.
|
||||||
:param kwargs: Browser session configuration options including:
|
:param headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
||||||
- headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
:param disable_resources: Drop requests of unnecessary resources for a speed boost.
|
||||||
- disable_resources: Drop requests of unnecessary resources for a speed boost.
|
:param useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
|
||||||
- useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
|
:param cookies: Set cookies for the next request.
|
||||||
- cookies: Set cookies for the next request.
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
||||||
- network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
||||||
- load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
||||||
- timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the Response object.
|
||||||
- wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the Response object.
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
||||||
- page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
||||||
- wait_selector: Wait for a specific CSS selector to be in a specific state.
|
:param init_script: An absolute path to a JavaScript file to be executed on page creation with this request.
|
||||||
- init_script: An absolute path to a JavaScript file to be executed on page creation with this request.
|
:param locale: Set the locale for the browser if wanted. The default value is `en-US`.
|
||||||
- locale: Set the locale for the browser if wanted. The default value is `en-US`.
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
||||||
- wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
:param stealth: Enables stealth mode, check the documentation to see what stealth mode does currently.
|
||||||
- stealth: Enables stealth mode, check the documentation to see what stealth mode does currently.
|
:param real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it.
|
||||||
- real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it.
|
:param hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
|
||||||
- hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
|
:param disable_webgl: Disables WebGL and WebGL 2.0 support entirely.
|
||||||
- disable_webgl: Disables WebGL and WebGL 2.0 support entirely.
|
:param cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
|
||||||
- cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
||||||
- google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
:param extra_headers: A dictionary of extra headers to add to the request.
|
||||||
- extra_headers: A dictionary of extra headers to add to the request.
|
:param proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
||||||
- proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
:param extra_flags: A list of additional browser flags to pass to the browser on launch.
|
||||||
- extra_flags: A list of additional browser flags to pass to the browser on launch.
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
||||||
- selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
:param additional_args: Additional arguments to be passed to Playwright's context as additional settings.
|
||||||
- additional_args: Additional arguments to be passed to Playwright's context as additional settings.
|
|
||||||
:return: A `Response` object.
|
:return: A `Response` object.
|
||||||
"""
|
"""
|
||||||
selector_config = kwargs.get("selector_config", {}) or kwargs.get(
|
selector_config = kwargs.get("selector_config", {}) or kwargs.get(
|
||||||
|
|||||||
@@ -16,36 +16,35 @@ class StealthyFetcher(BaseFetcher):
|
|||||||
Opens up a browser and do your request based on your chosen options below.
|
Opens up a browser and do your request based on your chosen options below.
|
||||||
|
|
||||||
:param url: Target url.
|
:param url: Target url.
|
||||||
:param kwargs: Browser session configuration options including:
|
:param headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
||||||
- headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
:param disable_resources: Drop requests for unnecessary resources for a speed boost.
|
||||||
- disable_resources: Drop requests for unnecessary resources for a speed boost.
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
||||||
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
:param useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
|
||||||
- useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
|
:param cookies: Set cookies for the next request.
|
||||||
- cookies: Set cookies for the next request.
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
||||||
- network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
||||||
- timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
||||||
- wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
||||||
- page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
||||||
- wait_selector: Wait for a specific CSS selector to be in a specific state.
|
:param init_script: An absolute path to a JavaScript file to be executed on page creation for all pages in this session.
|
||||||
- init_script: An absolute path to a JavaScript file to be executed on page creation for all pages in this session.
|
:param locale: Specify user locale, for example, `en-GB`, `de-DE`, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting
|
||||||
- locale: Specify user locale, for example, `en-GB`, `de-DE`, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting
|
rules. Defaults to the system default locale.
|
||||||
rules. Defaults to the system default locale.
|
:param timezone_id: Changes the timezone of the browser. Defaults to the system timezone.
|
||||||
- timezone_id: Changes the timezone of the browser. Defaults to the system timezone.
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
||||||
- wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
:param solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you.
|
||||||
- solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you.
|
:param real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it.
|
||||||
- real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it.
|
:param hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
|
||||||
- hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
|
:param block_webrtc: Forces WebRTC to respect proxy settings to prevent local IP address leak.
|
||||||
- block_webrtc: Forces WebRTC to respect proxy settings to prevent local IP address leak.
|
:param allow_webgl: Enabled by default. Disabling it disables WebGL and WebGL 2.0 support entirely. Disabling WebGL is not recommended as many WAFs now check if WebGL is enabled.
|
||||||
- allow_webgl: Enabled by default. Disabling it disables WebGL and WebGL 2.0 support entirely. Disabling WebGL is not recommended as many WAFs now check if WebGL is enabled.
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
||||||
- load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
:param cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
|
||||||
- cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
||||||
- google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
||||||
- extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
:param proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
||||||
- proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
:param user_data_dir: Path to a User Data Directory, which stores browser session data like cookies and local storage. The default is to create a temporary directory.
|
||||||
- user_data_dir: Path to a User Data Directory, which stores browser session data like cookies and local storage. The default is to create a temporary directory.
|
:param extra_flags: A list of additional browser flags to pass to the browser on launch.
|
||||||
- extra_flags: A list of additional browser flags to pass to the browser on launch.
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
||||||
- selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
:param additional_args: Additional arguments to be passed to Playwright's context as additional settings, and it takes higher priority than Scrapling's settings.
|
||||||
- additional_args: Additional arguments to be passed to Playwright's context as additional settings, and it takes higher priority than Scrapling's settings.
|
|
||||||
:return: A `Response` object.
|
:return: A `Response` object.
|
||||||
"""
|
"""
|
||||||
selector_config = kwargs.get("selector_config", {}) or kwargs.get(
|
selector_config = kwargs.get("selector_config", {}) or kwargs.get(
|
||||||
@@ -65,36 +64,35 @@ class StealthyFetcher(BaseFetcher):
|
|||||||
Opens up a browser and do your request based on your chosen options below.
|
Opens up a browser and do your request based on your chosen options below.
|
||||||
|
|
||||||
:param url: Target url.
|
:param url: Target url.
|
||||||
:param kwargs: Browser session configuration options including:
|
:param headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
||||||
- headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
:param disable_resources: Drop requests for unnecessary resources for a speed boost.
|
||||||
- disable_resources: Drop requests for unnecessary resources for a speed boost.
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
||||||
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
:param useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
|
||||||
- useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
|
:param cookies: Set cookies for the next request.
|
||||||
- cookies: Set cookies for the next request.
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
||||||
- network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
||||||
- timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
||||||
- wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
||||||
- page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
||||||
- wait_selector: Wait for a specific CSS selector to be in a specific state.
|
:param init_script: An absolute path to a JavaScript file to be executed on page creation for all pages in this session.
|
||||||
- init_script: An absolute path to a JavaScript file to be executed on page creation for all pages in this session.
|
:param locale: Specify user locale, for example, `en-GB`, `de-DE`, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting
|
||||||
- locale: Specify user locale, for example, `en-GB`, `de-DE`, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting
|
rules. Defaults to the system default locale.
|
||||||
rules. Defaults to the system default locale.
|
:param timezone_id: Changes the timezone of the browser. Defaults to the system timezone.
|
||||||
- timezone_id: Changes the timezone of the browser. Defaults to the system timezone.
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
||||||
- wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
:param solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you.
|
||||||
- solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you.
|
:param real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it.
|
||||||
- real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it.
|
:param hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
|
||||||
- hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
|
:param block_webrtc: Forces WebRTC to respect proxy settings to prevent local IP address leak.
|
||||||
- block_webrtc: Forces WebRTC to respect proxy settings to prevent local IP address leak.
|
:param allow_webgl: Enabled by default. Disabling it disables WebGL and WebGL 2.0 support entirely. Disabling WebGL is not recommended as many WAFs now check if WebGL is enabled.
|
||||||
- allow_webgl: Enabled by default. Disabling it disables WebGL and WebGL 2.0 support entirely. Disabling WebGL is not recommended as many WAFs now check if WebGL is enabled.
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
||||||
- load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
:param cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
|
||||||
- cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
||||||
- google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
||||||
- extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
:param proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
||||||
- proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
:param user_data_dir: Path to a User Data Directory, which stores browser session data like cookies and local storage. The default is to create a temporary directory.
|
||||||
- user_data_dir: Path to a User Data Directory, which stores browser session data like cookies and local storage. The default is to create a temporary directory.
|
:param extra_flags: A list of additional browser flags to pass to the browser on launch.
|
||||||
- extra_flags: A list of additional browser flags to pass to the browser on launch.
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
||||||
- selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
:param additional_args: Additional arguments to be passed to Playwright's context as additional settings, and it takes higher priority than Scrapling's settings.
|
||||||
- additional_args: Additional arguments to be passed to Playwright's context as additional settings, and it takes higher priority than Scrapling's settings.
|
|
||||||
:return: A `Response` object.
|
:return: A `Response` object.
|
||||||
"""
|
"""
|
||||||
selector_config = kwargs.get("selector_config", {}) or kwargs.get(
|
selector_config = kwargs.get("selector_config", {}) or kwargs.get(
|
||||||
|
|||||||
Reference in New Issue
Block a user