🎉 Exercism Research is now launched. Help Exercism, help science and have some fun at research.exercism.io 🎉
Avatar of ristvan

ristvan's solution

to SGF Parsing in the Python Track

Published at Feb 25 2021 · 0 comments
Instructions
Test suite
Solution

Note:

This exercise has changed since this solution was written.

Parsing a Smart Game Format string.

SGF is a standard format for storing board game files, in particular go.

SGF is a fairly simple format. An SGF file usually contains a single tree of nodes where each node is a property list. The property list contains key value pairs, each key can only occur once but may have multiple values.

An SGF file may look like this:

(;FF[4]C[root]SZ[19];B[aa];W[ab])

This is a tree with three nodes:

  • The top level node has three properties: FF[4] (key = "FF", value = "4"), C[root](key = "C", value = "root") and SZ[19] (key = "SZ", value = "19"). (FF indicates the version of SGF, C is a comment and SZ is the size of the board.)
    • The top level node has a single child which has a single property: B[aa]. (Black plays on the point encoded as "aa", which is the 1-1 point (which is a stupid place to play)).
      • The B[aa] node has a single child which has a single property: W[ab].

As you can imagine an SGF file contains a lot of nodes with a single child, which is why there's a shorthand for it.

SGF can encode variations of play. Go players do a lot of backtracking in their reviews (let's try this, doesn't work, let's try that) and SGF supports variations of play sequences. For example:

(;FF[4](;B[aa];W[ab])(;B[dd];W[ee]))

Here the root node has two variations. The first (which by convention indicates what's actually played) is where black plays on 1-1. Black was sent this file by his teacher who pointed out a more sensible play in the second child of the root node: B[dd] (4-4 point, a very standard opening to take the corner).

A key can have multiple values associated with it. For example:

(;FF[4];AB[aa][ab][ba])

Here AB (add black) is used to add three black stones to the board.

There are a few more complexities to SGF (and parsing in general), which you can mostly ignore. You should assume that the input is encoded in UTF-8, the tests won't contain a charset property, so don't worry about that. Furthermore you may assume that all newlines are unix style (\n, no \r or \r\n will be in the tests) and that no optional whitespace between properties, nodes, etc will be in the tests.

The exercise will have you parse an SGF string and return a tree structure of properties. You do not need to encode knowledge about the data types of properties, just use the rules for the text type everywhere.

Exception messages

Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to indicate what the source of the error is. This makes your code more readable and helps significantly with debugging. Not every exercise will require you to raise an exception, but for those that do, the tests will only pass if you include a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of raise Exception, you should write:

raise Exception("Meaningful message indicating the source of the error")

Running the tests

To run the tests, run pytest sgf_parsing_test.py

Alternatively, you can tell Python to run the pytest module: python -m pytest sgf_parsing_test.py

Common pytest options

  • -v : enable verbose output
  • -x : stop running tests on first failure
  • --ff : run failures from previous test before running other test cases

For other options, see python -m pytest -h

Submitting Exercises

Note that, when trying to submit an exercise, make sure the solution is in the $EXERCISM_WORKSPACE/python/sgf-parsing directory.

You can find your Exercism workspace by running exercism debug and looking for the line that starts with Workspace.

For more detailed information about running tests, code style and linting, please see Running the Tests.

Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.

sgf_parsing_test.py

import unittest

from sgf_parsing import parse, SgfTree

# Tests adapted from `problem-specifications//canonical-data.json` @ v1.2.0


class SgfParsingTest(unittest.TestCase):
    def test_empty_input(self):
        input_string = ""
        with self.assertRaisesWithMessage(ValueError):
            parse(input_string)

    def test_tree_with_no_nodes(self):
        input_string = "()"
        with self.assertRaisesWithMessage(ValueError):
            parse(input_string)

    def test_node_without_tree(self):
        input_string = ";"
        with self.assertRaisesWithMessage(ValueError):
            parse(input_string)

    def test_node_without_properties(self):
        input_string = "(;)"
        expected = SgfTree()
        self.assertEqual(parse(input_string), expected)

    def test_single_node_tree(self):
        input_string = "(;A[B])"
        expected = SgfTree(properties={"A": ["B"]})
        self.assertEqual(parse(input_string), expected)

    def test_multiple_properties(self):
        input_string = "(;A[b]C[d])"
        expected = SgfTree(properties={"A": ["b"], "C": ["d"]})
        self.assertEqual(parse(input_string), expected)

    def test_properties_without_delimiter(self):
        input_string = "(;A)"
        with self.assertRaisesWithMessage(ValueError):
            parse(input_string)

    def test_all_lowercase_property(self):
        input_string = "(;a[b])"
        with self.assertRaisesWithMessage(ValueError):
            parse(input_string)

    def test_upper_and_lowercase_property(self):
        input_string = "(;Aa[b])"
        with self.assertRaisesWithMessage(ValueError):
            parse(input_string)

    def test_two_nodes(self):
        input_string = "(;A[B];B[C])"
        expected = SgfTree(properties={"A": ["B"]}, children=[SgfTree({"B": ["C"]})])
        self.assertEqual(parse(input_string), expected)

    def test_two_child_trees(self):
        input_string = "(;A[B](;B[C])(;C[D]))"
        expected = SgfTree(
            properties={"A": ["B"]},
            children=[SgfTree({"B": ["C"]}), SgfTree({"C": ["D"]})],
        )
        self.assertEqual(parse(input_string), expected)

    def test_multiple_property_values(self):
        input_string = "(;A[b][c][d])"
        expected = SgfTree(properties={"A": ["b", "c", "d"]})
        self.assertEqual(parse(input_string), expected)

    def test_escaped_property(self):
        input_string = "(;A[\\]b\nc\nd\t\te \n\\]])"
        expected = SgfTree(properties={"A": ["]b\nc\nd  e \n]"]})
        self.assertEqual(parse(input_string), expected)

    # Utility functions
    def assertRaisesWithMessage(self, exception):
        return self.assertRaisesRegex(exception, r".+")


if __name__ == "__main__":
    unittest.main()
class SgfTree:
    def __init__(self, properties=None, children=None):
        self.properties = properties or {}
        self.children = children or []

    def __eq__(self, other):
        if not isinstance(other, SgfTree):
            return False
        for k, v in self.properties.items():
            if k not in other.properties:
                return False
            if other.properties[k] != v:
                return False
        for k in other.properties.keys():
            if k not in self.properties:
                return False
        if len(self.children) != len(other.children):
            return False
        for a, b in zip(self.children, other.children):
            if a != b:
                return False
        return True

    def __ne__(self, other):
        return not self == other

    def __str__(self):
        properties = "-".join([f"{key}:{value}" for key, value in self.properties.items()])
        if isinstance(self.children, SgfTree):
            print(f"Error: me: {self.properties} -> {self.children}")
        children = "-".join([f"{child}" for child in self.children])
        return f"p=({properties})#c=({children})"


class SgfParser:
    def __init__(self, input_string):
        self.__input = input_string

    def parse(self):
        game_tree = self._parse_game_tree()

        return game_tree

    def _parse_game_tree(self):
        self._parse_beginning_of_game_tree()
        game_tree = self._parse_sequence()
        children = list()
        while len(self.__input) > 0 and self.__input[0] == '(':
            child = self._parse_game_tree()
            children.append(child)
        self._parse_end_of_game_tree()
        if len(children) > 0:
            game_tree = SgfTree(properties=game_tree.properties, children=children)
        return game_tree

    def _parse_beginning_of_game_tree(self):
        self._verify_and_step_next_character("(")

    def _parse_sequence(self):
        properties = self._parse_node()
        children = list()
        if len(self.__input) > 0 and self.__input[0] == ';':
            child = self._parse_sequence()
            children.append(child)
        return SgfTree(properties=properties, children=children)

    def _parse_node(self):
        self._parse_begin_of_node()
        properties = self._parse_properties()
        return properties

    def _parse_begin_of_node(self):
        self._verify_and_step_next_character(";")

    def _parse_properties(self):
        properties = dict()
        property_id, property_values = self._parse_property()
        while property_id != "":
            if len(property_values) == 0:
                raise ValueError("Missing property value")
            properties[property_id] = property_values
            property_id, property_values = self._parse_property()
        return properties

    def _parse_property(self):
        property_id = self._parse_property_id()
        property_values = self._parse_property_values()
        return property_id, property_values

    def _parse_property_id(self):
        property_id = ""
        for c in self.__input:
            if c not in "ABCDEFGHIJKLMNOPQRSTUVWXYZ":
                break
            property_id = property_id + c
        self.__input = self.__input[len(property_id):]

        return property_id

    def _parse_property_values(self):
        property_values = list()
        while len(self.__input) > 0 and self.__input[0] == '[':
            property_value = self._parse_property_value()
            property_values.append(property_value)
        return property_values

    def _parse_property_value(self):
        self._verify_and_step_next_character("[")
        property_value = ""
        is_escaped = False
        number_of_characters = 0
        for c in self.__input:
            new_char = c
            if c == '\t':
                new_char = ' '
            if c in "]" and not is_escaped:
                break
            number_of_characters += 1
            if c == '\\':
                is_escaped = True
                new_char = ''
            else:
                is_escaped = False
            property_value = property_value + new_char
        self.__input = self.__input[number_of_characters:]
        self._verify_and_step_next_character("]")
        return property_value

    def _parse_end_of_game_tree(self):
        self._verify_and_step_next_character(")")

    def _verify_and_step_next_character(self, enabled_characters):
        if len(self.__input) == 0 or self.__input[0] not in enabled_characters:
            actually_seen = "End of Input" if len(self.__input) == 0 else self.__input[0]
            raise ValueError(f"Missing '{enabled_characters}' but got '{actually_seen}'")
        self.__input = self.__input[1:]


def parse(input_string):
    sgf_parser = SgfParser(input_string)
    return sgf_parser.parse()

Community comments

Find this solution interesting? Ask the author a question to learn more.

What can you learn from this solution?

A huge amount can be learned from reading other people’s code. This is why we wanted to give exercism users the option of making their solutions public.

Here are some questions to help you reflect on this solution and learn the most from it.

  • What compromises have been made?
  • Are there new concepts here that you could read more about to improve your understanding?