feat: add a new option for create batch

Signed-off-by: longhao <hal.long@outlook.com>

Author: loonghao

.gitignore

@@ -20,6 +20,7 @@ result/
 # Coverage output
 .coverage
 /venv/
+venv_python
 
 # Docs
 docs_src/_build/

examples/run_batch.py

@@ -0,0 +1,16 @@
+# Import built-in modules
+import os
+
+# Import local modules
+from photoshop import Session
+
+
+root = "your/images/root"
+files = []
+for name in os.listdir(root):
+    files.append(os.path.join(root, name))
+with Session() as api:
+    options = api.BatchOptions()
+    options.destination = 3
+    options.destinationFolder = "c:\\test"
+    api.app.batch(files=files, actionName="Quadrant Colors", actionSet="Default Actions", options=options)

photoshop/api/__init__.py

@@ -1,11 +1,11 @@
 """Python API for Photoshop."""
-
 # Import local modules
 from photoshop.api import constants
 from photoshop.api.action_descriptor import ActionDescriptor
 from photoshop.api.action_list import ActionList
 from photoshop.api.action_reference import ActionReference
 from photoshop.api.application import Application
+from photoshop.api.batch_options import BatchOptions
 from photoshop.api.colors import CMYKColor
 from photoshop.api.colors import GrayColor
 from photoshop.api.colors import HSBColor
@@ -35,6 +35,7 @@
     "ActionReference",
     "ActionList",
     "Application",
+    "BatchOptions",
     "constants",
     "enumerations",
     "PhotoshopPythonAPIError",

photoshop/api/application.py

@@ -10,7 +10,6 @@
 app.documents.add(800, 600, 72, "docRef")
 
 """
-
 # Import built-in modules
 import os
 from pathlib import Path
@@ -259,13 +258,13 @@ def windowsFileTypes(self):
         return self.app.windowsFileTypes
 
     # Methods.
-    def batch(self, *args, **kwargs):
+    def batch(self, files, actionName, actionSet, options):
         """Runs the batch automation routine.
 
         Similar to the **File** > **Automate** > **Batch** command.
 
         """
-        self.app.bath(*args, **kwargs)
+        self.app.batch(files, actionName, actionSet, options)
 
     def beep(self):
         """Causes a "beep" sound."""

photoshop/api/batch_options.py

@@ -0,0 +1,119 @@
+# https://theiviaxx.github.io/photoshop-docs/Photoshop/BatchOptions.html
+# Import local modules
+from photoshop.api._core import Photoshop
+
+
+class BatchOptions(Photoshop):
+    object_name = "BatchOptions"
+
+    def __init__(self):
+        super().__init__()
+
+    @property
+    def destination(self):
+        """The type of destination for the processed files."""
+        return self.app.destination
+
+    @destination.setter
+    def destination(self, value):
+        self.app.destination = value
+
+    @property
+    def destinationFolder(self):
+        """The folder location for the processed files. Valid only when ‘destination’ = folder."""
+        return self.app.destinationFolder
+
+    @destinationFolder.setter
+    def destinationFolder(self, path):
+        self.app.destinationFolder = path
+
+    @property
+    def errorFile(self):
+        """The file in which to log errors encountered.
+        To display errors on the screen and stop batch processing when errors occur, leave blank."""
+        return self.app.errorFile
+
+    @errorFile.setter
+    def errorFile(self, file_path):
+        self.app.errorFile = file_path
+
+    @property
+    def fileNaming(self) -> list:
+        """A list of file naming options. Maximum: 6."""
+        return self.app.fileNaming
+
+    @fileNaming.setter
+    def fileNaming(self, file_naming: list):
+        self.app.fileNaming = file_naming
+
+    @property
+    def macintoshCompatible(self) -> bool:
+        """If true, the final file names are Macintosh compatible."""
+        return self.app.macintoshCompatible
+
+    @macintoshCompatible.setter
+    def macintoshCompatible(self, value: bool):
+        self.app.macintoshCompatible = value
+
+    @property
+    def overrideOpen(self) -> bool:
+        """If true, overrides action open commands."""
+        return self.app.overrideOpen
+
+    @overrideOpen.setter
+    def overrideOpen(self, value: bool):
+        self.app.overrideOpen = value
+
+    @property
+    def overrideSave(self) -> bool:
+        """If true, overrides save as action steps with the specified destination."""
+        return self.app.overrideSave
+
+    @overrideSave.setter
+    def overrideSave(self, value: bool):
+        self.app.overrideSave = value
+
+    @property
+    def startingSerial(self) -> int:
+        """The starting serial number to use in naming files."""
+        return self.app.startingSerial
+
+    @startingSerial.setter
+    def startingSerial(self, value: int):
+        self.app.startingSerial = value
+
+    @property
+    def suppressOpen(self) -> bool:
+        """If true, suppresses file open options dialogs."""
+        return self.app.suppressOpen
+
+    @suppressOpen.setter
+    def suppressOpen(self, value: bool):
+        self.app.suppressOpen = value
+
+    @property
+    def suppressProfile(self) -> bool:
+        """If true, suppresses color profile warnings."""
+        return self.app.suppressProfile
+
+    @suppressProfile.setter
+    def suppressProfile(self, value: bool):
+        self.app.suppressProfile = value
+
+    @property
+    def unixCompatible(self) -> bool:
+        """If true, the final file names are Unix compatible."""
+        return self.app.unixCompatible
+
+    @unixCompatible.setter
+    def unixCompatible(self, value: bool):
+        self.app.unixCompatible = value
+
+    @property
+    def windowsCompatible(self) -> bool:
+        """If true, the final file names are Windows compatible."""
+        return self.app.windowsCompatible
+
+    @windowsCompatible.setter
+    def windowsCompatible(self, value: bool):
+        self.app.windowsCompatible = value

photoshop/session.py

@@ -35,6 +35,7 @@
 from photoshop.api import ActionReference
 from photoshop.api import Application
 from photoshop.api import BMPSaveOptions
+from photoshop.api import BatchOptions
 from photoshop.api import CMYKColor
 from photoshop.api import EPSSaveOptions
 from photoshop.api import EventID
@@ -128,6 +129,7 @@ def __init__(
         self.EventID = EventID
         self.SolidColor = SolidColor
         self.TextItem = TextItem
+        self.BatchOptions = BatchOptions
 
         # The save options.
         self.GIFSaveOptions = GIFSaveOptions