dulwich.filters.FilterDriver

class documentation

class FilterDriver(TypingProtocol):

Known subclasses: dulwich.line_ending.LineEndingFilter

Protocol for filter drivers.

Method	`clean`	Apply clean filter (working tree → repository).
Method	`cleanup`	Clean up any resources held by this filter driver.
Method	`reuse`	Check if this filter driver should be reused with the given configuration.
Method	`smudge`	Apply smudge filter (repository → working tree).

def clean(self, data: bytes) -> bytes: ¶

overridden in dulwich.line_ending.LineEndingFilter

Apply clean filter (working tree → repository).

def cleanup(self): ¶

overridden in dulwich.line_ending.LineEndingFilter

Clean up any resources held by this filter driver.

def reuse(self, config: StackedConfig, filter_name: str) -> bool: ¶

overridden in dulwich.line_ending.LineEndingFilter

Check if this filter driver should be reused with the given configuration.

This method determines whether a cached filter driver instance should continue to be used or if it should be recreated. Only filters that are expensive to create (like long-running process filters) and whose configuration hasn't changed should return True. Lightweight filters should return False to ensure they always use the latest configuration.

Parameters
config:`StackedConfig`	The current configuration stack
filter_name:`str`	The name of the filter in config

Returns
`bool`	True if the filter should be reused, False if it should be recreated

def smudge(self, data: bytes, path: bytes = b'') -> bytes: ¶

overridden in dulwich.line_ending.LineEndingFilter

Apply smudge filter (repository → working tree).