mpf 0.58.0.dev3__py3-none-any.whl → 0.58.0.dev4__py3-none-any.whl

mpf/_version.py

@@ -10,7 +10,7 @@ PyPI.
 
 """
 
-__version__ = '0.58.0.dev3'  # Also consider whether MPF-MC pyproject.toml should be updated
+__version__ = '0.58.0.dev4'  # Also consider whether MPF-MC pyproject.toml should be updated
 '''The full version of MPF.'''
 
 __short_version__ = '0.58'

mpf/assets/show.py

@@ -2,15 +2,15 @@
 import re
 from collections import namedtuple
 
-from typing import List, Dict, Any, Optional
+from typing import List, Dict, Any, Optional, TYPE_CHECKING
 
 from mpf.core.assets import AssetPool
 from mpf.core.config_validator import RuntimeToken
 from mpf.core.utility_functions import Util
 from mpf.exceptions.config_file_error import ConfigFileError
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from typing import NoReturn     # pylint: disable-msg=cyclic-import,unused-import
 
 __api__ = ['Show', 'RunningShow', 'ShowPool']

mpf/commands/__init__.py

@@ -1,9 +1,9 @@
 """MPF CLI commands."""
 import argparse
 from importlib import import_module
+import importlib.metadata
 import os
 import sys
-from pkg_resources import iter_entry_points
 
 
 import mpf.core
@@ -137,7 +137,8 @@ class CommandLineUtility(MpfCommandLineParser):
 
         This is used from mpf mc.
         """
-        for entry_point in iter_entry_points(group='mpf.command', name=None):
+        eps = importlib.metadata.entry_points(group='mpf.command')
+        for entry_point in eps:
             command, function_ref = entry_point.load()()
             self.external_commands[command] = function_ref
 

mpf/commands/game.py

@@ -31,13 +31,11 @@ class Command:
         self.machine = None
         self._sigint_count = 0
 
-        parser = argparse.ArgumentParser(
-            description='Starts the MPF game engine')
+        parser = argparse.ArgumentParser(description='Starts the MPF game engine')
 
         parser.add_argument("-a",
                             action="store_true", dest="no_load_cache",
-                            help="Forces the config to be loaded from files "
-                                 "and not cache")
+                            help="Forces the config to be loaded from files and not cache")
 
         parser.add_argument("-A",
                             action="store_false", dest="create_config_cache",
@@ -45,24 +43,24 @@ class Command:
 
         parser.add_argument("-b",
                             action="store_false", dest="bcp", default=True,
-                            help="Runs MPF without making a connection "
-                                 "attempt to a BCP Server")
+                            help="Runs MPF without making a connection attempt to a BCP Server")
 
         parser.add_argument("-c",
                             action="store", dest="configfile",
                             default="config.yaml", metavar='config_file',
-                            help="The name of a config file to load. Default "
-                                 "is "
-                                 "config.yaml. Multiple files can be used "
-                                 "via a comma-"
+                            help="The name of a config file to load. Default is "
+                                 "config.yaml. Multiple files can be used via a comma-"
                                  "separated list (no spaces between)")
 
+        parser.add_argument("-e",
+                            action="store_false", dest="echo_args", default=True,
+                            help="Stop logging the raw command line arguments on startup.")
+
         parser.add_argument("-f",
                             action="store_true", dest="force_assets_load",
                             default=False,
                             help="Load all assets upon startup.  Useful for "
-                            "ensuring all assets are set up properly "
-                            "during development.")
+                            "ensuring all assets are set up properly during development.")
 
         parser.add_argument("-pit", action="store", dest="platform_integration_test",
                             metavar='pit_file', default=False,
@@ -91,8 +89,8 @@ class Command:
 
         parser.add_argument("-P",
                             action="store_true", dest="production", default=False,
-                            help="Production mode. Will suppress errors, wait for hardware on start and "
-                                 "try to exit when startup fails. Run this inside a loop.")
+                            help="Production mode. Will suppress errors, wait for hardware on start "
+                                 "and try to exit when startup fails. Run this inside a loop.")
 
         parser.add_argument("-t",
                             action="store_false", dest='text_ui', default=True,
@@ -102,43 +100,35 @@ class Command:
                             action="store_const", dest="loglevel",
                             const=logging.DEBUG,
                             default=15,
-                            help="Enables verbose logging to the"
-                                 " log file")
+                            help="Enables verbose logging to the log file")
 
         parser.add_argument("-V",
                             action="store_const", dest="consoleloglevel",
                             const=logging.DEBUG,
                             default=logging.INFO,
                             help="Enables verbose logging to the console. DO "
-                                 "NOTE: you must also use -v for "
-                                 "this to work.")
+                                 "NOTE: you must also use -v for this to work.")
 
         parser.add_argument("-x",
                             action="store_const", dest="force_platform",
                             const='virtual',
-                            help="Forces the virtual platform to be "
-                                 "used for all devices")
+                            help="Forces the virtual platform to be used for all devices")
 
         parser.add_argument("--vpx",
                             action="store_const", dest="force_platform",
                             const='virtual_pinball',
-                            help="Forces the virtual_pinball platform to be "
-                                 "used for all devices")
+                            help="Forces the virtual_pinball platform to be used for all devices")
 
         parser.add_argument("--syslog_address",
                             action="store", dest="syslog_address",
-                            help="Log to the specified syslog address. This "
-                                 "can be a domain socket such as /dev/og on "
-                                 "Linux or /var/run/syslog on Mac. "
-                                 "Alternatively, you an specify host:port for "
-                                 "remote logging over UDP.")
+                            help="Log to the specified syslog address. This can be a domain socket "
+                                 "such as /dev/og on Linux or /var/run/syslog on Mac. Alternatively, "
+                                 "you an specify host:port for remote logging over UDP.")
 
         parser.add_argument("-X",
                             action="store_const", dest="force_platform",
                             const='smart_virtual',
-                            help="Forces the smart virtual platform to be "
-                                 "used for all"
-                                 " devices")
+                            help="Forces the smart virtual platform to be used for all devices")
 
         # The following are just included for full compatibility with mc
         # which is needed when using "mpf both".
@@ -180,6 +170,8 @@ class Command:
         console_log.setFormatter(logging.Formatter(
             '%(asctime)s.%(msecs)03d : %(levelname)s [%(name)s] %(message)s', "%H:%M:%S"))
 
+        console_log.addFilter(ConsoleCustomLevelFilter())
+
         # initialize async handler for console
         console_log_queue = Queue()
         console_queue_handler = QueueHandler(console_log_queue)
@@ -194,6 +186,7 @@ class Command:
         else:
             formatter = logging.Formatter('%(asctime)s : %(levelname)s : %(name)s : %(message)s')
         file_log.setFormatter(formatter)
+        file_log.addFilter(FileCustomLevelFilter())
 
         # initialize async handler for file log
         file_log_queue = Queue()
@@ -221,6 +214,10 @@ class Command:
 
         signal.signal(signal.SIGINT, self.sigint_handler)
 
+        if self.args.echo_args:
+            raw_cmd = " ".join(args) if args else "[None]"
+            logger.info("Raw command line: %s", raw_cmd)
+
         if not self.args.production:
             config_loader = YamlMultifileConfigLoader(machine_path, self.args.configfile,
                                                       not self.args.no_load_cache, self.args.create_config_cache)
@@ -248,6 +245,8 @@ class Command:
     def sigint_handler(self, signum=None, frame=None):
         """Handle SIGINT."""
         del signum, frame
+        if self.machine:
+            self.machine.error_log("SIGINT received")
         self._sigint_count += 1
         if self._sigint_count > 1:
             self.exit("Received second SIGINT. Will exit ungracefully!")
@@ -280,3 +279,25 @@ class Command:
             input('Press ENTER to continue...')     # nosec
 
         sys.exit()
+
+
+class ConsoleCustomLevelFilter(logging.Filter):
+
+    """Filters out custom levels meant strictly for files."""
+
+    def filter(self, record):
+        """Filters: 11 = DEBUG (File Only), 21 = INFO (File Only)."""
+        if record.levelno in (11, 21):
+            return False
+        return True
+
+
+class FileCustomLevelFilter(logging.Filter):
+
+    """Filters out custom levels meant strictly for console."""
+
+    def filter(self, record):
+        """Filters: 12 = DEBUG (Console Only), 22 = INFO (Console Only)."""
+        if record.levelno in (12, 22):
+            return False
+        return True

mpf/config_players/hardware_sound_player.py

@@ -1,10 +1,10 @@
 """Config player for sounds on an external sound card."""
-from typing import List
+from typing import List, TYPE_CHECKING
 
 from mpf.config_players.device_config_player import DeviceConfigPlayer
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.devices.hardware_sound_system import HardwareSoundSystem   # pylint: disable-msg=cyclic-import,unused-import; # noqa
 
 

mpf/config_players/segment_display_player.py

@@ -1,12 +1,14 @@
 """Config player for text on segment displays."""
+from typing import TYPE_CHECKING
+
 from mpf.core.delays import DelayManager
 
 from mpf.config_players.device_config_player import DeviceConfigPlayer
 from mpf.platforms.interfaces.segment_display_platform_interface import FlashingType
 from mpf.devices.segment_display.transition_manager import TransitionManager
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from typing import Dict     # pylint: disable-msg=cyclic-import,unused-import
     from mpf.devices.segment_display.segment_display import \
         SegmentDisplay  # pylint: disable-msg=cyclic-import,unused-import

mpf/config_spec.yaml

@@ -98,8 +98,8 @@ auditor:
     audit: list|str|None
     autosave: single|bool|true
     autosave_events: single|bool|true
-    events: list|event_handler|None
-    player: list|str|None
+    events: set|event_handler|None
+    player: set|str|None
     audit_shots: single|bool|true
     missing_switch_min_games: single|int|10
     num_player_top_records: single|int|1
@@ -326,6 +326,18 @@ coils:
 custom_code:
     __valid_in__: machine
     __type__: list
+dc_motors:
+    __valid_in__: machine
+    __type__: device
+    default_power: single|float|0.0
+    number: single|str|
+    control_events: dict|str:subconfig(dc_motors_pulse_settings)|None
+    platform: single|str|None
+    platform_settings: single|dict|None
+dc_motors_pulse_settings:
+    action: single|enum(pulse,reverse_pulse,stop)|pulse
+    power: single|float|None
+    duration: single|template_secs|None
 digital_outputs:
     __valid_in__: machine
     __type__: device
@@ -639,7 +651,7 @@ fast_net:
     console_log: single|enum(none,basic,full)|none
     file_log: single|enum(none,basic,full)|basic
     controller: single|enum(neuron,nano,sys11,wpc89,wpc95)|
-    watchdog: single|ms|1000
+    watchdog: single|ms|500
     default_quick_debounce_open: single|ms|2
     default_quick_debounce_close: single|ms|2
     default_normal_debounce_open: single|ms|4
@@ -647,6 +659,8 @@ fast_net:
     mute_unconfigured_switches: single|bool|false
     gi_hz: single|int|30
     lamp_hz: single|int|30
+    soft_power_hold_ms: single|ms|2500
+    soft_power_powerdown_delay: single|ms|4000
 fast_io_loop:
     model: single|str|  # FP-I/O-0804, etc.
     order: single|enum(1,2,3,4,5,6,7,8,9)|
@@ -814,6 +828,7 @@ hardware:
     i2c: list|str|default
     stepper_controllers: list|str|default
     shaker_controllers: list|str|default
+    motor_controllers: list|str|default
     hardware_sound_system: list|str|default
 hardware_sound_systems:
     __valid_in__: machine
@@ -1039,6 +1054,7 @@ machine:
     __type__: config
     balls_installed: single|int|1
     min_balls: single|int|1
+    soft_shutdown_exit_command: single|str|None
 machine_vars:
     __valid_in__: machine
     __type__: config_dict
@@ -1129,6 +1145,10 @@ mpf:
 mpf-mc:
     __valid_in__: machine                           # todo add to validator
     __type__: config
+data_manager:
+    __valid_in__: machine
+    __type__: config
+    use_fsync: single|bool|None
 multiballs:
     __valid_in__: machine, mode
     __type__: device
@@ -1585,6 +1605,7 @@ shots:
     switches: list|machine(switches)|None
     start_enabled: single|bool|None
     delay_switch: dict|machine(switches):ms|None
+    delay_event_list: dict|event_handler:ms|None
     persist_enable: single|bool|true
     playfield: single|machine(playfields)|playfield
     priority: single|int|0
@@ -2150,15 +2171,6 @@ trinamics_steprocker:
     __valid_in__: machine
     __type__: config
     port: single|str|
-twitch_client:
-    __valid_in__: machine
-    __type__: config
-    user: single|str|None
-    password: single|str|None
-    channel: single|str|None
-    user_var: single|str|None
-    password_var: single|str|None
-    channel_var: single|str|None
 variable_player:
     __valid_in__: machine, mode
     __type__: config_player

mpf/core/async_mode.py

@@ -1,13 +1,13 @@
 """Base class for asyncio modes."""
-from typing import Optional
+from typing import Optional, TYPE_CHECKING
 
 import abc
 import asyncio
 
 from mpf.core.mode import Mode
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.machine import MachineController  # pylint: disable-msg=cyclic-import,unused-import
 
 

mpf/core/ball_search.py

@@ -1,14 +1,14 @@
 """Implements the ball search procedure."""
 from collections import namedtuple
 
-from typing import List
+from typing import List, TYPE_CHECKING
 
 from mpf.core.delays import DelayManager
 from mpf.core.machine import MachineController
 from mpf.core.mpf_controller import MpfController
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.devices.playfield import Playfield     # pylint: disable-msg=cyclic-import,unused-import
 
 BallSearchCallback = namedtuple("BallSearchCallback", ["priority", "callback", "name", "restore_callback"])

mpf/core/bcp/bcp.py

@@ -1,7 +1,7 @@
 """BCP module."""
 import asyncio
 from functools import partial
-from typing import List
+from typing import List, TYPE_CHECKING
 
 from mpf.core.events import QueuedEvent
 from mpf.core.mpf_controller import MpfController
@@ -12,8 +12,8 @@ from mpf.core.utility_functions import Util
 from mpf.core.bcp.bcp_interface import BcpInterface
 from mpf.core.bcp.bcp_transport import BcpTransportManager
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.machine import MachineController  # pylint: disable-msg=cyclic-import,unused-import
 
 

mpf/core/bcp/bcp_transport.py

@@ -1,13 +1,13 @@
 """Classes which manage BCP transports."""
 from collections import defaultdict
 
-from typing import Union
+from typing import Union, TYPE_CHECKING
 
 from mpf.core.bcp.bcp_client import BaseBcpClient
 from mpf.core.utility_functions import Util
 
-MYPY = False  # noqa
-if MYPY:
+  # noqa
+if TYPE_CHECKING:
     from mpf.core.machine import MachineController  # pylint: disable-msg=cyclic-import,unused-import
 
 

mpf/core/config_player.py

@@ -3,7 +3,7 @@ import abc
 import asyncio
 import re
 from functools import partial
-from typing import List
+from typing import List, TYPE_CHECKING
 
 from mpf.core.machine import MachineController
 from mpf.core.mode import Mode
@@ -11,8 +11,8 @@ from mpf.core.logging import LogMixin
 from mpf.exceptions.config_file_error import ConfigFileError
 from mpf.core.placeholder_manager import ConditionalEvent
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.placeholder_manager import BoolTemplate   # pylint: disable-msg=cyclic-import,unused-import
     from typing import Dict     # pylint: disable-msg=cyclic-import,unused-import
 

mpf/core/config_spec_loader.py

@@ -1,11 +1,12 @@
 """Parse config_spec."""
-from pkg_resources import iter_entry_points
+from typing import TYPE_CHECKING
+import importlib.metadata
 
 from mpf.core.utility_functions import Util
 from mpf.file_interfaces.yaml_interface import YamlInterface
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.device import Device  # pylint: disable-msg=cyclic-import,unused-import
 
 
@@ -37,7 +38,8 @@ class ConfigSpecLoader:
     @staticmethod
     def load_external_platform_config_specs(config):
         """Load config spec for external platforms."""
-        for platform_entry in iter_entry_points(group='mpf.platforms'):
+        eps = importlib.metadata.entry_points(group='mpf.platforms')
+        for platform_entry in eps:
             config_spec = platform_entry.load().get_config_spec()
 
             if config_spec:

mpf/core/config_validator.py

@@ -6,8 +6,7 @@ import re
 from collections import namedtuple
 from copy import deepcopy
 
-from typing import Any
-from typing import Dict
+from typing import Any, Dict, TYPE_CHECKING
 
 from mpf.core.config_spec_loader import ConfigSpecLoader
 from mpf.core.rgb_color import NAMED_RGB_COLORS, RGBColor
@@ -15,8 +14,8 @@ from mpf.exceptions.config_file_error import ConfigFileError
 from mpf.file_interfaces.yaml_interface import YamlInterface
 from mpf.core.utility_functions import Util
 
-MYPY = False
-if MYPY:    # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.machine import MachineController  # pylint: disable-msg=cyclic-import,unused-import
 
 

mpf/core/data_manager.py

@@ -3,6 +3,7 @@
 import copy
 import os
 import errno
+import sys
 import threading
 import time
 import _thread
@@ -17,10 +18,10 @@ class DataManager(MpfController):
 
     config_name = "data_manager"
 
-    __slots__ = ["name", "min_wait_secs", "filename", "data", "_dirty"]
+    __slots__ = ["config", "name", "min_wait_secs", "filename", "data", "_dirty", "use_fsync"]
 
     def __init__(self, machine, name, min_wait_secs=1):
-        """Initialize data manger.
+        """Initialize data manager.
 
         The DataManager is responsible for reading and writing data to/from a
         file on disk.
@@ -48,6 +49,14 @@ class DataManager(MpfController):
         else:
             raise AssertionError("Invalid path {} for {}".format(config_path, name))
 
+        self.config = self.machine.config_validator.validate_config(
+            "data_manager", self.machine.config.get('data_manager'))
+
+        maybe_use_fsync = self.config.get('use_fsync', None)
+        if maybe_use_fsync is None:
+            maybe_use_fsync = sys.platform != 'win32'
+        self.use_fsync = maybe_use_fsync
+
         self.data = dict()
         self._dirty = threading.Event()
 
@@ -116,29 +125,22 @@ class DataManager(MpfController):
 
     def _writing_thread(self):  # pragma: no cover
         # prevent early writes at start-up
-        data = None
         time.sleep(self.min_wait_secs)
         while not self.machine.thread_stopper.is_set():
             if not self._dirty.wait(1):
                 continue
-            while FileManager.is_busy:
-                time.sleep(0.2)
             self._dirty.clear()
 
-            data = copy.deepcopy(self.data)
             # save data
             try:
-                FileManager.save(self.filename, data)
+                FileManager.save(self.filename, copy.deepcopy(self.data), self.use_fsync)
             except Exception as e:  # pylint: disable=broad-exception-caught
                 # If the file writer has an exception handle it here. Otherwise
                 # this thread will die and all subsequent write attempts will no-op.
                 self.info_log("ERROR writing file %s: %s", self.filename, e)
-            data = None
             # prevent too many writes
             time.sleep(self.min_wait_secs)
 
         # if dirty write data one last time during shutdown
-        if data and self._dirty.is_set():
-            while FileManager.is_busy:
-                time.sleep(0.2)
-            FileManager.save(self.filename, data)
+        if self._dirty.is_set():
+            FileManager.save(self.filename, copy.deepcopy(self.data), self.use_fsync)

mpf/core/delays.py

@@ -2,11 +2,11 @@
 
 import uuid
 from functools import partial
-from typing import Any, Callable, Dict, Tuple
+from typing import Any, Callable, Dict, Tuple, TYPE_CHECKING
 from mpf.core.mpf_controller import MpfController
 
-MYPY = False
-if MYPY:    # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.machine import MachineController  # pylint: disable-msg=cyclic-import,unused-import
 
 __api__ = ['DelayManager']

mpf/core/device.py

@@ -1,13 +1,13 @@
 """Contains the Device base class."""
 import abc
 
-from typing import List, Any, Optional
+from typing import List, Any, Optional, TYPE_CHECKING
 
 from mpf.core.machine import MachineController
 from mpf.core.logging import LogMixin
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.mode import Mode      # pylint: disable-msg=cyclic-import,unused-import
     from mpf.core.platform import BasePlatform    # pylint: disable-msg=cyclic-import,unused-import; # noqa
 

mpf/core/device_manager.py

@@ -1,13 +1,13 @@
 """Contains the DeviceManager base class."""
 import asyncio
 
-from typing import Callable, Tuple, List, Generator, Dict
+from typing import Callable, Tuple, List, Generator, Dict, TYPE_CHECKING
 
 from mpf.core.utility_functions import Util
 from mpf.core.mpf_controller import MpfController
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.device import Device  # pylint: disable-msg=cyclic-import,unused-import
 
 

mpf/core/enable_disable_mixin.py

@@ -1,5 +1,5 @@
 """Implements enable and disable events for devices."""
-from typing import Optional
+from typing import Optional, TYPE_CHECKING
 
 import abc
 
@@ -12,8 +12,8 @@ from mpf.core.events import event_handler
 from mpf.core.mode_device import ModeDevice
 from mpf.core.machine import MachineController
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.mode import Mode  # pylint: disable-msg=cyclic-import,unused-import
     from mpf.core.player import Player  # pylint: disable-msg=cyclic-import,unused-import
 

mpf/core/events.py

@@ -7,12 +7,12 @@ import asyncio
 from functools import partial, lru_cache
 from unittest.mock import MagicMock
 
-from typing import Dict, Any, Tuple, Optional, Callable, List
+from typing import Dict, Any, Tuple, Optional, Callable, List, TYPE_CHECKING
 
 from mpf.core.mpf_controller import MpfController
 
-MYPY = False
-if MYPY:   # pragma: no cover
+
+if TYPE_CHECKING:
     from mpf.core.machine import MachineController      # pylint: disable-msg=cyclic-import,unused-import
     from mpf.core.placeholder_manager import BaseTemplate   # pylint: disable-msg=cyclic-import,unused-import
     from typing import Deque    # pylint: disable-msg=cyclic-import,unused-import