Skip to content

batch_options

BatchOptions

Bases: Photoshop

Source code in photoshop/api/batch_options.py
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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

destination property writable

The type of destination for the processed files.

destinationFolder property writable

The folder location for the processed files. Valid only when ‘destination’ = folder.

errorFile property writable

The file in which to log errors encountered. To display errors on the screen and stop batch processing when errors occur, leave blank.

fileNaming: list property writable

A list of file naming options. Maximum: 6.

macintoshCompatible: bool property writable

If true, the final file names are Macintosh compatible.

overrideOpen: bool property writable

If true, overrides action open commands.

overrideSave: bool property writable

If true, overrides save as action steps with the specified destination.

startingSerial: int property writable

The starting serial number to use in naming files.

suppressOpen: bool property writable

If true, suppresses file open options dialogs.

suppressProfile: bool property writable

If true, suppresses color profile warnings.

unixCompatible: bool property writable

If true, the final file names are Unix compatible.

windowsCompatible: bool property writable

If true, the final file names are Windows compatible.


Last update: 2024-03-05
Created: 2024-03-05