def test_section_tags_in_header(self):
""" Section tags in header """
field = StructuredField("\n".join(
["[something]", self.start, self.one, self.end]))
self.assertTrue("something" not in field)
self.assertTrue("one" in field)
self.assertEqual(field.get("one"), "1\n")
def test_section_item_remove(self):
""" Remove section item """
text = "\n".join([self.start, "[section]\nx = 3\ny = 7\n", self.end])
field = StructuredField(text)
field.remove("section", "x")
self.assertEqual(
field.save(),
"\n".join([self.start, "[section]\ny = 7\n", self.end]))
def test_plain_text(self):
""" Plain text """
text = "Some plain text.\n"
field0 = StructuredField(text, version=0)
field1 = StructuredField(text)
for field in [field0, field1]:
self.assertEqual(field.header(), text)
self.assertEqual(field.footer(), "")
self.assertEqual(field.save(), text)
self.assertEqual(list(field), [])
self.assertEqual(bool(field), False)
def test_trailing_whitespace(self):
""" Trailing whitespace """
original = StructuredField()
original.set("name", "value")
# Test with both space and tab appended after the section tag
for char in [" ", "\t"]:
spaced = re.sub(r"\]\n", "]{0}\n".format(char), original.save())
copy = StructuredField(spaced)
self.assertEqual(original.get("name"), copy.get("name"))
def test_section_tag_escaping(self):
""" Section tag escaping """
field = StructuredField()
field.set("section", "\n[content]\n")
reloaded = StructuredField(field.save())
self.assertTrue("section" in reloaded)
self.assertTrue("content" not in reloaded)
self.assertEqual(reloaded.get("section"), "\n[content]\n")
def test_carriage_returns(self):
""" Carriage returns """
text1 = "\n".join([self.start, self.sections, self.end])
text2 = re.sub(r"\n", "\r\n", text1)
field1 = StructuredField(text1)
field2 = StructuredField(text2)
self.assertEqual(field1.save(), field2.save())
def test_remove_section(self):
""" Remove section """
field0 = StructuredField("\n".join([self.sections, self.zeroend]),
version=0)
field1 = StructuredField("\n".join(
[self.start, self.sections, self.end]))
for field in [field0, field1]:
field.remove("one")
field.remove("two")
self.assertEqual(field0.save(), "\n".join([self.three, self.zeroend]))
self.assertEqual(field1.save(),
"\n".join([self.start, self.three, self.end]))
def test_set_content(self):
""" Set section content """
field0 = StructuredField(version=0)
field1 = StructuredField()
for field in [field0, field1]:
field.set("one", "1")
self.assertEqual(field.get("one"), "1\n")
field.set("two", "2")
self.assertEqual(field.get("two"), "2\n")
field.set("three", "3")
self.assertEqual(field.get("three"), "3\n")
self.assertEqual(field0.save(),
"\n".join([self.sections, self.zeroend]))
self.assertEqual(field1.save(),
"\n".join([self.start, self.sections, self.end]))
def test_just_sections(self):
""" Just sections """
# Version 0
text0 = "\n".join([self.sections, self.zeroend])
field0 = StructuredField(text0, version=0)
self.assertEqual(field0.save(), text0)
# Version 1
text1 = "\n".join([self.start, self.sections, self.end])
field1 = StructuredField(text1)
self.assertEqual(field1.save(), text1)
# Common checks
for field in [field0, field1]:
self.assertEqual(field.header(), "")
self.assertEqual(field.footer(), "")
self.assertEqual(field.get("one"), "1\n")
self.assertEqual(field.get("two"), "2\n")
self.assertEqual(field.get("three"), "3\n")
def test_section_item_get(self):
""" Get section item """
text = "\n".join([self.start, "[section]\nx = 3\n", self.end])
field = StructuredField(text)
self.assertEqual(field.get("section", "x"), "3")
def test_header_footer_modify(self):
""" Modify header & footer """
original = StructuredField()
original.set("field", "field-content")
original.header("header-content\n")
original.footer("footer-content\n")
copy = StructuredField(original.save())
self.assertEqual(copy.header(), "header-content\n")
self.assertEqual(copy.footer(), "footer-content\n")
def test_nesting(self):
""" Nesting """
# Prepare structure parent -> child -> grandchild
grandchild = StructuredField()
grandchild.set('name', "Grand Child\n")
child = StructuredField()
child.set('name', "Child Name\n")
child.set("child", grandchild.save())
parent = StructuredField()
parent.set("name", "Parent Name\n")
parent.set("child", child.save())
# Reload back and check the names
parent = StructuredField(parent.save())
child = StructuredField(parent.get("child"))
grandchild = StructuredField(child.get("child"))
self.assertEqual(parent.get("name"), "Parent Name\n")
self.assertEqual(child.get("name"), "Child Name\n")
self.assertEqual(grandchild.get("name"), "Grand Child\n")
def test_unicode_section_name(self):
""" Unicode in section name """
chars = u"ěščřžýáíéů"
text = "\n".join([self.start, u"[{0}]\nx".format(chars), self.end])
field = StructuredField(text)
self.assertEqual(field.get(chars).strip(), "x")
def test_unicode_section_content(self):
""" Unicode in section content """
chars = u"ěščřžýáíéů"
text = "\n".join([self.start, "[section]", chars, self.end])
field = StructuredField(text)
self.assertEqual(field.get("section").strip(), chars)
def test_unicode_header(self):
""" Unicode text in header """
text = u"Už abychom měli unicode jako defaultní kódování!"
field = StructuredField(text)
field.set("section", "content")
self.assertTrue(text in field.save())
def test_empty_section(self):
""" Empty section """
field = StructuredField()
field.set("section", "")
reloaded = StructuredField(field.save())
self.assertEqual(reloaded.get("section"), "")
def test_multiple_values(self):
""" Multiple values """
# Reading multiple values
section = "[section]\nkey=val1 # comment\nkey = val2\n key = val3 "
text = "\n".join([self.start, section, self.end])
field = StructuredField(text, multi=True)
self.assertEqual(field.get("section", "key"), ["val1", "val2", "val3"])
# Writing multiple values
values = ['1', '2', '3']
field = StructuredField(multi=True)
field.set("section", values, "key")
self.assertEqual(field.get("section", "key"), values)
self.assertTrue("key = 1\nkey = 2\nkey = 3" in field.save())
# Remove multiple values
field.remove("section", "key")
self.assertTrue("key = 1\nkey = 2\nkey = 3" not in field.save())
self.assertRaises(StructuredFieldError, field.get, "section", "key")
def test_everything(self):
""" Everything """
# Version 0
text0 = "\n".join(
[self.header, self.sections, self.zeroend, self.footer])
inited0 = StructuredField(text0, version=0)
loaded0 = StructuredField()
loaded0.load(text0, version=0)
self.assertEqual(inited0.save(), text0)
self.assertEqual(loaded0.save(), text0)
# Version 1
text1 = "\n".join(
[self.header, self.start, self.sections, self.end, self.footer])
inited1 = StructuredField(text1)
loaded1 = StructuredField()
loaded1.load(text1)
self.assertEqual(inited1.save(), text1)
self.assertEqual(loaded1.save(), text1)
# Common checks
for field in [inited0, loaded0, inited1, loaded1]:
self.assertEqual(field.header(), self.header)
self.assertEqual(field.footer(), self.footer)
self.assertEqual(field.sections(), ["one", "two", "three"])
self.assertEqual(field.get("one"), "1\n")
self.assertEqual(field.get("two"), "2\n")
self.assertEqual(field.get("three"), "3\n")
def test_section_item_set(self):
""" Set section item """
text = "\n".join([self.start, "[section]\nx = 3\n", self.end])
field = StructuredField()
field.set("section", "3", "x")
self.assertEqual(field.save(), text)