asc/benchcoach-django
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cleanup and added comments

Browse Source
This commit is contained in:
Anthony Correa
2022-01-03 12:12:37 -06:00
parent f6ecc934a4
commit b14c66ba0f
12 changed files with 154 additions and 683 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
benchcoach/utils/sync_engine.py
View File

@@ -3,25 +3,30 @@ from abc import ABC, abstractmethod
import django.db.models
from django.db.models import QuerySet
from typing import List, Tuple
import benchcoach.models
class AbstractSyncEngine(ABC):
models: List[django.db.models.Model]
'''
Class used for importing and syncing Bench Coach models.
'''
models: List[benchcoach.models.BenchcoachModel]
@abstractmethod
def sync(self, qs: django.db.models.QuerySet = None, instance: django.db.models.Model = None, direction='download') -> List[Tuple[django.db.models.Model, bool]]:
def sync(self, qs: django.db.models.QuerySet = None, instance: benchcoach.models.BenchcoachModel = None, direction='download') -> List[Tuple[django.db.models.Model, bool]]:
'''
Syncs the input from/to the service. Either a query set or instance should be provided, but not both.
:param qs: the queryset to be updated. If set to 'download', it will be updated from the service, if set to uplad, its contents
will be sent to the server
:param instance: the instance to be updated. If set to 'download', it will be updated from the service, if set to uplad, its contents
will be sent to the server.
:param direction: the sync direction, either 'download' or 'upload'.
:return: a list of tuples in the form of (created/updated object, true if created/false if not)
It does not create Bench Coach objects.
:param qs: the queryset to be updated.
:param instance: the instance to be updated.
:param direction: the sync direction, either 'download' or 'upload'. If set to 'download', it will be updated from the service, if set to upload, its contents
will be sent to the service
:return: a list of BenchCoach objects that have been iterated (but not necessarily changed) during sync.
'''
@abstractmethod
def import_items(self):
'''
Imports the items from the service.
:return: a list of tuples in the form of (created/updated object, true if created/false if not)
Imports the items from the service. It imports all models specified in the class property 'model'.
It creates BenchCoach objects, but should not create duplicates.
:return: a list of BenchCoach objects that have been iterated (but not necessarily changed) during import.
'''