remove Option setter/getter with current property

this makes it more similar to the Ref interface

Author: rmorshea

src/idom/_option.py

@@ -33,8 +33,8 @@ def __init__(
         self._mutable = mutable
         self._validator = validator
         if name in os.environ:
-            self._value = validator(os.environ[name])
-        logger.debug(f"{self._name}={self.get()}")
+            self._current = validator(os.environ[name])
+        logger.debug(f"{self._name}={self.current}")
         ALL_OPTIONS.add(self)
 
     @property
@@ -52,39 +52,44 @@ def default(self) -> _O:
         """This option's default value"""
         return self._default
 
+    @property
+    def current(self) -> _O:
+        try:
+            return self._current
+        except AttributeError:
+            return self._default
+
+    @current.setter
+    def current(self, new: _O) -> None:
+        self.set_current(new)
+        return None
+
     def is_set(self) -> bool:
         """Whether this option has a value other than its default."""
-        return hasattr(self, "_value")
-
-    def get(self) -> _O:
-        """Get the current value of this option."""
-        return cast(_O, getattr(self, "_value", self._default))
+        return hasattr(self, "_current")
 
-    def set(self, new: Any) -> None:
+    def set_current(self, new: Any) -> None:
         """Set the value of this option
 
         Raises a ``TypeError`` if this option is not :attr:`Option.mutable`.
         """
         if not self._mutable:
             raise TypeError(f"{self} cannot be modified after initial load")
-        self._value = self._validator(new)
-        logger.debug(f"{self._name}={self._value}")
+        self._current = self._validator(new)
+        logger.debug(f"{self._name}={self._current}")
 
     def set_default(self, new: _O) -> _O:
         """Set the value of this option if not :meth:`Option.is_set`
 
         Returns the current value (a la :meth:`dict.set_default`)
         """
-        if not hasattr(self, "_value"):
-            self.set(new)
-        return self._value
+        if not hasattr(self, "_current"):
+            self.set_current(new)
+        return self._current
 
     def reload(self) -> None:
-        """Reload this option from its environment variable
-
-        Returns the old value of the option.
-        """
-        self.set(os.environ.get(self._name, self._default))
+        """Reload this option from its environment variable"""
+        self.set_current(os.environ.get(self._name, self._default))
 
     def reset(self) -> None:
         """Reset the value of this option to its default setting
@@ -93,7 +98,7 @@ def reset(self) -> None:
         """
         if not self._mutable:
             raise TypeError(f"{self} cannot be modified after initial load")
-        delattr(self, "_value")
+        delattr(self, "_current")
 
     def __repr__(self) -> str:
-        return f"Option({self._name}={self.get()!r})"
+        return f"Option({self._name}={self.current!r})"

src/idom/cli.py

@@ -70,7 +70,9 @@ def options() -> None:
     table.add_column("Mutable")
 
     for opt in options:
-        value, default, mutable = list(map(str, [opt.get(), opt.default, opt.mutable]))
+        value, default, mutable = list(
+            map(str, [opt.current, opt.default, opt.mutable])
+        )
         table.add_row(opt.name, value, default, mutable)
 
     console.print(table)

src/idom/client/_private.py

@@ -16,24 +16,24 @@
 
 
 def web_modules_dir() -> Path:
-    return IDOM_CLIENT_BUILD_DIR.get().joinpath(
+    return IDOM_CLIENT_BUILD_DIR.current.joinpath(
         *IDOM_CLIENT_IMPORT_SOURCE_URL_INFIX[1:].split("/")
     )
 
 
-if not IDOM_CLIENT_BUILD_DIR.get().exists():  # pragma: no cover
-    shutil.copytree(BACKUP_BUILD_DIR, IDOM_CLIENT_BUILD_DIR.get(), symlinks=True)
+if not IDOM_CLIENT_BUILD_DIR.current.exists():  # pragma: no cover
+    shutil.copytree(BACKUP_BUILD_DIR, IDOM_CLIENT_BUILD_DIR.current, symlinks=True)
 
 
 def restore_build_dir_from_backup() -> None:
-    target = IDOM_CLIENT_BUILD_DIR.get()
+    target = IDOM_CLIENT_BUILD_DIR.current
     if target.exists():
         shutil.rmtree(target)
     shutil.copytree(BACKUP_BUILD_DIR, target, symlinks=True)
 
 
 def replace_build_dir(source: Path) -> None:
-    target = IDOM_CLIENT_BUILD_DIR.get()
+    target = IDOM_CLIENT_BUILD_DIR.current
     if target.exists():
         shutil.rmtree(target)
     shutil.copytree(source, target, symlinks=True)
@@ -59,7 +59,7 @@ def split_package_name_and_version(pkg: str) -> Tuple[str, str]:
 
 
 def build_dependencies() -> Dict[str, str]:
-    package_json = IDOM_CLIENT_BUILD_DIR.get() / "package.json"
+    package_json = IDOM_CLIENT_BUILD_DIR.current / "package.json"
     return cast(Dict[str, str], json.loads(package_json.read_text())["dependencies"])
 
 

src/idom/client/manage.py

@@ -43,7 +43,7 @@ def web_module_url(package_name: str) -> str:
     """
     web_module_path(package_name, must_exist=True)
     return (
-        IDOM_CLIENT_IMPORT_SOURCE_URL.get()
+        IDOM_CLIENT_IMPORT_SOURCE_URL.current
         + f"{_private.IDOM_CLIENT_IMPORT_SOURCE_URL_INFIX}/{package_name}.js"
     )
 

src/idom/core/layout.py

@@ -121,7 +121,7 @@ async def render(self) -> LayoutUpdate:
                     f"Did not render component - {component} already unmounted or does not belong to this layout"
                 )
 
-    if IDOM_DEBUG_MODE.get():
+    if IDOM_DEBUG_MODE.current:
         # If in debug mode inject a function that ensures all returned updates
         # contain valid VDOM models. We only do this in debug mode in order to
         # avoid unnecessarily impacting performance.
@@ -482,7 +482,7 @@ def _process_child_type_and_key(
         yield (child, child_type, key)
 
 
-if IDOM_FEATURE_INDEX_AS_DEFAULT_KEY.get():
+if IDOM_FEATURE_INDEX_AS_DEFAULT_KEY.current:
 
     def _default_key(index: int) -> Any:  # pragma: no cover
         return index

src/idom/log.py

@@ -21,7 +21,7 @@ def logging_config_defaults() -> Any:
         "disable_existing_loggers": False,
         "loggers": {
             "idom": {
-                "level": "DEBUG" if IDOM_DEBUG_MODE.get() else "INFO",
+                "level": "DEBUG" if IDOM_DEBUG_MODE.current else "INFO",
                 "handlers": ["console"],
             },
         },

src/idom/server/fastapi.py

@@ -125,7 +125,7 @@ def _setup_static_files(self, config: Config, app: FastAPI) -> None:
             app.mount(
                 f"{url_prefix}/client",
                 StaticFiles(
-                    directory=str(IDOM_CLIENT_BUILD_DIR.get()),
+                    directory=str(IDOM_CLIENT_BUILD_DIR.current),
                     html=True,
                     check_dir=True,
                 ),

src/idom/server/flask.py

@@ -110,7 +110,7 @@ def _setup_blueprint_routes(self, config: Config, blueprint: Blueprint) -> None:
 
             @blueprint.route("/client/<path:path>")
             def send_build_dir(path: str) -> Any:
-                return send_from_directory(str(IDOM_CLIENT_BUILD_DIR.get()), path)
+                return send_from_directory(str(IDOM_CLIENT_BUILD_DIR.current), path)
 
             if config["redirect_root_to_index"]:
 

src/idom/server/sanic.py

@@ -105,7 +105,7 @@ async def sock_recv() -> LayoutEvent:
             await self._run_dispatcher(sock_send, sock_recv, component_params)
 
         if config["serve_static_files"]:
-            blueprint.static("/client", str(IDOM_CLIENT_BUILD_DIR.get()))
+            blueprint.static("/client", str(IDOM_CLIENT_BUILD_DIR.current))
 
             if config["redirect_root_to_index"]:
 

src/idom/server/tornado.py

@@ -97,7 +97,7 @@ def _create_route_handlers(self, config: Config) -> _RouteHandlerSpecs:
                 (
                     r"/client/(.*)",
                     StaticFileHandler,
-                    {"path": str(IDOM_CLIENT_BUILD_DIR.get())},
+                    {"path": str(IDOM_CLIENT_BUILD_DIR.current)},
                 )
             )
             if config["redirect_root_to_index"]:

tests/test__option.py

@@ -15,57 +15,57 @@ def test_option_repr():
 @mock.patch.dict(os.environ, {"A_FAKE_OPTION": "value-from-environ"})
 def test_option_from_os_environ():
     opt = Option("A_FAKE_OPTION", "default-value")
-    assert opt.get() == "value-from-environ"
+    assert opt.current == "value-from-environ"
 
 
 def test_option_from_default():
     opt = Option("A_FAKE_OPTION", "default-value")
-    assert opt.get() == "default-value"
-    assert opt.get() is opt.default
+    assert opt.current == "default-value"
+    assert opt.current is opt.default
 
 
 @mock.patch.dict(os.environ, {"A_FAKE_OPTION": "1"})
 def test_option_validator():
     opt = Option("A_FAKE_OPTION", False, validator=lambda x: bool(int(x)))
 
-    assert opt.get() is True
+    assert opt.current is True
 
-    opt.set("0")
-    assert opt.get() is False
+    opt.current = "0"
+    assert opt.current is False
 
     with pytest.raises(ValueError, match="invalid literal for int"):
-        opt.set("not-an-int")
+        opt.current = "not-an-int"
 
 
 def test_immutable_option():
     opt = Option("A_FAKE_OPTION", "default-value", mutable=False)
     assert not opt.mutable
     with pytest.raises(TypeError, match="cannot be modified after initial load"):
-        opt.set("a-new-value")
+        opt.current = "a-new-value"
     with pytest.raises(TypeError, match="cannot be modified after initial load"):
         opt.reset()
 
 
 def test_option_reset():
     opt = Option("A_FAKE_OPTION", "default-value")
-    opt.set("a-new-value")
+    opt.current = "a-new-value"
     opt.reset()
-    assert opt.get() is opt.default
+    assert opt.current is opt.default
     assert not opt.is_set()
 
 
 @mock.patch.dict(os.environ, {"A_FAKE_OPTION": "value-from-environ"})
 def test_option_reload():
     opt = Option("A_FAKE_OPTION", "default-value")
-    opt.set("some-other-value")
+    opt.current = "some-other-value"
     opt.reload()
-    assert opt.get() == "value-from-environ"
+    assert opt.current == "value-from-environ"
 
 
 def test_option_set():
     opt = Option("A_FAKE_OPTION", "default-value")
     assert not opt.is_set()
-    opt.set("a-new-value")
+    opt.current = "a-new-value"
     assert opt.is_set()
 
 

tests/test_cli.py

@@ -6,7 +6,7 @@
 import idom
 from idom.cli import main
 from idom.client.manage import _private, web_module_exists
-from idom.config import IDOM_CLIENT_BUILD_DIR
+from idom.config import IDOM_CLIENT_BUILD_DIR, IDOM_DEBUG_MODE
 
 
 cli_runner = CliRunner()
@@ -26,7 +26,8 @@ def assert_rich_table_equals(stdout, expected_header, expected_rows):
 
     actual_header, *actual_rows = parsed_lines
 
-    assert actual_header == expected_header and actual_rows == expected_rows
+    assert actual_header == list(map(str, expected_header))
+    assert actual_rows == [list(map(str, row)) for row in expected_rows]
 
 
 @with_large_console
@@ -70,14 +71,23 @@ def test_show_version():
 
 @with_large_console
 def test_show_options():
-    build_dir = str(IDOM_CLIENT_BUILD_DIR.get())
     assert_rich_table_equals(
         cli_runner.invoke(main, ["options"]).stdout,
         ["Name", "Value", "Default", "Mutable"],
         [
-            ["IDOM_CLIENT_BUILD_DIR", build_dir, build_dir, "True"],
+            [
+                "IDOM_CLIENT_BUILD_DIR",
+                IDOM_CLIENT_BUILD_DIR.current,
+                IDOM_CLIENT_BUILD_DIR.default,
+                "True",
+            ],
             ["IDOM_CLIENT_IMPORT_SOURCE_URL", "/client", "/client", "True"],
-            ["IDOM_DEBUG_MODE", "False", "False", "False"],
+            [
+                "IDOM_DEBUG_MODE",
+                IDOM_DEBUG_MODE.current,
+                IDOM_DEBUG_MODE.default,
+                "False",
+            ],
             ["IDOM_FEATURE_INDEX_AS_DEFAULT_KEY", "False", "False", "False"],
         ],
     )