dicfg.configs.configlist.ConfigList

class ConfigList(data: Any, updater: tuple[UpdaterAddon] | None = None, validator: tuple[ValidatorAddon] | None = None)

Bases: ConfigValue, UserList

Wraps a value into a ConfigList

Parameters:

data (list) – value of the config

__init__(data: Any, updater: tuple[UpdaterAddon] | None = None, validator: tuple[ValidatorAddon] | None = None)

Methods

__init__(data[, updater, validator])
append(item)	S.append(value) -- append value to the end of the sequence
cast()	Cast wrapped value to builtin python value
clear()
copy()
count(value)
extend(other)	S.extend(iterable) -- extend sequence by appending elements from the iterable
factory(data[, updater, validator, modifier])
index(value, [start, [stop]])	Raises ValueError if the value is not present.
insert(i, item)	S.insert(index, value) -- insert value before index
modify(b)	Merges config b with it self
pop([index])	Raise IndexError if list is empty or index is out of range.
remove(item)	S.remove(value) -- remove first occurrence of value.
reverse()	S.reverse() -- reverse IN PLACE
sort(*args, **kwds)
validate()	Validate the config

append(item)

S.append(value) – append value to the end of the sequence

cast()

Cast wrapped value to builtin python value

clear() → None -- remove all items from S

count(value) → integer -- return number of occurrences of value

extend(other)

S.extend(iterable) – extend sequence by appending elements from the iterable

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

insert(i, item)

S.insert(index, value) – insert value before index

modify(b: ConfigValue) → ConfigValue

Merges config b with it self

Parameters:

b (ConfigValue) – another config

Returns:

self

Return type:

ConfigValue

pop([index]) → item -- remove and return item at index (default last).

Raise IndexError if list is empty or index is out of range.

remove(item)

S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()

S.reverse() – reverse IN PLACE

validate()

Validate the config