chore: disable BoardManual.pin_read

Author: machow

.env.dev

@@ -1,6 +1,7 @@
 # This allows the unit tests to run, while not using
 # the full <user_name>/<pin_name> format.
 PINS_ALLOW_RSC_SHORT_NAME=1
+PINS_FEATURE_PREVIEW=1
 
 # Pins optional config ----
 #PINS_CACHE_DIR=.pins_cache

.github/workflows/ci.yml

@@ -10,6 +10,7 @@ on:
 
 env:
   PINS_ALLOW_RSC_SHORT_NAME: 1
+  PINS_FEATURE_PREVIEW: 1
 
 jobs:
   tests:

pins/boards.py

@@ -16,7 +16,7 @@
 from .errors import PinsError
 from .drivers import load_data, save_data, default_title
 from .utils import inform
-from .config import get_allow_rsc_short_name
+from .config import get_allow_rsc_short_name, get_feature_preview
 
 
 _log = logging.getLogger(__name__)
@@ -623,6 +623,15 @@ def __init__(self, *args, pin_paths: dict, **kwargs):
 
         self.pin_paths = pin_paths
 
+    def pin_read(self, *args, **kwargs):
+        if not get_feature_preview():
+            raise NotImplementedError(
+                "pin_read with BoardManual is currently unimplemented. "
+                "See https://github.com/machow/pins-python/issues/59."
+            )
+
+        return super().pin_read(*args, **kwargs)
+
     def pin_list(self):
         return list(self.pin_paths)
 

pins/config.py

@@ -8,6 +8,7 @@
 PINS_ENV_CACHE_DIR = "PINS_CACHE_DIR"
 PINS_ENV_INSECURE_READ = "PINS_ALLOW_PICKLE_READ"
 PINS_ENV_ALLOW_RSC_SHORT_NAME = "PINS_ALLOW_RSC_SHORT_NAME"
+PINS_ENV_FEATURE_PREVIEW = "PINS_FEATURE_PREVIEW"
 
 pins_options = SimpleNamespace(quiet=False)
 
@@ -42,3 +43,7 @@ def get_allow_pickle_read(flag):
 
 def get_allow_rsc_short_name():
     return _interpret_int(PINS_ENV_ALLOW_RSC_SHORT_NAME)
+
+
+def get_feature_preview():
+    return _interpret_int(PINS_ENV_FEATURE_PREVIEW)