Adds hurry up and grace period features to multiball ball save

[atummons]

Added hurry up and grace period features to the multiball ball save. This allows the user to run shows off the hurry up, as well as provide a grace period for saves.

The tests for test_Modes are failing when I run bulk, but run fine when I run just them. So not sure what is going on there. If you also see this issue, please let me know what I changed or need to do to fix that issue.

If this is approved and merged, I would also like to go add similar features for add_a_ball to provide a different and shorter ball save feature.

Relates to 768 (set shoot_again to 0) and 1132. The wording is slightly inconsistent with ball_saves, but I didn't want to change it and break users configs. But might be worth doing (however that works) to ultimately have them be the same verbiage.

[jabdoa2]

Tests fail because of this:

========

mpf/devices/multiball.py

Line: 147

pep257: D202 / No blank lines allowed after function docstring (found 1)

Line: 166

pep8: E128 / continuation line under-indented for visual indent (col 28)

pep8: E128 / continuation line under-indented for visual indent (col 28)

[atummons]

Jan, Thanks! I know see where those errors are located in Travis_CI, so I can fix them going forward. So everything passes now, but on my local it still fails the same 7 tests... Kinda weird. They all have the exact same stack trace. I've tried hunting, but can't seem to find it, and obviously is happening on my machine, but not in Travis. Thanks!

ERROR: test_ball_end (mpf.tests.test_Modes.TestModes)

Traceback (most recent call last):
File "c:\users\atummons\desktop\mpf\mpf\tests\MpfTestCase.py", line 548, in setUp
self._initialise_machine()
File "c:\users\atummons\desktop\mpf\mpf\tests\MpfTestCase.py", line 564, in _initialise_machine
self._wait_for_start(init, 20)
File "c:\users\atummons\desktop\mpf\mpf\tests\MpfTestCase.py", line 576, in _wait_for_start
init.result()
asyncio.base_futures.InvalidStateError: Result is not set.

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
File "c:\desktop\mpf\mpf\tests\MpfTestCase.py", line 557, in setUp
raise self._exception['exception']
File "C:\AppData\Local\Programs\Python\Python37\lib\asyncio\events.py", line 88, in _run
self._context.run(self._callback, *self._args)
File "c:\desktop\mpf\mpf\core\events.py", line 115, in _async_handler_done
future.result()
File "c:\desktop\mpf\mpf\core\mode_controller.py", line 119, in load_modes
self.machine.modes[mode] = self._load_mode(mode)
File "c:\desktop\mpf\mpf\core\mode_controller.py", line 157, in _load_mode
mode_class = self._load_mode_code(mode_string, config['mode']['code'])
File "c:\desktop\mpf\mpf\core\mode_controller.py", line 135, in _load_mode_code
return Util.string_to_class("modes.{}.code.{}".format(mode_string, code_path))
File "c:\desktop\mpf\mpf\core\utility_functions.py", line 608, in string_to_class
m = import(module)
ModuleNotFoundError: No module named 'modes.mode3'

[jabdoa2]

Jan, Thanks! I know see where those errors are located in Travis_CI, so I can fix them going forward. So everything passes now, but on my local it still fails the same 7 tests... Kinda weird. They all have the exact same stack trace. I've tried hunting, but can't seem to find it, and obviously is happening on my machine, but not in Travis. Thanks!

ERROR: test_ball_end (mpf.tests.test_Modes.TestModes)

Traceback (most recent call last):
File "c:\users\atummons\desktop\mpf\mpf\tests\MpfTestCase.py", line 548, in setUp
self._initialise_machine()
File "c:\users\atummons\desktop\mpf\mpf\tests\MpfTestCase.py", line 564, in _initialise_machine
self._wait_for_start(init, 20)
File "c:\users\atummons\desktop\mpf\mpf\tests\MpfTestCase.py", line 576, in _wait_for_start
init.result()
asyncio.base_futures.InvalidStateError: Result is not set.

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
File "c:\desktop\mpf\mpf\tests\MpfTestCase.py", line 557, in setUp
raise self._exception['exception']
File "C:\AppData\Local\Programs\Python\Python37\lib\asyncio\events.py", line 88, in _run
self._context.run(self._callback, *self._args)
File "c:\desktop\mpf\mpf\core\events.py", line 115, in _async_handler_done
future.result()
File "c:\desktop\mpf\mpf\core\mode_controller.py", line 119, in load_modes
self.machine.modes[mode] = self._load_mode(mode)
File "c:\desktop\mpf\mpf\core\mode_controller.py", line 157, in _load_mode
mode_class = self._load_mode_code(mode_string, config['mode']['code'])
File "c:\desktop\mpf\mpf\core\mode_controller.py", line 135, in _load_mode_code
return Util.string_to_class("modes.{}.code.{}".format(mode_string, code_path))
File "c:\desktop\mpf\mpf\core\utility_functions.py", line 608, in string_to_class
m = import(module)
ModuleNotFoundError: No module named 'modes.mode3'

Did you run the tests from inside the mpf folder? I think I fixed something similar recently. I think it needed some init.py (which should be optional in python 3 but that seems not to be always true). If CI is happy you at least did not make it worse ;-).

[jabdoa2]

Looks good overall. One small question regarding premature stop of the multiball (i.e. due to mode end).

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[jabdoa2]

Looks very good to me. Thanks for making all those changes.