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 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
|
from pathlib import Path
from typing import Optional, Tuple
import pytest
from cyclopts import types as ct
from cyclopts.exceptions import ValidationError
@pytest.fixture
def tmp_file(tmp_path):
file_path = tmp_path / "file.bin"
file_path.touch()
return file_path
# ExistingPath
def test_types_existing_path(convert, tmp_file):
assert tmp_file == convert(ct.ExistingPath, tmp_file)
def test_types_existing_path_validation_error(convert, tmp_path):
with pytest.raises(ValidationError):
convert(ct.ExistingPath, tmp_path / "foo")
# ExistingFile
def test_types_existing_file(convert, tmp_file):
assert tmp_file == convert(ct.ExistingFile, tmp_file)
def test_types_existing_file_app(app):
"""https://github.com/BrianPugh/cyclopts/issues/287"""
@app.default
def main(f: ct.ExistingFile):
pass
with pytest.raises(ValidationError):
app(["this-file-does-not-exist"], exit_on_error=False)
def test_types_existing_file_app_signature_default(app):
@app.default
def main(f: ct.ExistingFile = Path("this-file-does-not-exist")):
pass
with pytest.raises(ValidationError):
app([""], exit_on_error=False)
def test_types_optional_existing_file_app_signature_default(app):
@app.default
def main(f: Optional[ct.ExistingFile] = Path("this-file-does-not-exist")):
pass
with pytest.raises(ValidationError):
app([""], exit_on_error=False)
def test_types_optional_existing_file_app_signature_default_none(app, assert_parse_args):
@app.default
def main(f: Optional[ct.ExistingFile] = None):
pass
assert_parse_args(main, "")
def test_types_existing_file_app_list(app):
"""https://github.com/BrianPugh/cyclopts/issues/287"""
@app.default
def main(f: list[ct.ExistingFile]):
pass
with pytest.raises(ValidationError):
app(["this-file-does-not-exist"], exit_on_error=False)
def test_types_existing_file_validation_error(convert, tmp_path):
with pytest.raises(ValidationError):
convert(ct.ExistingFile, tmp_path)
# ExistingDirectory
def test_types_existing_directory(convert, tmp_path):
assert tmp_path == convert(ct.ExistingDirectory, tmp_path)
def test_types_existing_directory_validation_error(convert, tmp_file):
with pytest.raises(ValidationError):
convert(ct.ExistingDirectory, tmp_file)
# Directory
def test_types_directory(convert, tmp_path):
assert tmp_path == convert(ct.Directory, tmp_path)
def test_types_directory_validation_error(convert, tmp_file):
with pytest.raises(ValidationError):
convert(ct.Directory, tmp_file)
# File
def test_types_file(convert, tmp_file):
assert tmp_file == convert(ct.File, tmp_file)
def test_types_file_validation_error(convert, tmp_path):
with pytest.raises(ValidationError):
convert(ct.File, tmp_path)
# ResolvedExistingPath
@pytest.mark.parametrize("action", ["touch", "mkdir"])
def test_types_resolved_existing_path(convert, tmp_path, action):
src = tmp_path / ".." / tmp_path.name / "foo"
getattr(src, action)()
assert src.resolve() == convert(ct.ResolvedExistingPath, src)
def test_types_resolved_existing_path_list(app, assert_parse_args):
@app.default
def main(f: list[ct.ResolvedFile]):
pass
expected = Path("foo.bin").resolve()
assert_parse_args(main, "foo.bin", [expected])
def test_types_resolved_existing_path_validation_error(convert, tmp_path):
with pytest.raises(ValidationError):
convert(ct.ResolvedExistingPath, tmp_path / "foo")
# ResolvedExistingFile
def test_types_resolved_existing_file(convert, tmp_path):
src = tmp_path / ".." / tmp_path.name / "foo"
src.touch()
assert src.resolve() == convert(ct.ResolvedExistingFile, src)
def test_types_resolved_existing_file_validation_error(convert, tmp_path):
with pytest.raises(ValidationError):
convert(ct.ResolvedExistingFile, tmp_path / "foo")
# ResolvedExistingDirectory
def test_types_resolved_existing_directory(convert, tmp_path):
src = tmp_path / ".." / tmp_path.name / "foo"
src.mkdir()
assert src.resolve() == convert(ct.ResolvedExistingDirectory, src)
def test_types_resolved_existing_directory_validation_error(convert, tmp_path):
src = tmp_path / ".." / tmp_path.name / "foo"
with pytest.raises(ValidationError):
convert(ct.ResolvedExistingDirectory, src)
# ResolvedDirectory
def test_types_resolved_directory(convert, tmp_path):
assert tmp_path == convert(ct.ResolvedDirectory, tmp_path / "foo" / "..")
def test_types_resolved_directory_validation_error(convert, tmp_file):
with pytest.raises(ValidationError):
convert(ct.ResolvedDirectory, tmp_file)
# ResolvedFile
def test_types_resolved_file(convert, tmp_path):
src = tmp_path / ".." / tmp_path.name / "foo"
src.touch()
assert src.resolve() == convert(ct.ResolvedFile, src)
def test_types_resolved_file_validation_error(convert, tmp_path):
with pytest.raises(ValidationError):
convert(ct.ResolvedFile, tmp_path)
# Misc
def test_types_path_resolve_converter(convert, tmp_path):
"""Tests that ``_path_resolve_converter`` handles things like tuples correctly."""
dir1 = tmp_path / "foo"
dir2 = tmp_path / "bar"
dir1.mkdir()
dir2.mkdir()
actual = convert(Tuple[ct.ResolvedDirectory, ct.ResolvedDirectory], [dir1.as_posix(), dir2.as_posix()])
assert (dir1, dir2) == actual
# File extensions
@pytest.mark.parametrize(
"annotation, ext",
[
(ct.BinPath, "bin"),
(ct.CsvPath, "csv"),
(ct.TxtPath, "txt"),
(ct.ImagePath, "jpg"),
(ct.ImagePath, "jpeg"),
(ct.ImagePath, "png"),
(ct.Mp4Path, "mp4"),
(ct.JsonPath, "json"),
(ct.TomlPath, "toml"),
(ct.YamlPath, "yaml"),
],
)
def test_types_file_extensions_good(annotation, ext, convert, tmp_path):
path = tmp_path / f"foo.{ext}"
convert(annotation, path)
# File extensions
@pytest.mark.parametrize(
"annotation, ext",
[
(ct.ExistingBinPath, "bin"),
(ct.ExistingCsvPath, "csv"),
(ct.ExistingTxtPath, "txt"),
(ct.ExistingImagePath, "jpg"),
(ct.ExistingImagePath, "jpeg"),
(ct.ExistingImagePath, "png"),
(ct.ExistingMp4Path, "mp4"),
(ct.ExistingJsonPath, "json"),
(ct.ExistingTomlPath, "toml"),
(ct.ExistingYamlPath, "yaml"),
],
)
def test_types_file_extensions_exist_good(annotation, ext, convert, tmp_path):
path = tmp_path / f"foo.{ext}"
with pytest.raises(ValidationError):
# File has not been created yet
convert(annotation, path)
path.touch()
convert(annotation, path)
@pytest.mark.parametrize(
"annotation",
[
ct.BinPath,
ct.CsvPath,
ct.TxtPath,
ct.ImagePath,
ct.Mp4Path,
ct.JsonPath,
ct.TomlPath,
ct.YamlPath,
],
)
def test_types_file_extensions_bad(annotation, convert, tmp_path):
path = tmp_path / "foo.bar"
with pytest.raises(ValidationError):
convert(annotation, path)
|