comet.batch

The comet.batch module provides access to document batch processing functionality

Methods

comet.batch.start()

Start the batch process.

Returns:

None

Raises:

CometError – When batch is already running

Available:

Illustrator®

CScript:

batch::start

comet.batch.stop()

Stop the batch process.

Returns:

None

Raises:

CometError – When batch is not running

Available:

Illustrator®

CScript:

batch::stop

comet.batch.isRunning()

Return whether the batch process is running

Returns:

Whether the batch process is running

Return type:

bool

Available:

Illustrator®

CScript:

batch::get_running

comet.batch.setStart(hours, minutes)

Set the start time for any subsequent calls to start()

Parameters:

  • hours (int) – The start time hours (0-23)

  • minutes (int) – The start time minutes (0-59)

Returns:

None

Raises:

  • TypeError – When parameter types are invalid

  • ValueError – When parameters hours or minutes have invalid values

Available:

Illustrator®

CScript:

batch::set_start

comet.batch.getStart()

Fetch the next set starttime for the batch process

Returns:

Tuple of [hours, minutes].

Values are (-1, -1) if no start time is set

Return type:

tuple[int, int]

Available:

Illustrator®

CScript:

batch::get_start

comet.batch.setInverval(interval)

Set the interval between two batch actions

Parameters:

interval (int) –

The interval from the following values:

  • 0: 1 Second

  • 1: 2 Seconds

  • 2: 5 Seconds

  • 3: 10 Seconds

  • 4: 30 Seconds

  • 5: 1 Minute

  • 6: 2 Minutes

  • 7: 5 Minutes

  • 8: 15 Minutes

  • 9: 30 Minutes

  • 10: 1 Hour

  • 11: 2 Hours

  • 12: 4 Hours

  • 13: 6 Hours

  • 14: 12 Hours

  • 15: 24 Hours

Returns:

None

Raises:

  • TypeError – When parameter types are invalid

  • ValueError – When parameter interval has invalid value

Available:

Illustrator®

CScript:

batch::set_interval

comet.batch.setInHotFolder(path)

Set the input hot folder for the batch mode

Parameters:

path (str) – Full folder path to the input folder

Returns:

None

Raises:
Available:

Illustrator®

CScript:

batch::set_hotfolder_in

comet.batch.getInHotFolder()

Fetch the input hot folder

Returns:

The full path to the input folder, or empty string if not set

Return type:

str

Available:

Illustrator®

CScript:

batch::get_hotfolder_in

comet.batch.setOutHotFolder(path)

Set the output hot folder for the batch mode

Parameters:

path (str) – Full folder path to the output folder

Returns:

None

Raises:
Available:

Illustrator®

CScript:

batch::set_hotfolder_out

comet.batch.getOutHotFolder()

Fetch the output hot folder

Returns:

The full path to the output folder, or empty string if not set

Return type:

str

Available:

Illustrator®

CScript:

batch::get_hotfolder_out