farm-ng-core
Public Member Functions | Static Public Attributes | List of all members
core.events_file_reader.EventsFileReader Class Reference

Public Member Functions

None __init__ (self, str|Path file_name)
 
EventsFileReader __enter__ (self)
 
None __exit__ (self, object type, object value, object traceback)
 
str __repr__ (self)
 
int file_length (self)
 
Path file_name (self)
 
list[EventLogPosition] events_index (self)
 
bool is_open (self)
 
bool is_closed (self)
 
bool open (self)
 
bool close (self)
 
EventLogPosition read_next_event (self)
 
list[EventLogPosition] get_index (self)
 
Message read_message (self, EventLogPosition event_log)
 
tuple[Event, Message] read (self)
 
Generator[tuple[Event, Message], None, None] read_messages (self)
 

Static Public Attributes

 int
 

Detailed Description

EventsFileReader reads events from a file.

Constructor & Destructor Documentation

◆ __init__()

None core.events_file_reader.EventsFileReader.__init__ (   self,
str | Path  file_name 
) 
Initialize EventsFileReader.

Args:
    file_name: path to the file

Member Function Documentation

◆ __enter__()

EventsFileReader core.events_file_reader.EventsFileReader.__enter__ (   self) 
Open the file and return the EventsFileReader instance.

◆ __exit__()

None core.events_file_reader.EventsFileReader.__exit__ (   self,
object  type,
object  value,
object  traceback 
) 
Close the file.

◆ __repr__()

str core.events_file_reader.EventsFileReader.__repr__ (   self) 
Return a string representation of the EventsFileReader.

◆ close()

bool core.events_file_reader.EventsFileReader.close (   self) 
Close the file and return True if successful.

Returns:
    bool: True if successful

◆ events_index()

list[EventLogPosition] core.events_file_reader.EventsFileReader.events_index (   self) 
Return the index of events in the file.

◆ file_length()

int core.events_file_reader.EventsFileReader.file_length (   self) 
Return the length of the file.

◆ file_name()

Path core.events_file_reader.EventsFileReader.file_name (   self) 
Return the path to the file.

◆ get_index()

list[EventLogPosition] core.events_file_reader.EventsFileReader.get_index (   self) 
Return the index of events in the file.

Returns:
    list[EventLogPosition]: the index of events

◆ is_closed()

bool core.events_file_reader.EventsFileReader.is_closed (   self) 
Return True if the file is closed.

◆ is_open()

bool core.events_file_reader.EventsFileReader.is_open (   self) 
Return True if the file is open.

◆ open()

bool core.events_file_reader.EventsFileReader.open (   self) 
Open the file and return True if successful.

Returns:
    bool: True if successful

◆ read()

tuple[Event, Message] core.events_file_reader.EventsFileReader.read (   self) 
Read the next event and message and return them.

Returns:
    tuple[Event, Message]: the event and message

◆ read_message()

Message core.events_file_reader.EventsFileReader.read_message (   self,
EventLogPosition  event_log 
) 
Read the message from the event.

Args:
    event_log (EventLogPosition): the event log

◆ read_messages()

Generator[tuple[Event, Message], None, None] core.events_file_reader.EventsFileReader.read_messages (   self) 
Read all the messages in the file and return them.

Yields:
    Generator[tuple[Event, Message], None, None]: the event and message

◆ read_next_event()

EventLogPosition core.events_file_reader.EventsFileReader.read_next_event (   self) 
Read the next event and return it as an EventLogPosition.

Returns:
    EventLogPosition: the event, position and reader

Member Data Documentation

◆ int

core.events_file_reader.EventsFileReader.int
static
The documentation for this class was generated from the following file: