The_Great_Archive/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-09-13 18:46:17 +05:00
Code Issues Actions Packages Projects Releases Wiki Activity
dev
ArchiveBox/docs/apidocs/archivebox/archivebox.plugins.hooks.md

5.2 KiB
Raw Permalink Blame History

{py:mod}archivebox.plugins.hooks

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`ConfigDump <archivebox.plugins.hooks.ConfigDump>`
  -

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`_has_config_dump <archivebox.plugins.hooks._has_config_dump>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks._has_config_dump
    :summary:
    ```
* - {py:obj}`_config_to_overrides <archivebox.plugins.hooks._config_to_overrides>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks._config_to_overrides
    :summary:
    ```
* - {py:obj}`is_background_hook <archivebox.plugins.hooks.is_background_hook>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks.is_background_hook
    :summary:
    ```
* - {py:obj}`normalize_hook_event_name <archivebox.plugins.hooks.normalize_hook_event_name>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks.normalize_hook_event_name
    :summary:
    ```
* - {py:obj}`_model_output_dir_from_child_path <archivebox.plugins.hooks._model_output_dir_from_child_path>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks._model_output_dir_from_child_path
    :summary:
    ```
* - {py:obj}`discover_hooks <archivebox.plugins.hooks.discover_hooks>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks.discover_hooks
    :summary:
    ```
* - {py:obj}`run_hook <archivebox.plugins.hooks.run_hook>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks.run_hook
    :summary:
    ```
* - {py:obj}`extract_records_from_process <archivebox.plugins.hooks.extract_records_from_process>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks.extract_records_from_process
    :summary:
    ```
* - {py:obj}`collect_urls_from_plugins <archivebox.plugins.hooks.collect_urls_from_plugins>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks.collect_urls_from_plugins
    :summary:
    ```
* - {py:obj}`process_hook_records <archivebox.plugins.hooks.process_hook_records>`
  - ```{autodoc2-docstring} archivebox.plugins.hooks.process_hook_records
    :summary:
    ```

API

:canonical: archivebox.plugins.hooks.ConfigDump

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

````{py:method} as_dict() -> dict[str, typing.Any]
:canonical: archivebox.plugins.hooks.ConfigDump.as_dict

```{autodoc2-docstring} archivebox.plugins.hooks.ConfigDump.as_dict
```

````


:canonical: archivebox.plugins.hooks._has_config_dump

```{autodoc2-docstring} archivebox.plugins.hooks._has_config_dump
```

:canonical: archivebox.plugins.hooks._config_to_overrides

```{autodoc2-docstring} archivebox.plugins.hooks._config_to_overrides
```

:canonical: archivebox.plugins.hooks.is_background_hook

```{autodoc2-docstring} archivebox.plugins.hooks.is_background_hook
```

:canonical: archivebox.plugins.hooks.normalize_hook_event_name

```{autodoc2-docstring} archivebox.plugins.hooks.normalize_hook_event_name
```

:canonical: archivebox.plugins.hooks._model_output_dir_from_child_path

```{autodoc2-docstring} archivebox.plugins.hooks._model_output_dir_from_child_path
```

:canonical: archivebox.plugins.hooks.discover_hooks

```{autodoc2-docstring} archivebox.plugins.hooks.discover_hooks
```

:canonical: archivebox.plugins.hooks.run_hook

```{autodoc2-docstring} archivebox.plugins.hooks.run_hook
```

:canonical: archivebox.plugins.hooks.extract_records_from_process

```{autodoc2-docstring} archivebox.plugins.hooks.extract_records_from_process
```

:canonical: archivebox.plugins.hooks.collect_urls_from_plugins

```{autodoc2-docstring} archivebox.plugins.hooks.collect_urls_from_plugins
```

:canonical: archivebox.plugins.hooks.process_hook_records

```{autodoc2-docstring} archivebox.plugins.hooks.process_hook_records
```