Initial version of v2 pull integration + project info v2 by MarcelGeo · Pull Request #282 · MerginMaps/python-api-client

MarcelGeo · 2025-12-08T12:06:54Z

Resolved #280

new pull mechanism using /delta endpoint, where pull changes between current version and server are calculated from delta items

tests for both v2 and v1 features
projectinfo v2 compatibility test

Fixes

handle conflicting copy of versioned files properly without rebase logic

Pull logic updates

in pull_project_async is check if server supports v2_pull
If supports: get pull delta from server
If not: calculate pull delta from files and projects config.json
Then calculate delta items between local files and server (local delta) - delta needs to be applied to server
Compare pull_delta and local_delta -> PullAction with actions needs to be done after files are downloaded from a server defined in PullActionType enum
Starting download
After download is finished -> call pull_project_finalize
Method apply_pull_actions is then responsible to finalize PullAction based on type

+ tests for both v2 and v1 features + projectinfo v2 compatibility test

wonder-sk

let's first do a bit of refactoring... the idea is that:

we introduce a new class that captures project delta (added/updated/updated_diff/deleted) files
the project delta class would be returned by get_pull_changes and get_push_changes
there would a function that can combine server changes (from get_pull_changes) and local changes (from get_push_changes) and return a list of tasks to do at the end of the pull (e.g. copy, copy conflict, apply diff, delete - like PullTask in mobile app's merginapi)
apply_pull_changes() would just go through the list of "pull tasks" and apply them, rather than again getting local changes and doing logic based on that

mergin/client.py

mergin/client_pull.py

- models.py for some classes without specific location - clenup of non-necssary functions from previous version - refactor of pull handling using PullActions

+ descriptions + tests for appl_pull_actions + restore get_pull_changes for backward compatibility with project status

mergin/client.py

mergin/client_pull.py

varmar05 · 2026-01-08T07:07:35Z

mergin/client_pull.py

+        self.size_check = size_check  # whether we want to do merged file size check
+
+    def merge(self):
+        with open(self.dest_file, "wb") as final:


don't we need to create intermediate dirs?

it was done before. I updated this to create also directory.

varmar05 · 2026-01-08T07:09:48Z

mergin/client_pull.py

+        resp = mc.get(
+            f"/v2/projects/{mp.project_id()}/raw/diff/{self.file_path}",
+        )
+        if resp.status in [200, 206]:


Do we always download diff in single request? If so, let's state it explicitly somewhere.

added comments ⬇️

mergin/client_pull.py

varmar05 · 2026-01-08T07:35:53Z

mergin/merginproject.py

+            (DeltaChangeType.UPDATE_DIFF, DeltaChangeType.UPDATE): PullActionType.COPY_CONFLICT,
+            (DeltaChangeType.UPDATE_DIFF, DeltaChangeType.DELETE): PullActionType.COPY,
+            (DeltaChangeType.UPDATE_DIFF, DeltaChangeType.UPDATE_DIFF): PullActionType.APPLY_DIFF,  # rebase
+            (DeltaChangeType.DELETE, None): PullActionType.DELETE,


why pull action type delete here and not also for other use cases?

not sure what you mean here. better to discuss @varmar05

mergin/merginproject.py

…nitial

coveralls · 2026-01-19T16:15:55Z

Pull Request Test Coverage Report for Build 21143761159

Details

605 of 704 (85.94%) changed or added relevant lines in 8 files are covered.
18 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.3%) to 82.059%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
mergin/test/test_mergin_project.py	181	182	99.45%
mergin/merginproject.py	121	123	98.37%
mergin/client.py	14	23	60.87%
mergin/test/test_client.py	60	78	76.92%
mergin/test/test_client_pull.py	19	46	41.3%
mergin/client_pull.py	140	182	76.92%

Files with Coverage Reduction	New Missed Lines	%
mergin/client_pull.py	2	79.39%
mergin/merginproject.py	16	89.21%

Totals
Change from base Build 21135933534:	-0.3%
Covered Lines:	4638
Relevant Lines:	5652

💛 - Coveralls

mergin/client.py

Copilot

Pull request overview

Implements the initial v2 pull integration using the /delta endpoint (with a v1 fallback), and adds v2 project info support plus related integration/unit tests.

Changes:

Add v2 pull flow in pull_project_async based on server feature flag (v2_pull_enabled) and project delta items.
Introduce typed models for delta items, pull actions, and v2 project info responses.
Expand test coverage for pull actions/delta calculation and project info v2 compatibility.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
`mergin/client_pull.py`	Refactors pull pipeline around `ProjectDelta` + `PullAction`, adds v2 diff download path.
`mergin/client.py`	Adds `project_info_v2()` and `get_project_delta()` API wrappers and a server-version capability check.
`mergin/merginproject.py`	Adds delta/local-delta computation and applies pull via action-based execution.
`mergin/models.py`	Adds dataclasses for delta items, pull actions, and v2 project info response typing.
`mergin/common.py`	Adds enums for delta change and pull action types.
`mergin/test/test_client.py`	Updates/extends integration tests for v2 pull and v2 project info.
`mergin/test/test_mergin_project.py`	Adds unit tests for pull-action selection, delta calculation, local delta, and applying actions.
`mergin/test/test_client_pull.py`	Adds unit tests for download item creation helpers.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mergin/merginproject.py

mergin/common.py

mergin/client_pull.py

mergin/client.py

mergin/test/test_client_pull.py

mergin/test/test_mergin_project.py

mergin/test/test_client.py

mergin/merginproject.py

mergin/models.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

- unify get_pull_changes with get_pull_delta - add pull action with rebase and no_rebase - simplify PullAction class

Initial dirty version of v2 pull integration + porject info v2

2220abc

+ tests for both v2 and v1 features + projectinfo v2 compatibility test

MarcelGeo changed the base branch from master to v2-pull-integration December 8, 2025 12:07

MarcelGeo changed the title ~~Initial dirty version of v2 pull integration + porject info v2~~ Initial version of v2 pull integration + project info v2 Dec 8, 2025

wonder-sk reviewed Dec 8, 2025

View reviewed changes

MarcelGeo added 7 commits December 9, 2025 08:58

Separate diff files from merge files + comments @wonder-sk

001c83d

Introduce:

68b84c1

- models.py for some classes without specific location - clenup of non-necssary functions from previous version - refactor of pull handling using PullActions

Added return types fo new functions

ae3e55c

+ descriptions + tests for appl_pull_actions + restore get_pull_changes for backward compatibility with project status

Fix test test_mergin_project

55d9e5a

add optional download_path for pattern with diff files

db7be6c

solve base file missing

8e3f2ec

Handle unfinished pull

9552372

MarcelGeo requested review from varmar05 and wonder-sk December 18, 2025 17:11

varmar05 reviewed Jan 8, 2026

View reviewed changes

MarcelGeo added 9 commits January 16, 2026 16:25

comments @varmar05

fc90173

fix files to merge renamig

411d3e1

fix download base files + import

5e2eccc

fix for is_gpgkg_open results

5891088

update tests for cases where geopackage is modified

9a18374

Black 26.1.0 upgrades

9c82771

Merge remote-tracking branch 'origin/v2-pull-integration' into pull-i…

7a144b1

…nitial

fixed imports after merge

ec500a5

pull actions tests

7fb335f

MarcelGeo requested a review from Copilot February 11, 2026 09:18

Copilot started reviewing on behalf of MarcelGeo February 11, 2026 09:18 View session

MarcelGeo commented Feb 11, 2026

View reviewed changes

mergin/client.py Outdated Show resolved Hide resolved

MarcelGeo commented Feb 11, 2026

View reviewed changes

mergin/client.py Outdated Show resolved Hide resolved

Copilot AI reviewed Feb 11, 2026

View reviewed changes

MarcelGeo commented Feb 11, 2026

View reviewed changes

mergin/merginproject.py Outdated Show resolved Hide resolved

MarcelGeo commented Feb 11, 2026

View reviewed changes

mergin/models.py Outdated Show resolved Hide resolved

MarcelGeo and others added 9 commits February 12, 2026 14:36

First comments resolving from a reviews

93995ec

Update mergin/test/test_client_pull.py

3a1f47f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update mergin/common.py

be1ffed

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update mergin/merginproject.py

337757f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestions from code review

d1585fb

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Address comments @wonder-sk

c3dd5ec

- unify get_pull_changes with get_pull_delta - add pull action with rebase and no_rebase - simplify PullAction class

Fix arguments of pull changes

f6aea66

Fix rest of tests

e4afd04

Fix renamed missing key

a41258a

Conversation

MarcelGeo commented Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wonder-sk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

varmar05 Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

MarcelGeo Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

varmar05 Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

MarcelGeo Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

varmar05 Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

MarcelGeo Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coveralls commented Jan 19, 2026

Pull Request Test Coverage Report for Build 21143761159

Details

💛 - Coveralls

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

MarcelGeo commented Dec 8, 2025 •

edited

Loading