vcspull status - vcspull.cli.status

Repository status checking functionality for vcspull.

class vcspull.cli.status.StatusCheckConfig

class

class

class vcspull.cli.status.StatusCheckConfig

Bases: object

Configuration options for status checking.

max_concurrent: int

attribute

attribute

max_concurrent: int

detailed: bool

attribute

attribute

detailed: bool

__init__(max_concurrent, detailed)

method

method

__init__(max_concurrent, detailed)

Parameters:

• max_concurrent (int)

• detailed (bool)

Return type:

None

vcspull.cli.status._visible_length(text)

function

function

vcspull.cli.status._visible_length(text)

Return the printable length of string stripped of ANSI codes.

Parameters:

text (str)

Return type:

int

class vcspull.cli.status.StatusProgressPrinter

class

class

class vcspull.cli.status.StatusProgressPrinter

Bases: object

Render incremental status check progress for TTY output.

__init__(total, colors, enabled)

method

method

__init__(total, colors, enabled)

Initialize the progress printer.

Parameters:

• total (int) – Total number of repositories to check

• colors (Colors) – Color formatter instance

• enabled (bool) – Whether progress output is enabled

Return type:

None

update(processed, exists, missing)

method

method

update(processed, exists, missing)

Update the progress line with the latest counts.

Parameters:

• processed (int) – Number of repositories processed so far

• exists (int) – Number of repositories that exist

• missing (int) – Number of repositories that are missing

Return type:

None

finish()

method

method

finish()

Ensure the progress line is terminated with a newline.

Return type:

None

vcspull.cli.status.create_status_subparser(parser)

function

function

vcspull.cli.status.create_status_subparser(parser)

Create vcspull status argument subparser.

Parameters:

parser (argparse.ArgumentParser) – The parser to configure

Return type:

None

async vcspull.cli.status._check_repos_status_async(repos, *, config, progress)

async function

async function

async vcspull.cli.status._check_repos_status_async(repos, *, config, progress)

Check repository status concurrently using asyncio.

Parameters:

• repos (list[ConfigDict]) – List of repository configurations to check

• config (StatusCheckConfig) – Configuration for status checking

• progress (StatusProgressPrinter | None) – Optional progress printer for live updates

Returns:

List of status dictionaries in completion order

Return type:

list[dict[str, t.Any]]

vcspull.cli.status._run_git_command(repo_path, *args)

function

function

vcspull.cli.status._run_git_command(repo_path, *args)

Execute a git command and return the completed process.

Parameters:

• repo_path (Path)

• args (str)

Return type:

CompletedProcess[str] | None

vcspull.cli.status.check_repo_status(repo, detailed=False)

function

function

vcspull.cli.status.check_repo_status(repo, detailed=False)

Check the status of a single repository.

Parameters:

• repo (ConfigDict) – Repository configuration

• detailed (bool) – Whether to include detailed status information

Returns:

Repository status information

Return type:

dict

vcspull.cli.status.status_repos(repo_patterns, config_path, workspace_root, detailed, output_json, output_ndjson, color, concurrent=True, max_concurrent=None)

function

function

vcspull.cli.status.status_repos(repo_patterns, config_path, workspace_root, detailed, output_json, output_ndjson, color, concurrent=True, max_concurrent=None)

Check status of configured repositories.

Parameters:

• repo_patterns (list[str]) – Patterns to filter repositories (fnmatch)

• config_path (pathlib.Path | None) – Path to config file, or None to auto-discover

• workspace_root (str | None) – Filter by workspace root

• detailed (bool) – Show detailed status information

• output_json (bool) – Output as JSON

• output_ndjson (bool) – Output as NDJSON

• color (str) – Color mode (auto, always, never)

• concurrent (bool) – Whether to check repositories concurrently (default: True)

• max_concurrent (int | None) – Maximum concurrent status checks (default: based on CPU count)

Return type:

None

vcspull.cli.status._format_status_line(status, formatter, colors, detailed)

function

function

vcspull.cli.status._format_status_line(status, formatter, colors, detailed)

Format a single repository status line for human output.

Parameters:

• status (dict) – Repository status information

• formatter (OutputFormatter) – Output formatter

• colors (Colors) – Color manager

• detailed (bool) – Whether to show detailed information

Return type:

None