refactor!: tmuxp.workspacebuilder -> tmuxp.workspace.builder · tmux-python/tmuxp@6dfeb38 · GitHub
Skip to content

Commit 6dfeb38

Browse files
committed
refactor!: tmuxp.workspacebuilder -> tmuxp.workspace.builder
1 parent ae29549 commit 6dfeb38

8 files changed

Lines changed: 20 additions & 20 deletions

File tree

‎docs/api.md‎

Lines changed: 2 additions & 2 deletions

‎docs/configuration/examples.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -761,7 +761,7 @@ windows:
761761

762762
tmuxp sessions can be scripted in python. The first way is to use the
763763
ORM in the {ref}`API`. The second is to pass a {py:obj}`dict` into
764-
{class}`~tmuxp.workspacebuilder.WorkspaceBuilder` with a correct schema.
764+
{class}`~tmuxp.workspace.builder.WorkspaceBuilder` with a correct schema.
765765
See: {meth}`tmuxp.config.validate_schema`.
766766

767767
:::

‎src/tmuxp/cli/freeze.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
from .. import util
1212
from ..workspace import config
13-
from ..workspacebuilder import freeze
13+
from ..workspace.builder import freeze
1414
from .utils import get_config_dir, prompt, prompt_choices, prompt_yes_no
1515

1616
if t.TYPE_CHECKING:

‎src/tmuxp/cli/load.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
from .. import config_reader, exc, log, util
2222
from ..workspace import config
23-
from ..workspacebuilder import WorkspaceBuilder
23+
from ..workspace.builder import WorkspaceBuilder
2424
from .utils import (
2525
find_workspace_file,
2626
get_config_dir,
@@ -154,7 +154,7 @@ def _reattach(builder: WorkspaceBuilder):
154154
155155
Parameters
156156
----------
157-
builder: :class:`workspacebuilder.WorkspaceBuilder`
157+
builder: :class:`workspace.builder.WorkspaceBuilder`
158158
159159
Notes
160160
-----
@@ -183,7 +183,7 @@ def _load_attached(builder: WorkspaceBuilder, detached: bool) -> None:
183183
184184
Parameters
185185
----------
186-
builder: :class:`workspacebuilder.WorkspaceBuilder`
186+
builder: :class:`workspace.builder.WorkspaceBuilder`
187187
detached : bool
188188
"""
189189
builder.build()
@@ -216,7 +216,7 @@ def _load_detached(builder: WorkspaceBuilder) -> None:
216216
217217
Parameters
218218
----------
219-
builder: :class:`workspacebuilder.WorkspaceBuilder`
219+
builder: :class:`workspace.builder.WorkspaceBuilder`
220220
"""
221221
builder.build()
222222

@@ -233,7 +233,7 @@ def _load_append_windows_to_current_session(builder: WorkspaceBuilder) -> None:
233233
234234
Parameters
235235
----------
236-
builder: :class:`workspacebuilder.WorkspaceBuilder`
236+
builder: :class:`workspace.builder.WorkspaceBuilder`
237237
"""
238238
current_attached_session = builder.find_current_attached_session()
239239
builder.build(current_attached_session, append=True)
@@ -248,7 +248,7 @@ def _setup_plugins(builder: WorkspaceBuilder) -> Session:
248248
249249
Parameters
250250
----------
251-
builder: :class:`workspacebuilder.WorkspaceBuilder`
251+
builder: :class:`workspace.builder.WorkspaceBuilder`
252252
"""
253253
for plugin in builder.plugins:
254254
plugin.before_script(builder.session)
@@ -311,7 +311,7 @@ def load_workspace(
311311
just the object.
312312
313313
The prepared configuration and the server object is passed into an instance
314-
of :class:`~tmuxp.workspacebuilder.WorkspaceBuilder`.
314+
of :class:`~tmuxp.workspace.builder.WorkspaceBuilder`.
315315
316316
A sanity check against :meth:`libtmux.common.which` is ran. It will raise
317317
an exception if tmux isn't found.
@@ -321,7 +321,7 @@ def load_workspace(
321321
does not allow appending a workspace / incremental building on top of a
322322
current session (pull requests are welcome!).
323323
324-
:meth:`~tmuxp.workspacebuilder.WorkspaceBuilder.build` will build the session in
324+
:meth:`~tmuxp.workspace.builder.build` will build the session in
325325
the background via using tmux's detached state (``-d``).
326326
327327
After the session (workspace) is built, unless the user decided to load
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
"""Create a tmux workspace from a configuration :py:obj:`dict`.
1+
"""Create a tmux workspace from a workspace configuration :py:obj:`dict`.
22
3-
tmuxp.workspacebuilder
4-
~~~~~~~~~~~~~~~~~~~~~~
3+
tmuxp.workspace.builder
4+
~~~~~~~~~~~~~~~~~~~~~~~
55
66
"""
77
import logging
@@ -13,8 +13,8 @@
1313
from libtmux.session import Session
1414
from libtmux.window import Window
1515

16-
from . import exc
17-
from .util import get_current_pane, run_before_script
16+
from .. import exc
17+
from ..util import get_current_pane, run_before_script
1818

1919
logger = logging.getLogger(__name__)
2020

‎tests/test_cli.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
)
3232
from tmuxp.config_reader import ConfigReader
3333
from tmuxp.workspace import config
34-
from tmuxp.workspacebuilder import WorkspaceBuilder
34+
from tmuxp.workspace.builder import WorkspaceBuilder
3535

3636
from .constants import FIXTURE_PATH
3737
from .fixtures import utils as test_utils

‎tests/test_workspacebuilder.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
from tmuxp.cli.load import load_plugins
1616
from tmuxp.config_reader import ConfigReader
1717
from tmuxp.workspace import config
18-
from tmuxp.workspacebuilder import WorkspaceBuilder
18+
from tmuxp.workspace.builder import WorkspaceBuilder
1919

2020
from .constants import EXAMPLE_PATH, FIXTURE_PATH
2121
from .fixtures import utils as test_utils

‎tests/test_workspacefreezer.py‎

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)