vcspull sync - vcspull.cli.sync

Synchronization functionality for vcspull.

class vcspull.cli.sync.SyncPlanConfig

class

Bases: object

Configuration options for building sync plans.

fetch: bool

attribute

offline: bool

attribute

__init__(fetch, offline)

method

Parameters:

• fetch (bool)

• offline (bool)

Return type:

None

vcspull.cli.sync._visible_length(text)

function

Return the printable length of string stripped of ANSI codes.

Parameters:

text (str)

Return type:

int

class vcspull.cli.sync.PlanProgressPrinter

class

Bases: object

Render incremental plan progress for human-readable dry runs.

__init__(total, colors, enabled)

method

Parameters:

• total (int)

• colors (Colors)

• enabled (bool)

Return type:

None

update(summary, processed)

method

Update the progress line with the latest summary counts.

Parameters:

• summary (PlanSummary)

• processed (int)

Return type:

None

finish()

method

Ensure the progress line is terminated with a newline.

Return type:

None

vcspull.cli.sync._extract_repo_url(repo)

function

Extract the primary repository URL from a config dictionary.

Parameters:

repo (ConfigDict)

Return type:

str | None

vcspull.cli.sync._get_repo_path(repo)

function

Return the resolved filesystem path for a repository entry.

Parameters:

repo (ConfigDict)

Return type:

Path

vcspull.cli.sync.clamp(n, _min, _max)

function

Clamp a number between a min and max value.

Parameters:

• n (int)

• _min (int)

• _max (int)

Return type:

int

vcspull.cli.sync._maybe_fetch(repo_path, *, config)

function

Optionally fetch remote refs to provide accurate status.

Parameters:

• repo_path (Path)

• config (SyncPlanConfig)

Return type:

tuple[bool, str | None]

vcspull.cli.sync._determine_plan_action(status, *, config)

function

Decide which plan action applies to a repository.

Parameters:

• status (dict[str, Any])

• config (SyncPlanConfig)

Return type:

tuple[PlanAction, str | None]

vcspull.cli.sync._update_summary(summary, action)

function

Update summary counters for the given plan action.

Parameters:

• summary (PlanSummary)

• action (PlanAction)

Return type:

None

vcspull.cli.sync._build_plan_entry(repo, *, config)

function

Construct a plan entry for a repository configuration.

Parameters:

• repo (ConfigDict)

• config (SyncPlanConfig)

Return type:

PlanEntry

async vcspull.cli.sync._build_plan_result_async(repos, *, config, progress)

async function

Build a plan asynchronously while updating progress output.

Parameters:

• repos (list[ConfigDict])

• config (SyncPlanConfig)

• progress (PlanProgressPrinter | None)

Return type:

PlanResult

vcspull.cli.sync._filter_entries_for_display(entries, *, show_unchanged)

function

Filter entries based on whether unchanged repos should be rendered.

Parameters:

• entries (list[PlanEntry])

• show_unchanged (bool)

Return type:

list[PlanEntry]

vcspull.cli.sync._format_detail_text(entry, *, colors, include_extras)

function

Generate the detail text for a plan entry.

Parameters:

• entry (PlanEntry)

• colors (Colors)

• include_extras (bool)

Return type:

str

vcspull.cli.sync._render_plan(formatter, colors, plan, render_options, *, dry_run, total_repos)

function

Render the plan in human-readable format.

Parameters:

• formatter (OutputFormatter)

• colors (Colors)

• plan (PlanResult)

• render_options (PlanRenderOptions)

• dry_run (bool)

• total_repos (int)

Return type:

None

vcspull.cli.sync._emit_plan_output(formatter, colors, plan, render_options, *, dry_run, total_repos)

function

Emit plan output for the requested format.

Parameters:

• formatter (OutputFormatter)

• colors (Colors)

• plan (PlanResult)

• render_options (PlanRenderOptions)

• dry_run (bool)

• total_repos (int)

Return type:

None

vcspull.cli.sync.create_sync_subparser(parser)

function

Create vcspull sync argument subparser.

Parameters:

parser (ArgumentParser)

Return type:

ArgumentParser

vcspull.cli.sync.sync(repo_patterns, config, workspace_root, dry_run, output_json, output_ndjson, color, exit_on_error, show_unchanged, summary_only, long_view, relative_paths, fetch, offline, verbosity, sync_all=False, parser=None, include_worktrees=False)

function

Entry point for vcspull sync.

Parameters:

• repo_patterns (list[str])

• config (Path | None)

• workspace_root (str | None)

• dry_run (bool)

• output_json (bool)

• output_ndjson (bool)

• color (str)

• exit_on_error (bool)

• show_unchanged (bool)

• summary_only (bool)

• long_view (bool)

• relative_paths (bool)

• fetch (bool)

• offline (bool)

• verbosity (int)

• sync_all (bool)

• parser (ArgumentParser | None)

• include_worktrees (bool)

Return type:

None

vcspull.cli.sync._emit_summary(formatter, colors, summary)

function

Emit the structured summary event and optional human-readable text.

Parameters:

• formatter (OutputFormatter)

• colors (Colors)

• summary (dict[str, int])

Return type:

None

vcspull.cli.sync.progress_cb(output, timestamp)

function

CLI Progress callback for command.

Parameters:

• output (str)

• timestamp (datetime)

Return type:

None

vcspull.cli.sync.guess_vcs(url)

function

Guess the VCS from a URL.

Parameters:

url (str)

Return type:

VCSLiteral | None

exception vcspull.cli.sync.CouldNotGuessVCSFromURL

exception

Bases: VCSPullException

Raised when no VCS could be guessed from a URL.

__init__(repo_url, *args, **kwargs)

method

Parameters:

• repo_url (str)

• args (object)

• kwargs (object)

Return type:

None

exception vcspull.cli.sync.SyncFailedError

exception

Bases: VCSPullException

Raised when a sync operation completes but with errors.

__init__(repo_name, errors, *args, **kwargs)

method

Parameters:

• repo_name (str)

• errors (str)

• args (object)

• kwargs (object)

Return type:

None

vcspull.cli.sync.update_repo(repo_dict, progress_callback=None)

function

Synchronize a single repository.

Parameters:

• repo_dict (Any)

• progress_callback (ProgressCallback | None)

Return type:

GitSync | HgSync | SvnSync