dulwich.object_filters.FilterSpec

class documentation

class FilterSpec(ABC):

Known subclasses: dulwich.object_filters.BlobLimitFilter, dulwich.object_filters.BlobNoneFilter, dulwich.object_filters.CombineFilter, dulwich.object_filters.SparseOidFilter, dulwich.object_filters.TreeDepthFilter

View In Hierarchy

Base class for all filter specifications.

Method	`should_include_blob`	Determine if a blob of given size should be included.
Method	`should_include_tree`	Determine if a tree at given depth should be included.
Method	`to_spec_string`	Convert filter spec back to string format.

@abstractmethod

def should_include_blob(self, blob_size: int) -> bool: ¶

overridden in dulwich.object_filters.BlobLimitFilter, dulwich.object_filters.BlobNoneFilter, dulwich.object_filters.CombineFilter, dulwich.object_filters.SparseOidFilter, dulwich.object_filters.TreeDepthFilter

Determine if a blob of given size should be included.

Parameters
blob_size:`int`	Size of the blob in bytes

Returns
`bool`	True if the blob should be included, False otherwise

@abstractmethod

def should_include_tree(self, depth: int) -> bool: ¶

Determine if a tree at given depth should be included.

Parameters
depth:`int`	Depth of the tree (0 = root)

Returns
`bool`	True if the tree should be included, False otherwise

@abstractmethod

def to_spec_string(self) -> str: ¶

Convert filter spec back to string format.

Returns
`str`	Filter specification string (e.g., `blob:none`, `blob:limit=1m`)