Mirrors/ArchiveBox
2
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox synced 2024-11-10 06:34:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

add docstrings

Browse source
This commit is contained in:
Nick Sweeting 2024-05-14 18:46:38 -07:00
parent 406f57031a
commit fdf6f465db
No known key found for this signature in database
2 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
archivebox/abid_utils/models.py
View file

@ -1,3 +1,9 @@
"""
This file provides the Django ABIDField and ABIDModel base model to inherit from.
It implements the ArchiveBox ID (ABID) interfaces including abid_values, get_abid, .abid, .uuid, .id.
"""
from typing import Any, Dict, Union, List, Set, NamedTuple, cast
from ulid import ULID
@ -54,6 +60,9 @@ def get_or_create_system_user_pk(username='system'):
class ABIDModel(models.Model):
"""
Abstract Base Model for other models to depend on. Provides ArchiveBox ID (ABID) interface.
"""
abid_prefix: str = DEFAULT_ABID_PREFIX # e.g. 'tag_'
abid_ts_src = 'None' # e.g. 'self.created'
abid_uri_src = 'None' # e.g. 'self.uri'

2
archivebox/core/models.py
View file

@ -50,7 +50,7 @@ STATUS_CHOICES = [
class Tag(ABIDModel):
"""
Based on django-taggit model
Based on django-taggit model + ABID base.
"""
abid_prefix = 'tag_'
abid_ts_src = 'self.created' # TODO: add created/modified time