search

AcademySoftwareFoundation / OpenTimelineIO

Open Source API and interchange format for editorial timeline information.
http://opentimeline.io
Apache License 2.0
1.47k stars 294 forks source link

Updated Effect schema with enabled flag #1798

Closed fschleich closed 1 month ago

fschleich commented 2 months ago

This PR addresses #1187 - Add enabled Flag to Effects

If there is an associated issue, link it in the form:

Fixes #1187

Summarize your change.

Reference associated tests.

linux-foundation-easycla[bot] commented 2 months ago

CLA Signed

The committers listed above are authorized under a signed CLA.

fschleich commented 2 months ago

I need some guidance on how to correctly update CORE_VERSION_MAP.cpp, as running make version-map-update results in the below error. Manually setting the version to 0.18.0 results in the failed tests, e.g. here. Would appreciate any pointers or guidance!

(.venv) fschleich@Florians-MacBook-Pro OpenTimelineIO % make version-map-update
updating the CORE_VERSION_MAP...
Traceback (most recent call last):
  File "/Users/fschleich/Developer/github/fschleich/OpenTimelineIO/src/py-opentimelineio/opentimelineio/console/autogen_version_map.py", line 116, in <module>
    main()
  File "/Users/fschleich/Developer/github/fschleich/OpenTimelineIO/src/py-opentimelineio/opentimelineio/console/autogen_version_map.py", line 86, in main
    args = _parsed_args()
           ^^^^^^^^^^^^^^
  File "/Users/fschleich/Developer/github/fschleich/OpenTimelineIO/src/py-opentimelineio/opentimelineio/console/autogen_version_map.py", line 38, in _parsed_args
    default=otio.__version__,
            ^^^^^^^^^^^^^^^^
AttributeError: module 'opentimelineio' has no attribute '__version__'
make: *** [version-map-update] Error 1
jminor commented 1 month ago

A while back when we added enabled to Clip, we were able to do so without increasing the schema version because the new property has a clear fallback value (true). I think you can do the same here for Effect. Here's the PR for Clip for reference: https://github.com/AcademySoftwareFoundation/OpenTimelineIO/pull/1175

codecov-commenter commented 1 month ago

Codecov Report

Attention: Patch coverage is 94.73684% with 1 line in your changes missing coverage. Please review.

Project coverage is 81.62%. Comparing base (c0e97b0) to head (c2ab22f). Report is 23 commits behind head on main.

Files with missing lines Patch % Lines
src/opentimelineio/effect.h 50.00% 1 Missing :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798/graphs/tree.svg?width=650&height=150&src=pr&token=mfnfUB4h7u&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation)](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) ```diff @@ Coverage Diff @@ ## main #1798 +/- ## ========================================== - Coverage 84.11% 81.62% -2.50% ========================================== Files 198 176 -22 Lines 22241 12350 -9891 Branches 4687 3036 -1651 ========================================== - Hits 18709 10081 -8628 + Misses 2610 1730 -880 + Partials 922 539 -383 ``` | [Flag](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) | Coverage Δ | | |---|---|---| | [py-unittests](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) | `81.62% <94.73%> (-2.50%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files with missing lines](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) | Coverage Δ | | |---|---|---| | [src/opentimelineio/effect.cpp](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?src=pr&el=tree&filepath=src%2Fopentimelineio%2Feffect.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2VmZmVjdC5jcHA=) | `93.33% <100.00%> (+1.66%)` | :arrow_up: | | [...entimelineio-bindings/otio\_serializableObjects.cpp](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?src=pr&el=tree&filepath=src%2Fpy-opentimelineio%2Fopentimelineio-bindings%2Fotio_serializableObjects.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL3B5LW9wZW50aW1lbGluZWlvL29wZW50aW1lbGluZWlvLWJpbmRpbmdzL290aW9fc2VyaWFsaXphYmxlT2JqZWN0cy5jcHA=) | `93.69% <100.00%> (-0.17%)` | :arrow_down: | | [.../py-opentimelineio/opentimelineio/schema/effect.py](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?src=pr&el=tree&filepath=src%2Fpy-opentimelineio%2Fopentimelineio%2Fschema%2Feffect.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL3B5LW9wZW50aW1lbGluZWlvL29wZW50aW1lbGluZWlvL3NjaGVtYS9lZmZlY3QucHk=) | `100.00% <ø> (ø)` | | | [tests/test\_effect.py](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?src=pr&el=tree&filepath=tests%2Ftest_effect.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-dGVzdHMvdGVzdF9lZmZlY3QucHk=) | `96.42% <100.00%> (+0.35%)` | :arrow_up: | | [tests/test\_json\_backend.py](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?src=pr&el=tree&filepath=tests%2Ftest_json_backend.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-dGVzdHMvdGVzdF9qc29uX2JhY2tlbmQucHk=) | `93.65% <100.00%> (+0.20%)` | :arrow_up: | | [src/opentimelineio/effect.h](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?src=pr&el=tree&filepath=src%2Fopentimelineio%2Feffect.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2VmZmVjdC5o) | `80.00% <50.00%> (-20.00%)` | :arrow_down: | ... and [65 files with indirect coverage changes](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation). Last update [5184c36...c2ab22f](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1798?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation).