Update TaskWorkflowTemplate.create_task_workflow() method and unit test #1339
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tasks/models/workflow.py
Outdated
| def create_task_workflow(self) -> "TaskWorkflow": | ||
| """Create a workflow and it subtasks, using values from this template | ||
| workflow and its task templates.""" | ||
| def create_task_workflow(self, summary_data: dict) -> "TaskWorkflow": |
There was a problem hiding this comment.
Might it be preferable, better documenting this API, to be explicit stating which fields are required or expected to create a TaskWorkflow, with TaskWorkflow.summary_task being kept as an internal detail?
Suggested change
| def create_task_workflow(self, summary_data: dict) -> "TaskWorkflow": | |
| def create_task_workflow(self, title: str, description: str) -> "TaskWorkflow": |
paulpepper-trade
approved these changes
Nov 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update TaskWorkflowTemplate.create_task_workflow() method
Why
The task-workflow megabranch has a failing test following changes to
TaskWorkflowmodel:tasks/tests/test_workflow_models.py::test_create_task_workflow_from_task_workflow_templateWhat
summary_dataparam toTaskWorkflowTemplate.create_task_workflow()to populate the details of theTaskWorkflow.summary_taskinstance (since it has become a required field), replacing the old way of using the workflow template's title and descriptiontasks/migrations/0012_taskworkflow_assign_summary_task.pyby saving the modified object instances in the forward migration operationChecklist