-
Notifications
You must be signed in to change notification settings - Fork 237
Expand file tree
/
Copy pathconvert.py
More file actions
140 lines (116 loc) · 3.79 KB
/
convert.py
File metadata and controls
140 lines (116 loc) · 3.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
"""CLI for ``tmuxp convert`` subcommand."""
from __future__ import annotations
import locale
import logging
import os
import pathlib
import typing as t
from tmuxp import exc
from tmuxp._internal.config_reader import ConfigReader
from tmuxp._internal.private_path import PrivatePath
from tmuxp.workspace.finders import find_workspace_file, get_workspace_dir
from ._colors import Colors, build_description, get_color_mode
from .utils import prompt_yes_no, tmuxp_echo
logger = logging.getLogger(__name__)
CONVERT_DESCRIPTION = build_description(
"""
Convert workspace files between YAML and JSON format.
""",
(
(
None,
[
"tmuxp convert workspace.yaml",
"tmuxp convert workspace.json",
"tmuxp convert -y workspace.yaml",
],
),
),
)
if t.TYPE_CHECKING:
import argparse
AllowedFileTypes = t.Literal["json", "yaml"]
CLIColorModeLiteral: t.TypeAlias = t.Literal["auto", "always", "never"]
def create_convert_subparser(
parser: argparse.ArgumentParser,
) -> argparse.ArgumentParser:
"""Augment :class:`argparse.ArgumentParser` with ``convert`` subcommand."""
workspace_file = parser.add_argument(
dest="workspace_file",
type=str,
metavar="workspace-file",
help="checks tmuxp and current directory for workspace files.",
)
try:
import shtab
workspace_file.complete = shtab.FILE # type: ignore
except ImportError:
pass
parser.add_argument(
"--yes",
"-y",
dest="answer_yes",
action="store_true",
help="always answer yes",
)
return parser
class ConvertUnknownFileType(exc.TmuxpException):
"""Raise if tmuxp convert encounters an unknown filetype."""
def __init__(self, ext: str, *args: object, **kwargs: object) -> None:
return super().__init__(
f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])",
)
def command_convert(
workspace_file: str | pathlib.Path,
answer_yes: bool,
parser: argparse.ArgumentParser | None = None,
color: CLIColorModeLiteral | None = None,
) -> None:
"""Entrypoint for ``tmuxp convert`` convert a tmuxp config between JSON and YAML."""
color_mode = get_color_mode(color)
colors = Colors(color_mode)
workspace_file = find_workspace_file(
workspace_file,
workspace_dir=get_workspace_dir(),
)
if isinstance(workspace_file, str):
workspace_file = pathlib.Path(workspace_file)
_, ext = os.path.splitext(workspace_file)
ext = ext.lower()
to_filetype: AllowedFileTypes
if ext == ".json":
to_filetype = "yaml"
elif ext in {".yaml", ".yml"}:
to_filetype = "json"
else:
raise ConvertUnknownFileType(ext)
configparser = ConfigReader.from_file(workspace_file)
newfile = workspace_file.parent / (str(workspace_file.stem) + f".{to_filetype}")
new_workspace = configparser.dump(
fmt=to_filetype,
indent=2,
**{"default_flow_style": False} if to_filetype == "yaml" else {},
)
if (
not answer_yes
and prompt_yes_no(
f"Convert {colors.info(str(PrivatePath(workspace_file)))} to "
f"{colors.highlight(to_filetype)}?",
color_mode=color_mode,
)
and prompt_yes_no(
f"Save workspace to {colors.info(str(PrivatePath(newfile)))}?",
color_mode=color_mode,
)
):
answer_yes = True
if answer_yes:
pathlib.Path(newfile).write_text(
new_workspace,
encoding=locale.getpreferredencoding(False),
)
tmuxp_echo(
colors.success("New workspace file saved to ")
+ colors.info(str(PrivatePath(newfile)))
+ ".",
)