dulwich.maintenance.MaintenanceTask

class documentation

class MaintenanceTask(ABC):

Known subclasses: dulwich.maintenance.CommitGraphTask, dulwich.maintenance.GcTask, dulwich.maintenance.IncrementalRepackTask, dulwich.maintenance.LooseObjectsTask, dulwich.maintenance.PackRefsTask, dulwich.maintenance.PrefetchTask

Constructor: MaintenanceTask(repo, auto, progress)

View In Hierarchy

Base class for maintenance tasks.

Method	`__init__`	Initialize maintenance task.
Method	`default_enabled`	Return default enabled state for this task.
Method	`is_enabled`	Check if task is enabled in repository configuration.
Method	`run`	Run the maintenance task.
Class Variable	`name`	Undocumented
Instance Variable	`auto`	Undocumented
Instance Variable	`progress`	Undocumented
Instance Variable	`repo`	Undocumented

def __init__(self, repo: BaseRepo, auto: bool = False, progress: Callable[[str], None] | None = None): ¶

Initialize maintenance task.

Parameters
repo:`BaseRepo`	Repository object
auto:`bool`	If True, only run if needed
progress:`Callable[[str], None] \| None`	Optional progress callback

def default_enabled(self) -> bool: ¶

overridden in dulwich.maintenance.CommitGraphTask, dulwich.maintenance.GcTask

Return default enabled state for this task.

Returns
`bool`	True if task should be enabled by default

def is_enabled(self) -> bool: ¶

Check if task is enabled in repository configuration.

Returns
`bool`	True if task is enabled

@abstractmethod

def run(self) -> bool: ¶

overridden in dulwich.maintenance.CommitGraphTask, dulwich.maintenance.GcTask, dulwich.maintenance.IncrementalRepackTask, dulwich.maintenance.LooseObjectsTask, dulwich.maintenance.PackRefsTask, dulwich.maintenance.PrefetchTask

Run the maintenance task.

Returns
`bool`	True if successful, False otherwise

name: str = ¶

Undocumented

auto = ¶

Undocumented

progress = ¶

Undocumented

repo = ¶

Undocumented