dulwich.line_ending.LineEndingFilter

class documentation

class LineEndingFilter(FilterDriver):

Constructors: LineEndingFilter.from_config(config, for_text_attr), LineEndingFilter(clean_conversion, smudge_conversion, binary_detection, safecrlf)

View In Hierarchy

Filter driver for line ending conversion.

Class Method	`from_config`	Create a LineEndingFilter from git configuration.
Method	`__init__`	Initialize LineEndingFilter.
Method	`clean`	Apply line ending conversion for checkin (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 line ending conversion for checkout (repository -> working tree).
Instance Variable	`binary_detection`	Undocumented
Instance Variable	`clean_conversion`	Undocumented
Instance Variable	`safecrlf`	Undocumented
Instance Variable	`smudge_conversion`	Undocumented

@classmethod

def from_config(cls, config: StackedConfig | None, for_text_attr: bool = False) -> LineEndingFilter: ¶

Create a LineEndingFilter from git configuration.

Parameters
config:`StackedConfig \| None`	Git configuration stack
for_text_attr:`bool`	If True, always normalize on checkin (for text attribute)

Returns
`LineEndingFilter`	Configured LineEndingFilter instance

def __init__(self, clean_conversion: Callable[[bytes], bytes] | None = None, smudge_conversion: Callable[[bytes], bytes] | None = None, binary_detection: bool = True, safecrlf: bytes = b'false'): ¶

Initialize LineEndingFilter.

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

overrides dulwich.filters.FilterDriver.clean

Apply line ending conversion for checkin (working tree -> repository).

def cleanup(self): ¶

overrides dulwich.filters.FilterDriver.cleanup

Clean up any resources held by this filter driver.

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

overrides dulwich.filters.FilterDriver.reuse

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

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

overrides dulwich.filters.FilterDriver.smudge

Apply line ending conversion for checkout (repository -> working tree).

binary_detection = ¶

Undocumented

clean_conversion = ¶

Undocumented

safecrlf = ¶

Undocumented

smudge_conversion = ¶

Undocumented