ArchiveBox/docs/apidocs/archivebox/archivebox.misc.util.md

{py:mod}archivebox.misc.util

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`ExtendedEncoder <archivebox.misc.util.ExtendedEncoder>`
  - ```{autodoc2-docstring} archivebox.misc.util.ExtendedEncoder
    :summary:
    ```

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`filter_queryset_by_uuid_substring <archivebox.misc.util.filter_queryset_by_uuid_substring>`
  - ```{autodoc2-docstring} archivebox.misc.util.filter_queryset_by_uuid_substring
    :summary:
    ```
* - {py:obj}`sanitize_html_text <archivebox.misc.util.sanitize_html_text>`
  - ```{autodoc2-docstring} archivebox.misc.util.sanitize_html_text
    :summary:
    ```
* - {py:obj}`ts_to_date_str <archivebox.misc.util.ts_to_date_str>`
  - ```{autodoc2-docstring} archivebox.misc.util.ts_to_date_str
    :summary:
    ```
* - {py:obj}`sanitize_extracted_url <archivebox.misc.util.sanitize_extracted_url>`
  - ```{autodoc2-docstring} archivebox.misc.util.sanitize_extracted_url
    :summary:
    ```
* - {py:obj}`validate_url_length <archivebox.misc.util.validate_url_length>`
  - ```{autodoc2-docstring} archivebox.misc.util.validate_url_length
    :summary:
    ```
* - {py:obj}`validate_url <archivebox.misc.util.validate_url>`
  - ```{autodoc2-docstring} archivebox.misc.util.validate_url
    :summary:
    ```
* - {py:obj}`parens_are_matched <archivebox.misc.util.parens_are_matched>`
  - ```{autodoc2-docstring} archivebox.misc.util.parens_are_matched
    :summary:
    ```
* - {py:obj}`fix_url_from_markdown <archivebox.misc.util.fix_url_from_markdown>`
  - ```{autodoc2-docstring} archivebox.misc.util.fix_url_from_markdown
    :summary:
    ```
* - {py:obj}`split_comma_separated_urls <archivebox.misc.util.split_comma_separated_urls>`
  - ```{autodoc2-docstring} archivebox.misc.util.split_comma_separated_urls
    :summary:
    ```
* - {py:obj}`find_all_urls <archivebox.misc.util.find_all_urls>`
  - ```{autodoc2-docstring} archivebox.misc.util.find_all_urls
    :summary:
    ```
* - {py:obj}`parse_filesize_to_bytes <archivebox.misc.util.parse_filesize_to_bytes>`
  - ```{autodoc2-docstring} archivebox.misc.util.parse_filesize_to_bytes
    :summary:
    ```
* - {py:obj}`enforce_types <archivebox.misc.util.enforce_types>`
  - ```{autodoc2-docstring} archivebox.misc.util.enforce_types
    :summary:
    ```
* - {py:obj}`docstring <archivebox.misc.util.docstring>`
  - ```{autodoc2-docstring} archivebox.misc.util.docstring
    :summary:
    ```
* - {py:obj}`parse_date <archivebox.misc.util.parse_date>`
  - ```{autodoc2-docstring} archivebox.misc.util.parse_date
    :summary:
    ```
* - {py:obj}`download_url <archivebox.misc.util.download_url>`
  - ```{autodoc2-docstring} archivebox.misc.util.download_url
    :summary:
    ```
* - {py:obj}`ansi_to_html <archivebox.misc.util.ansi_to_html>`
  - ```{autodoc2-docstring} archivebox.misc.util.ansi_to_html
    :summary:
    ```
* - {py:obj}`to_json <archivebox.misc.util.to_json>`
  - ```{autodoc2-docstring} archivebox.misc.util.to_json
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`scheme <archivebox.misc.util.scheme>`
  - ```{autodoc2-docstring} archivebox.misc.util.scheme
    :summary:
    ```
* - {py:obj}`without_scheme <archivebox.misc.util.without_scheme>`
  - ```{autodoc2-docstring} archivebox.misc.util.without_scheme
    :summary:
    ```
* - {py:obj}`without_query <archivebox.misc.util.without_query>`
  - ```{autodoc2-docstring} archivebox.misc.util.without_query
    :summary:
    ```
* - {py:obj}`without_fragment <archivebox.misc.util.without_fragment>`
  - ```{autodoc2-docstring} archivebox.misc.util.without_fragment
    :summary:
    ```
* - {py:obj}`without_path <archivebox.misc.util.without_path>`
  - ```{autodoc2-docstring} archivebox.misc.util.without_path
    :summary:
    ```
* - {py:obj}`path <archivebox.misc.util.path>`
  - ```{autodoc2-docstring} archivebox.misc.util.path
    :summary:
    ```
* - {py:obj}`basename <archivebox.misc.util.basename>`
  - ```{autodoc2-docstring} archivebox.misc.util.basename
    :summary:
    ```
* - {py:obj}`domain <archivebox.misc.util.domain>`
  - ```{autodoc2-docstring} archivebox.misc.util.domain
    :summary:
    ```
* - {py:obj}`query <archivebox.misc.util.query>`
  - ```{autodoc2-docstring} archivebox.misc.util.query
    :summary:
    ```
* - {py:obj}`fragment <archivebox.misc.util.fragment>`
  - ```{autodoc2-docstring} archivebox.misc.util.fragment
    :summary:
    ```
* - {py:obj}`extension <archivebox.misc.util.extension>`
  - ```{autodoc2-docstring} archivebox.misc.util.extension
    :summary:
    ```
* - {py:obj}`base_url <archivebox.misc.util.base_url>`
  - ```{autodoc2-docstring} archivebox.misc.util.base_url
    :summary:
    ```
* - {py:obj}`urlencode <archivebox.misc.util.urlencode>`
  - ```{autodoc2-docstring} archivebox.misc.util.urlencode
    :summary:
    ```
* - {py:obj}`urldecode <archivebox.misc.util.urldecode>`
  - ```{autodoc2-docstring} archivebox.misc.util.urldecode
    :summary:
    ```
* - {py:obj}`htmlencode <archivebox.misc.util.htmlencode>`
  - ```{autodoc2-docstring} archivebox.misc.util.htmlencode
    :summary:
    ```
* - {py:obj}`htmldecode <archivebox.misc.util.htmldecode>`
  - ```{autodoc2-docstring} archivebox.misc.util.htmldecode
    :summary:
    ```
* - {py:obj}`COLOR_REGEX <archivebox.misc.util.COLOR_REGEX>`
  - ```{autodoc2-docstring} archivebox.misc.util.COLOR_REGEX
    :summary:
    ```
* - {py:obj}`URL_REGEX <archivebox.misc.util.URL_REGEX>`
  - ```{autodoc2-docstring} archivebox.misc.util.URL_REGEX
    :summary:
    ```
* - {py:obj}`MAX_URL_LENGTH <archivebox.misc.util.MAX_URL_LENGTH>`
  - ```{autodoc2-docstring} archivebox.misc.util.MAX_URL_LENGTH
    :summary:
    ```
* - {py:obj}`QUOTE_DELIMITERS <archivebox.misc.util.QUOTE_DELIMITERS>`
  - ```{autodoc2-docstring} archivebox.misc.util.QUOTE_DELIMITERS
    :summary:
    ```
* - {py:obj}`QUOTE_ENTITY_DELIMITERS <archivebox.misc.util.QUOTE_ENTITY_DELIMITERS>`
  - ```{autodoc2-docstring} archivebox.misc.util.QUOTE_ENTITY_DELIMITERS
    :summary:
    ```
* - {py:obj}`URL_ENTITY_REPLACEMENTS <archivebox.misc.util.URL_ENTITY_REPLACEMENTS>`
  - ```{autodoc2-docstring} archivebox.misc.util.URL_ENTITY_REPLACEMENTS
    :summary:
    ```
* - {py:obj}`FILESIZE_UNITS <archivebox.misc.util.FILESIZE_UNITS>`
  - ```{autodoc2-docstring} archivebox.misc.util.FILESIZE_UNITS
    :summary:
    ```

API

:canonical: archivebox.misc.util.filter_queryset_by_uuid_substring

```{autodoc2-docstring} archivebox.misc.util.filter_queryset_by_uuid_substring
```

:canonical: archivebox.misc.util.scheme
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.scheme
```

:canonical: archivebox.misc.util.without_scheme
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.without_scheme
```

:canonical: archivebox.misc.util.without_query
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.without_query
```

:canonical: archivebox.misc.util.without_fragment
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.without_fragment
```

:canonical: archivebox.misc.util.without_path
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.without_path
```

:canonical: archivebox.misc.util.path
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.path
```

:canonical: archivebox.misc.util.basename
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.basename
```

:canonical: archivebox.misc.util.domain
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.domain
```

:canonical: archivebox.misc.util.query
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.query
```

:canonical: archivebox.misc.util.fragment
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.fragment
```

:canonical: archivebox.misc.util.extension
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.extension
```

:canonical: archivebox.misc.util.base_url
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.base_url
```

:canonical: archivebox.misc.util.urlencode
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.urlencode
```

:canonical: archivebox.misc.util.urldecode
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.urldecode
```

:canonical: archivebox.misc.util.htmlencode
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.htmlencode
```

:canonical: archivebox.misc.util.htmldecode
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.htmldecode
```

:canonical: archivebox.misc.util.sanitize_html_text

```{autodoc2-docstring} archivebox.misc.util.sanitize_html_text
```

:canonical: archivebox.misc.util.ts_to_date_str

```{autodoc2-docstring} archivebox.misc.util.ts_to_date_str
```

:canonical: archivebox.misc.util.COLOR_REGEX
:value: >
   'compile(...)'

```{autodoc2-docstring} archivebox.misc.util.COLOR_REGEX
```

:canonical: archivebox.misc.util.URL_REGEX
:value: >
   'compile(...)'

```{autodoc2-docstring} archivebox.misc.util.URL_REGEX
```

:canonical: archivebox.misc.util.MAX_URL_LENGTH
:value: >
   65535

```{autodoc2-docstring} archivebox.misc.util.MAX_URL_LENGTH
```

:canonical: archivebox.misc.util.QUOTE_DELIMITERS
:value: >
   ('"', "'", '`', '“', '”', '‘', '’')

```{autodoc2-docstring} archivebox.misc.util.QUOTE_DELIMITERS
```

:canonical: archivebox.misc.util.QUOTE_ENTITY_DELIMITERS
:value: >
   ('"', '"', '"', ''', ''', ''')

```{autodoc2-docstring} archivebox.misc.util.QUOTE_ENTITY_DELIMITERS
```

:canonical: archivebox.misc.util.URL_ENTITY_REPLACEMENTS
:value: >
   (('&', '&'), ('&', '&'), ('&', '&'))

```{autodoc2-docstring} archivebox.misc.util.URL_ENTITY_REPLACEMENTS
```

:canonical: archivebox.misc.util.FILESIZE_UNITS
:type: dict[str, int]
:value: >
   None

```{autodoc2-docstring} archivebox.misc.util.FILESIZE_UNITS
```

:canonical: archivebox.misc.util.sanitize_extracted_url

```{autodoc2-docstring} archivebox.misc.util.sanitize_extracted_url
```

:canonical: archivebox.misc.util.validate_url_length

```{autodoc2-docstring} archivebox.misc.util.validate_url_length
```

:canonical: archivebox.misc.util.validate_url

```{autodoc2-docstring} archivebox.misc.util.validate_url
```

:canonical: archivebox.misc.util.parens_are_matched

```{autodoc2-docstring} archivebox.misc.util.parens_are_matched
```

:canonical: archivebox.misc.util.fix_url_from_markdown

```{autodoc2-docstring} archivebox.misc.util.fix_url_from_markdown
```

:canonical: archivebox.misc.util.split_comma_separated_urls

```{autodoc2-docstring} archivebox.misc.util.split_comma_separated_urls
```

:canonical: archivebox.misc.util.find_all_urls

```{autodoc2-docstring} archivebox.misc.util.find_all_urls
```

:canonical: archivebox.misc.util.parse_filesize_to_bytes

```{autodoc2-docstring} archivebox.misc.util.parse_filesize_to_bytes
```

:canonical: archivebox.misc.util.enforce_types

```{autodoc2-docstring} archivebox.misc.util.enforce_types
```

:canonical: archivebox.misc.util.docstring

```{autodoc2-docstring} archivebox.misc.util.docstring
```

:canonical: archivebox.misc.util.parse_date

```{autodoc2-docstring} archivebox.misc.util.parse_date
```

:canonical: archivebox.misc.util.download_url

```{autodoc2-docstring} archivebox.misc.util.download_url
```

:canonical: archivebox.misc.util.ansi_to_html

```{autodoc2-docstring} archivebox.misc.util.ansi_to_html
```

:canonical: archivebox.misc.util.ExtendedEncoder

Bases: {py:obj}`json.JSONEncoder`

```{autodoc2-docstring} archivebox.misc.util.ExtendedEncoder
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.misc.util.ExtendedEncoder.__init__
```

````{py:method} default(o)
:canonical: archivebox.misc.util.ExtendedEncoder.default

````

:canonical: archivebox.misc.util.to_json

```{autodoc2-docstring} archivebox.misc.util.to_json
```