ini2toml.types

class ini2toml.types.CommentKey

Bases: HiddenKey

class ini2toml.types.Commented(value: T | NotGiven = NotGiven.NOT_GIVEN, comment: str | None = None)

Bases: Generic[T]

as_commented_list() → CommentedList[T]

comment_only()

has_comment()

value_or(fallback: S) → T | S

class ini2toml.types.CommentedKV(data: Sequence[Commented[List[Tuple[str, T]]]] = ())

Bases: Generic[T], UserList

as_dict() → dict

find(key: str) → Tuple[int, int] | None

insert_line(i, values: Iterable[Tuple[str, T]], comment: str | None = None)

to_ir() → IntermediateRepr

CommentedKV are usually intended to represent INI options, while IntermediateRepr are usually intended to represent INI sections. Therefore this function allows “promoting” an option-equivalent to a section-equivalent representation.

class ini2toml.types.CommentedList(data: Sequence[Commented[List[T]]] = ())

Bases: Generic[T], UserList

as_list() → list

insert_line(i, values: Iterable[T], comment: str | None = None)

class ini2toml.types.HiddenKey

Bases: object

class ini2toml.types.IntermediateRepr(elements: Mapping[str | HiddenKey | Tuple[str | HiddenKey, ...], Any] = mappingproxy({}), order: Sequence[str | HiddenKey | Tuple[str | HiddenKey, ...]] = (), inline_comment: str = '', **kwargs)

Bases: MutableMapping

append(key: str | HiddenKey | Tuple[str | HiddenKey, ...], value: Any)

Simulate the position-aware collections.abc.MutableMapping.append() method, but also require a key to be specified.

copy() → R

index(key: str | HiddenKey | Tuple[str | HiddenKey, ...]) → int

Find the position of key

insert(position: int, key: str | HiddenKey | Tuple[str | HiddenKey, ...], value: Any)

Simulate the position-aware collections.abc.MutableMapping.insert() method, but also require a key to be specified.

rename(old_key: str | HiddenKey | Tuple[str | HiddenKey, ...], new_key: str | HiddenKey | Tuple[str | HiddenKey, ...], ignore_missing=False)

This method renames an existing key, without changing its position. Notice that new_key cannot be already present, and that trying to rename a non-pre-existing key will also result in error (unless ignore_missing=True).

replace_first_remove_others(existing_keys: Sequence[str | HiddenKey | Tuple[str | HiddenKey, ...]], new_key: str | HiddenKey | Tuple[str | HiddenKey, ...], value: Any)

Find the first key in existing_keys that existing in the intermediate representation, and replaces it with new_key (similar to replace()). All the other keys in existing_keys are removed and the value of new_key is set to value.

class ini2toml.types.Profile(*args, **kwargs)

Bases: Protocol

help_text: str

intermediate_processors: List[Callable[[R], R]]

name: str

post_processors: List[Callable[[str], str]]

pre_processors: List[Callable[[str], str]]

class ini2toml.types.ProfileAugmentation(*args, **kwargs)

Bases: Protocol

active_by_default: bool

fn(profile: Profile)

help_text: str

is_active(explicitly_active: bool | None = None) → bool

explicitly_active is a tree-state variable: True if the user explicitly asked for the augmentation, False if the user explicitly denied the augmentation, or None otherwise.

name: str

class ini2toml.types.Translator(*args, **kwargs)

Bases: Protocol

augment_profiles(fn: Callable[[Profile], None], active_by_default: bool = False, name: str = '', help_text: str = '')

Register a profile augmentation function (see Core Concepts). The keyword name and help_text can be used to customise the description featured in ini2toml’s CLI, but when these arguments are not given (or empty strings), name is taken from fn.__name__ and help_text is taken from fn.__doc__ (docstring).

class ini2toml.types.WhitespaceKey

Bases: HiddenKey