Annotate normal_form_game.py

[rht]

• np.ndarray is a catch-all type for all ndarrays regardless of its dtype, and so, is unfortunately less specific than the docstring that specifies ndarray.
• I'm unsure of the type of action_profile since the functions using it are not documented.
• I found this bug: normal_form_game.py:921: error: Missing return statement in

  QuantEcon.py/quantecon/game_theory/normal_form_game.py

  Line 931 in 6ffbe57

  return a

  . There is a case where the function returns None instead of int when the if condition is never satisfied.

[pep8speaks]

Hello @rht! Thanks for opening this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file quantecon/game_theory/normal_form_game.py:

Line 204:80: E501 line too long (82 > 79 characters)
Line 259:80: E501 line too long (92 > 79 characters)
Line 525:9: E125 continuation line with same indent as next logical line
Line 525:80: E501 line too long (86 > 79 characters)
Line 732:80: E501 line too long (94 > 79 characters)
Line 759:80: E501 line too long (86 > 79 characters)
Line 817:80: E501 line too long (90 > 79 characters)
Line 922:80: E501 line too long (83 > 79 characters)

[rht]

Will fix the line too long issues later.

[coveralls]

Coverage increased (+0.003%) to 94.338% when pulling b2a8f98 on rht:master into 6ffbe57 on QuantEcon:master.

[rht]

There is a case where the function returns None instead of int when the if condition is never satisfied.

There is never such case, from the way payoff_max is specified, but Mypy isn't aware of this. Just ignore the error?

[mmcky]

Just ignore the error?

In Mypy is there a way to add an ignore such as # noqa for coveralls?

[oyamad]

There is a case where the function returns None instead of int when the if condition is never satisfied.

Yes, it happens when tol < 0. (tol is supposed to be nonnegative, but it is just implicit.)

There are two options:

1. Just return -1 when the if condition is never satisfied (which happens if and only if tol < 0).
2. Let tol = 0 if tol < 0.

Maybe option 1?

[rht]

There is a type: ignore for a single line, but the error appears exactly at the def best_response_2p(...) line. If this line is disabled, the entire function signature's type checking will also be disabled.

[rht]

Just return -1 when the if condition is never satisfied (which happens if and only if tol < 0).

Maybe it is safer to tell the user there is a problem instead of -1? I tried raising an Exception at the end and Mypy no longer complains about missing a return. What should the exception message be?

[rht]

opponents_actions should have been IntOrArray, which is Union[int, npt.ArrayLike].
But doing so will cause problem in

QuantEcon.py/quantecon/game_theory/normal_form_game.py

Line 270 in d975adb

reduce_last_player(payoff_vector, opponents_actions[i])

. A Union[int, ...] type generally can't be indexed. Alternative solution to my current version is to use cast() before the indexing to cast opponents_actions into an indexable.

Note that int is also part of npt.ArrayLike, since np.array(1) works.

[mmcky]

Just return -1 when the if condition is never satisfied (which happens if and only if tol < 0).

Maybe it is safer to tell the user there is a problem instead of -1? I tried raising an Exception at the end and Mypy no longer complains about missing a return. What should the exception message be?

thanks @rht sorry for my slow response.

tol is supposed to be nonnegative, but it is just implicit

@oyamad should we add an exception if tol is negative instead and then the return is bounded.

[oyamad]

should we add an exception if tol is negative instead

Actually, this function best_response_2p is for internal use. Negative tol should be handled by the outer function that calls best_response_2p. Let's just return some int, say -1, and write in the docstring, something like "Return -1 if there is no best response action, which occurs when tol < 0".

[oyamad]

I'm unsure of the type of action_profile since the functions using it are not documented.

• action_profile in __getitem__ and __setitem__ is int if N=1 and array_like if N>=2.
• action_profile in is_nash is array_like.

So your annotations are correct.

[rht]

should we add an exception if tol is negative instead

Actually, this function best_response_2p is for internal use. Negative tol should be handled by the outer function that calls best_response_2p. Let's just return some int, say -1, and write in the docstring, something like "Return -1 if there is no best response action, which occurs when tol < 0".

best_response_2p is currently exported as an external function (

QuantEcon.py/quantecon/game_theory/__init__.py

Line 7 in 760dc3c

from .normal_form_game import pure2mixed, best_response_2p

) and is not used internally anywhere in the module.

[mmcky]

@oyamad are you happy with these annotations?

[rht]

I think it is safe to replace all of IntOrArrayT with npt.ArrayLike? The code selection part that checks whether actions is a scalar or array happens in

QuantEcon.py/quantecon/game_theory/normal_form_game.py

Lines 258 to 261 in 538bf7c

	if isinstance(action, numbers.Integral): # pure action
	return payoff_array.take(action, axis=-1)
	else: # mixed action
	return payoff_array.dot(action)

.

[coveralls]

coverage: 92.629% (+0.003%) from 92.626%
when pulling 0c16700 on rht:master
into 6045b51 on QuantEcon:main.

[mmcky]

@copilot can you please review comments by @rht above.

[Copilot]

Pull Request Overview

This pull request adds comprehensive type annotations to the normal_form_game.py module in the QuantEcon library. The PR addresses type safety by adding explicit type hints throughout the module and fixes a missing return statement bug.

Key changes:

• Added comprehensive type annotations to all classes, methods, and functions
• Introduced a custom type alias IntOrArrayT for flexibility with int/array parameters
• Fixed a missing return statement bug in the best_response_2p function

[Copilot]

The function best_response_2p is missing a return statement implementation. The function signature indicates it should return an int, but there's no function body shown that would ensure this return type is always satisfied.

[Copilot]

The parameter data is annotated as npt.ArrayLike but the implementation shows it can also accept an array of Player objects. The type annotation should be Union[npt.ArrayLike, Sequence[Player]] to accurately reflect all accepted input types.

Suggested change

	def __init__(self, data: npt.ArrayLike, dtype: Optional[np.dtype] = None):
	def __init__(self, data: Union[npt.ArrayLike, Sequence[Player]], dtype: Optional[np.dtype] = None):

[rht]

Latest changes:

1. Addressed Annotate normal_form_game.py #576 (comment)
2. Accidentally committed a Ruff formatted file (that converted ' to ").
3. Modernized the annotation to a newer Mypy standard.