From 929214b3f7e603977fba1064aae73ebb2665cf76 Mon Sep 17 00:00:00 2001 From: Laurent Monin Date: Sun, 26 May 2024 18:49:34 +0200 Subject: [PATCH] FileNamingScript -> PicardFileNamingScript --- picard/config_upgrade.py | 6 +++--- picard/script/__init__.py | 10 +++++----- picard/script/serializer.py | 2 +- picard/ui/scripteditor.py | 20 ++++++++++---------- test/test_script_serializer.py | 4 ++-- 5 files changed, 21 insertions(+), 21 deletions(-) diff --git a/picard/config_upgrade.py b/picard/config_upgrade.py index e6aaed13a..8e212e90a 100644 --- a/picard/config_upgrade.py +++ b/picard/config_upgrade.py @@ -429,19 +429,19 @@ def upgrade_to_v2_7_0dev3(config): """ from picard.script import get_file_naming_script_presets from picard.script.serializer import ( - FileNamingScript, + PicardFileNamingScript, PicardScriptFromFileError, ) scripts = {} for item in config.setting.raw_value('file_naming_scripts') or []: try: - script_item = FileNamingScript().create_from_yaml(item, create_new_id=False) + script_item = PicardFileNamingScript().create_from_yaml(item, create_new_id=False) scripts[script_item['id']] = script_item.to_dict() except PicardScriptFromFileError: log.error("Error converting file naming script") script_list = set(scripts.keys()) | set(map(lambda item: item['id'], get_file_naming_script_presets())) if config.setting['selected_file_naming_script_id'] not in script_list: - script_item = FileNamingScript( + script_item = PicardFileNamingScript( script=config.setting.value('file_naming_format', TextOption), title=_("Primary file naming script"), readonly=False, diff --git a/picard/script/__init__.py b/picard/script/__init__.py index 10d34c31a..28f96f711 100644 --- a/picard/script/__init__.py +++ b/picard/script/__init__.py @@ -63,7 +63,7 @@ from picard.script.parser import ( # noqa: F401 # pylint: disable=unused-import ScriptUnknownFunction, ScriptVariable, ) -from picard.script.serializer import FileNamingScript +from picard.script.serializer import PicardFileNamingScript class TaggingScriptSetting: @@ -173,7 +173,7 @@ def get_file_naming_script_presets(): """Generator of preset example file naming script objects. Yields: - FileNamingScript: the next example FileNamingScript object + PicardFileNamingScript: the next example PicardFileNamingScript object """ AUTHOR = "MusicBrainz Picard Development Team" DESCRIPTION = _("This preset example file naming script does not require any special settings, tagging scripts or plugins.") @@ -185,7 +185,7 @@ def get_file_naming_script_presets(): 'title': _(title), } - yield FileNamingScript( + yield PicardFileNamingScript( id=DEFAULT_NAMING_PRESET_ID, title=preset_title(1, N_("Default file naming script")), script=DEFAULT_FILE_NAMING_FORMAT, @@ -197,7 +197,7 @@ def get_file_naming_script_presets(): script_language_version="1.0", ) - yield FileNamingScript( + yield PicardFileNamingScript( id="Preset 2", title=preset_title(2, N_("[album artist]/[album]/[track #]. [title]")), script="%albumartist%/\n" @@ -211,7 +211,7 @@ def get_file_naming_script_presets(): script_language_version="1.0", ) - yield FileNamingScript( + yield PicardFileNamingScript( id="Preset 3", title=preset_title(3, N_("[album artist]/[album]/[disc and track #] [artist] - [title]")), script="$if2(%albumartist%,%artist%)/\n" diff --git a/picard/script/serializer.py b/picard/script/serializer.py index dd1a6f675..817a28558 100644 --- a/picard/script/serializer.py +++ b/picard/script/serializer.py @@ -397,7 +397,7 @@ class PicardTaggingScript(PicardScript): super().__init__(script=script, title=title, id=id, last_updated=last_updated, script_language_version=script_language_version) -class FileNamingScript(PicardScript): +class PicardFileNamingScript(PicardScript): """Picard file naming script class """ TYPE = PicardScriptType.FILENAMING diff --git a/picard/ui/scripteditor.py b/picard/ui/scripteditor.py index cefa33375..671d27b3c 100644 --- a/picard/ui/scripteditor.py +++ b/picard/ui/scripteditor.py @@ -60,7 +60,7 @@ from picard.script import ( iter_tagging_scripts_from_tuples, ) from picard.script.serializer import ( - FileNamingScript, + PicardFileNamingScript, PicardScriptImportExportError, ) from picard.util import ( @@ -386,7 +386,7 @@ def populate_script_selection_combo_box(naming_scripts, selected_script_id, comb """Populate the specified script selection combo box and identify the selected script. Args: - naming_scripts (dict): Dictionary of available user-defined naming scripts as script dictionaries as produced by FileNamingScript().to_dict() + naming_scripts (dict): Dictionary of available user-defined naming scripts as script dictionaries as produced by PicardFileNamingScript().to_dict() selected_script_id (str): ID code for the currently selected script combo_box (QComboBox): Combo box object to populate @@ -936,7 +936,7 @@ class ScriptEditorDialog(PicardDialog, SingletonDialog): """Insert a new item into the script selection combo box and update the script list in the settings. Args: - script_item (dict): File naming script to insert as produced by FileNamingScript().to_dict() + script_item (dict): File naming script to insert as produced by PicardFileNamingScript().to_dict() """ self.selected_script_id = script_item['id'] self.naming_scripts[self.selected_script_id] = script_item @@ -960,7 +960,7 @@ class ScriptEditorDialog(PicardDialog, SingletonDialog): def new_script(self, script): """Add a new script to the script selection combo box and script list. """ - script_item = FileNamingScript(script=script) + script_item = PicardFileNamingScript(script=script) script_item.title = self.new_script_name() self._insert_item(script_item.to_dict()) @@ -968,7 +968,7 @@ class ScriptEditorDialog(PicardDialog, SingletonDialog): """Add a copy of the script as a new editable script to the script selection combo box. """ selected, script_item = self.get_selected_index_and_item() - new_item = FileNamingScript.create_from_dict(script_dict=script_item).copy() + new_item = PicardFileNamingScript.create_from_dict(script_dict=script_item).copy() base_title = "%s %s" % (get_base_title(script_item['title']), gettext_constants(DEFAULT_COPY_TEXT)) new_item.title = self.new_script_name(base_title) @@ -1009,7 +1009,7 @@ class ScriptEditorDialog(PicardDialog, SingletonDialog): """Get the specified item from the script selection combo box. Returns: - dict: File naming script dictionary as produced by FileNamingScript().to_dict() + dict: File naming script dictionary as produced by PicardFileNamingScript().to_dict() """ return self.get_script_item(self.ui.preset_naming_scripts.currentIndex()) @@ -1058,7 +1058,7 @@ class ScriptEditorDialog(PicardDialog, SingletonDialog): Args: idx (int): Index of the item to update - script_item (dict): Updated file naming script information as produced by FileNamingScript().to_dict() + script_item (dict): Updated file naming script information as produced by PicardFileNamingScript().to_dict() """ self.ui.preset_naming_scripts.setItemData(idx, script_item) title = script_item['title'] @@ -1233,7 +1233,7 @@ class ScriptEditorDialog(PicardDialog, SingletonDialog): a naming script package. """ try: - script_item = FileNamingScript().import_script(self) + script_item = PicardFileNamingScript().import_script(self) except PicardScriptImportExportError as error: self.output_file_error(error.format, error.filename, error.error_msg) return @@ -1277,7 +1277,7 @@ class ScriptEditorDialog(PicardDialog, SingletonDialog): script or a naming script package. """ selected = self.get_selected_item() - script_item = FileNamingScript.create_from_dict(script_dict=selected, create_new_id=False) + script_item = PicardFileNamingScript.create_from_dict(script_dict=selected, create_new_id=False) script_item.title = get_base_title(script_item.title) try: script_item.export_script(parent=self) @@ -1402,7 +1402,7 @@ class ScriptDetailsEditor(PicardDialog): def set_last_updated(self): """Set the last updated value to the current timestamp. """ - self.ui.script_last_updated.setText(FileNamingScript.make_last_updated()) + self.ui.script_last_updated.setText(PicardFileNamingScript.make_last_updated()) self.ui.script_last_updated.setModified(True) def save_changes(self): diff --git a/test/test_script_serializer.py b/test/test_script_serializer.py index 422b26c9e..9f4366110 100644 --- a/test/test_script_serializer.py +++ b/test/test_script_serializer.py @@ -28,7 +28,7 @@ import yaml from test.picardtestcase import PicardTestCase from picard.script.serializer import ( - FileNamingScript, + PicardFileNamingScript, PicardScript, PicardScriptFromFileError, ) @@ -131,7 +131,7 @@ class PicardScriptTest(PicardTestCase): def test_naming_script_object_1(self): # Check initial loaded values. - test_script = FileNamingScript( + test_script = PicardFileNamingScript( title='Script 1', script='Script text', id='12345', last_updated='2021-04-26', description='Script description', author='Script author', script_language_version='1.0' )