Summary

Add functions for checking if a spy was called only once.

Review Request #14621 — Created Sept. 19, 2025 and submitted Sept. 22, 2025, 5:24 p.m.

Information

Owner

chipx86

Repository

kgb

Branch

master

Bugs

Depends On

Reviewers

Groups

kgb

People

Description

This introduce two new functions to perform these checks in a simpler
manner:

assertSpyCalledOnce()
assertSpyCalledOnceWith()

There are also pytest equivalent functions for both.

Testing Done

All unit tests pass on all environments.

Commits

Summary	ID
Add functions for checking if a spy was called only once. A common pattern when using kgb is to check if a spy was called only once, and sometimes once with specific arguments. Callers had to do this by checking the call count and then checking the arguments, or to use a spy operation that would fail if executed more than once. This introduce two new functions to perform these checks in a simpler manner: * `assertSpyCalledOnce()` * `assertSpyCalledOnceWith()` There are also pytest equivalent functions for both.	d76767489b23045696d1a5edeec6ffd315b02f6f

Summary

Add functions for checking if a spy was called only once.

A common pattern when using kgb is to check if a spy was called only once, and sometimes once with specific arguments. Callers had to do this by checking the call count and then checking the arguments, or to use a spy operation that would fail if executed more than once. This introduce two new functions to perform these checks in a simpler manner: * `assertSpyCalledOnce()` * `assertSpyCalledOnceWith()` There are also pytest equivalent functions for both.

d76767489b23045696d1a5edeec6ffd315b02f6f

Issues

Description	From	Last Updated
Given that we pass this into assertSpyCalledOnce, it can't actually be a call, it can only be a function/spy, right?	david	Sept. 20, 2025, 2:15 a.m.
Typo: Position -> Positional	david	Sept. 20, 2025, 2:15 a.m.

flake8 passed.

JSHint passed.

kgb/agency.py (Diff revision 1)

The issue has been resolved. Show all issues

Given that we pass this into assertSpyCalledOnce, it can't actually be a call, it can only be a function/spy, right?

chipx86 Sept. 20, 2025, 2:16 a.m.
```
Good catch.
```

kgb/agency.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo: Position -> Positional
```

Change Summary:


Fixed the docstring and variable name in assertSpyCalledOnceWith to only take a spy or function, not a call.
Fixed docstrings for several functions to say "Positional" instead of "Position" for arguments.

Commits:

	Summary	ID
	Add functions for checking if a spy was called only once. A common pattern when using kgb is to check if a spy was called only once, and sometimes once with specific arguments. Callers had to do this by checking the call count and then checking the arguments, or to use a spy operation that would fail if executed more than once. This introduce two new functions to perform these checks in a simpler manner: * `assertSpyCalledOnce()` * `assertSpyCalledOnceWith()` There are also pytest equivalent functions for both.	8e621c79fdc1fc6ed956e4570ed6e630748045c4
	Add functions for checking if a spy was called only once. A common pattern when using kgb is to check if a spy was called only once, and sometimes once with specific arguments. Callers had to do this by checking the call count and then checking the arguments, or to use a spy operation that would fail if executed more than once. This introduce two new functions to perform these checks in a simpler manner: * `assertSpyCalledOnce()` * `assertSpyCalledOnceWith()` There are also pytest equivalent functions for both.	d76767489b23045696d1a5edeec6ffd315b02f6f

Diff:

Revision 2 (+426 -6)

Show changes

	kgb/agency.py
	kgb/tests/test_spy_agency.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (62ea9f0)