Skip to content

Added logic to check input type for Block name #65

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

Open
Chsudeepta wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Added logic to check input type for Block name #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ff1759d
Added logic to check input type for Block name
Oct 14, 2025
391600c
Changed the error message
Oct 14, 2025
80dbf3a
Changed the error message
Oct 14, 2025
797e831
Reformatted
Oct 14, 2025
0b45370
Added test case
Oct 14, 2025
e105962
Added test case
Oct 14, 2025
d314397
Added test case
Oct 14, 2025
5bef3a4
Added test case
Oct 14, 2025
18531ba
Corrected usage of format in exception message
Oct 15, 2025
ee5985d
bypass pyright
Oct 15, 2025
6b6b560
bypass pyright
Oct 15, 2025
8ff4047
fixed ruff
Oct 15, 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: 4 additions & 0 deletions src/genie_python/genie_waitfor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,10 @@ def start_waiting(
)

if block is not None:
if not isinstance(block, str):
error = "First argument must be a valid block name or None, not {}".format(block)
raise TypeError(error)

if not self.api.block_exists(block):
raise NameError('No block with the name "{}" exists'.format(block))
block = self.api.correct_blockname(block, add_prefix=False)
Expand Down
57 changes: 33 additions & 24 deletions tests/test_genie_waitfor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,57 +28,66 @@ def setUp(self):
self.genie_waitfor = WaitForController(API())

def test_GIVEN_silent_waitfor_time_WHEN_waitfor_time_THEN_no_output(self):
capturedOutput = StringIO()
sys.stdout = capturedOutput
capturedoutput = StringIO()
sys.stdout = capturedoutput
self.genie_waitfor.start_waiting(seconds=0, quiet=True)
sys.stdout = sys.__stdout__
self.assertIs("", capturedOutput.getvalue())
self.assertIs("", capturedoutput.getvalue())

def test_GIVEN_waitfor_time_WHEN_waitfor_time_THEN_output(self):
capturedOutput = StringIO()
sys.stdout = capturedOutput
capturedoutput = StringIO()
sys.stdout = capturedoutput
self.genie_waitfor.start_waiting(seconds=0, quiet=False)
sys.stdout = sys.__stdout__
self.assertIsNot("", capturedOutput.getvalue())
self.assertIsNot("", capturedoutput.getvalue())

def test_GIVEN_silent_waitfor_uamps_WHEN_waitfor_uamps_THEN_no_output(self):
capturedOutput = StringIO()
sys.stdout = capturedOutput
capturedoutput = StringIO()
sys.stdout = capturedoutput
self.genie_waitfor.start_waiting(uamps=0, quiet=True)
sys.stdout = sys.__stdout__
self.assertIs("", capturedOutput.getvalue())
self.assertIs("", capturedoutput.getvalue())

def test_GIVEN_waitfor_uamps_WHEN_waitfor_uamps_THEN_output(self):
capturedOutput = StringIO()
sys.stdout = capturedOutput
capturedoutput = StringIO()
sys.stdout = capturedoutput
self.genie_waitfor.start_waiting(uamps=0, quiet=False)
sys.stdout = sys.__stdout__
self.assertIsNot("", capturedOutput.getvalue())
self.assertIsNot("", capturedoutput.getvalue())

def test_GIVEN_silent_waitfor_raw_frames_WHEN_waitfor_raw_frames_THEN_no_output(self):
capturedOutput = StringIO()
sys.stdout = capturedOutput
capturedoutput = StringIO()
sys.stdout = capturedoutput
self.genie_waitfor.start_waiting(raw_frames=0, quiet=True)
sys.stdout = sys.__stdout__
self.assertIs("", capturedOutput.getvalue())
self.assertIs("", capturedoutput.getvalue())

def test_GIVEN_waitfor_raw_frames_WHEN_waitfor_raw_frames_THEN_output(self):
capturedOutput = StringIO()
sys.stdout = capturedOutput
capturedoutput = StringIO()
sys.stdout = capturedoutput
self.genie_waitfor.start_waiting(raw_frames=0, quiet=False)
sys.stdout = sys.__stdout__
self.assertIsNot("", capturedOutput.getvalue())
self.assertIsNot("", capturedoutput.getvalue())

def test_GIVEN_silent_waitfor_mevents_WHEN_waitfor_mevents_THEN_no_output(self):
capturedOutput = StringIO()
sys.stdout = capturedOutput
capturedoutput = StringIO()
sys.stdout = capturedoutput
self.genie_waitfor.start_waiting(mevents=0, quiet=True)
sys.stdout = sys.__stdout__
self.assertIs("", capturedOutput.getvalue())
self.assertIs("", capturedoutput.getvalue())

def test_GIVEN_waitfor_mevents_WHEN_waitfor_mevents_THEN_output(self):
capturedOutput = StringIO()
sys.stdout = capturedOutput
capturedoutput = StringIO()
sys.stdout = capturedoutput
self.genie_waitfor.start_waiting(mevents=0, quiet=False)
sys.stdout = sys.__stdout__
self.assertIsNot("", capturedOutput.getvalue())
self.assertIsNot("", capturedoutput.getvalue())

def test_GIVEN_waitfor_block_WHEN_waitfor_block_integer_THEN_error_output(self):
# Exception condition
with self.assertRaises(TypeError) as context:
self.genie_waitfor.start_waiting(block=10) # pyright: ignore
self.assertEqual(
str(context.exception),
"First argument must be a valid block name or None, not {}".format(10),
)
Comment on lines +88 to +93
Copy link
Copy Markdown
Contributor

@rerpha rerpha Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we install pytest as a dev dependency in genie, so you don't need to try and patch the sys module here (which is also not very good practice and we should be using mocks instead). Instead you can use

with pytest.raises(TypeError, match="some error message printed by the exception"):