Merge pull request #13 from iluvcapra/testing

Testing

.github/workflows/lint_and_pytest.yml

@@ -31,9 +31,9 @@ jobs:
  python -m pip install --upgrade pip
  pip install flake8 pytest
  python -m pip install -e .
-#  - name: Lint with flake8
-#  run: |
-#  flake8 . 
+ - name: Lint with flake8
+ run: |
+ flake8 . 
  - name: Test with pytest
  run: |
  pytest

ptsl/client.py

@@ -101,8 +101,9 @@ def __init__(self,
 
  ..note:: If `certificate_path` is given, the legacy AuthorizeConnection
  method will be used for setting up the connection session. If it is
- `None`, then `company_name` and `application_name` will be used with
- the RegisterConnection method (available since Pro Tools 2023.3).
+ `None`, then `company_name` and `application_name` will be used
+ with the RegisterConnection method (available since Pro Tools
+ 2023.3).
  """
 
  self.channel = grpc.insecure_channel(address)
@@ -122,7 +123,8 @@ def __init__(self,
 
  else:
  raise AssertionError(
- "company_name and application_name parameters were not given")
+ "company_name and application_name parameters were " +
+ "not given")
 
  self.is_open = True
 
@@ -276,8 +278,9 @@ def _primitive_register_connection(self, company_name: str,
  This method is called automatically by the initializer.
  """
 
- req = pt.RegisterConnectionRequestBody(company_name=company_name,
- application_name=application_name)
+ req = pt.RegisterConnectionRequestBody(
+ company_name=company_name,
+ application_name=application_name)
 
  req_json = json_format.MessageToJson(req,
  preserving_proto_field_name=True)
@@ -297,7 +300,8 @@ def _primitive_register_connection(self, company_name: str,
 
  def _primitive_authorize_connection(self, api_key_path) -> Optional[str]:
  """
- (Deprecated) Authorizes the client's connection to the Pro Tools RPC server.
+ (Deprecated) Authorizes the client's connection to the Pro Tools RPC
+ server.
 
  This method is called automatically by the initializer.
  """

ptsl/engine.py

@@ -87,7 +87,8 @@ def ptsl_version(self) -> int:
  op = ops.GetPTSLVersion()
  self.client.run(op)
  assert isinstance(
- op.response, pt.GetPTSLVersionResponseBody), f"Expected response body, encountered {op.response}"
+ op.response, pt.GetPTSLVersionResponseBody), \
+ f"Expected response body, encountered {op.response}"
 
  return op.response.version
 
@@ -253,20 +254,22 @@ def save_session_as(self, path: str, name: str):
  op = ops.SaveSessionAs(session_name=name, session_location=path)
  self.client.run(op)
 
- def export_session_as_text(self,
- include_clip_list: bool = False,
- include_file_list: bool = False,
- include_markers: bool = False,
- include_plugin_list: bool = False,
- include_track_edls: bool = False,
- show_sub_frames: bool = False,
- track_list_type: Optional[pt.TrackListType] = pt.SelectedTracksOnly,
- include_user_timestamp=False,
- fade_handling_type: pt.FadeHandlingType = pt.DontShowCrossfades,
- track_offset_options: pt.TrackOffsetOptions = pt.TimeCode,
- text_as_file_format: pt.TextAsFileFormat = pt.UTF8,
- output_type: pt.ESI_OutputType = pt.ESI_String,
- output_path: Optional[str] = None) -> str:
+ def export_session_as_text(
+ self,
+ include_clip_list: bool = False,
+ include_file_list: bool = False,
+ include_markers: bool = False,
+ include_plugin_list: bool = False,
+ include_track_edls: bool = False,
+ show_sub_frames: bool = False,
+ track_list_type: Optional[pt.TrackListType] =
+ pt.SelectedTracksOnly,
+ include_user_timestamp=False,
+ fade_handling_type: pt.FadeHandlingType = pt.DontShowCrossfades,
+ track_offset_options: pt.TrackOffsetOptions = pt.TimeCode,
+ text_as_file_format: pt.TextAsFileFormat = pt.UTF8,
+ output_type: pt.ESI_OutputType = pt.ESI_String,
+ output_path: Optional[str] = None) -> str:
  """
  Export the open session as text.
  """
@@ -324,7 +327,8 @@ def extend_selection_to_target_tracks(self, tracks: List[str]):
  """
  Extend selection to target tracks.
 
- :param List[str] tracks: A list of track names to extend the selection to.
+ :param List[str] tracks: A list of track names to extend
+ the selection to.
  """
  op = ops.ExtendSelectionToTargetTracks(tracks_to_extend_to=tracks)
  self.client.run(op)
@@ -427,12 +431,13 @@ def edit_memory_location(self, location_number: int,
  """
  Edit a memory location.
 
- :param int location_number: Location number to edit (if location does not
- exist, this will create a new location in 2023.6)
+ :param int location_number: Location number to edit (if location
+ does not exist, this will create a new location in 2023.6)
  :param str name: Location name
  :param str start_time: Start time
  :param str end_time: End time
- :param TimeProperties time_properties: Time properties, either this is a range or a marker
+ :param TimeProperties time_properties: Time properties, either this
+ is a range or a marker
  :param MemoryLocationReference reference: Reference
  :param MemoryLocationProperties general_properties: Location properties
  :param str comments: Comment field

ptsl/ops/__init__.py

@@ -80,8 +80,7 @@
 from .rename_selected_clip import RenameSelectedClip
 from .rename_target_clip import RenameTargetClip
 from .toggle_play_state import \
-  TogglePlayState, ToggleRecordEnable, \
-  PlayHalfSpeed, RecordHalfSpeed
+ TogglePlayState, ToggleRecordEnable, \
+ PlayHalfSpeed, RecordHalfSpeed
 
 from .memory_locations import EditMemoryLocation, GetMemoryLocations
-

ptsl/ops/export_selected_tracks_as_aaf_omf.py

@@ -1,4 +1,5 @@
 from ptsl.ops import Operation
 
+
 class ExportSelectedTracksAsAAFOMF(Operation):
  pass

ptsl/ops/export_session_info_as_text.py

@@ -6,7 +6,7 @@
 #
 # https://duc.avid.com/showthread.php?t=422971
 class ExportSessionInfoAsText(Operation):
- 
+
  @classmethod
  def response_body(cls):
  return None

ptsl/ops/extend_selection_to_target_tracks.py

@@ -1,6 +1,5 @@
-from ptsl import PTSL_pb2 as pt
-
 from .operation import Operation
 
+
 class ExtendSelectionToTargetTracks(Operation):
- pass 
+ pass

ptsl/ops/get_dyamic_properties.py

@@ -1,4 +1,5 @@
 from ptsl.ops import Operation
 
+
 class GetDynamicProperties(Operation):
  pass

ptsl/ops/get_file_location.py

@@ -1,4 +1,5 @@
 from ptsl.ops import Operation
 
+
 class GetFileLocation(Operation):
  pass

ptsl/ops/get_playback_mode.py

@@ -4,6 +4,7 @@
 
 from ptsl.ops import Operation
 
+
 class GetPlaybackMode(Operation):
  pass
 
@@ -14,13 +15,12 @@ def xform(x):
 
  decoder = json.JSONDecoder()
  decoded = decoder.decode(in_json)
- if isinstance(['possible_settings'][0],str):
- decoded['current_settings'] = [xform(x) for x in decoded['current_settings']]
- decoded['possible_settings'] = [xform(x) for x in decoded['possible_settings']]
+ if isinstance(['possible_settings'][0], str):
+ decoded['current_settings'] = [
+ xform(x) for x in decoded['current_settings']]
+ decoded['possible_settings'] = [
+ xform(x) for x in decoded['possible_settings']]
  encoder = json.JSONEncoder()
  encoded = encoder.encode(decoded)
 
- return encoded 
-
-
-
+ return encoded

ptsl/ops/get_ptsl_version.py

@@ -1,4 +1,5 @@
 from ptsl.ops import Operation
 
+
 class GetPTSLVersion(Operation):
- pass
+ pass

ptsl/ops/get_record_mode.py

@@ -1,4 +1,5 @@
 from ptsl.ops import Operation
 
+
 class GetRecordMode(Operation):
  pass

ptsl/ops/get_session_audio_format.py

@@ -1,4 +1,5 @@
 from ptsl.ops import Operation
 
+
 class GetSessionAudioFormat(Operation):
- pass
+ pass

ptsl/ops/operation.py

@@ -76,6 +76,7 @@ def on_empty_response_body(self):
 
  def on_response_body(self, response_body: R):
  """
- The client calls this when the server responds with a JSON `pt.ResponseBody`.
+ The client calls this when the server responds with a JSON
+ `pt.ResponseBody`.
  """
  self.response = response_body