docs: change docstring style for some methods

2026-01-01 21:06:35 +02:00
parent 9742b239be
commit 4947152be2
4 changed files with 156 additions and 164 deletions
@@ -12,31 +12,30 @@ class DynamicFetcher(BaseFetcher):
        """Opens up a browser and do your request based on your chosen options below.

        :param url: Target url.
-        :param kwargs: Browser session configuration options including:
-            - headless: Run the browser in headless/hidden (default), or headful/visible mode.
-            - disable_resources: Drop requests of unnecessary resources for a speed boost.
-            - useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
-            - cookies: Set cookies for the next request.
-            - network_idle: Wait for the page until there are no network connections for at least 500 ms.
-            - load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
-            - timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
-            - wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the Response object.
-            - page_action: Added for automation. A function that takes the `page` object and does the automation you need.
-            - wait_selector: Wait for a specific CSS selector to be in a specific state.
-            - init_script: An absolute path to a JavaScript file to be executed on page creation with this request.
-            - locale: Set the locale for the browser if wanted. The default value is `en-US`.
-            - wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
-            - stealth: Enables stealth mode, check the documentation to see what stealth mode does currently.
-            - 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.
-            - hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
-            - disable_webgl: Disables WebGL and WebGL 2.0 support entirely.
-            - cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
-            - 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.
-            - extra_headers: A dictionary of extra headers to add to the request.
-            - proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
-            - extra_flags: A list of additional browser flags to pass to the browser on launch.
-            - selector_config: The arguments that will be passed in the end while creating the final Selector's class.
-            - additional_args: Additional arguments to be passed to Playwright's context as additional settings.
+        :param headless: Run the browser in headless/hidden (default), or headful/visible mode.
+        :param 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.
+        :param 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.
+        :param 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
+        :param 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.
+        :param 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.
+        :param 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`.
+        :param 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.
+        :param hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
+        :param 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.
+        :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.
+        :param 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.
+        :param 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.
+        :param additional_args: Additional arguments to be passed to Playwright's context as additional settings.
        :return: A `Response` object.
        """
        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.

        :param url: Target url.
-        :param kwargs: Browser session configuration options including:
-            - headless: Run the browser in headless/hidden (default), or headful/visible mode.
-            - disable_resources: Drop requests of unnecessary resources for a speed boost.
-            - useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it.
-            - cookies: Set cookies for the next request.
-            - network_idle: Wait for the page until there are no network connections for at least 500 ms.
-            - load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
-            - timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
-            - wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the Response object.
-            - page_action: Added for automation. A function that takes the `page` object and does the automation you need.
-            - wait_selector: Wait for a specific CSS selector to be in a specific state.
-            - init_script: An absolute path to a JavaScript file to be executed on page creation with this request.
-            - locale: Set the locale for the browser if wanted. The default value is `en-US`.
-            - wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
-            - stealth: Enables stealth mode, check the documentation to see what stealth mode does currently.
-            - 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.
-            - hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
-            - disable_webgl: Disables WebGL and WebGL 2.0 support entirely.
-            - cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP.
-            - 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.
-            - extra_headers: A dictionary of extra headers to add to the request.
-            - proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
-            - extra_flags: A list of additional browser flags to pass to the browser on launch.
-            - selector_config: The arguments that will be passed in the end while creating the final Selector's class.
-            - additional_args: Additional arguments to be passed to Playwright's context as additional settings.
+        :param headless: Run the browser in headless/hidden (default), or headful/visible mode.
+        :param 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.
+        :param 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.
+        :param 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
+        :param 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.
+        :param 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.
+        :param 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`.
+        :param 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.
+        :param hide_canvas: Add random noise to canvas operations to prevent fingerprinting.
+        :param 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.
+        :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.
+        :param 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.
+        :param 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.
+        :param additional_args: Additional arguments to be passed to Playwright's context as additional settings.
        :return: A `Response` object.
        """
        selector_config = kwargs.get("selector_config", {}) or kwargs.get(