Section is now full yaml

patacrep/content/__init__.py

@@ -232,8 +232,8 @@ def process_content(content, config=None):
     """Process content, and return a list of ContentItem() objects.
 
     Arguments are:
-    - content: the content field of the .sb file, which should be a list, and
+    - content: the content field of the .sb file, which should be an imbricated list
-      describe what is to be included in the songbook;
+    and describe what is to be included in the songbook;
     - config: the configuration dictionary of the current songbook.
 
     Return: a list of ContentItem objects, corresponding to the content to be
@@ -245,6 +245,19 @@ def process_content(content, config=None):
     if not content:
         content = [["song"]]
     for elem in content:
+        if isinstance(elem, dict):
+            # new way
+            for keyword, argument in elem.items():
+                if keyword not in plugins:
+                    contentlist.append_error(ContentError(keyword, "Unknown content type."))
+                    continue
+                contentlist.extend(plugins[keyword](
+                    keyword,
+                    argument=argument,
+                    config=config,
+                    ))
+        else:
+            # old way
             if isinstance(elem, str):
                 elem = ["song", elem]
             try:

patacrep/content/section.py

@@ -23,35 +23,29 @@ class Section(ContentItem):
         self.short = short
 
     def render(self, __context):
-        if self.short is None:
+        if self.short is None or self.keyword not in KEYWORDS:
             return r'\{}{{{}}}'.format(self.keyword, self.name)
         else:
             return r'\{}[{}]{{{}}}'.format(self.keyword, self.short, self.name)
 
 #pylint: disable=unused-argument
-def parse(keyword, argument, contentlist, config):
+def parse(keyword, argument, config):
     """Parse the contentlist.
 
     Arguments:
     - keyword (one of "part", "chapter", "section", ... , "subparagraph", and
       their starred versions "part*", "chapter*", ... , "subparagraph*"): the
       section to use;
-    - argument: unused;
+    - argument:
-    - contentlist: a list of one or two strings, which are the names (long
+        either a string describing the section name
-      and short) of the section;
+        or a dict
+            name: Name of the section
+            short: Shortname of the section (only for non starred sections)
     - config: configuration dictionary of the current songbook.
     """
-    try:
+    if isinstance(argument, str):
-        if (keyword not in KEYWORDS) and (len(contentlist) != 1):
+        argument = {'name': argument}
-            raise ContentError(
+    return ContentList([Section(keyword, **argument)])
-                keyword,
-                "Starred section names must have exactly one argument."
-                )
-        if (len(contentlist) not in [1, 2]):
-            raise ContentError(keyword, "Section can have one or two arguments.")
-        return ContentList([Section(keyword, *contentlist)])
-    except ContentError as error:
-        return EmptyContentList(errors=[error])
 
 
 CONTENT_PLUGINS = dict([

test/test_content/sections.source

@@ -1,6 +1,6 @@
-[["section", "Traditional"],
+- section: Traditional
-                "exsong.sg",
+- "exsong.sg"
-                ["section", "Example"],
+- section: Example
-                "texsong.tsg",
+- "texsong.tsg"
-                "chordpro.csg",
+- "chordpro.csg"
-                "exsong.sg"]
+- "exsong.sg"

test/test_content/sections_short.source

@@ -1,6 +1,8 @@
-[["section", "Traditional", "tradi"],
+- section:
-                "exsong.sg",
+    name: Traditional
-                ["section*", "Example"],
+    short: tradi
-                "texsong.tsg",
+- "exsong.sg"
-                "chordpro.csg",
+- section*: Example
-                "exsong.sg"]
+- "texsong.tsg"
+- "chordpro.csg"
+- "exsong.sg"

test/test_content/test_content.py

@@ -5,7 +5,7 @@
 import glob
 import os
 import unittest
-import json
+import yaml
 
 from patacrep.songs import DataSubpath
 from patacrep import content, files
@@ -18,7 +18,7 @@ from .. import dynamic # pylint: disable=unused-import
 class FileTest(unittest.TestCase, metaclass=dynamic.DynamicTest):
     """Test of the content plugins.
 
-    For any given `foo.source`, it parses the content as a json "content"
+    For any given `foo.source`, it parses the content as a yaml "content"
     argument of a .sb file.
     It controls that the generated file list is equal to the one in `foo.control`.
     """
@@ -51,7 +51,7 @@ class FileTest(unittest.TestCase, metaclass=dynamic.DynamicTest):
             """Test that `base.source` produces the correct file list"""
             sourcename = "{}.source".format(base)
             with open(sourcename, mode="r", encoding="utf8") as sourcefile:
-                sbcontent = json.load(sourcefile)
+                sbcontent = yaml.load(sourcefile)
 
             with logging_reduced('patacrep.content.song'):
                 expandedlist = content.process_content(sbcontent, cls.config.copy())
@@ -61,7 +61,7 @@ class FileTest(unittest.TestCase, metaclass=dynamic.DynamicTest):
             if not os.path.exists(controlname):
                 raise Exception("Missing control:" + str(sourcelist).replace("'", '"'))
             with open(controlname, mode="r", encoding="utf8") as controlfile:
-                controllist = json.load(controlfile)
+                controllist = yaml.load(controlfile)
 
             self.assertEqual(controllist, sourcelist)
 

test/test_songbook/content.sb

@@ -6,13 +6,12 @@ chords:
   repeatchords: no
   diagramreminder: all
 
-content: [
+content:
-  ["section", "Test of section"],
+  - section: Test of section
-  ["sorted"],
+  - ["sorted"]
-  ["songsection", "Test of song section"],
+  - ["songsection", "Test of song section"]
-  ["cwd(content_datadir/content)",
+  - ["cwd(content_datadir/content)",
     "song.csg", "song.tsg",
     ["tex", "foo.tex"]
-  ],
-  ["include", "include.sbc"]
   ]
+  - ["include", "include.sbc"]

test/test_songbook/content_datadir/songs/include.sbc

@@ -1 +1 @@
-[["section", "This is an included section"]]
+[{"section": "This is an included section"}]