[PY-542] Set stage

[saurbhc]

Problem

Feature Request to set a 'Workflow Stage' to an Item/ItemQuery object.

Solution

Implement item.set_stage on both Item and ItemQuery level.

Notes:

1. there are 2 arguments to set_stage:
   • stage_or_stage_id - you can pass either a Stage object OR stage_id str.
   • workflow_id is optional. If this is called via workflow object then set_stage will infer workflow_id from workflow meta_params. Otherwise, then workflow_id is required.
2. Updated workflow meta object attribute items. It was calling the list_items API with workflow_id as QueryParam, removed it, and added workflow_id with value of self.id,dataset_ids in meta_params with value as the 1st dataset stage id (assuming a workflow only has 1 dataset stage).

Tested below cases:

• Updating stage for Item(s) via workflow object

  workflow = client.team.workflows.where(dataset_name=dataset_name).collect_one()
  items = workflow.items.collect_all()
  workflow_id = str(workflow.id)
  for stage in workflow.stages:
      print(f"stage: {stage.name}")
      stage_id = str(stage.id)
      # dataset.items.set_stage(stage, workflow_id)  # works ✅
      for item in items:
          print(f"moving item {item.name} to stage {stage.name}")
          # item.set_stage(stage_id, workflow_id)  # works ✅
          item.set_stage(stage)  # works ✅

• Updating stage for Item(s) via dataset object

  workflow = client.team.workflows.where(dataset_name=dataset_name).collect_one()
  workflow_id = str(workflow.id)
  dataset = client.team.datasets.where(name=dataset_name).collect_one()
  items = dataset.items.collect()
  for stage in workflow.stages:
      print(f"stage: {stage.name}")
      stage_id = str(stage.id)
      # workflow.items.set_stage(stage)  # works ✅
      for item in items:
          print(f"moving item {item.name} to stage {stage.name}")
          # item.set_stage(stage_id, workflow_id)  # works ✅
          item.set_stage(stage, workflow_id)  # works ✅

Changelog

Ability to Set Workflow Stage for Item/ItemQuery

[linear]

PY-542 Set stage

• Set by id
• Bypass stage object that was fetched before

WIP Acceptance Criteria

Item.set_stage(stage_id | stage, workflow_id)
ItemQuery.set_stage(stage_id | stage, workflow_id) # Batch operation

[Nathanjp91]

Looks good.

[Nathanjp91]

I think it might be useful (in the future, not in this PR) to have like a protocols.py or interfaces.py file that imports all these objects (core only to avoid circular imports), that way we can build on these protocols

[Nathanjp91]

As above comment. Then we won't have to define these seperately. Single source of truth.