Put changes dicts back

Author: harminius

mergin/client_push.py

@@ -15,7 +15,7 @@
 import tempfile
 import concurrent.futures
 import os
-from typing import Dict, List
+from typing import Dict, List, Optional
 
 from .common import UPLOAD_CHUNK_SIZE, ClientError
 from .merginproject import MerginProject
@@ -139,7 +139,7 @@ def split_by_type(self) -> List[Dict[str, List[dict]]]:
         return result
 
 
-def push_project_async(mc, directory) -> List[UploadJob]:
+def push_project_async(mc, directory) -> Optional[List[UploadJob]]:
     """Starts push of a project and returns pending upload jobs"""
 
     mp = MerginProject(directory)
@@ -164,8 +164,8 @@ def push_project_async(mc, directory) -> List[UploadJob]:
 
     username = mc.username()
     # permissions field contains information about update, delete and upload privileges of the user
-    # on a specific project. This is more accurate information then "writernames" field, as it takes
-    # into account namespace privileges. So we have to check only "permissions", namely "upload" one
+    # on a specific project. This is more accurate information than "writernames" field, as it takes
+    # into account namespace privileges. So we have to check only "permissions", namely "upload" once
     if not mc.has_writing_permissions(project_path):
         mp.log.error(f"--- push {project_path} - username {username} does not have write access")
         raise ClientError(f"You do not seem to have write access to the project (username '{username}')")
@@ -180,12 +180,12 @@ def push_project_async(mc, directory) -> List[UploadJob]:
     changes_handler = UploadChangesHandler(mp, mc, project_info)
     changes_groups = changes_handler.split_by_type()
 
+    tmp_dir = tempfile.TemporaryDirectory(prefix="python-api-client-")
     jobs = []
+
     for changes in changes_groups:
         mp.log.debug("push changes:\n" + pprint.pformat(changes))
 
-        tmp_dir = tempfile.TemporaryDirectory(prefix="python-api-client-")
-
         # If there are any versioned files (aka .gpkg) that are not updated through a diff,
         # we need to make a temporary copy somewhere to be sure that we are uploading full content.
         # That's because if there are pending transactions, checkpointing or switching from WAL mode

mergin/editor.py

@@ -1,8 +1,7 @@
 from itertools import filterfalse
 from typing import Callable, Dict, List
 
-from .client_push import UploadChanges
-from .utils import is_mergin_config, is_qgis_file, is_versioned_file
+from .utils import is_qgis_file
 
 EDITOR_ROLE_NAME = "editor"
 
@@ -37,7 +36,7 @@ def _apply_editor_filters(changes: Dict[str, List[dict]]) -> Dict[str, List[dict
     """
     updated = changes.get("updated", [])
 
-    changes.updated = list(filterfalse(_disallowed_changes, updated))
+    changes["updated"] = list(filterfalse(_disallowed_changes, updated))
     return changes
 
 

mergin/merginproject.py

@@ -7,9 +7,9 @@
 import uuid
 import tempfile
 from datetime import datetime
+from typing import List, Dict
 from dateutil.tz import tzlocal
 
-from .client_push import UploadChanges
 from .editor import prevent_conflicted_copy
 
 from .common import UPLOAD_CHUNK_SIZE, InvalidProject, ClientError
@@ -315,13 +315,20 @@ def inspect_files(self):
                 )
         return files_meta
 
-    def compare_file_sets(self, origin, current) -> UploadChanges:
-        """
-        Calculate difference between two sets of file metadata using file names and checksums.
-
-        :param origin: List of original file metadata
-        :param current: List of current file metadata
-        :return: UploadChanges instance with added, updated, removed
+    def compare_file_sets(self, origin, current) -> Dict[str, List[dict]]:
+        """
+        Calculate difference between two sets of files metadata using file names and checksums.
+        :Example:
+        >>> origin = [{'checksum': '08b0e8caddafe74bf5c11a45f65cedf974210fed', 'path': 'base.gpkg', 'size': 2793, 'mtime': '2019-08-26T11:08:34.051221+02:00'}]
+        >>> current = [{'checksum': 'c9a4fd2afd513a97aba19d450396a4c9df8b2ba4', 'path': 'test.qgs', 'size': 31980, 'mtime': '2019-08-26T11:09:30.051221+02:00'}]
+        >>> self.compare_file_sets(origin, current)
+        {"added": [{'checksum': 'c9a4fd2afd513a97aba19d450396a4c9df8b2ba4', 'path': 'test.qgs', 'size': 31980, 'mtime': '2019-08-26T11:09:30.051221+02:00'}], "removed": [[{'checksum': '08b0e8caddafe74bf5c11a45f65cedf974210fed', 'path': 'base.gpkg', 'size': 2793, 'mtime': '2019-08-26T11:08:34.051221+02:00'}]], "renamed": [], "updated": []}
+        :param origin: origin set of files metadata
+        :type origin: list[dict]
+        :param current: current set of files metadata to be compared against origin
+        :type current: list[dict]
+        :returns: changes between two sets with change type
+        :rtype: dict[str, list[dict]]'
         """
         origin_map = {f["path"]: f for f in origin}
         current_map = {f["path"]: f for f in current}
@@ -338,12 +345,7 @@ def compare_file_sets(self, origin, current) -> UploadChanges:
             f["origin_checksum"] = origin_map[path]["checksum"]
             updated.append(f)
 
-        return UploadChanges(
-            added=added,
-            updated=updated,
-            removed=removed,
-        )
-
+        return {"renamed": [], "added": added, "removed": removed, "updated": updated}
 
     def get_pull_changes(self, server_files):
         """
@@ -401,7 +403,7 @@ def get_pull_changes(self, server_files):
         changes["updated"] = [f for f in changes["updated"] if f not in not_updated]
         return changes
 
-    def get_push_changes(self) -> UploadChanges:
+    def get_push_changes(self) -> Dict[str, List[dict]]:
         """
         Calculate changes needed to be pushed to server.
 
@@ -425,7 +427,7 @@ def get_push_changes(self) -> UploadChanges:
 
         # need to check for real changes in geodiff files using geodiff tool (comparing checksum is not enough)
         not_updated = []
-        for file in changes.updated:
+        for file in changes["updated"]:
             path = file["path"]
             if not self.is_versioned_file(path):
                 continue
@@ -459,7 +461,7 @@ def get_push_changes(self) -> UploadChanges:
                 # we will need to do full upload of the file
                 pass
 
-        changes.updated = [f for f in changes.updated if f not in not_updated]
+        changes["updated"] = [f for f in changes["updated"] if f not in not_updated]
         return changes
 
     def copy_versioned_file_for_upload(self, f, tmp_dir):