MerginMaps / MerginMaps/geodiff

Optionally provide a callback in apply_changeset

Open
#175 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
183
Forks
21
Avg merge
9d 11h
Merged PRs (30d)
2

Description

Sometimes it is useful to be able to provide a callback function when applying changes - especially if the input diff file contains many changes. The callback could do things like

  • report progress of the operation to the user
  • allow early cancellation if the client is impatient
  • on server side, yield to indicate that the worker is doing work (did not freeze and should not get killed)

The callback could be something like this:

bool callback(geodiff_context, caller_context, progress);

... and apply_changeset would call it every now and then (not necessarily after each statement it applies).

Should be also supported in python API.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing apply_changeset and how the Python API exposes it. Define the callback behavior around progress, cancellation, and periodic invocation, then verify that the callback is supported in both the main API and Python API without requiring a call after every statement.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.