{py:mod}archivebox.extractors

:allowtitles:

Package Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`ExtractorModuleProtocol <archivebox.extractors.ExtractorModuleProtocol>`
  - ```{autodoc2-docstring} archivebox.extractors.ExtractorModuleProtocol
    :summary:
    ```

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`get_default_archive_methods <archivebox.extractors.get_default_archive_methods>`
  - ```{autodoc2-docstring} archivebox.extractors.get_default_archive_methods
    :summary:
    ```
* - {py:obj}`get_archive_methods_for_link <archivebox.extractors.get_archive_methods_for_link>`
  - ```{autodoc2-docstring} archivebox.extractors.get_archive_methods_for_link
    :summary:
    ```
* - {py:obj}`ignore_methods <archivebox.extractors.ignore_methods>`
  - ```{autodoc2-docstring} archivebox.extractors.ignore_methods
    :summary:
    ```
* - {py:obj}`archive_link <archivebox.extractors.archive_link>`
  - ```{autodoc2-docstring} archivebox.extractors.archive_link
    :summary:
    ```
* - {py:obj}`archive_links <archivebox.extractors.archive_links>`
  - ```{autodoc2-docstring} archivebox.extractors.archive_links
    :summary:
    ```
* - {py:obj}`get_extractors <archivebox.extractors.get_extractors>`
  - ```{autodoc2-docstring} archivebox.extractors.get_extractors
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`ShouldSaveFunction <archivebox.extractors.ShouldSaveFunction>`
  - ```{autodoc2-docstring} archivebox.extractors.ShouldSaveFunction
    :summary:
    ```
* - {py:obj}`SaveFunction <archivebox.extractors.SaveFunction>`
  - ```{autodoc2-docstring} archivebox.extractors.SaveFunction
    :summary:
    ```
* - {py:obj}`ArchiveMethodEntry <archivebox.extractors.ArchiveMethodEntry>`
  - ```{autodoc2-docstring} archivebox.extractors.ArchiveMethodEntry
    :summary:
    ```
* - {py:obj}`ARCHIVE_METHODS_INDEXING_PRECEDENCE <archivebox.extractors.ARCHIVE_METHODS_INDEXING_PRECEDENCE>`
  - ```{autodoc2-docstring} archivebox.extractors.ARCHIVE_METHODS_INDEXING_PRECEDENCE
    :summary:
    ```
* - {py:obj}`EXTRACTORS_DIR <archivebox.extractors.EXTRACTORS_DIR>`
  - ```{autodoc2-docstring} archivebox.extractors.EXTRACTORS_DIR
    :summary:
    ```
* - {py:obj}`EXTRACTORS <archivebox.extractors.EXTRACTORS>`
  - ```{autodoc2-docstring} archivebox.extractors.EXTRACTORS
    :summary:
    ```

API

:canonical: archivebox.extractors.ShouldSaveFunction
:value: >
   None

```{autodoc2-docstring} archivebox.extractors.ShouldSaveFunction
```

:canonical: archivebox.extractors.SaveFunction
:value: >
   None

```{autodoc2-docstring} archivebox.extractors.SaveFunction
```

:canonical: archivebox.extractors.ArchiveMethodEntry
:value: >
   None

```{autodoc2-docstring} archivebox.extractors.ArchiveMethodEntry
```

:canonical: archivebox.extractors.get_default_archive_methods

```{autodoc2-docstring} archivebox.extractors.get_default_archive_methods
```

:canonical: archivebox.extractors.ARCHIVE_METHODS_INDEXING_PRECEDENCE
:value: >
   [('readability', 1), ('mercury', 2), ('htmltotext', 3), ('singlefile', 4), ('dom', 5), ('wget', 6)]

```{autodoc2-docstring} archivebox.extractors.ARCHIVE_METHODS_INDEXING_PRECEDENCE
```

:canonical: archivebox.extractors.get_archive_methods_for_link

```{autodoc2-docstring} archivebox.extractors.get_archive_methods_for_link
```

:canonical: archivebox.extractors.ignore_methods

```{autodoc2-docstring} archivebox.extractors.ignore_methods
```

:canonical: archivebox.extractors.archive_link

```{autodoc2-docstring} archivebox.extractors.archive_link
```

:canonical: archivebox.extractors.archive_links

```{autodoc2-docstring} archivebox.extractors.archive_links
```

:canonical: archivebox.extractors.EXTRACTORS_DIR
:value: >
   None

```{autodoc2-docstring} archivebox.extractors.EXTRACTORS_DIR
```

:canonical: archivebox.extractors.ExtractorModuleProtocol

Bases: {py:obj}`typing.Protocol`

```{autodoc2-docstring} archivebox.extractors.ExtractorModuleProtocol
```

````{py:attribute} get_output_path
:canonical: archivebox.extractors.ExtractorModuleProtocol.get_output_path
:type: typing.Callable
:value: >
   None

```{autodoc2-docstring} archivebox.extractors.ExtractorModuleProtocol.get_output_path
```

````

:canonical: archivebox.extractors.get_extractors

```{autodoc2-docstring} archivebox.extractors.get_extractors
```

:canonical: archivebox.extractors.EXTRACTORS
:value: >
   'get_extractors(...)'

```{autodoc2-docstring} archivebox.extractors.EXTRACTORS
```