mirrors/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2025-05-13 06:34:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

better docstrings and comments

Browse source
This commit is contained in:
Nick Sweeting 2024-11-15 23:21:34 -08:00
parent 6448968952
commit ed43f1d027
No known key found for this signature in database
4 changed files with 36 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

3
archivebox/actors/actor.py
View file

@ -32,7 +32,7 @@ class ActorQueueIsEmpty(Exception):
CPU_COUNT = cpu_count() CPU_COUNT = cpu_count()
DEFAULT_MAX_TICK_TIME = 60 DEFAULT_MAX_TICK_TIME = 60
DEFAULT_MAX_CONCURRENT_ACTORS = min(max(2, int(CPU_COUNT * 0.6)), 8) # 2 < 60% * num available cpu cores < 8 DEFAULT_MAX_CONCURRENT_ACTORS = min(max(2, int(CPU_COUNT * 0.6)), 8) # 2 < (60% * num available cpu cores) < 8
limit = lambda n, max: min(n, max) limit = lambda n, max: min(n, max)
@ -569,3 +569,4 @@ def compile_sql_update(queryset: QuerySet, update_kwargs: dict[str, Any], filter
# e.g. UPDATE core_archiveresult SET status='%s', retry_at='%s' WHERE status NOT IN (%s, %s, %s) AND retry_at <= %s # e.g. UPDATE core_archiveresult SET status='%s', retry_at='%s' WHERE status NOT IN (%s, %s, %s) AND retry_at <= %s
update_sql, update_params = query.get_compiler(queryset.db).as_sql() update_sql, update_params = query.get_compiler(queryset.db).as_sql()
return update_sql, update_params return update_sql, update_params

20
archivebox/core/actors.py
View file

@ -10,12 +10,16 @@ from actors.actor import ActorType
class SnapshotActor(ActorType[Snapshot]): class SnapshotActor(ActorType[Snapshot]):
"""
The primary actor for progressing Snapshot objects
through their lifecycle using the SnapshotMachine.
"""
Model = Snapshot Model = Snapshot
StateMachineClass = SnapshotMachine StateMachineClass = SnapshotMachine
ACTIVE_STATE: ClassVar[State] = SnapshotMachine.started ACTIVE_STATE: ClassVar[State] = SnapshotMachine.started # 'started'
FINAL_STATES: ClassVar[list[State]] = SnapshotMachine.final_states FINAL_STATES: ClassVar[list[State]] = SnapshotMachine.final_states # ['sealed']
STATE_FIELD_NAME: ClassVar[str] = SnapshotMachine.state_field_name STATE_FIELD_NAME: ClassVar[str] = SnapshotMachine.state_field_name # status
MAX_CONCURRENT_ACTORS: ClassVar[int] = 3 MAX_CONCURRENT_ACTORS: ClassVar[int] = 3
MAX_TICK_TIME: ClassVar[int] = 10 MAX_TICK_TIME: ClassVar[int] = 10
@ -24,12 +28,16 @@ class SnapshotActor(ActorType[Snapshot]):
class ArchiveResultActor(ActorType[ArchiveResult]): class ArchiveResultActor(ActorType[ArchiveResult]):
"""
The primary actor for progressing ArchiveResult objects
through their lifecycle using the ArchiveResultMachine.
"""
Model = ArchiveResult Model = ArchiveResult
StateMachineClass = ArchiveResultMachine StateMachineClass = ArchiveResultMachine
ACTIVE_STATE: ClassVar[State] = ArchiveResultMachine.started ACTIVE_STATE: ClassVar[State] = ArchiveResultMachine.started # 'started'
FINAL_STATES: ClassVar[list[State]] = ArchiveResultMachine.final_states FINAL_STATES: ClassVar[list[State]] = ArchiveResultMachine.final_states # ['succeeded', 'failed', 'skipped']
STATE_FIELD_NAME: ClassVar[str] = ArchiveResultMachine.state_field_name STATE_FIELD_NAME: ClassVar[str] = ArchiveResultMachine.state_field_name # status
MAX_CONCURRENT_ACTORS: ClassVar[int] = 6 MAX_CONCURRENT_ACTORS: ClassVar[int] = 6
MAX_TICK_TIME: ClassVar[int] = 60 MAX_TICK_TIME: ClassVar[int] = 60

13
archivebox/core/statemachines.py
View file

@ -11,7 +11,11 @@ from core.models import Snapshot, ArchiveResult
class SnapshotMachine(StateMachine, strict_states=True): class SnapshotMachine(StateMachine, strict_states=True):
"""State machine for managing Snapshot lifecycle.""" """
State machine for managing Snapshot lifecycle.
https://github.com/ArchiveBox/ArchiveBox/wiki/ArchiveBox-Architecture-Diagrams
"""
model: Snapshot model: Snapshot
@ -47,8 +51,13 @@ class SnapshotMachine(StateMachine, strict_states=True):
self.snapshot.retry_at = None self.snapshot.retry_at = None
self.snapshot.save() self.snapshot.save()
class ArchiveResultMachine(StateMachine, strict_states=True): class ArchiveResultMachine(StateMachine, strict_states=True):
"""State machine for managing ArchiveResult lifecycle.""" """
State machine for managing ArchiveResult lifecycle.
https://github.com/ArchiveBox/ArchiveBox/wiki/ArchiveBox-Architecture-Diagrams
"""
model: ArchiveResult model: ArchiveResult

18
archivebox/pkgs/abx-plugin-singlefile/abx_plugin_singlefile/models.py
View file

@ -1,14 +1,14 @@
from django.db import models # from django.db import models
from core.models import ArchiveResult # from core.models import ArchiveResult
class SinglefileResultManager(models.Manager): # class SinglefileResultManager(models.Manager):
def get_queryset(self): # def get_queryset(self):
return super().get_queryset().filter(extractor='singlefile') # return super().get_queryset().filter(extractor='singlefile')
class SinglefileResult(ArchiveResult): # class SinglefileResult(ArchiveResult):
objects = SinglefileResultManager() # objects = SinglefileResultManager()
class Meta: # class Meta:
proxy = True # proxy = True