Skip to content

Add testing framework for parser#5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
aradi wants to merge 1 commit into from
Closed

Add testing framework for parser #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/hsd/__init__.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,5 +9,5 @@
Central module for the hsd package
"""
from .dump import dump, dumps
from .parser import HsdParser
from .parser import HsdParser, HsdEventHandler
from .dictbuilder import HsdDictBuilder
6 changes: 3 additions & 3 deletions src/hsd/parser.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@
import hsd.common as common


__all__ = ["HsdParser",
__all__ = ["HsdParser", "HsdEventHandler",
"SYNTAX_ERROR", "UNCLOSED_TAG_ERROR", "UNCLOSED_OPTION_ERROR",
"UNCLOSED_QUOTATION_ERROR", "ORPHAN_TEXT_ERROR"]

Expand DownExpand Up@@ -286,8 +286,8 @@ def _starttag(self, tagname, closeprev):
if len(tagname_stripped.split()) > 1:
self._error(SYNTAX_ERROR, (self._currline, self._currline))
self._hsdoptions[common.HSDATTR_LINE] = self._currline
self._hsdoptions[common.HSDATTR_TAG] = tagname_stripped
tagname_stripped = tagname_stripped.lower()
#self._hsdoptions[common.HSDATTR_TAG] = tagname_stripped
#tagname_stripped = tagname_stripped.lower()

@awvwgkawvwgkApr 6, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change does make the HSD parser case sensitive which is not really in line with the reference implementation.
From the DFTB+ manual:

The name of the properties, the methods and the logical values are case insensitive

@aradiaradiMay 25, 2020

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. However, IMO it is better, if the parser just passes the tokens literally. The tree builder can then decide to convert everything to lower case (and eventually store the original form somewhere for later reference...)

@awvwgkawvwgkMay 25, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I totally agree, forcing a case-insensitive input will limit the applicability of HSD. But with this change there should be an easy way or a recipe to generate a DFTB+ compatible parser.

Than again, one has also to think about clarifying this part about HSD in the DFTB+ manual, which is the only existing specification.

self._eventhandler.open_tag(tagname_stripped, self._attrib,
self._hsdoptions)
self._opened_tags.append(
Expand Down
63 changes: 56 additions & 7 deletions test/test_parser.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,15 +6,64 @@
# See the LICENSE file for terms of usage and distribution. #
#------------------------------------------------------------------------------#
#
import io
import pytest
import hsd
import os.path as op

_OPEN_TAG_EVENT = 1
_CLOSE_TAG_EVENT = 2
_ADD_TEXT_EVENT = 3

def test_parser():
parser = hsd.HsdParser()
with open(op.join(op.dirname(__file__), "test.hsd"), "r") as fobj:
parser.feed(fobj)
_HSD_LINE = 'line'
_HSD_EQUAL = 'equal'

_TESTS = [
# Simple test
("""Test {} """,
[(_OPEN_TAG_EVENT, "Test", None, {_HSD_LINE: 0}),
(_CLOSE_TAG_EVENT, "Test"),
]
),

if __name__ == '__main__':
test_parser()
# Test data with quoted strings
("""O = SelectedShells { "s" "p" }""",
[(_OPEN_TAG_EVENT, "O", None, {_HSD_LINE: 0, _HSD_EQUAL: True}),
(_OPEN_TAG_EVENT, 'SelectedShells', None, {_HSD_LINE: 0}),
(_ADD_TEXT_EVENT, '"s" "p"'),
(_CLOSE_TAG_EVENT, 'SelectedShells'),
(_CLOSE_TAG_EVENT, 'O'),
]
),

# Test attribute containing comma
("""PolarRadiusCharge [AA^3,AA,] = {\n1.030000 3.800000 2.820000\n}""",
[(_OPEN_TAG_EVENT, "PolarRadiusCharge", "AA^3,AA,", {_HSD_LINE: 0, }),
(_ADD_TEXT_EVENT, '1.030000 3.800000 2.820000'),
(_CLOSE_TAG_EVENT, 'PolarRadiusCharge'),
]
),
]


class _TestEventHandler(hsd.HsdEventHandler):

def __init__(self):
self.events = []

def open_tag(self, tagname, attrib, hsdoptions):
self.events.append((_OPEN_TAG_EVENT, tagname, attrib, hsdoptions))

def close_tag(self, tagname):
self.events.append((_CLOSE_TAG_EVENT, tagname))

def add_text(self, text):
self.events.append((_ADD_TEXT_EVENT, text))


@pytest.mark.parametrize("hsd_input,expected_events", _TESTS)
def test_parser_events(hsd_input, expected_events):
testhandler = _TestEventHandler()
parser = hsd.HsdParser(eventhandler=testhandler)
hsdfile = io.StringIO(hsd_input)
parser.feed(hsdfile)
assert testhandler.events == expected_events