il2fb-game-log-parser 1.0.3

Parse events from game log produced by dedicated server of «IL-2 Forgotten Battles» flight simulator

Table of contents

• Synopsis

• Demo

• Known events

• Installation

• Usage

• Exceptions

• Safe usage

Synopsis

This is a Python library which parses events from game log produced by dedicated server of «IL-2 Forgotten Battles» flight simulator. Resulting information about events is stored in special data structures.

Demo

You may see this library in action even if you do not understand its purpose.

All you need is just to visit project’s demo page.

That page allows you to test parser’s ability to process strings. If you do not know what to enter into a text area, you may click Insert test data and parse it.

If something goes wrong, you will be prompted to confirm automatic creation of bug report which will be listed on this page.

Known events

This library supports all known events produced by dedicated server (129 unique events).

To see their list, go to the demo page and click See the list of supported events link.

Installation

Get Python package from PyPI:

pip install il2fb-game-log-parser

Usage

If you need to be able to parse all events this library knows about, use GameLogEventParser.parse_string():

Import GameLogEventParser and create its instance:

from il2fb.parsers.game_log import GameLogEventParser

parser = GameLogEventParser()

Parse a string to get an instance of event:

event = parser.parse("[8:33:05 PM] User0 has connected")

Explore event’s internal structure:

print(event)
# <Event: HumanHasConnected>

print(event.time)
# datetime.time(20, 33, 5)

print(event.actor)
# <Human 'User0'>

print(event.actor.callsign)
# User0

Convert event into a dictionary:

import pprint

pprint.pprint(event.to_primitive())
# {'actor': {'callsign': 'User0'},
#  'name': 'HumanHasConnected',
#  'time': '20:33:05',
#  'verbose_name': 'Human has connected'}

Exceptions

If you try to parse unknown event, EventParsingException will be raised:

parser.parse("foo bar")
# Traceback (most recent call last):
# …
# EventParsingException: No event was found for string "foo bar"

Current list of supported events is rather full, but EventParsingException is quite possible, because server’s events are undocumented and this library may do not know about all of them.

In case you need to catch this error, its full name is il2fb.commons.events.EventParsingException.

Safe usage

You can set flag ignore_errors=True if you don’t care about any exceptions:

from il2fb.parsers.game_log import GameLogEventParser

parser = GameLogEventParser()
event = parser.parse("foo bar", ignore_errors=True)
print(event is None)
# True

Any error (except SystemExit and KeyboardInterrupt) will be muted and None will be returned.