fix typo and some docstrings for localProjectChanges

Author: MarcelGeo

mergin/client_push.py

@@ -22,7 +22,7 @@
 import time
 from typing import List, Tuple, Optional, ByteString
 
-from .local_changes import FileChange, LocalPojectChanges
+from .local_changes import FileChange, LocalProjectChanges
 
 from .common import UPLOAD_CHUNK_ATTEMPT_WAIT, UPLOAD_CHUNK_ATTEMPTS, UPLOAD_CHUNK_SIZE, ClientError, ErrorCode
 from .merginproject import MerginProject
@@ -133,10 +133,10 @@ class UploadJob:
     """Keeps all the important data about a pending upload job"""
 
     def __init__(
-        self, version: str, changes: LocalPojectChanges, transaction_id: Optional[str], mp: MerginProject, mc, tmp_dir
+        self, version: str, changes: LocalProjectChanges, transaction_id: Optional[str], mp: MerginProject, mc, tmp_dir
     ):
         self.version = version
-        self.changes: LocalPojectChanges = changes  # dictionary of local changes to the project
+        self.changes: LocalProjectChanges = changes  # dictionary of local changes to the project
         self.transaction_id = transaction_id  # ID of the transaction assigned by the server
         self.total_size = 0  # size of data to upload (in bytes)
         self.transferred_size = 0  # size of data already uploaded (in bytes)
@@ -179,7 +179,7 @@ def update_chunks_from_items(self):
         Update chunks in LocalChanges from the upload queue items.
         Used just before finalizing the transaction to set the server_chunk_id in v2 API.
         """
-        self.changes.update_chunks([(item.chunk_id, item.server_chunk_id) for item in self.upload_queue_items])
+        self.changes.update_chunk_ids([(item.chunk_id, item.server_chunk_id) for item in self.upload_queue_items])
 
 
 def _do_upload(item: UploadQueueItem, job: UploadJob):
@@ -224,7 +224,7 @@ def create_upload_chunks(mc, mp: MerginProject, local_changes: List[FileChange])
 
 
 def create_upload_job(
-    mc, mp: MerginProject, changes: LocalPojectChanges, tmp_dir: tempfile.TemporaryDirectory
+    mc, mp: MerginProject, changes: LocalProjectChanges, tmp_dir: tempfile.TemporaryDirectory
 ) -> Optional[UploadJob]:
     """
     Prepare transaction and create an upload job for the project using the v1 API.
@@ -317,7 +317,7 @@ def push_project_async(mc, directory) -> Optional[UploadJob]:
         if mp.is_versioned_file(f["path"]):
             mp.copy_versioned_file_for_upload(f, tmp_dir.name)
 
-    local_changes = LocalPojectChanges(
+    local_changes = LocalProjectChanges(
         added=[FileChange(**change) for change in changes["added"]],
         updated=[FileChange(**change) for change in changes["updated"]],
         removed=[FileChange(**change) for change in changes["removed"]],

mergin/local_changes.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 from datetime import datetime
-from typing import Dict, Optional, List, Tuple
+from typing import Optional, List, Tuple
 
 
 @dataclass
@@ -27,6 +27,7 @@ class FileChange:
     chunks: List[str] = field(default_factory=list)
     # optional diff information for geopackage files with geodiff metadata
     diff: Optional[dict] = None
+    # File path to be used for reading a file by creating and uploading file in chunks
     upload_file: Optional[str] = None
     # some functions (MerginProject.compare_file_sets) are adding version to the change from project info
     version: Optional[str] = None
@@ -45,6 +46,7 @@ def get_diff(self) -> Optional[FileDiffChange]:
             )
 
     def to_server_data(self) -> dict:
+        """Convert the FileChange instance to a dictionary format suitable for server payload."""
         result = {
             "path": self.path,
             "checksum": self.checksum,
@@ -61,7 +63,7 @@ def to_server_data(self) -> dict:
 
 
 @dataclass
-class LocalPojectChanges:
+class LocalProjectChanges:
     added: List[FileChange] = field(default_factory=list)
     updated: List[FileChange] = field(default_factory=list)
     removed: List[FileChange] = field(default_factory=list)
@@ -93,7 +95,7 @@ def _map_unique_chunks(self, change_chunks: List[str], server_chunks: List[Tuple
                     seen.add(server_chunk_id)
         return mapped
 
-    def update_chunks(self, server_chunks: List[Tuple[str, str]]) -> None:
+    def update_chunk_ids(self, server_chunks: List[Tuple[str, str]]) -> None:
         """
         Map chunk ids to chunks returned from server (server_chunk_id).
 

mergin/test/test_local_changes.py

@@ -1,10 +1,10 @@
 from datetime import datetime
 
-from ..local_changes import FileChange, LocalPojectChanges
+from ..local_changes import FileChange, LocalProjectChanges
 
 
 def test_local_changes_from_dict():
-    """Test generating LocalChanges from a dictionary."""
+    """Test generating LocalProjectChanges from a dictionary."""
     changes_dict = {
         "added": [{"path": "file1.txt", "checksum": "abc123", "size": 1024, "mtime": datetime.now()}],
         "updated": [{"path": "file2.txt", "checksum": "xyz789", "size": 2048, "mtime": datetime.now()}],
@@ -35,7 +35,7 @@ def test_local_changes_from_dict():
     updated = [FileChange(**file) for file in changes_dict["updated"]]
     removed = [FileChange(**file) for file in changes_dict["removed"]]
 
-    local_changes = LocalPojectChanges(added=added, updated=updated, removed=removed)
+    local_changes = LocalProjectChanges(added=added, updated=updated, removed=removed)
 
     # Assertions
     assert len(local_changes.added) == 1
@@ -72,7 +72,7 @@ def test_local_changes_to_server_payload():
     updated = [FileChange(path="file2.txt", checksum="xyz789", size=2048, mtime=datetime.now())]
     removed = [FileChange(path="file3.txt", checksum="lmn456", size=512, mtime=datetime.now())]
 
-    local_changes = LocalPojectChanges(added=added, updated=updated, removed=removed)
+    local_changes = LocalProjectChanges(added=added, updated=updated, removed=removed)
     server_request = local_changes.to_server_payload()
 
     assert "added" in server_request
@@ -83,33 +83,33 @@ def test_local_changes_to_server_payload():
     assert server_request["removed"][0]["path"] == "file3.txt"
 
 
-def test_local_changes_update_chunks():
+def test_local_changes_update_chunk_ids():
     """Test the update_chunks method of LocalChanges."""
     added = [
         FileChange(path="file1.txt", checksum="abc123", size=1024, mtime=datetime.now(), chunks=["abc123"]),
         FileChange(path="file2.txt", checksum="abc123", size=1024, mtime=datetime.now(), chunks=["abc123"]),
     ]
     updated = [FileChange(path="file2.txt", checksum="xyz789", size=2048, mtime=datetime.now(), chunks=["xyz789"])]
 
-    local_changes = LocalPojectChanges(added=added, updated=updated)
+    local_changes = LocalProjectChanges(added=added, updated=updated)
     chunks = [("abc123", "chunk1"), ("abc123", "chunk1"), ("xyz789", "chunk2")]
 
-    local_changes.update_chunks(chunks)
+    local_changes.update_chunk_ids(chunks)
 
     assert local_changes.added[0].chunks == ["chunk1"]
     assert local_changes.added[1].chunks == ["chunk1"]
     assert local_changes.updated[0].chunks == ["chunk2"]
 
 
 def test_local_changes_get_upload_changes():
-    """Test the get_upload_changes method of LocalChanges."""
+    """Test the get_upload_changes method of LocalProjectChanges."""
     # Create sample LocalChange instances
     added = [FileChange(path="file1.txt", checksum="abc123", size=1024, mtime=datetime.now())]
     updated = [FileChange(path="file2.txt", checksum="xyz789", size=2048, mtime=datetime.now())]
     removed = [FileChange(path="file3.txt", checksum="lmn456", size=512, mtime=datetime.now())]
 
     # Initialize LocalChanges with added, updated, and removed changes
-    local_changes = LocalPojectChanges(added=added, updated=updated, removed=removed)
+    local_changes = LocalProjectChanges(added=added, updated=updated, removed=removed)
 
     # Call get_upload_changes
     upload_changes = local_changes.get_upload_changes()