PICARD-2213: Use YAML for script package export/import

Author: phw

picard/script/__init__.py

@@ -44,6 +44,8 @@
 import json
 import uuid
 
+import yaml
+
 from picard.config import get_config
 from picard.const import (
     DEFAULT_FILE_NAMING_FORMAT,
@@ -131,6 +133,17 @@ def __init__(self, *args):
         super().__init__(*args)
 
 
+class ScriptLiteral(str):
+    @staticmethod
+    def yaml_presenter(dumper, data):
+        if data:
+            data = data.rstrip() + '\n'
+        return dumper.represent_scalar("tag:yaml.org,2002:str", data, style="|")
+
+
+yaml.add_representer(ScriptLiteral, ScriptLiteral.yaml_presenter)
+
+
 class PicardScript():
     """Base class for Picard script objects.
     """
@@ -188,6 +201,14 @@ def __getitem__(self, setting):
             return value
         return None
 
+    @property
+    def script(self):
+        return self._script
+
+    @script.setter
+    def script(self, value):
+        self._script = ScriptLiteral(value)
+
     @staticmethod
     def make_last_updated():
         """Provide consistently formatted last updated string.
@@ -242,17 +263,15 @@ def copy(self):
         new_object._set_new_id()
         return new_object
 
-    # TODO: Enable once PyYAML requirement resolved with Python 3.8
-    #
-    # def to_yaml(self):
-    #     """Converts the properties of the script object to a YAML formatted string.  Note that only property
-    #     names listed in `OUTPUT_FIELDS` will be included in the output.
+    def to_yaml(self):
+        """Converts the properties of the script object to a YAML formatted string.  Note that only property
+        names listed in `OUTPUT_FIELDS` will be included in the output.
 
-    #     Returns:
-    #         str: The properties of the script object formatted as a YAML string.
-    #     """
-    #     items = {key: getattr(self, key) for key in dir(self) if key in self.OUTPUT_FIELDS}
-    #     return yaml.dump(items)
+        Returns:
+            str: The properties of the script object formatted as a YAML string.
+        """
+        items = {key: getattr(self, key) for key in dir(self) if key in self.OUTPUT_FIELDS}
+        return yaml.dump(items)
 
     def to_json(self, indent=None):
         """Converts the properties of the script object to a JSON formatted string.  Note that only property
@@ -267,29 +286,27 @@ def to_json(self, indent=None):
         items = {key: getattr(self, key) for key in dir(self) if key in self.OUTPUT_FIELDS}
         return json.dumps(items, indent=indent, sort_keys=True)
 
-    # TODO: Enable once PyYAML requirement resolved with Python 3.8
-    #
-    # @classmethod
-    # def create_from_yaml(cls, yaml_string, create_new_id=True):
-    #     """Creates an instance based on the contents of the YAML string provided.
-    #     Properties in the YAML string that are not found in the script object are ignored.
-
-    #     Args:
-    #         yaml_string (str): YAML string containing the property settings.
-
-    #     Returns:
-    #         object: An instance of the class, populated from the property settings in the YAML string.
-    #     """
-    #     new_object = cls()
-    #     yaml_dict = yaml.safe_load(yaml_string)
-    #     if not isinstance(yaml_dict, dict):
-    #         raise ScriptImportError(N_("File content not a dictionary"))
-    #     if 'title' not in yaml_dict or 'script' not in yaml_dict:
-    #         raise ScriptImportError(N_('Invalid script package'))
-    #     new_object._update_from_dict(yaml_dict)
-    #     if create_new_id or not new_object['id']:
-    #         new_object._set_new_id()
-    #     return new_object
+    @classmethod
+    def create_from_yaml(cls, yaml_string, create_new_id=True):
+        """Creates an instance based on the contents of the YAML string provided.
+        Properties in the YAML string that are not found in the script object are ignored.
+
+        Args:
+            yaml_string (str): YAML string containing the property settings.
+
+        Returns:
+            object: An instance of the class, populated from the property settings in the YAML string.
+        """
+        new_object = cls()
+        yaml_dict = yaml.safe_load(yaml_string)
+        if not isinstance(yaml_dict, dict):
+            raise ScriptImportError(N_("File content not a dictionary"))
+        if 'title' not in yaml_dict or 'script' not in yaml_dict:
+            raise ScriptImportError(N_('Invalid script package'))
+        new_object._update_from_dict(yaml_dict)
+        if create_new_id or not new_object['id']:
+            new_object._set_new_id()
+        return new_object
 
     @classmethod
     def create_from_json(cls, json_string, create_new_id=True):

picard/ui/scripteditor.py

@@ -284,7 +284,7 @@ def __init__(self, parent=None, examples=None):
 
         self.FILE_TYPE_ALL = _("All Files") + " (*)"
         self.FILE_TYPE_SCRIPT = _("Picard Script Files") + " (*.pts *.txt)"
-        self.FILE_TYPE_PACKAGE = _("Picard Naming Script Package") + " (*.pnsp *.json)"
+        self.FILE_TYPE_PACKAGE = _("Picard Naming Script Package") + " (*.pnsp *.yaml)"
 
         self.SCRIPT_TITLE_SYSTEM = _("System: %s")
         self.SCRIPT_TITLE_USER = _("User: %s")
@@ -873,7 +873,7 @@ def import_script(self):
                 return
             if file_type == self.FILE_TYPE_PACKAGE:
                 try:
-                    script_item = FileNamingScript().create_from_json(file_content)
+                    script_item = FileNamingScript().create_from_yaml(file_content)
                 except ScriptImportError as error:
                     self.output_file_error(FILE_ERROR_DECODE, filename, error)
                     return
@@ -907,7 +907,7 @@ def export_script(self):
                     filename = name
                 log.debug('Exporting naming script file: %s' % filename)
                 if file_type == self.FILE_TYPE_PACKAGE:
-                    script_text = script_item.to_json(indent=4)
+                    script_text = script_item.to_yaml()
                 try:
                     with open(filename, 'w', encoding='utf8') as o_file:
                         o_file.write(script_text)

requirements-macos-10.12.txt

@@ -6,3 +6,4 @@ mutagen==1.45.1
 pyobjc-core==6.2.2
 pyobjc-framework-Cocoa==6.2.2
 PyQt5==5.13.1
+pyyaml==5.4.1

requirements-macos-10.14.txt

@@ -6,3 +6,4 @@ mutagen==1.45.1
 pyobjc-core==6.2.2
 pyobjc-framework-Cocoa==6.2.2
 PyQt5==5.15.4
+pyyaml==5.4.1

requirements-win.txt

@@ -5,3 +5,4 @@ markdown==3.3.4
 mutagen==1.45.1
 PyQt5==5.15.4
 pywin32==300
+pyyaml==5.4.1

requirements.txt

@@ -7,3 +7,4 @@ pyobjc-core~=6.2; sys_platform == 'darwin'
 pyobjc-framework-Cocoa~=6.2; sys_platform == 'darwin'
 PyQt5~=5.10
 pywin32; sys_platform == 'win32'
+pyyaml>=5.1