waveform_editor.annotations.Annotations¶

class waveform_editor.annotations.Annotations(initlist=None)¶

Bases: UserList

__init__(initlist=None)¶

Methods

__init__([initlist])
add(line_number, error_msg[, is_warning])	Adds the error message to the list of annotations.
add_annotations(annotations)	Merge another Annotations instance into this instance by appending its annotations.
add_yaml_error(error)	Add a YAML parsing error to the annotations.
append(item)	S.append(value) -- append value to the end of the sequence
clear()
copy()
count(value)
extend(other)	S.extend(iterable) -- extend sequence by appending elements from the iterable
index(value, [start, [stop]])	Raises ValueError if the value is not present.
insert(i, item)	S.insert(index, value) -- insert value before index
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)
suggest(word_to_match, possible_matches)	Suggest a close match for a given word from a list of possible matches.

add(line_number, error_msg, is_warning=False)¶

Adds the error message to the list of annotations.

Parameters:

line_number¶

The line number at which the error occurs.

error_msg¶

The error message the annotation should display.

is_warning=False¶

Whether the annotation is a warning. If set to False, it is treated as an error.

add_annotations(annotations)¶

Merge another Annotations instance into this instance by appending its annotations.

Parameters:

annotations¶

The Annotations object to append.

add_yaml_error(error)¶

Add a YAML parsing error to the annotations.

Parameters:

error¶

The YAML parsing error to be added as annotations.

append(item)¶

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

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

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

suggest(word_to_match, possible_matches)¶

Suggest a close match for a given word from a list of possible matches.

Parameters:

word_to_match¶

The word for which a suggestion is needed.

possible_matches¶

A list of possible correct words.