Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Loft arguments out of kwargs #56

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ssteinbach
Copy link
Member

@ssteinbach ssteinbach commented Jan 27, 2025

  • Lofting the arguments out of kwargs and into the function signatures makes it easier to discover what controls are available to the adapter
  • because otiopluginfo uses reflection to discover arguments, non-kwargs arguments will show up in the output of otiopluginfo if they are lofted out:
❯ otiopluginfo AAF -p adapters
Manifests loaded:
  ~/workspace/otio-aaf-adapter/src/otio_aaf_adapter/plugin_manifest.json
  ~/opt/miniconda3/envs/otio.test.py38/lib/python3.8/site-packages/opentimelineio/adapters/builtin_adapters.plugin_manifest.json

adapters:
  AAF
    doc (short): OpenTimelineIO Advanced Authoring Format (AAF) Adapter
    path: ~/Documents/workspace/otio-aaf-adapter/src/otio_aaf_adapter/adapters/advanced_authoring_format.py
    from manifest: ~/Documents/workspace/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']

* for users that want to know what commandline options are available,
  lofting them out of kwargs makes them visible in `otiopluginfo`
  output.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants