feat(step-generation): blow_out py generation and rename to blowOutInWell (#17804)

This PR adds python generation for `blowOut` atomic command and renames
`blowOut` atomic command to `blowOutInWell` since it is used only for
blowing out in a well.

Author: jerader

step-generation/src/__tests__/blowout.test.ts step-generation/src/__tests__/blowOutInWell.test.ts

@@ -1,6 +1,6 @@
 import { beforeEach, describe, it, expect, vi } from 'vitest'
 import { expectTimelineError } from '../__utils__/testMatchers'
-import { blowout } from '../commandCreators/atomic/blowout'
+import { blowOutInWell } from '../commandCreators/atomic/blowOutInWell'
 import {
   makeContext,
   getInitialRobotStateStandard,
@@ -16,7 +16,7 @@ import type { RobotState, InvariantContext } from '../types'
 
 vi.mock('../utils/heaterShakerCollision')
 
-describe('blowout', () => {
+describe('blowOutInWell', () => {
   let invariantContext: InvariantContext
   let initialRobotState: RobotState
   let robotStateWithTip: RobotState
@@ -39,7 +39,7 @@ describe('blowout', () => {
     }
   })
   it('blowout with tip', () => {
-    const result = blowout(params, invariantContext, robotStateWithTip)
+    const result = blowOutInWell(params, invariantContext, robotStateWithTip)
     const res = getSuccessResult(result)
     expect(res.commands).toEqual([
       {
@@ -59,17 +59,20 @@ describe('blowout', () => {
         },
       },
     ])
+    expect(res.python).toBe(
+      'mockPythonName.blow_out(mockPythonName["A1"].top(z=-1.3))'
+    )
   })
   it('blowout with invalid pipette ID should throw error', () => {
-    const result = blowout(
+    const result = blowOutInWell(
       { ...params, pipetteId: 'badPipette' },
       invariantContext,
       robotStateWithTip
     )
     expectTimelineError(getErrorResult(result).errors, 'PIPETTE_DOES_NOT_EXIST')
   })
   it('blowout with invalid labware ID should throw error', () => {
-    const result = blowout(
+    const result = blowOutInWell(
       { ...params, labwareId: 'badLabware' },
       invariantContext,
       robotStateWithTip
@@ -81,7 +84,7 @@ describe('blowout', () => {
     })
   })
   it('blowout with no tip should throw error', () => {
-    const result = blowout(params, invariantContext, initialRobotState)
+    const result = blowOutInWell(params, invariantContext, initialRobotState)
     const res = getErrorResult(result)
     expect(res.errors).toHaveLength(1)
     expect(res.errors[0]).toMatchObject({
@@ -92,7 +95,7 @@ describe('blowout', () => {
     initialRobotState = getInitialRobotStateWithOffDeckLabwareStandard(
       invariantContext
     )
-    const result = blowout(
+    const result = blowOutInWell(
       {
         flowRate: 10,
         wellLocation: {

step-generation/src/__tests__/blowoutUtil.test.ts

@@ -4,7 +4,7 @@ import {
   SOURCE_WELL_BLOWOUT_DESTINATION,
   DEST_WELL_BLOWOUT_DESTINATION,
 } from '../utils'
-import { blowout } from '../commandCreators/atomic'
+import { blowOutInWell } from '../commandCreators/atomic'
 import { blowOutInWasteChute } from '../commandCreators/compound'
 import { curryCommandCreator } from '../utils/curryCommandCreator'
 import {
@@ -59,7 +59,7 @@ describe('blowoutUtil', () => {
       ...blowoutArgs,
       blowoutLocation: SOURCE_WELL_BLOWOUT_DESTINATION,
     })
-    expect(curryCommandCreator).toHaveBeenCalledWith(blowout, {
+    expect(curryCommandCreator).toHaveBeenCalledWith(blowOutInWell, {
       pipetteId: blowoutArgs.pipette,
       labwareId: blowoutArgs.sourceLabwareId,
       wellName: blowoutArgs.sourceWell,
@@ -101,7 +101,7 @@ describe('blowoutUtil', () => {
       ...blowoutArgs,
       blowoutLocation: DEST_WELL_BLOWOUT_DESTINATION,
     })
-    expect(curryCommandCreator).toHaveBeenCalledWith(blowout, {
+    expect(curryCommandCreator).toHaveBeenCalledWith(blowOutInWell, {
       pipetteId: blowoutArgs.pipette,
       labwareId: blowoutArgs.destLabwareId,
       wellName: blowoutArgs.destWell,
@@ -119,7 +119,7 @@ describe('blowoutUtil', () => {
       ...blowoutArgs,
       blowoutLocation: TROUGH_LABWARE,
     })
-    expect(curryCommandCreator).toHaveBeenCalledWith(blowout, {
+    expect(curryCommandCreator).toHaveBeenCalledWith(blowOutInWell, {
       pipetteId: blowoutArgs.pipette,
       labwareId: TROUGH_LABWARE,
       wellName: 'A1',

step-generation/src/commandCreators/atomic/blowout.ts step-generation/src/commandCreators/atomic/blowOutInWell.ts

@@ -11,23 +11,26 @@ import {
   getIsHeaterShakerEastWestMultiChannelPipette,
   getIsHeaterShakerEastWestWithLatchOpen,
   getIsHeaterShakerNorthSouthOfNonTiprackWithMultiChannelPipette,
+  formatPyStr,
+  formatPyWellLocation,
 } from '../../utils'
 import { COLUMN_4_SLOTS } from '../../constants'
 import * as errorCreators from '../../errorCreators'
 import type { CreateCommand, BlowoutParams } from '@opentrons/shared-data'
 import type { CommandCreatorError, CommandCreator } from '../../types'
 
-export const blowout: CommandCreator<BlowoutParams> = (
+export const blowOutInWell: CommandCreator<BlowoutParams> = (
   args,
   invariantContext,
   prevRobotState
 ) => {
   /** Blowout with given args. Requires tip. */
   const { pipetteId, labwareId, wellName, wellLocation, flowRate } = args
-
+  const { pipetteEntities, labwareEntities } = invariantContext
+  const pipette = pipetteEntities[pipetteId]
   const actionName = 'blowout'
   const errors: CommandCreatorError[] = []
-  const pipetteSpec = invariantContext.pipetteEntities[pipetteId]?.spec
+  const pipetteSpec = pipette?.spec
   const isFlexPipette =
     (pipetteSpec?.displayCategory === 'FLEX' || pipetteSpec?.channels === 96) ??
     false
@@ -184,6 +187,9 @@ export const blowout: CommandCreator<BlowoutParams> = (
     }
   }
 
+  const pipettePythonName = pipette.pythonName
+  const labwarePythonName = labwareEntities[labwareId].pythonName
+
   const commands: CreateCommand[] = [
     {
       commandType: 'blowout',
@@ -199,5 +205,8 @@ export const blowout: CommandCreator<BlowoutParams> = (
   ]
   return {
     commands,
+    python: `${pipettePythonName}.blow_out(${labwarePythonName}[${formatPyStr(
+      wellName
+    )}]${formatPyWellLocation(wellLocation)})`,
   }
 }

step-generation/src/commandCreators/atomic/index.ts

@@ -4,7 +4,7 @@ import { absorbanceReaderOpenLid } from './absorbanceReaderOpenLid'
 import { absorbanceReaderRead } from './absorbanceReaderRead'
 import { aspirate } from './aspirate'
 import { aspirateInPlace } from './aspirateInPlace'
-import { blowout } from './blowout'
+import { blowOutInWell } from './blowOutInWell'
 import { blowOutInPlace } from './blowOutInPlace'
 import { configureForVolume } from './configureForVolume'
 import { configureNozzleLayout } from './configureNozzleLayout'
@@ -36,7 +36,7 @@ export {
   absorbanceReaderRead,
   aspirate,
   aspirateInPlace,
-  blowout,
+  blowOutInWell,
   blowOutInPlace,
   comment,
   configureForVolume,

step-generation/src/commandCreators/index.ts

@@ -19,7 +19,7 @@ export {
   absorbanceReaderOpenLid,
   absorbanceReaderRead,
   aspirate,
-  blowout,
+  blowOutInWell,
   comment,
   deactivateTemperature,
   delay,

step-generation/src/index.ts

@@ -6,7 +6,7 @@ export {
   absorbanceReaderOpenLid,
   absorbanceReaderRead,
   aspirate,
-  blowout,
+  blowOutInWell,
   comment,
   consolidate,
   deactivateTemperature,

step-generation/src/utils/misc.ts

@@ -30,7 +30,7 @@ import {
   blowOutInWasteChute,
   dispenseInWasteChute,
 } from '../commandCreators/compound'
-import { blowout } from '../commandCreators/atomic/blowout'
+import { blowOutInWell } from '../commandCreators/atomic/blowOutInWell'
 import { curryCommandCreator } from './curryCommandCreator'
 import type {
   AddressableAreaName,
@@ -365,7 +365,7 @@ export const blowoutUtil = (args: {
 
   if (well != null && trashOrLabware === 'labware' && labware != null) {
     return [
-      curryCommandCreator(blowout, {
+      curryCommandCreator(blowOutInWell, {
         pipetteId: pipette,
         labwareId: labware.id,
         wellName: well,