refactor!: config_reader to tmuxp._internal (#897)

Fixes #894

Author: tony

CHANGES

@@ -24,6 +24,7 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
 - libtmux: 0.24.1 -> 0.25.0, maintenance release (#896)
 
   Improve styling via pydocstyle.
+- `config_reader`: Move to `tmuxp._internal` (#897)
 
 ## tmuxp 1.33.0 (2023-12-21)
 

docs/api.md

@@ -110,7 +110,7 @@ If you need an internal API stabilized please [file an issue](https://github.com
 ## Configuration reader
 
 ```{eval-rst}
-.. automodule:: tmuxp.config_reader
+.. automodule:: tmuxp._internal.config_reader
 ```
 
 ## Workspace Builder

src/tmuxp/_internal/__init__.py

@@ -0,0 +1 @@
+"""Internal APIs for tmuxp."""

src/tmuxp/config_reader.py renamed to src/tmuxp/_internal/config_reader.py

@@ -55,13 +55,13 @@ def load(cls, format: "FormatLiteral", content: str) -> "ConfigReader":
 
         >>> cfg = ConfigReader.load("json", '{ "session_name": "my session" }')
         >>> cfg
-        <tmuxp.config_reader.ConfigReader object at ...>
+        <tmuxp._internal.config_reader.ConfigReader object at ...>
         >>> cfg.content
         {'session_name': 'my session'}
 
         >>> cfg = ConfigReader.load("yaml", 'session_name: my session')
         >>> cfg
-        <tmuxp.config_reader.ConfigReader object at ...>
+        <tmuxp._internal.config_reader.ConfigReader object at ...>
         >>> cfg.content
         {'session_name': 'my session'}
         """
@@ -133,7 +133,7 @@ def from_file(cls, path: pathlib.Path) -> "ConfigReader":
 
         >>> cfg = ConfigReader.from_file(yaml_file)
         >>> cfg
-        <tmuxp.config_reader.ConfigReader object at ...>
+        <tmuxp._internal.config_reader.ConfigReader object at ...>
 
         >>> cfg.content
         {'session_name': 'my session'}
@@ -150,7 +150,7 @@ def from_file(cls, path: pathlib.Path) -> "ConfigReader":
 
         >>> cfg = ConfigReader.from_file(json_file)
         >>> cfg
-        <tmuxp.config_reader.ConfigReader object at ...>
+        <tmuxp._internal.config_reader.ConfigReader object at ...>
 
         >>> cfg.content
         {'session_name': 'my session'}

src/tmuxp/cli/convert.py

@@ -4,7 +4,7 @@
 import pathlib
 import typing as t
 
-from tmuxp.config_reader import ConfigReader
+from tmuxp._internal.config_reader import ConfigReader
 from tmuxp.workspace.finders import find_workspace_file, get_workspace_dir
 
 from .. import exc

src/tmuxp/cli/freeze.py

@@ -7,7 +7,7 @@
 
 from libtmux.server import Server
 
-from tmuxp.config_reader import ConfigReader
+from tmuxp._internal.config_reader import ConfigReader
 from tmuxp.exc import TmuxpException
 from tmuxp.workspace.finders import get_workspace_dir
 

src/tmuxp/cli/import_config.py

@@ -5,7 +5,7 @@
 import sys
 import typing as t
 
-from tmuxp.config_reader import ConfigReader
+from tmuxp._internal.config_reader import ConfigReader
 from tmuxp.workspace.finders import find_workspace_file
 
 from ..workspace import importers

src/tmuxp/cli/load.py

@@ -14,7 +14,8 @@
 
 from tmuxp.types import StrPath
 
-from .. import config_reader, exc, log, util
+from .. import exc, log, util
+from .._internal import config_reader
 from ..workspace import loader
 from ..workspace.builder import WorkspaceBuilder
 from ..workspace.finders import find_workspace_file, get_workspace_dir

src/tmuxp/workspace/builder.py

@@ -97,15 +97,15 @@ class WorkspaceBuilder:
 
     1. Load JSON / YAML file via via :class:`pathlib.Path`::
 
-           from tmuxp import config_reader
+           from tmuxp._internal import config_reader
            session_config = config_reader.ConfigReader._load(raw_yaml)
 
        The reader automatically detects the file type from :attr:`pathlib.suffix`.
 
        We can also parse raw file::
 
            import pathlib
-           from tmuxp import config_reader
+           from tmuxp._internal import config_reader
 
            session_config = config_reader.ConfigReader._from_file(
                pathlib.Path('path/to/config.yaml')

tests/cli/test_cli.py

@@ -9,10 +9,10 @@
 from libtmux.server import Server
 
 from tmuxp import cli
+from tmuxp._internal.config_reader import ConfigReader
 from tmuxp.cli.import_config import get_teamocil_dir, get_tmuxinator_dir
 from tmuxp.cli.load import _reattach, load_plugins
 from tmuxp.cli.utils import tmuxp_echo
-from tmuxp.config_reader import ConfigReader
 from tmuxp.workspace import loader
 from tmuxp.workspace.builder import WorkspaceBuilder
 from tmuxp.workspace.finders import find_workspace_file

tests/cli/test_freeze.py

@@ -8,7 +8,7 @@
 from libtmux.server import Server
 
 from tmuxp import cli
-from tmuxp.config_reader import ConfigReader
+from tmuxp._internal.config_reader import ConfigReader
 
 
 @pytest.mark.parametrize(

tests/cli/test_load.py

@@ -12,13 +12,13 @@
 from pytest_mock import MockerFixture
 
 from tmuxp import cli
+from tmuxp._internal.config_reader import ConfigReader
 from tmuxp.cli.load import (
     _load_append_windows_to_current_session,
     _load_attached,
     load_plugins,
     load_workspace,
 )
-from tmuxp.config_reader import ConfigReader
 from tmuxp.workspace import loader
 from tmuxp.workspace.builder import WorkspaceBuilder
 

tests/workspace/test_builder.py

@@ -18,8 +18,8 @@
 from libtmux.window import Window
 
 from tmuxp import exc
+from tmuxp._internal.config_reader import ConfigReader
 from tmuxp.cli.load import load_plugins
-from tmuxp.config_reader import ConfigReader
 from tmuxp.workspace import loader
 from tmuxp.workspace.builder import WorkspaceBuilder
 

tests/workspace/test_config.py

@@ -5,7 +5,7 @@
 import pytest
 
 from tmuxp import exc
-from tmuxp.config_reader import ConfigReader
+from tmuxp._internal.config_reader import ConfigReader
 from tmuxp.workspace import loader, validation
 
 from ..constants import EXAMPLE_PATH

tests/workspace/test_freezer.py

@@ -5,7 +5,7 @@
 
 from libtmux.session import Session
 
-from tmuxp.config_reader import ConfigReader
+from tmuxp._internal.config_reader import ConfigReader
 from tmuxp.workspace import freezer, validation
 from tmuxp.workspace.builder import WorkspaceBuilder
 

tests/workspace/test_import_teamocil.py

@@ -3,7 +3,7 @@
 
 import pytest
 
-from tmuxp import config_reader
+from tmuxp._internal import config_reader
 from tmuxp.workspace import importers, validation
 
 from ..fixtures import import_teamocil as fixtures

tests/workspace/test_import_tmuxinator.py

@@ -3,7 +3,7 @@
 
 import pytest
 
-from tmuxp.config_reader import ConfigReader
+from tmuxp._internal.config_reader import ConfigReader
 from tmuxp.workspace import importers, validation
 
 from ..fixtures import import_tmuxinator as fixtures