{py:mod}abx_plugin_chrome.config

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`ChromeConfig <abx_plugin_chrome.config.ChromeConfig>`
  -

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`autodetect_system_chrome_install <abx_plugin_chrome.config.autodetect_system_chrome_install>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.autodetect_system_chrome_install
    :summary:
    ```
* - {py:obj}`create_macos_app_symlink <abx_plugin_chrome.config.create_macos_app_symlink>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.create_macos_app_symlink
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`CHROMIUM_BINARY_NAMES_LINUX <abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES_LINUX>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES_LINUX
    :summary:
    ```
* - {py:obj}`CHROMIUM_BINARY_NAMES_MACOS <abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES_MACOS>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES_MACOS
    :summary:
    ```
* - {py:obj}`CHROMIUM_BINARY_NAMES <abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES
    :summary:
    ```
* - {py:obj}`CHROME_BINARY_NAMES_LINUX <abx_plugin_chrome.config.CHROME_BINARY_NAMES_LINUX>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.CHROME_BINARY_NAMES_LINUX
    :summary:
    ```
* - {py:obj}`CHROME_BINARY_NAMES_MACOS <abx_plugin_chrome.config.CHROME_BINARY_NAMES_MACOS>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.CHROME_BINARY_NAMES_MACOS
    :summary:
    ```
* - {py:obj}`CHROME_BINARY_NAMES <abx_plugin_chrome.config.CHROME_BINARY_NAMES>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.CHROME_BINARY_NAMES
    :summary:
    ```
* - {py:obj}`APT_DEPENDENCIES <abx_plugin_chrome.config.APT_DEPENDENCIES>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.APT_DEPENDENCIES
    :summary:
    ```
* - {py:obj}`CHROME_CONFIG <abx_plugin_chrome.config.CHROME_CONFIG>`
  - ```{autodoc2-docstring} abx_plugin_chrome.config.CHROME_CONFIG
    :summary:
    ```

API

:canonical: abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES_LINUX
:value: >
   ['chromium', 'chromium-browser', 'chromium-browser-beta', 'chromium-browser-unstable', 'chromium-bro...

```{autodoc2-docstring} abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES_LINUX
```

:canonical: abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES_MACOS
:value: >
   ['/Applications/Chromium.app/Contents/MacOS/Chromium']

```{autodoc2-docstring} abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES_MACOS
```

:canonical: abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES
:value: >
   None

```{autodoc2-docstring} abx_plugin_chrome.config.CHROMIUM_BINARY_NAMES
```

:canonical: abx_plugin_chrome.config.CHROME_BINARY_NAMES_LINUX
:value: >
   ['google-chrome', 'google-chrome-stable', 'google-chrome-beta', 'google-chrome-canary', 'google-chro...

```{autodoc2-docstring} abx_plugin_chrome.config.CHROME_BINARY_NAMES_LINUX
```

:canonical: abx_plugin_chrome.config.CHROME_BINARY_NAMES_MACOS
:value: >
   ['/Applications/Google Chrome.app/Contents/MacOS/Google Chrome', '/Applications/Google Chrome Canary...

```{autodoc2-docstring} abx_plugin_chrome.config.CHROME_BINARY_NAMES_MACOS
```

:canonical: abx_plugin_chrome.config.CHROME_BINARY_NAMES
:value: >
   None

```{autodoc2-docstring} abx_plugin_chrome.config.CHROME_BINARY_NAMES
```

:canonical: abx_plugin_chrome.config.APT_DEPENDENCIES
:value: >
   ['apt-transport-https', 'at-spi2-common', 'chromium-browser', 'fontconfig', 'fonts-freefont-ttf', 'f...

```{autodoc2-docstring} abx_plugin_chrome.config.APT_DEPENDENCIES
```

:canonical: abx_plugin_chrome.config.autodetect_system_chrome_install

```{autodoc2-docstring} abx_plugin_chrome.config.autodetect_system_chrome_install
```

:canonical: abx_plugin_chrome.config.create_macos_app_symlink

```{autodoc2-docstring} abx_plugin_chrome.config.create_macos_app_symlink
```

:canonical: abx_plugin_chrome.config.ChromeConfig

Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`

````{py:attribute} USE_CHROME
:canonical: abx_plugin_chrome.config.ChromeConfig.USE_CHROME
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.USE_CHROME
```

````

````{py:attribute} CHROME_BINARY
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_BINARY
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_BINARY
```

````

````{py:attribute} CHROME_DEFAULT_ARGS
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_DEFAULT_ARGS
:type: typing.List[str]
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_DEFAULT_ARGS
```

````

````{py:attribute} CHROME_EXTRA_ARGS
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_EXTRA_ARGS
:type: typing.List[str]
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_EXTRA_ARGS
```

````

````{py:attribute} CHROME_TIMEOUT
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_TIMEOUT
:type: int
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_TIMEOUT
```

````

````{py:attribute} CHROME_HEADLESS
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_HEADLESS
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_HEADLESS
```

````

````{py:attribute} CHROME_SANDBOX
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_SANDBOX
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_SANDBOX
```

````

````{py:attribute} CHROME_RESOLUTION
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_RESOLUTION
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_RESOLUTION
```

````

````{py:attribute} CHROME_CHECK_SSL_VALIDITY
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_CHECK_SSL_VALIDITY
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_CHECK_SSL_VALIDITY
```

````

````{py:attribute} CHROME_USER_AGENT
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_USER_AGENT
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_USER_AGENT
```

````

````{py:attribute} CHROME_USER_DATA_DIR
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_USER_DATA_DIR
:type: pathlib.Path | None
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_USER_DATA_DIR
```

````

````{py:attribute} CHROME_PROFILE_NAME
:canonical: abx_plugin_chrome.config.ChromeConfig.CHROME_PROFILE_NAME
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.CHROME_PROFILE_NAME
```

````

````{py:attribute} SAVE_SCREENSHOT
:canonical: abx_plugin_chrome.config.ChromeConfig.SAVE_SCREENSHOT
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.SAVE_SCREENSHOT
```

````

````{py:attribute} SAVE_DOM
:canonical: abx_plugin_chrome.config.ChromeConfig.SAVE_DOM
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.SAVE_DOM
```

````

````{py:attribute} SAVE_PDF
:canonical: abx_plugin_chrome.config.ChromeConfig.SAVE_PDF
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.SAVE_PDF
```

````

````{py:method} validate()
:canonical: abx_plugin_chrome.config.ChromeConfig.validate

````

````{py:method} chrome_args(**options) -> typing.List[str]
:canonical: abx_plugin_chrome.config.ChromeConfig.chrome_args

```{autodoc2-docstring} abx_plugin_chrome.config.ChromeConfig.chrome_args
```

````

:canonical: abx_plugin_chrome.config.CHROME_CONFIG
:value: >
   'ChromeConfig(...)'

```{autodoc2-docstring} abx_plugin_chrome.config.CHROME_CONFIG
```