sections

• CommentConfig
• Section
• SectionChanges
• SectionPart
• changed_sections
• compare_sections
• extract_sections
• extract_sections_from_path
• get_comment_config
• has_sections
• has_sections_in_path
• parse_sections
• parse_sections_from_path
• replace_sections
• slug
• wrap_in_default_section
• wrap_section

Symbol Details

class: CommentConfig

• source
• Example: Frozen dataclass holding comment prefix/suffix for section markers

  Since: 0.101.0

class CommentConfig:
    prefix: str
    suffix: str = ''

Field	Type	Default	Since
prefix	str	-	0.101.0
suffix	str	''	0.101.0

Changes

Version	Change
0.101.0	Made public

function: compare_sections

• source

  Since: 0.101.0

def compare_sections(baseline_content: str, current_content: str, tool_name: str, config: CommentConfig, skip: set[str] | None = None, filename: str = '') -> list[str]:
    ...

Return section IDs with changes (modified or removed), excluding skipped sections.

Changes

Version	Change
0.101.0	Made public

function: extract_sections

• source

  Since: 0.101.0

def extract_sections(content: str, tool_name: str, config: CommentConfig, filename: str = '') -> dict[str, str]:
    ...

Changes

Version	Change
0.101.0	Made public

function: extract_sections_from_path

• source

  Since: 0.101.0

def extract_sections_from_path(path: Path, tool_name: str) -> dict[str, str]:
    ...

Changes

Version	Change
0.101.0	Made public

function: has_sections

• source

  Since: 0.101.0

def has_sections(content: str, tool_name: str, config: CommentConfig) -> bool:
    ...

Changes

Version	Change
0.101.0	Made public

function: has_sections_in_path

• source

  Since: 0.101.0

def has_sections_in_path(path: Path, tool_name: str) -> bool:
    ...

Changes

Version	Change
0.101.0	Made public

function: parse_sections_from_path

• source

  Since: 0.101.0

def parse_sections_from_path(path: Path, tool_name: str) -> list[Section]:
    ...

Changes

Version	Change
0.101.0	Made public

function: slug

• source

  Since: 0.101.0

def slug(text: str) -> str:
    ...

Convert text to lowercase slug suitable for section marker IDs.

Changes

Version	Change
0.101.0	Made public

function: wrap_in_default_section

• source

  Since: 0.101.0

def wrap_in_default_section(content: str, tool_name: str, config: CommentConfig) -> str:
    ...

Changes

Version	Change
0.101.0	Made public

function: wrap_section

• source

  Since: 0.101.0

def wrap_section(content: str, section_id: str, tool_name: str, config: CommentConfig) -> str:
    ...

Changes

Version	Change
0.101.0	Made public

class: SectionChanges

• source

  Since: 0.102.0

class SectionChanges:
    modified: list[str]
    missing: list[str]

Field	Type	Default	Since
modified	list[str]	-	0.102.0
missing	list[str]	-	0.102.0

Changes

Version	Change
0.102.0	Made public

function: changed_sections

• source

  Since: 0.102.0

def changed_sections(baseline_content: str, current_content: str, tool_name: str, config: CommentConfig, skip: set[str] | None = None, filename: str = '') -> SectionChanges:
    ...

Return modified and missing sections separately.

Changes

Version	Change
0.102.0	Made public

function: get_comment_config

• source
• Example: Resolve CommentConfig from a file path or override

  Since: 0.101.0

def get_comment_config(path: Path | str, override: CommentConfig | None = None) -> CommentConfig:
    ...

Changes

Version	Change
0.101.0	Made public

function: parse_sections

• source
• Example: Parse content with DO_NOT_EDIT/OK_EDIT markers into Section objects

  Since: 0.101.0

def parse_sections(content: str, tool_name: str, config: CommentConfig, filename: str = '') -> list[Section]:
    ...

Changes

Version	Change
0.101.0	Made public