Added support for custom adapter hooks

[timlehr]

Summarize your change.

Rebased PR #1711

Required by OpenTimelineIO/otio-aaf-adapter#43

This adds support for attributing custom hooks to adapters and executing them with hook_function_argument_map being passed along through the adapter IO functions.

Describe the reason for the change.

I added two custom hooks to the OTIO AAF adapter (OpenTimelineIO/otio-aaf-adapter#43), allowing for embedding of media essence into the resulting AAF. This was needed to facilitate just-in-time DNXHR transcoding of the media for the AAF creation and adding a certain level of control and flexibility to the feature.

These features to the core are required in order to properly pass the hook argument map along to potential custom hooks run by the adapter. I tried to work with _FEATURE_MAP instead of creating a new version of the Adapter schema in order to minimize the impact of this change, while adding the necessary changes to facilitate custom hooks for adapters.

Reference associated tests.

tests/test_adapter_plugin.py
tests/test_hooks_plugins.py

[timlehr]

@ssteinbach I finally had some time to revive #1711. Please have a look when you find some time. Thank you! 🙏

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 77.35849% with 12 lines in your changes missing coverage. Please review.

Project coverage is 84.76%. Comparing base (c0e97b0) to head (31053e1).
Report is 42 commits behind head on main.

Files with missing lines	Patch %	Lines
...-opentimelineio/opentimelineio/adapters/adapter.py	60.00%	5 Missing and 3 partials ⚠️
...ntimelineio/opentimelineio/console/otiopluginfo.py	20.00%	2 Missing and 2 partials ⚠️

❌ Your changes status has failed because you have indirect coverage changes. Learn more about Unexpected Coverage Changes and reasons for indirect coverage changes.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1801      +/-   ##
==========================================
+ Coverage   84.11%   84.76%   +0.64%     
==========================================
  Files         198      177      -21     
  Lines       22241    12788    -9453     
  Branches     4687     1190    -3497     
==========================================
- Hits        18709    10840    -7869     
+ Misses       2610     1765     -845     
+ Partials      922      183     -739     

Flag	Coverage Δ
py-unittests	84.76% <77.35%> (+0.64%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...sts/baselines/custom_adapter_hookscript_example.py	100.00% <100.00%> (ø)
tests/baselines/example.py	100.00% <100.00%> (ø)
tests/test_adapter_plugin.py	91.27% <100.00%> (+3.43%)	⬆️
tests/test_hooks_plugins.py	98.01% <100.00%> (+0.29%)	⬆️
...ntimelineio/opentimelineio/console/otiopluginfo.py	64.60% <20.00%> (-10.63%)	⬇️
...-opentimelineio/opentimelineio/adapters/adapter.py	75.43% <60.00%> (-13.57%)	⬇️

... and 125 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f62b332...31053e1. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[timlehr]

@ssteinbach @jminor Finally rebased this again 👍

[ssteinbach]

The code looks good. This could use a note in the hook scripts documentation:

https://opentimelineio.readthedocs.io/en/latest/tutorials/write-a-hookscript.html

and adding it to the pluginfo script as well would be nice. I think all you need to do is add a "hooks" field to the plugin feature map:

OpenTimelineIO/src/py-opentimelineio/opentimelineio/plugins/python_plugin.py

Line 77 in 9deff1d

def plugin_info_map(self):

[timlehr]

@ssteinbach otiopluginfo now prints the custom adapter names. Example for the OTIO AAF adapter:

adapters:
  AAF
    doc (short): OpenTimelineIO Advanced Authoring Format (AAF) Adapter
    path: /Users/tlehr/dev/otio-aaf-adapter/src/otio_aaf_adapter/adapters/advanced_authoring_format.py
    from manifest: /Users/tlehr/dev/otio-aaf-adapter/src/otio_aaf_adapter/plugin_manifest.json
    explicit supported features:
      read_from_file args: ['filepath', 'simplify', 'transcribe_log', 'attach_markers', 'bake_keyframed_properties']
      write_to_file args: ['input_otio', 'filepath', 'prefer_file_mob_id', 'use_empty_mob_ids', 'embed_essence', 'create_edgecode']
      adapter hooks: ['otio_aaf_post_read_transcribe', 'otio_aaf_post_write_transcribe', 'otio_aaf_pre_read_transcribe', 'otio_aaf_pre_write_transcribe']

[ssteinbach]

LGTM! Thanks @timlehr.

Did you want to add any notes to the documentation this feature?

https://opentimelineio.readthedocs.io/en/latest/tutorials/write-a-hookscript.html

If you want to do that as a separate step thats ok too, but probably good to add a note about it there for future discoverability.

[timlehr]

Thanks @ssteinbach! I forgot about that. I now added some documentation!

[ssteinbach]

Looks great, thanks!