Skip to content

chore(api): lint API doc example protocol files #18142

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.

Sign up for GitHub

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

Merged
ecormany merged 2 commits into from
Apr 23, 2025
Merged

chore(api): lint API doc example protocol files #18142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f7c148
lint API doc example protocol files
ecormany Apr 22, 2025
d149709
ran format on protocols, removed them from flake
ecormany Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,12 +124,12 @@ test-ot2:
.PHONY: lint
lint:
$(python) -m mypy src tests
$(python) -m black --check src tests setup.py
$(python) -m black --check src tests docs/v2/example_protocols setup.py
$(python) -m flake8 src tests setup.py

.PHONY: format
format:
$(python) -m black src tests setup.py
$(python) -m black src tests docs/v2/example_protocols setup.py

docs/build/html/v%: docs/v%
$(sphinx_build) -b html -d docs/build/doctrees -n $< $@
Expand Down
35 changes: 19 additions & 16 deletions api/docs/v2/example_protocols/dilution_tutorial.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,29 @@
https://docs.opentrons.com/v2/tutorial.html. It takes a
solution and progressively dilutes it by transferring it
stepwise across a plate.""",
"author": "New API User"
}
"author": "New API User",
}


def run(protocol: protocol_api.ProtocolContext):
tips = protocol.load_labware("opentrons_96_tiprack_300ul", 1)
reservoir = protocol.load_labware("nest_12_reservoir_15ml", 2)
plate = protocol.load_labware("nest_96_wellplate_200ul_flat", 3)
left_pipette = protocol.load_instrument("p300_single_gen2", "left", tip_racks=[tips])
tips = protocol.load_labware("opentrons_96_tiprack_300ul", 1)
reservoir = protocol.load_labware("nest_12_reservoir_15ml", 2)
plate = protocol.load_labware("nest_96_wellplate_200ul_flat", 3)
left_pipette = protocol.load_instrument(
"p300_single_gen2", "left", tip_racks=[tips]
)

# distribute diluent
left_pipette.transfer(100, reservoir["A1"], plate.wells())
# distribute diluent
left_pipette.transfer(100, reservoir["A1"], plate.wells())

# loop through each row
for i in range(8):
# loop through each row
for i in range(8):

# save the destination row to a variable
row = plate.rows()[i]
# save the destination row to a variable
row = plate.rows()[i]

# transfer solution to first well in column
left_pipette.transfer(100, reservoir["A2"], row[0], mix_after=(3, 50))
# transfer solution to first well in column
left_pipette.transfer(100, reservoir["A2"], row[0], mix_after=(3, 50))

# dilute the sample down the row
left_pipette.transfer(100, row[:11], row[1:], mix_after=(3, 50))
# dilute the sample down the row
left_pipette.transfer(100, row[:11], row[1:], mix_after=(3, 50))
18 changes: 9 additions & 9 deletions api/docs/v2/example_protocols/dilution_tutorial_flex.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@
https://docs.opentrons.com/v2/tutorial.html. It takes a
solution and progressively dilutes it by transferring it
stepwise across a plate.""",
"author": "New API User"
}

requirements = {
"robotType": "Flex",
"apiLevel": "2.16"
}
"author": "New API User",
}

requirements = {"robotType": "Flex", "apiLevel": "2.16"}


def run(protocol: protocol_api.ProtocolContext):
tips = protocol.load_labware("opentrons_flex_96_tiprack_200ul", "D1")
reservoir = protocol.load_labware("nest_12_reservoir_15ml", "D2")
plate = protocol.load_labware("nest_96_wellplate_200ul_flat", "D3")
trash = protocol.load_trash_bin("A3")
left_pipette = protocol.load_instrument("flex_1channel_1000", "left", tip_racks=[tips])
left_pipette = protocol.load_instrument(
"flex_1channel_1000", "left", tip_racks=[tips]
)

# distribute diluent
left_pipette.transfer(100, reservoir["A1"], plate.wells())
Expand All @@ -35,4 +35,4 @@ def run(protocol: protocol_api.ProtocolContext):
left_pipette.transfer(100, reservoir["A2"], row[0], mix_after=(3, 50))

# dilute the sample down the row
left_pipette.transfer(100, row[:11], row[1:], mix_after=(3, 50))
left_pipette.transfer(100, row[:11], row[1:], mix_after=(3, 50))
35 changes: 19 additions & 16 deletions api/docs/v2/example_protocols/dilution_tutorial_multi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,28 @@
https://docs.opentrons.com/v2/tutorial.html. It takes a
solution and progressively dilutes it by transferring it
stepwise across a plate.""",
"author": "New API User"
}

"author": "New API User",
}


def run(protocol: protocol_api.ProtocolContext):
tips = protocol.load_labware("opentrons_96_tiprack_300ul", 1)
reservoir = protocol.load_labware("nest_12_reservoir_15ml", 2)
plate = protocol.load_labware("nest_96_wellplate_200ul_flat", 3)
left_pipette = protocol.load_instrument("p300_multi_gen2", "right", tip_racks=[tips])
tips = protocol.load_labware("opentrons_96_tiprack_300ul", 1)
reservoir = protocol.load_labware("nest_12_reservoir_15ml", 2)
plate = protocol.load_labware("nest_96_wellplate_200ul_flat", 3)
left_pipette = protocol.load_instrument(
"p300_multi_gen2", "right", tip_racks=[tips]
)

# distribute diluent
left_pipette.transfer(100, reservoir["A1"], plate.rows()[0])
# distribute diluent
left_pipette.transfer(100, reservoir["A1"], plate.rows()[0])

# no loop, 8-channel pipette
# no loop, 8-channel pipette

# save the destination row to a variable
row = plate.rows()[0]
# save the destination row to a variable
row = plate.rows()[0]

# transfer solution to first well in column
left_pipette.transfer(100, reservoir["A2"], row[0], mix_after=(3, 50))
# transfer solution to first well in column
left_pipette.transfer(100, reservoir["A2"], row[0], mix_after=(3, 50))

# dilute the sample down the row
left_pipette.transfer(100, row[:11], row[1:], mix_after=(3, 50))
# dilute the sample down the row
left_pipette.transfer(100, row[:11], row[1:], mix_after=(3, 50))
22 changes: 11 additions & 11 deletions api/docs/v2/example_protocols/dilution_tutorial_multi_flex.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@
https://docs.opentrons.com/v2/tutorial.html. It takes a
solution and progressively dilutes it by transferring it
stepwise across a plate.""",
"author": "New API User"
}

requirements = {
"robotType": "Flex",
"apiLevel": "2.16"
}

"author": "New API User",
}

requirements = {"robotType": "Flex", "apiLevel": "2.16"}


def run(protocol: protocol_api.ProtocolContext):
tips = protocol.load_labware("opentrons_96_tiprack_300ul", "D1")
reservoir = protocol.load_labware("nest_12_reservoir_15ml", "D2")
plate = protocol.load_labware("nest_96_wellplate_200ul_flat", "D3")
trash = protocol.load_trash_bin("A3")
left_pipette = protocol.load_instrument("flex_8channel_1000", "right", tip_racks=[tips])
left_pipette = protocol.load_instrument(
"flex_8channel_1000", "right", tip_racks=[tips]
)

# distribute diluent
left_pipette.transfer(100, reservoir["A1"], plate.rows()[0])
left_pipette.transfer(100, reservoir["A1"], plate.rows()[0])

# no loop, 8-channel pipette

Expand All @@ -34,4 +34,4 @@ def run(protocol: protocol_api.ProtocolContext):
left_pipette.transfer(100, reservoir["A2"], row[0], mix_after=(3, 50))

# dilute the sample down the row
left_pipette.transfer(100, row[:11], row[1:], mix_after=(3, 50))
left_pipette.transfer(100, row[:11], row[1:], mix_after=(3, 50))