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

Added support for pathlib.Path filepath arguments for adapter IO functions #1704

Merged
merged 1 commit into from
Feb 29, 2024
Merged

Added support for pathlib.Path filepath arguments for adapter IO functions #1704

merged 1 commit into from
Feb 29, 2024

Conversation

timlehr
Copy link
Contributor

@timlehr timlehr commented Feb 29, 2024

Simple little PR: Currently the read_from_file, write_to_file of opentimelineio.adapter do not support pathlib.Path objects for their filepath argument. This addresses this.

JeanChristopheMorinPerso
JeanChristopheMorinPerso reviewed Feb 29, 2024
View reviewed changes
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's recommended to use os.fspath to convert a Path object into a string.

src/py-opentimelineio/opentimelineio/adapters/__init__.py Outdated Show resolved Hide resolved
src/py-opentimelineio/opentimelineio/adapters/__init__.py Outdated Show resolved Hide resolved
@timlehr
added support for pathlib.Path filepath arguments for adapter IO func…
e1dd154 
…tions

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>
@timlehr
Copy link
Contributor Author

timlehr commented Feb 29, 2024

@JeanChristopheMorinPerso Thanks, I changed the code accordingly!

JeanChristopheMorinPerso
JeanChristopheMorinPerso approved these changes Feb 29, 2024
View reviewed changes
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@meshula meshula merged commit 134b9b2 into AcademySoftwareFoundation:extract_adapters Feb 29, 2024
39 checks passed
meshula
meshula reviewed Feb 29, 2024
View reviewed changes
Copy link
Collaborator

@meshula meshula left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

reinecke pushed a commit that referenced this pull request Apr 4, 2024
@timlehr @reinecke
added support for pathlib.Path filepath arguments for adapter IO func…
38b8edb 
…tions (#1704)

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>
reinecke pushed a commit that referenced this pull request Apr 12, 2024
@timlehr @reinecke
added support for pathlib.Path filepath arguments for adapter IO func…
fbe098e 
…tions (#1704)

Signed-off-by: Tim Lehr <tim.lehr@disneyanimation.com>
reinecke pushed a commit that referenced this pull request Apr 12, 2024
@timlehr @reinecke
added support for pathlib.Path filepath arguments for adapter IO func…
7f09945 
…tions (#1704)

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
@timlehr @reinecke
added support for pathlib.Path filepath arguments for adapter IO func…
f955573 
…tions (#1704)

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
@timlehr @reinecke
added support for pathlib.Path filepath arguments for adapter IO func…
f374158 
…tions (#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>
reinecke pushed a commit that referenced this pull request Jun 12, 2024
@timlehr @reinecke
added support for pathlib.Path filepath arguments for adapter IO func…
2168022 
…tions (#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>
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 <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>
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 <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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@meshula meshula meshula left review comments

@JeanChristopheMorinPerso JeanChristopheMorinPerso JeanChristopheMorinPerso approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@timlehr @meshula @JeanChristopheMorinPerso