Register

class Register(previous=None, next=None, data=None)[source]

Class for a generic register in a textfile, with a given identifier which is located at the beginning of the line.

classmethod matches(line: str | bytes, storage: str = '')[source]

Checks if the current line matches the identifier of the register.

Parameters:: line (str | bytes) – The candidate line for containing the register information

read(file: IO, storage: str = '', *args, **kwargs) → bool[source]

Generic function to perform the reading of the register using a filepointer.

read_register(file: IO, storage: str = '', *args, **kwargs)[source]

Function that reads the register and evaluates the result.

write(file: IO, storage: str = '', *args, **kwargs) → bool[source]

Generic function to perform the writing of the register using a filepointer.

write_register(file: IO, storage: str = '', *args, **kwargs)[source]

Function that writes the register, if it was succesfully read.

DefaultRegister

class DefaultRegister(previous=None, next=None, data=None)[source]

A class for representing a default register, which contains exactly the data from the read line. Mainly used for comments.

read(file: IO, storage: str = '', *args, **kwargs) → bool[source]

Generic function to perform the reading of the register using a filepointer.

write(file: IO, storage: str = '', *args, **kwargs) → bool[source]

Generic function to perform the writing of the register using a filepointer.