{py:mod}archivebox.base_models.models

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`AutoDateTimeField <archivebox.base_models.models.AutoDateTimeField>`
  - ```{autodoc2-docstring} archivebox.base_models.models.AutoDateTimeField
    :summary:
    ```
* - {py:obj}`ModelWithUUID <archivebox.base_models.models.ModelWithUUID>`
  -
* - {py:obj}`ModelWithNotes <archivebox.base_models.models.ModelWithNotes>`
  - ```{autodoc2-docstring} archivebox.base_models.models.ModelWithNotes
    :summary:
    ```
* - {py:obj}`ModelWithHealthStats <archivebox.base_models.models.ModelWithHealthStats>`
  - ```{autodoc2-docstring} archivebox.base_models.models.ModelWithHealthStats
    :summary:
    ```
* - {py:obj}`ModelWithConfig <archivebox.base_models.models.ModelWithConfig>`
  - ```{autodoc2-docstring} archivebox.base_models.models.ModelWithConfig
    :summary:
    ```
* - {py:obj}`ModelWithOutputDir <archivebox.base_models.models.ModelWithOutputDir>`
  -

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`get_or_create_system_user_pk <archivebox.base_models.models.get_or_create_system_user_pk>`
  - ```{autodoc2-docstring} archivebox.base_models.models.get_or_create_system_user_pk
    :summary:
    ```

API

:canonical: archivebox.base_models.models.get_or_create_system_user_pk

```{autodoc2-docstring} archivebox.base_models.models.get_or_create_system_user_pk
```

:canonical: archivebox.base_models.models.AutoDateTimeField

Bases: {py:obj}`django.db.models.DateTimeField`

```{autodoc2-docstring} archivebox.base_models.models.AutoDateTimeField
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.base_models.models.AutoDateTimeField.__init__
```

````{py:method} pre_save(model_instance, add)
:canonical: archivebox.base_models.models.AutoDateTimeField.pre_save

````

:canonical: archivebox.base_models.models.ModelWithUUID

Bases: {py:obj}`django.db.models.Model`

````{py:attribute} id
:canonical: archivebox.base_models.models.ModelWithUUID.id
:value: >
   'UUIDField(...)'

```{autodoc2-docstring} archivebox.base_models.models.ModelWithUUID.id
```

````

````{py:attribute} created_at
:canonical: archivebox.base_models.models.ModelWithUUID.created_at
:value: >
   'DateTimeField(...)'

```{autodoc2-docstring} archivebox.base_models.models.ModelWithUUID.created_at
```

````

````{py:attribute} modified_at
:canonical: archivebox.base_models.models.ModelWithUUID.modified_at
:value: >
   'DateTimeField(...)'

```{autodoc2-docstring} archivebox.base_models.models.ModelWithUUID.modified_at
```

````

````{py:attribute} created_by
:canonical: archivebox.base_models.models.ModelWithUUID.created_by
:value: >
   'ForeignKey(...)'

```{autodoc2-docstring} archivebox.base_models.models.ModelWithUUID.created_by
```

````

`````{py:class} Meta
:canonical: archivebox.base_models.models.ModelWithUUID.Meta

Bases: {py:obj}`django_stubs_ext.db.models.TypedModelMeta`

````{py:attribute} abstract
:canonical: archivebox.base_models.models.ModelWithUUID.Meta.abstract
:value: >
   True

```{autodoc2-docstring} archivebox.base_models.models.ModelWithUUID.Meta.abstract
```

````

`````

````{py:method} __str__()
:canonical: archivebox.base_models.models.ModelWithUUID.__str__

````

````{py:property} admin_change_url
:canonical: archivebox.base_models.models.ModelWithUUID.admin_change_url
:type: str

```{autodoc2-docstring} archivebox.base_models.models.ModelWithUUID.admin_change_url
```

````

````{py:property} api_url
:canonical: archivebox.base_models.models.ModelWithUUID.api_url
:type: str

```{autodoc2-docstring} archivebox.base_models.models.ModelWithUUID.api_url
```

````

````{py:property} api_docs_url
:canonical: archivebox.base_models.models.ModelWithUUID.api_docs_url
:type: str

```{autodoc2-docstring} archivebox.base_models.models.ModelWithUUID.api_docs_url
```

````

:canonical: archivebox.base_models.models.ModelWithNotes

Bases: {py:obj}`django.db.models.Model`

```{autodoc2-docstring} archivebox.base_models.models.ModelWithNotes
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.base_models.models.ModelWithNotes.__init__
```

````{py:attribute} notes
:canonical: archivebox.base_models.models.ModelWithNotes.notes
:value: >
   'TextField(...)'

```{autodoc2-docstring} archivebox.base_models.models.ModelWithNotes.notes
```

````

`````{py:class} Meta
:canonical: archivebox.base_models.models.ModelWithNotes.Meta

```{autodoc2-docstring} archivebox.base_models.models.ModelWithNotes.Meta
```

````{py:attribute} abstract
:canonical: archivebox.base_models.models.ModelWithNotes.Meta.abstract
:value: >
   True

```{autodoc2-docstring} archivebox.base_models.models.ModelWithNotes.Meta.abstract
```

````

`````

:canonical: archivebox.base_models.models.ModelWithHealthStats

Bases: {py:obj}`django.db.models.Model`

```{autodoc2-docstring} archivebox.base_models.models.ModelWithHealthStats
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.base_models.models.ModelWithHealthStats.__init__
```

````{py:attribute} num_uses_failed
:canonical: archivebox.base_models.models.ModelWithHealthStats.num_uses_failed
:value: >
   'PositiveIntegerField(...)'

```{autodoc2-docstring} archivebox.base_models.models.ModelWithHealthStats.num_uses_failed
```

````

````{py:attribute} num_uses_succeeded
:canonical: archivebox.base_models.models.ModelWithHealthStats.num_uses_succeeded
:value: >
   'PositiveIntegerField(...)'

```{autodoc2-docstring} archivebox.base_models.models.ModelWithHealthStats.num_uses_succeeded
```

````

`````{py:class} Meta
:canonical: archivebox.base_models.models.ModelWithHealthStats.Meta

```{autodoc2-docstring} archivebox.base_models.models.ModelWithHealthStats.Meta
```

````{py:attribute} abstract
:canonical: archivebox.base_models.models.ModelWithHealthStats.Meta.abstract
:value: >
   True

```{autodoc2-docstring} archivebox.base_models.models.ModelWithHealthStats.Meta.abstract
```

````

`````

````{py:property} health
:canonical: archivebox.base_models.models.ModelWithHealthStats.health
:type: int

```{autodoc2-docstring} archivebox.base_models.models.ModelWithHealthStats.health
```

````

````{py:method} increment_health_stats(success: bool)
:canonical: archivebox.base_models.models.ModelWithHealthStats.increment_health_stats

```{autodoc2-docstring} archivebox.base_models.models.ModelWithHealthStats.increment_health_stats
```

````

:canonical: archivebox.base_models.models.ModelWithConfig

Bases: {py:obj}`django.db.models.Model`

```{autodoc2-docstring} archivebox.base_models.models.ModelWithConfig
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.base_models.models.ModelWithConfig.__init__
```

````{py:attribute} config
:canonical: archivebox.base_models.models.ModelWithConfig.config
:value: >
   'JSONField(...)'

```{autodoc2-docstring} archivebox.base_models.models.ModelWithConfig.config
```

````

`````{py:class} Meta
:canonical: archivebox.base_models.models.ModelWithConfig.Meta

```{autodoc2-docstring} archivebox.base_models.models.ModelWithConfig.Meta
```

````{py:attribute} abstract
:canonical: archivebox.base_models.models.ModelWithConfig.Meta.abstract
:value: >
   True

```{autodoc2-docstring} archivebox.base_models.models.ModelWithConfig.Meta.abstract
```

````

`````

:canonical: archivebox.base_models.models.ModelWithOutputDir

Bases: {py:obj}`archivebox.base_models.models.ModelWithUUID`

`````{py:class} Meta
:canonical: archivebox.base_models.models.ModelWithOutputDir.Meta

```{autodoc2-docstring} archivebox.base_models.models.ModelWithOutputDir.Meta
```

````{py:attribute} abstract
:canonical: archivebox.base_models.models.ModelWithOutputDir.Meta.abstract
:value: >
   True

```{autodoc2-docstring} archivebox.base_models.models.ModelWithOutputDir.Meta.abstract
```

````

`````

````{py:method} save(*args, **kwargs)
:canonical: archivebox.base_models.models.ModelWithOutputDir.save

````

````{py:property} output_dir_parent
:canonical: archivebox.base_models.models.ModelWithOutputDir.output_dir_parent
:type: str

```{autodoc2-docstring} archivebox.base_models.models.ModelWithOutputDir.output_dir_parent
```

````

````{py:property} output_dir_name
:canonical: archivebox.base_models.models.ModelWithOutputDir.output_dir_name
:type: str

```{autodoc2-docstring} archivebox.base_models.models.ModelWithOutputDir.output_dir_name
```

````

````{py:property} output_dir_str
:canonical: archivebox.base_models.models.ModelWithOutputDir.output_dir_str
:type: str

```{autodoc2-docstring} archivebox.base_models.models.ModelWithOutputDir.output_dir_str
```

````

````{py:property} output_dir
:canonical: archivebox.base_models.models.ModelWithOutputDir.output_dir
:abstractmethod:
:type: pathlib.Path

```{autodoc2-docstring} archivebox.base_models.models.ModelWithOutputDir.output_dir
```

````