refactor!: Move validate_schema to workspace.validators

Author: tony

docs/api.md

@@ -84,7 +84,7 @@ If you need an internal API stabilized please [file an issue](https://github.com
 ### Validation
 
 ```{eval-rst}
-.. automethod:: tmuxp.workspace.config.validate_schema
+.. automethod:: tmuxp.workspace.validation.validate_schema
 ```
 
 ### Processing

docs/configuration/examples.md

@@ -762,7 +762,7 @@ windows:
 tmuxp sessions can be scripted in python. The first way is to use the
 ORM in the {ref}`API`. The second is to pass a {py:obj}`dict` into
 {class}`~tmuxp.workspace.builder.WorkspaceBuilder` with a correct schema.
-See: {meth}`tmuxp.config.validate_schema`.
+See: {meth}`tmuxp.validation.validate_schema`.
 
 :::
 

src/tmuxp/workspace/builder.py

@@ -157,7 +157,7 @@ def __init__(self, sconf, plugins=[], server=None):
         if not sconf:
             raise exc.EmptyConfigException("session configuration is empty.")
 
-        # config.validate_schema(sconf)
+        # validation.validate_schema(sconf)
 
         if isinstance(server, Server):
             self.server = server

src/tmuxp/workspace/config.py

@@ -8,42 +8,9 @@
 import os
 from typing import Dict
 
-from .. import exc
-
 logger = logging.getLogger(__name__)
 
 
-def validate_schema(workspace_dict):
-    """
-    Return True if workspace schema is correct.
-
-    Parameters
-    ----------
-    workspace_dict : dict
-        tmuxp workspace data
-
-    Returns
-    -------
-    bool
-    """
-    # verify session_name
-    if "session_name" not in workspace_dict:
-        raise exc.WorkspaceError('workspace requires "session_name"')
-
-    if "windows" not in workspace_dict:
-        raise exc.WorkspaceError('workspace requires list of "windows"')
-
-    for window in workspace_dict["windows"]:
-        if "window_name" not in window:
-            raise exc.WorkspaceError('workspace window is missing "window_name"')
-
-    if "plugins" in workspace_dict:
-        if not isinstance(workspace_dict["plugins"], list):
-            raise exc.WorkspaceError('"plugins" only supports list type')
-
-    return True
-
-
 def expandshell(_path):
     """
     Return expanded path based on user's ``$HOME`` and ``env``.

src/tmuxp/workspace/validation.py

@@ -0,0 +1,32 @@
+from .. import exc
+
+
+def validate_schema(workspace_dict):
+    """
+    Return True if workspace schema is correct.
+
+    Parameters
+    ----------
+    workspace_dict : dict
+        tmuxp workspace data
+
+    Returns
+    -------
+    bool
+    """
+    # verify session_name
+    if "session_name" not in workspace_dict:
+        raise exc.WorkspaceError('workspace requires "session_name"')
+
+    if "windows" not in workspace_dict:
+        raise exc.WorkspaceError('workspace requires list of "windows"')
+
+    for window in workspace_dict["windows"]:
+        if "window_name" not in window:
+            raise exc.WorkspaceError('workspace window is missing "window_name"')
+
+    if "plugins" in workspace_dict:
+        if not isinstance(workspace_dict["plugins"], list):
+            raise exc.WorkspaceError('"plugins" only supports list type')
+
+    return True

tests/workspace/test_config.py

@@ -8,7 +8,7 @@
 
 from tmuxp import exc
 from tmuxp.config_reader import ConfigReader
-from tmuxp.workspace import config
+from tmuxp.workspace import config, validation
 
 from ..constants import EXAMPLE_PATH
 
@@ -175,7 +175,7 @@ def test_in_session_scope(config_fixture: "WorkspaceTestData"):
         format="yaml", content=config_fixture.shell_command_before_session.before
     )
 
-    config.validate_schema(sconfig)
+    validation.validate_schema(sconfig)
 
     assert config.expand(sconfig) == sconfig
     assert config.expand(config.trickle(sconfig)) == ConfigReader._load(
@@ -199,7 +199,7 @@ def test_trickle_window_with_no_pane_workspace():
     - window_name: test_no_panes
     """
     sconfig = ConfigReader._load(format="yaml", content=test_yaml)
-    config.validate_schema(sconfig)
+    validation.validate_schema(sconfig)
 
     assert config.expand(config.trickle(sconfig))["windows"][1]["panes"][0] == {
         "shell_command": []
@@ -255,7 +255,7 @@ def test_no_session_name():
     sconfig = ConfigReader._load(format="yaml", content=yaml_workspace)
 
     with pytest.raises(exc.WorkspaceError) as excinfo:
-        config.validate_schema(sconfig)
+        validation.validate_schema(sconfig)
         assert excinfo.matches(r'requires "session_name"')
 
 
@@ -267,7 +267,7 @@ def test_no_windows():
     sconfig = ConfigReader._load(format="yaml", content=yaml_workspace)
 
     with pytest.raises(exc.WorkspaceError) as excinfo:
-        config.validate_schema(sconfig)
+        validation.validate_schema(sconfig)
         assert excinfo.match(r'list of "windows"')
 
 
@@ -289,7 +289,7 @@ def test_no_window_name():
     sconfig = ConfigReader._load(format="yaml", content=yaml_workspace)
 
     with pytest.raises(exc.WorkspaceError) as excinfo:
-        config.validate_schema(sconfig)
+        validation.validate_schema(sconfig)
         assert excinfo.matches('missing "window_name"')
 
 
@@ -351,5 +351,5 @@ def test_plugins():
     sconfig = ConfigReader._load(format="yaml", content=yaml_workspace)
 
     with pytest.raises(exc.WorkspaceError) as excinfo:
-        config.validate_schema(sconfig)
+        validation.validate_schema(sconfig)
         assert excinfo.matches("only supports list type")

tests/workspace/test_freezer.py

@@ -4,7 +4,7 @@
 import typing
 
 from tmuxp.config_reader import ConfigReader
-from tmuxp.workspace import config, freezer
+from tmuxp.workspace import freezer, validation
 from tmuxp.workspace.builder import WorkspaceBuilder
 
 from ..fixtures import utils as test_utils
@@ -27,7 +27,7 @@ def test_freeze_config(session):
     session = session
     new_config = freezer.freeze(session)
 
-    config.validate_schema(new_config)
+    validation.validate_schema(new_config)
 
     # These should dump without an error
     ConfigReader._dump(format="json", content=new_config)

tests/workspace/test_import_teamocil.py

@@ -2,7 +2,7 @@
 import pytest
 
 from tmuxp import config_reader
-from tmuxp.workspace import config, importers
+from tmuxp.workspace import importers, validation
 
 from ..fixtures import import_teamocil as fixtures
 
@@ -40,7 +40,7 @@ def test_config_to_dict(teamocil_yaml, teamocil_dict, tmuxp_dict):
 
     assert importers.import_teamocil(teamocil_dict) == tmuxp_dict
 
-    config.validate_schema(importers.import_teamocil(teamocil_dict))
+    validation.validate_schema(importers.import_teamocil(teamocil_dict))
 
 
 @pytest.fixture(scope="module")
@@ -76,4 +76,6 @@ def test_multisession_config(session_name, expected, multisession_config):
     # teamocil can fit multiple sessions in a config
     assert importers.import_teamocil(multisession_config[session_name]) == expected
 
-    config.validate_schema(importers.import_teamocil(multisession_config[session_name]))
+    validation.validate_schema(
+        importers.import_teamocil(multisession_config[session_name])
+    )

tests/workspace/test_import_tmuxinator.py

@@ -2,7 +2,7 @@
 import pytest
 
 from tmuxp.config_reader import ConfigReader
-from tmuxp.workspace import config, importers
+from tmuxp.workspace import importers, validation
 
 from ..fixtures import import_tmuxinator as fixtures
 
@@ -33,4 +33,4 @@ def test_config_to_dict(tmuxinator_yaml, tmuxinator_dict, tmuxp_dict):
 
     assert importers.import_tmuxinator(tmuxinator_dict) == tmuxp_dict
 
-    config.validate_schema(importers.import_tmuxinator(tmuxinator_dict))
+    validation.validate_schema(importers.import_tmuxinator(tmuxinator_dict))