DevContainer Fix/Updates & Backwards Compatiblity Support for EventMsgType 'UNKNOWN/INSTANT_REPLAY' (#402)

* updated regular expression for team turnover to account for no space T# 12 --> T#12

* Debian 12 (latest) broke DevContainers using the Python feature. Flake8 has been deprecated as a setting in settings.json.

* Updated devcontainer extensions

* updated postCreateCommand.sh to install the root project

* Added deprecation warning for UNKNOWN within eventmsgtype along with included test.

Author: rsforbes

.devcontainer/devcontainer.json

@@ -6,7 +6,7 @@
 		"ghcr.io/devcontainers/features/python:latest": {},
 		"ghcr.io/devcontainers-contrib/features/poetry:2": {}
 	},
-	"image": "mcr.microsoft.com/devcontainers/base:debian",
+	"image": "mcr.microsoft.com/devcontainers/base:debian-11",
 	"name": "nba_api",
 	"postCreateCommand": "bash .devcontainer/postCreateCommand.sh",
 	"remoteEnv": {
@@ -15,12 +15,14 @@
 	"customizations": {
 		"vscode": {
 			"extensions": [
-				"ms-python.python",
-				"ms-toolsai.jupyter-keymap",
 				"ms-python.black-formatter",
+				"ms-python.flake8",
+				"ms-python.python",
+				"ms-python.vscode-pylance",
 				"ms-toolsai.jupyter",
-				"ms-toolsai.vscode-jupyter-powertoys",
-				"ms-toolsai.jupyter-renderers"
+				"ms-toolsai.jupyter-keymap",
+				"ms-toolsai.jupyter-renderers",
+				"ms-toolsai.vscode-jupyter-powertoys"
 			]
 		}
 	}

.devcontainer/postCreateCommand.sh

@@ -1,5 +1,5 @@
 pip install --upgrade pip
-poetry install --no-root
+poetry install
 
 # Activate poetry environment
 source $(poetry env info --path)/bin/activate

.vscode/settings.json

@@ -1,6 +1,8 @@
 {
     "editor.formatOnSave": true,
-    "python.linting.flake8Enabled": true,
+    "flake8.args": [
+        "--config=.flake8"
+    ],
     "python.formatting.provider": "black",
     "python.formatting.blackArgs": [
         "--line-length",

src/nba_api/library/_enum_base.py

@@ -0,0 +1,48 @@
+from enum import Enum, EnumMeta
+
+
+class OnAccess(EnumMeta):
+    """
+    runs a user-specified function whenever member is accessed
+    """
+
+    def __getattribute__(cls, name):
+        obj = super().__getattribute__(name)
+        if isinstance(obj, Enum) and obj._on_access:
+            obj._on_access()
+        return obj
+
+    def __getitem__(cls, name):
+        member = super().__getitem__(name)
+        if member._on_access:
+            member._on_access()
+        return member
+
+    def __call__(
+        cls, value, names=None, *, module=None, qualname=None, type=None, start=1
+    ):
+        obj = super().__call__(
+            value, names, module=module, qualname=qualname, type=type, start=start
+        )
+        if isinstance(obj, Enum) and obj._on_access:
+            obj._on_access()
+        return obj
+
+
+class DeprecatedEnum(Enum, metaclass=OnAccess):
+    def __new__(cls, value, *args):
+        member = object.__new__(cls)
+        member._value_ = value
+        member._args = args
+        member._on_access = member.deprecate if args else None
+        return member
+
+    def deprecate(self):
+        args = self._args
+        import warnings
+
+        warnings.warn(
+            "%s" % args,
+            DeprecationWarning,
+            stacklevel=3,
+        )

src/nba_api/stats/library/eventmsgtype.py

@@ -1,7 +1,7 @@
-from enum import Enum
+from nba_api.library._enum_base import DeprecatedEnum
 
 
-class EventMsgType(Enum):
+class EventMsgType(DeprecatedEnum):
     FIELD_GOAL_MADE = 1
     FIELD_GOAL_MISSED = 2
     FREE_THROW = 3
@@ -15,4 +15,6 @@ class EventMsgType(Enum):
     EJECTION = 11
     PERIOD_BEGIN = 12
     PERIOD_END = 13
+    # Deprecated as of 2023.11.10
+    UNKNOWN = 18, "'UNKNOWN' member is deprecated; use 'INSTANT_REPLAY' instead."
     INSTANT_REPLAY = 18

tests/unit/test_eventmsgtype.py

@@ -0,0 +1,16 @@
+import warnings
+from nba_api.stats.library.eventmsgtype import EventMsgType
+
+
+def test_eventmsgtype():
+    with warnings.catch_warnings(record=True) as w:
+        # Invoke Deprecation Warning
+        _ = EventMsgType.UNKNOWN
+
+        assert len(w) == 1
+
+        assert issubclass(w[0].category, DeprecationWarning)
+        assert (
+            str(w[0].message)
+            == "'UNKNOWN' member is deprecated; use 'INSTANT_REPLAY' instead."
+        )