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.

Sign up for GitHub

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

Jump to bottom

extract_adapters: plugin docs generation fails when hook is present #1644

Merged
merged 1 commit into from
Aug 31, 2023
Merged

extract_adapters: plugin docs generation fails when hook is present #1644

merged 1 commit into from
Aug 31, 2023

Conversation

timlehr
Copy link
Contributor

@timlehr timlehr commented Aug 1, 2023

Fixes #1643

Summarize your change.

This change cleans up the code a bit and makes sure it ignores hooks plugin types, as they are not getting the same output by plugin_info_map() needed for type formatting.

Reference associated tests.

test_plugin_documentation (test_serialized_schema.PluginDocumentationTester)

@codecov-commenter
Copy link

codecov-commenter commented Aug 1, 2023 •
edited
Loading

Codecov Report

Merging #1644 (798c9c0) into extract_adapters (186303f) will decrease coverage by 0.02%.
The diff coverage is 88.88%.

Additional details and impacted files

Impacted file tree graph

@@                 Coverage Diff                  @@
##           extract_adapters    #1644      +/-   ##
====================================================
- Coverage             74.60%   74.59%   -0.02%     
====================================================
  Files                   175      175              
  Lines                 11977    11980       +3     
  Branches               2732     2734       +2     
====================================================
+ Hits                   8936     8937       +1     
- Misses                 1292     1293       +1     
- Partials               1749     1750       +1
Flag Coverage Δ
py-unittests 74.59% <88.88%> (-0.02%) ⬇️

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

Files Changed Coverage Δ
...timelineio/console/autogen_plugin_documentation.py 64.40% <88.88%> (-0.82%) ⬇️

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 186303f...798c9c0. Read the comment docs.

@ssteinbach
Copy link
Collaborator

So the build error is legitimate. In the extract_adapters branch, rationalTime.h is missing a #include <cstdint>, from this commit in this PR by @JeanChristopheMorinPerso -- #1605 . I think a merge or a rebase would solve this. @apetrynet @reinecke how do you want to handle this? Could one of you merge or cherry pick into extract_adapters? After accepting that fix, then this PR should build correctly.

@apetrynet
Copy link
Contributor

If @reinecke doesn't beat me to it, I can attempt a cherry pick

@apetrynet apetrynet mentioned this pull request Aug 7, 2023
Merged
@jminor
Copy link
Collaborator

jminor commented Aug 7, 2023

@timlehr can you rebase onto the extract_adapters branch now that #1645 is landed?

@timlehr
Copy link
Contributor Author

timlehr commented Aug 26, 2023

@jminor rebased!

@apetrynet apetrynet merged commit ade1672 into AcademySoftwareFoundation:extract_adapters Aug 31, 2023
38 checks passed
reinecke pushed a commit that referenced this pull request Oct 6, 2023
@timlehr @reinecke
fixed doc-plugins-update when custom hooks are in environment (#1644)
292a3d4 
Signed-off-by: Tim Lehr <[email protected]>
reinecke pushed a commit that referenced this pull request Oct 6, 2023
@timlehr @reinecke
fixed doc-plugins-update when custom hooks are in environment (#1644)
16fdad9 
Signed-off-by: Tim Lehr <[email protected]>
@apetrynet apetrynet mentioned this pull request Oct 21, 2023
Closed
@reinecke reinecke added this to the Public Beta 17 milestone Mar 25, 2024
reinecke pushed a commit that referenced this pull request Apr 4, 2024
@timlehr @reinecke
fixed doc-plugins-update when custom hooks are in environment (#1644)
4960592 
Signed-off-by: Tim Lehr <[email protected]>
reinecke pushed a commit that referenced this pull request Apr 12, 2024
@timlehr @reinecke
fixed doc-plugins-update when custom hooks are in environment (#1644)
feac606 
Signed-off-by: Tim Lehr <[email protected]>
reinecke pushed a commit that referenced this pull request Apr 12, 2024
@timlehr @reinecke
fixed doc-plugins-update when custom hooks are in environment (#1644)
0d91688 
Signed-off-by: Tim Lehr <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
reinecke pushed a commit that referenced this pull request Jun 12, 2024
@timlehr @reinecke
fixed doc-plugins-update when custom hooks are in environment (#1644)
3655a1d 
Signed-off-by: Tim Lehr <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
reinecke pushed a commit that referenced this pull request Jun 12, 2024
@timlehr @reinecke
fixed doc-plugins-update when custom hooks are in environment (#1644)
2313459 
Signed-off-by: Tim Lehr <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
reinecke pushed a commit that referenced this pull request Jun 12, 2024
@timlehr @reinecke
fixed doc-plugins-update when custom hooks are in environment (#1644)
14e66cd 
Signed-off-by: Tim Lehr <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
reinecke added a commit that referenced this pull request Jun 12, 2024
@reinecke @apetrynet
@markreidvfx @rosborne132 @timlehr
Remove non-core adapters (#1725)
e10fdd2 
* Prepare plugin detection for removal of the cmx_3600 adapter (#1488)

* add "extract_adapters" to CI triggers
* use "otiod" as override example

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Extracted CMX3600 adapter and related sample data and tests (#1487)

* Removed the cmx_3600 adapter
* Removed sample data only used by the cmx_3600 adapter
* Add "extract_adapters" to CI triggers
* otioz test called for an edl we removed. Replaced with an otio file
* Converted screening_example.edl to screening_example.otio and used it in tests
* Removed other adapter suffixes from plugin tests as they belong to adapters soon to be extracted
* Autogenerated docs for CMX3600 removed

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Extract AAF Adapter from OTIO core and establish separate git repo (#1348)

* Remove AAF adapter
* Add Note about the AAF adapter being moved

Signed-off-by: Mark Reid <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove fcp adapter (#1501)

* removing the fcp adapter and it's test files
* replaced premiere_example.xml with premiere_example.otio to pass console tests.
* updated auto generated docs

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove svg adapter (#1502)

* removed svg adapter and related test files
* updated auto documentation

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove maya sequencer adapter related files (#1520)

* Remove maya adapter related files
* Update docs

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove fcp x xml adapter related files (#1529)

* remove fcp x xml adapter files
* update docs

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* remove hls adapter related files (#1535)

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* remove ale adapter related files (#1536)

* remove ale adapter related files

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove burnins adapter related files (#1537)

* extract burnin files
* remove test

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* extract xges adapter files (#1538)

* extract xges adapter files

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove the remains of "contrib"

* Removed the "contrib" directory tree and all references to the contrib adapters.
* Plugin system, setup and auto doc scripts no longer rely on contrib files.
* Also removed some entries on other adapters left behind in the adapters.md file.
* add README_contrib.md to the manifest

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* fixed `doc-plugins-update` when custom hooks are in environment (#1644)

Signed-off-by: Tim Lehr <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* added support for pathlib.Path filepath arguments for adapter IO functions (#1704)

Signed-off-by: Tim Lehr <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Removed orphaned FCP XML adapter post-rebase.

Signed-off-by: Eric Reinecke <[email protected]>

* Update README.md to point users to the adapter repos

Co-authored-by: Daniel Flehner Heen <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Updated documentation about adapters to better reflect the current landscape

Signed-off-by: Eric Reinecke <[email protected]>

* Removed contrib plugin manifest from package data

Signed-off-by: Eric Reinecke <[email protected]>

* Removed extract_adapters branch from CI references

Signed-off-by: Eric Reinecke <[email protected]>

---------

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Mark Reid <[email protected]>
Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Tim Lehr <[email protected]>
Co-authored-by: Daniel Flehner Heen <[email protected]>
Co-authored-by: Mark Reid <[email protected]>
Co-authored-by: Rob Osborne <[email protected]>
Co-authored-by: Tim Lehr <[email protected]>
darbyjohnston pushed a commit to darbyjohnston/OpenTimelineIO that referenced this pull request Jun 14, 2024
@reinecke @apetrynet
@markreidvfx @rosborne132 @timlehr @darbyjohnston
Remove non-core adapters (AcademySoftwareFoundation#1725)
15eac94 
* Prepare plugin detection for removal of the cmx_3600 adapter (AcademySoftwareFoundation#1488)

* add "extract_adapters" to CI triggers
* use "otiod" as override example

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Extracted CMX3600 adapter and related sample data and tests (AcademySoftwareFoundation#1487)

* Removed the cmx_3600 adapter
* Removed sample data only used by the cmx_3600 adapter
* Add "extract_adapters" to CI triggers
* otioz test called for an edl we removed. Replaced with an otio file
* Converted screening_example.edl to screening_example.otio and used it in tests
* Removed other adapter suffixes from plugin tests as they belong to adapters soon to be extracted
* Autogenerated docs for CMX3600 removed

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Extract AAF Adapter from OTIO core and establish separate git repo (AcademySoftwareFoundation#1348)

* Remove AAF adapter
* Add Note about the AAF adapter being moved

Signed-off-by: Mark Reid <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove fcp adapter (AcademySoftwareFoundation#1501)

* removing the fcp adapter and it's test files
* replaced premiere_example.xml with premiere_example.otio to pass console tests.
* updated auto generated docs

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove svg adapter (AcademySoftwareFoundation#1502)

* removed svg adapter and related test files
* updated auto documentation

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove maya sequencer adapter related files (AcademySoftwareFoundation#1520)

* Remove maya adapter related files
* Update docs

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove fcp x xml adapter related files (AcademySoftwareFoundation#1529)

* remove fcp x xml adapter files
* update docs

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* remove hls adapter related files (AcademySoftwareFoundation#1535)

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* remove ale adapter related files (AcademySoftwareFoundation#1536)

* remove ale adapter related files

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove burnins adapter related files (AcademySoftwareFoundation#1537)

* extract burnin files
* remove test

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* extract xges adapter files (AcademySoftwareFoundation#1538)

* extract xges adapter files

Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Remove the remains of "contrib"

* Removed the "contrib" directory tree and all references to the contrib adapters.
* Plugin system, setup and auto doc scripts no longer rely on contrib files.
* Also removed some entries on other adapters left behind in the adapters.md file.
* add README_contrib.md to the manifest

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* fixed `doc-plugins-update` when custom hooks are in environment (AcademySoftwareFoundation#1644)

Signed-off-by: Tim Lehr <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* added support for pathlib.Path filepath arguments for adapter IO functions (AcademySoftwareFoundation#1704)

Signed-off-by: Tim Lehr <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Removed orphaned FCP XML adapter post-rebase.

Signed-off-by: Eric Reinecke <[email protected]>

* Update README.md to point users to the adapter repos

Co-authored-by: Daniel Flehner Heen <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>

* Updated documentation about adapters to better reflect the current landscape

Signed-off-by: Eric Reinecke <[email protected]>

* Removed contrib plugin manifest from package data

Signed-off-by: Eric Reinecke <[email protected]>

* Removed extract_adapters branch from CI references

Signed-off-by: Eric Reinecke <[email protected]>

---------

Signed-off-by: apetrynet <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Eric Reinecke <[email protected]>
Signed-off-by: Mark Reid <[email protected]>
Signed-off-by: rosborne132 <[email protected]>
Signed-off-by: Tim Lehr <[email protected]>
Co-authored-by: Daniel Flehner Heen <[email protected]>
Co-authored-by: Mark Reid <[email protected]>
Co-authored-by: Rob Osborne <[email protected]>
Co-authored-by: Tim Lehr <[email protected]>
Signed-off-by: Darby Johnston <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jminor jminor jminor approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Public Beta 17
Development

Successfully merging this pull request may close these issues.
6 participants
@timlehr @codecov-commenter @ssteinbach @apetrynet @jminor @reinecke