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

timlehr · 2023-08-01T22:56:53Z

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 · 2023-08-01T23:09:43Z

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

@@                 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 · 2023-08-07T15:51:24Z

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 · 2023-08-07T16:32:12Z

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

jminor · 2023-08-07T17:36:44Z

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

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>

timlehr · 2023-08-26T00:43:02Z

@jminor rebased!

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com>

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com>

* 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 <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * 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 <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * 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 <mindmark@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * 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 <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Remove svg adapter (#1502) * removed svg adapter and related test files * updated auto documentation Signed-off-by: apetrynet <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Remove maya sequencer adapter related files (#1520) * Remove maya adapter related files * Update docs Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Remove fcp x xml adapter related files (#1529) * remove fcp x xml adapter files * update docs Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * remove hls adapter related files (#1535) Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * remove ale adapter related files (#1536) * remove ale adapter related files Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Remove burnins adapter related files (#1537) * extract burnin files * remove test Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * extract xges adapter files (#1538) * extract xges adapter files Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * 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 <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * fixed `doc-plugins-update` when custom hooks are in environment (#1644) Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * added support for pathlib.Path filepath arguments for adapter IO functions (#1704) Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Removed orphaned FCP XML adapter post-rebase. Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Update README.md to point users to the adapter repos Co-authored-by: Daniel Flehner Heen <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> * Updated documentation about adapters to better reflect the current landscape Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Removed contrib plugin manifest from package data Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Removed extract_adapters branch from CI references Signed-off-by: Eric Reinecke <ereinecke@netflix.com> --------- Signed-off-by: apetrynet <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> Signed-off-by: Mark Reid <mindmark@gmail.com> Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Co-authored-by: Daniel Flehner Heen <flehnerheener@gmail.com> Co-authored-by: Mark Reid <mindmark@gmail.com> Co-authored-by: Rob Osborne <ozborne132@gmail.com> Co-authored-by: Tim Lehr <timlehr@users.noreply.github.com>

* 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 <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * 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 <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * 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 <mindmark@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * 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 <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Remove svg adapter (AcademySoftwareFoundation#1502) * removed svg adapter and related test files * updated auto documentation Signed-off-by: apetrynet <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Remove maya sequencer adapter related files (AcademySoftwareFoundation#1520) * Remove maya adapter related files * Update docs Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Remove fcp x xml adapter related files (AcademySoftwareFoundation#1529) * remove fcp x xml adapter files * update docs Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * remove hls adapter related files (AcademySoftwareFoundation#1535) Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * remove ale adapter related files (AcademySoftwareFoundation#1536) * remove ale adapter related files Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Remove burnins adapter related files (AcademySoftwareFoundation#1537) * extract burnin files * remove test Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * extract xges adapter files (AcademySoftwareFoundation#1538) * extract xges adapter files Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * 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 <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * fixed `doc-plugins-update` when custom hooks are in environment (AcademySoftwareFoundation#1644) Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * added support for pathlib.Path filepath arguments for adapter IO functions (AcademySoftwareFoundation#1704) Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Removed orphaned FCP XML adapter post-rebase. Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Update README.md to point users to the adapter repos Co-authored-by: Daniel Flehner Heen <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> * Updated documentation about adapters to better reflect the current landscape Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Removed contrib plugin manifest from package data Signed-off-by: Eric Reinecke <ereinecke@netflix.com> * Removed extract_adapters branch from CI references Signed-off-by: Eric Reinecke <ereinecke@netflix.com> --------- Signed-off-by: apetrynet <flehnerheener@gmail.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com> Signed-off-by: Eric Reinecke <ereinecke@netflix.com> Signed-off-by: Mark Reid <mindmark@gmail.com> Signed-off-by: rosborne132 <ozborne132@gmail.com> Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Co-authored-by: Daniel Flehner Heen <flehnerheener@gmail.com> Co-authored-by: Mark Reid <mindmark@gmail.com> Co-authored-by: Rob Osborne <ozborne132@gmail.com> Co-authored-by: Tim Lehr <timlehr@users.noreply.github.com> Signed-off-by: Darby Johnston <darbyjohnston@yahoo.com>

timlehr force-pushed the fix_docs_gen_timlehr branch from cf3911e to f402941 Compare August 1, 2023 23:05

apetrynet mentioned this pull request Aug 7, 2023

Cherry picked commit to unblock PR #1644 #1645

Merged

fixed doc-plugins-update when custom hooks are in environment

798c9c0

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>

timlehr force-pushed the fix_docs_gen_timlehr branch from f402941 to 798c9c0 Compare August 26, 2023 00:42

jminor approved these changes Aug 31, 2023

View reviewed changes

apetrynet merged commit ade1672 into AcademySoftwareFoundation:extract_adapters Aug 31, 2023

reinecke pushed a commit that referenced this pull request Oct 6, 2023

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

292a3d4

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>

reinecke pushed a commit that referenced this pull request Oct 6, 2023

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

16fdad9

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>

apetrynet mentioned this pull request Oct 21, 2023

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

Closed

reinecke added this to the Public Beta 17 milestone Mar 25, 2024

reinecke pushed a commit that referenced this pull request Apr 4, 2024

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

4960592

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>

reinecke pushed a commit that referenced this pull request Apr 12, 2024

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

feac606

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>

reinecke pushed a commit that referenced this pull request Apr 12, 2024

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

0d91688

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com>

reinecke pushed a commit that referenced this pull request Jun 12, 2024

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

3655a1d

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com> Signed-off-by: Eric Reinecke <reinecke.eric@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

Uh oh!

timlehr commented Aug 1, 2023

Uh oh!

codecov-commenter commented Aug 1, 2023 •

edited

Loading

Uh oh!

ssteinbach commented Aug 7, 2023

Uh oh!

apetrynet commented Aug 7, 2023

Uh oh!

jminor commented Aug 7, 2023

Uh oh!

timlehr commented Aug 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

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

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

Uh oh!

Conversation

timlehr commented Aug 1, 2023

Uh oh!

codecov-commenter commented Aug 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ssteinbach commented Aug 7, 2023

Uh oh!

apetrynet commented Aug 7, 2023

Uh oh!

jminor commented Aug 7, 2023

Uh oh!

timlehr commented Aug 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

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

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

codecov-commenter commented Aug 1, 2023 •

edited

Loading