Page Comparison

...

In order to find the hook files the file name must match exactly. Please see list below.
The example scripts can be found here:
https://github.com/das-element/resources/tree/main/scripts/hooks/examples

The software follows this order looking for Python Hook files.

1. directory defined in the $DASELEMENT_

...

1. HOOKS environment variable

2. directory defined in the $DASELEMENT_RESOURCES/scripts/hooks environment variable

3. your local .das-element folder (for Linux: ~/.das-element/scripts/hooks or for Windows %homepath%/.das-element/scripts/hooks)

Pre Render Hook

The input is the resolver data dictionary which will be used to resolve the path pattern. You can modify it here before the transcoding task gets processed.

...

https://github.com/das-element/resources/blob/main/scripts/hooks/examples/shotgrid/pre_export.py

Troubleshooting

Logger inside python file

Since version 2.1.2 you can directly access the logger inside the hook files.

def main(*args, logger=none):
    items = args[0]

    # use the Das Element logger
    # will log to  ~/.das-element/logs/
    
    logger.warning('This is a warning!')
    
    return items

if __name__ == '__main__':
    main(sys.argv[1:])

Print inside python file

To output data to the console when customizing the hook files use a print statement inside the main function. The input args will be a list of data.

To get a better idea what’s happening inside the hook files you can follow these steps:

1. inside the Python hook file you can add print statements

   Code Block
   print(item) print(item['path'])

2. start a terminal/command prompt

3. activate the debug mode - set the environment variable

   Code Block
   # Linux/MacOS export DASELEMENT_LOG_LEVEL=debug # Windows set DASELEMENT_LOG_LEVEL=debug

4. now run the software via the command line

   Code Block
   # Linux /opt/das-element-1.2.1/das-element-1.2.1 # MacOS /Applications/das-element-1.2.1.app/Contents/MacOS/das-element-1.2.1 # Windows "C:\Program Files\das element\das element 1.2.1\das element 1.2.1.exe"

5. If you make changes to the hook file you will need to restart the application to re-read these changes

Example for pre_load_ingest.py

import logging

def main(*args, logger=none):
    items = args[0]

    logger.warning('This is a warning!') # <- use the Das Element logger (~/.das-element/logs/)

    logging.warning('This is a warning!') # <- use the default logging module

    for item in items:
      print(item) # <- this print() will be output to the console
    return items

if __name__ == '__main__':
    main(sys.argv[1:])