{py:mod}archivebox.logging_util

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`RuntimeStats <archivebox.logging_util.RuntimeStats>`
  - ```{autodoc2-docstring} archivebox.logging_util.RuntimeStats
    :summary:
    ```
* - {py:obj}`SmartFormatter <archivebox.logging_util.SmartFormatter>`
  - ```{autodoc2-docstring} archivebox.logging_util.SmartFormatter
    :summary:
    ```
* - {py:obj}`TimedProgress <archivebox.logging_util.TimedProgress>`
  - ```{autodoc2-docstring} archivebox.logging_util.TimedProgress
    :summary:
    ```

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`debug_dict_summary <archivebox.logging_util.debug_dict_summary>`
  - ```{autodoc2-docstring} archivebox.logging_util.debug_dict_summary
    :summary:
    ```
* - {py:obj}`get_fd_info <archivebox.logging_util.get_fd_info>`
  - ```{autodoc2-docstring} archivebox.logging_util.get_fd_info
    :summary:
    ```
* - {py:obj}`reject_stdin <archivebox.logging_util.reject_stdin>`
  - ```{autodoc2-docstring} archivebox.logging_util.reject_stdin
    :summary:
    ```
* - {py:obj}`accept_stdin <archivebox.logging_util.accept_stdin>`
  - ```{autodoc2-docstring} archivebox.logging_util.accept_stdin
    :summary:
    ```
* - {py:obj}`progress_bar <archivebox.logging_util.progress_bar>`
  - ```{autodoc2-docstring} archivebox.logging_util.progress_bar
    :summary:
    ```
* - {py:obj}`log_cli_command <archivebox.logging_util.log_cli_command>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_cli_command
    :summary:
    ```
* - {py:obj}`log_importing_started <archivebox.logging_util.log_importing_started>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_importing_started
    :summary:
    ```
* - {py:obj}`log_source_saved <archivebox.logging_util.log_source_saved>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_source_saved
    :summary:
    ```
* - {py:obj}`log_parsing_finished <archivebox.logging_util.log_parsing_finished>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_parsing_finished
    :summary:
    ```
* - {py:obj}`log_deduping_finished <archivebox.logging_util.log_deduping_finished>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_deduping_finished
    :summary:
    ```
* - {py:obj}`log_crawl_started <archivebox.logging_util.log_crawl_started>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_crawl_started
    :summary:
    ```
* - {py:obj}`log_indexing_process_started <archivebox.logging_util.log_indexing_process_started>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_indexing_process_started
    :summary:
    ```
* - {py:obj}`log_indexing_process_finished <archivebox.logging_util.log_indexing_process_finished>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_indexing_process_finished
    :summary:
    ```
* - {py:obj}`log_indexing_started <archivebox.logging_util.log_indexing_started>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_indexing_started
    :summary:
    ```
* - {py:obj}`log_indexing_finished <archivebox.logging_util.log_indexing_finished>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_indexing_finished
    :summary:
    ```
* - {py:obj}`log_archiving_started <archivebox.logging_util.log_archiving_started>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_archiving_started
    :summary:
    ```
* - {py:obj}`log_archiving_paused <archivebox.logging_util.log_archiving_paused>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_archiving_paused
    :summary:
    ```
* - {py:obj}`log_archiving_finished <archivebox.logging_util.log_archiving_finished>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_archiving_finished
    :summary:
    ```
* - {py:obj}`log_link_archiving_started <archivebox.logging_util.log_link_archiving_started>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_link_archiving_started
    :summary:
    ```
* - {py:obj}`log_link_archiving_finished <archivebox.logging_util.log_link_archiving_finished>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_link_archiving_finished
    :summary:
    ```
* - {py:obj}`log_archive_method_started <archivebox.logging_util.log_archive_method_started>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_archive_method_started
    :summary:
    ```
* - {py:obj}`log_archive_method_finished <archivebox.logging_util.log_archive_method_finished>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_archive_method_finished
    :summary:
    ```
* - {py:obj}`log_list_started <archivebox.logging_util.log_list_started>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_list_started
    :summary:
    ```
* - {py:obj}`log_list_finished <archivebox.logging_util.log_list_finished>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_list_finished
    :summary:
    ```
* - {py:obj}`log_removal_started <archivebox.logging_util.log_removal_started>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_removal_started
    :summary:
    ```
* - {py:obj}`log_removal_finished <archivebox.logging_util.log_removal_finished>`
  - ```{autodoc2-docstring} archivebox.logging_util.log_removal_finished
    :summary:
    ```
* - {py:obj}`pretty_path <archivebox.logging_util.pretty_path>`
  - ```{autodoc2-docstring} archivebox.logging_util.pretty_path
    :summary:
    ```
* - {py:obj}`printable_filesize <archivebox.logging_util.printable_filesize>`
  - ```{autodoc2-docstring} archivebox.logging_util.printable_filesize
    :summary:
    ```
* - {py:obj}`printable_folders <archivebox.logging_util.printable_folders>`
  - ```{autodoc2-docstring} archivebox.logging_util.printable_folders
    :summary:
    ```
* - {py:obj}`printable_config <archivebox.logging_util.printable_config>`
  - ```{autodoc2-docstring} archivebox.logging_util.printable_config
    :summary:
    ```
* - {py:obj}`printable_folder_status <archivebox.logging_util.printable_folder_status>`
  - ```{autodoc2-docstring} archivebox.logging_util.printable_folder_status
    :summary:
    ```
* - {py:obj}`printable_dependency_version <archivebox.logging_util.printable_dependency_version>`
  - ```{autodoc2-docstring} archivebox.logging_util.printable_dependency_version
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`_LAST_RUN_STATS <archivebox.logging_util._LAST_RUN_STATS>`
  - ```{autodoc2-docstring} archivebox.logging_util._LAST_RUN_STATS
    :summary:
    ```

API

:canonical: archivebox.logging_util.RuntimeStats

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats
```

````{py:attribute} skipped
:canonical: archivebox.logging_util.RuntimeStats.skipped
:type: int
:value: >
   0

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats.skipped
```

````

````{py:attribute} succeeded
:canonical: archivebox.logging_util.RuntimeStats.succeeded
:type: int
:value: >
   0

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats.succeeded
```

````

````{py:attribute} failed
:canonical: archivebox.logging_util.RuntimeStats.failed
:type: int
:value: >
   0

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats.failed
```

````

````{py:attribute} parse_start_ts
:canonical: archivebox.logging_util.RuntimeStats.parse_start_ts
:type: typing.Optional[datetime.datetime]
:value: >
   None

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats.parse_start_ts
```

````

````{py:attribute} parse_end_ts
:canonical: archivebox.logging_util.RuntimeStats.parse_end_ts
:type: typing.Optional[datetime.datetime]
:value: >
   None

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats.parse_end_ts
```

````

````{py:attribute} index_start_ts
:canonical: archivebox.logging_util.RuntimeStats.index_start_ts
:type: typing.Optional[datetime.datetime]
:value: >
   None

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats.index_start_ts
```

````

````{py:attribute} index_end_ts
:canonical: archivebox.logging_util.RuntimeStats.index_end_ts
:type: typing.Optional[datetime.datetime]
:value: >
   None

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats.index_end_ts
```

````

````{py:attribute} archiving_start_ts
:canonical: archivebox.logging_util.RuntimeStats.archiving_start_ts
:type: typing.Optional[datetime.datetime]
:value: >
   None

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats.archiving_start_ts
```

````

````{py:attribute} archiving_end_ts
:canonical: archivebox.logging_util.RuntimeStats.archiving_end_ts
:type: typing.Optional[datetime.datetime]
:value: >
   None

```{autodoc2-docstring} archivebox.logging_util.RuntimeStats.archiving_end_ts
```

````

:canonical: archivebox.logging_util._LAST_RUN_STATS
:value: >
   'RuntimeStats(...)'

```{autodoc2-docstring} archivebox.logging_util._LAST_RUN_STATS
```

:canonical: archivebox.logging_util.debug_dict_summary

```{autodoc2-docstring} archivebox.logging_util.debug_dict_summary
```

:canonical: archivebox.logging_util.get_fd_info

```{autodoc2-docstring} archivebox.logging_util.get_fd_info
```

:canonical: archivebox.logging_util.SmartFormatter

Bases: {py:obj}`django.core.management.base.DjangoHelpFormatter`, {py:obj}`rich_argparse.RichHelpFormatter`

```{autodoc2-docstring} archivebox.logging_util.SmartFormatter
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.logging_util.SmartFormatter.__init__
```

````{py:method} _split_lines(text, width)
:canonical: archivebox.logging_util.SmartFormatter._split_lines

```{autodoc2-docstring} archivebox.logging_util.SmartFormatter._split_lines
```

````

:canonical: archivebox.logging_util.reject_stdin

```{autodoc2-docstring} archivebox.logging_util.reject_stdin
```

:canonical: archivebox.logging_util.accept_stdin

```{autodoc2-docstring} archivebox.logging_util.accept_stdin
```

:canonical: archivebox.logging_util.TimedProgress

```{autodoc2-docstring} archivebox.logging_util.TimedProgress
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.logging_util.TimedProgress.__init__
```

````{py:method} end()
:canonical: archivebox.logging_util.TimedProgress.end

```{autodoc2-docstring} archivebox.logging_util.TimedProgress.end
```

````

:canonical: archivebox.logging_util.progress_bar

```{autodoc2-docstring} archivebox.logging_util.progress_bar
```

:canonical: archivebox.logging_util.log_cli_command

```{autodoc2-docstring} archivebox.logging_util.log_cli_command
```

:canonical: archivebox.logging_util.log_importing_started

```{autodoc2-docstring} archivebox.logging_util.log_importing_started
```

:canonical: archivebox.logging_util.log_source_saved

```{autodoc2-docstring} archivebox.logging_util.log_source_saved
```

:canonical: archivebox.logging_util.log_parsing_finished

```{autodoc2-docstring} archivebox.logging_util.log_parsing_finished
```

:canonical: archivebox.logging_util.log_deduping_finished

```{autodoc2-docstring} archivebox.logging_util.log_deduping_finished
```

:canonical: archivebox.logging_util.log_crawl_started

```{autodoc2-docstring} archivebox.logging_util.log_crawl_started
```

:canonical: archivebox.logging_util.log_indexing_process_started

```{autodoc2-docstring} archivebox.logging_util.log_indexing_process_started
```

:canonical: archivebox.logging_util.log_indexing_process_finished

```{autodoc2-docstring} archivebox.logging_util.log_indexing_process_finished
```

:canonical: archivebox.logging_util.log_indexing_started

```{autodoc2-docstring} archivebox.logging_util.log_indexing_started
```

:canonical: archivebox.logging_util.log_indexing_finished

```{autodoc2-docstring} archivebox.logging_util.log_indexing_finished
```

:canonical: archivebox.logging_util.log_archiving_started

```{autodoc2-docstring} archivebox.logging_util.log_archiving_started
```

:canonical: archivebox.logging_util.log_archiving_paused

```{autodoc2-docstring} archivebox.logging_util.log_archiving_paused
```

:canonical: archivebox.logging_util.log_archiving_finished

```{autodoc2-docstring} archivebox.logging_util.log_archiving_finished
```

:canonical: archivebox.logging_util.log_link_archiving_started

```{autodoc2-docstring} archivebox.logging_util.log_link_archiving_started
```

:canonical: archivebox.logging_util.log_link_archiving_finished

```{autodoc2-docstring} archivebox.logging_util.log_link_archiving_finished
```

:canonical: archivebox.logging_util.log_archive_method_started

```{autodoc2-docstring} archivebox.logging_util.log_archive_method_started
```

:canonical: archivebox.logging_util.log_archive_method_finished

```{autodoc2-docstring} archivebox.logging_util.log_archive_method_finished
```

:canonical: archivebox.logging_util.log_list_started

```{autodoc2-docstring} archivebox.logging_util.log_list_started
```

:canonical: archivebox.logging_util.log_list_finished

```{autodoc2-docstring} archivebox.logging_util.log_list_finished
```

:canonical: archivebox.logging_util.log_removal_started

```{autodoc2-docstring} archivebox.logging_util.log_removal_started
```

:canonical: archivebox.logging_util.log_removal_finished

```{autodoc2-docstring} archivebox.logging_util.log_removal_finished
```

:canonical: archivebox.logging_util.pretty_path

```{autodoc2-docstring} archivebox.logging_util.pretty_path
```

:canonical: archivebox.logging_util.printable_filesize

```{autodoc2-docstring} archivebox.logging_util.printable_filesize
```

:canonical: archivebox.logging_util.printable_folders

```{autodoc2-docstring} archivebox.logging_util.printable_folders
```

:canonical: archivebox.logging_util.printable_config

```{autodoc2-docstring} archivebox.logging_util.printable_config
```

:canonical: archivebox.logging_util.printable_folder_status

```{autodoc2-docstring} archivebox.logging_util.printable_folder_status
```

:canonical: archivebox.logging_util.printable_dependency_version

```{autodoc2-docstring} archivebox.logging_util.printable_dependency_version
```