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

Initial support for new commands added in 2023.9 #24

Merged
merged 6 commits into from
Apr 11, 2024

Conversation

noerw
Copy link
Contributor

@noerw noerw commented Nov 30, 2023

Description of this PR:
Initial work for support of new commands added in Pro Tools 2023.9.

Scope:
PTSL Coverage


I started work on this assuming it would just be a matter of calling build_proto.sh, but noticed there is quite a lot of manual steps - so I just started the work of adding the new functions for now.
The changes are largely untested for now, I'm sending this PR at this stage to get feedback wether I'm missing something about the process.
The steps I took are outlined in the commit messages.


open questions about some upstream changes:

  • 2023.9 deprecated a couple fields - how should this be handled in py-ptsl wrt to backwards compatibility and documentation?
  • 2023.9 introduced a new pagination mechanism - any preferences on how this should be handled in py-ptsl?

Copy link

codecov bot commented Nov 30, 2023

Codecov Report

Attention: Patch coverage is 80.85106% with 9 lines in your changes are missing coverage. Please review.

Project coverage is 89.56%. Comparing base (a6145b0) to head (35ad326).
Report is 5 commits behind head on master.

❗ Current head 35ad326 differs from pull request most recent head 835d148. Consider uploading reports for the commit 835d148 to get more accurate results

Files Patch % Lines
ptsl/engine.py 30.76% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master      #24      +/-   ##
==========================================
+ Coverage   89.48%   89.56%   +0.07%     
==========================================
  Files          80       86       +6     
  Lines        1398     1437      +39     
==========================================
+ Hits         1251     1287      +36     
- Misses        147      150       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@iluvcapra
Copy link
Owner

I've switched on the CI tests for this branch. Take a look at your changes and make sure everything is passing flake8 and then I'll review everything. The new engine methods are looking good though!

@iluvcapra
Copy link
Owner

iluvcapra commented Nov 30, 2023

Regarding these:

  • 2023.9 deprecated a couple fields - how should this be handled in py-ptsl wrt to backwards compatibility and documentation?

For now all I've been doing is keeping track of which releases work for which version of Pro Tools and if someone needs support for an older version, they can pin the older version of py-ptsl in their environment. Unfortunately each PTSL version is introducing breaking changes and Avid isn't changing the PTSLVersion, and they don't provide a method for interrogating the Pro Tools version itself so it's very challenging to provide support for a range of versions.

  • 2023.9 introduced a new pagination mechanism - any preferences on how this should be handled in py-ptsl?

My feeling is, for now, on the Engine class it should just be ignored, make the limit extremely high and just let the response be huge, for 99% of cases that will work. If someone needed pagination, there should be separate methods on the Engine class to provide paginating methods, and these should return cursor objects that are Iterables.

@iluvcapra
Copy link
Owner

Hey just checking in on this, I might have a little time this week if you'd like some help!

@iluvcapra iluvcapra merged commit 835d148 into iluvcapra:master Apr 11, 2024
2 of 10 checks passed
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