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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
|
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
import copy
import json
import pickle
from datetime import datetime
import pytest
import tomlkit
from tomlkit import parse
from tomlkit._utils import _utc
from tomlkit.exceptions import NonExistentKey
def test_document_is_a_dict(example):
content = example("example")
doc = parse(content)
assert isinstance(doc, dict)
assert "owner" in doc
# owner
owner = doc["owner"]
assert doc.get("owner") == owner
assert isinstance(owner, dict)
assert "name" in owner
assert owner["name"] == "Tom Preston-Werner"
assert owner["organization"] == "GitHub"
assert owner["bio"] == "GitHub Cofounder & CEO\nLikes tater tots and beer."
assert owner["dob"] == datetime(1979, 5, 27, 7, 32, tzinfo=_utc)
# database
database = doc["database"]
assert isinstance(database, dict)
assert database["server"] == "192.168.1.1"
assert database["ports"] == [8001, 8001, 8002]
assert database["connection_max"] == 5000
assert database["enabled"] is True
# servers
servers = doc["servers"]
assert isinstance(servers, dict)
alpha = servers["alpha"]
assert servers.get("alpha") == alpha
assert isinstance(alpha, dict)
assert alpha["ip"] == "10.0.0.1"
assert alpha["dc"] == "eqdc10"
beta = servers["beta"]
assert isinstance(beta, dict)
assert beta["ip"] == "10.0.0.2"
assert beta["dc"] == "eqdc10"
assert beta["country"] == "中国"
# clients
clients = doc["clients"]
assert isinstance(clients, dict)
data = clients["data"]
assert isinstance(data, list)
assert data[0] == ["gamma", "delta"]
assert data[1] == [1, 2]
assert clients["hosts"] == ["alpha", "omega"]
# Products
products = doc["products"]
assert isinstance(products, list)
hammer = products[0]
assert hammer == {"name": "Hammer", "sku": 738594937}
nail = products[1]
assert nail["name"] == "Nail"
assert nail["sku"] == 284758393
assert nail["color"] == "gray"
nail["color"] = "black"
assert nail["color"] == "black"
assert doc["products"][1]["color"] == "black"
assert nail.get("color") == "black"
content = """foo = "bar"
"""
doc = parse(content)
doc.update({"bar": "baz"})
assert (
doc.as_string()
== """foo = "bar"
bar = "baz"
"""
)
doc.update({"bar": "boom"})
assert (
doc.as_string()
== """foo = "bar"
bar = "boom"
"""
)
assert doc.setdefault("bar", "waldo") == "boom"
assert (
doc.as_string()
== """foo = "bar"
bar = "boom"
"""
)
assert doc.setdefault("thud", "waldo") == "waldo"
assert (
doc.as_string()
== """foo = "bar"
bar = "boom"
thud = "waldo"
"""
)
def test_toml_document_without_super_tables():
content = """[tool.poetry]
name = "foo"
"""
doc = parse(content)
assert "tool" in doc
assert "poetry" in doc["tool"]
assert doc["tool"]["poetry"]["name"] == "foo"
doc["tool"]["poetry"]["name"] = "bar"
assert (
doc.as_string()
== """[tool.poetry]
name = "bar"
"""
)
d = {}
d.update(doc)
assert "tool" in d
def test_toml_document_with_dotted_keys(example):
content = example("0.5.0")
doc = parse(content)
assert "physical" in doc
assert "color" in doc["physical"]
assert "shape" in doc["physical"]
assert doc["physical"]["color"] == "orange"
assert doc["physical"]["shape"] == "round"
assert "site" in doc
assert "google.com" in doc["site"]
assert doc["site"]["google.com"]
assert doc["a"]["b"]["c"] == 1
assert doc["a"]["b"]["d"] == 2
def test_toml_document_super_table_with_different_sub_sections(example):
content = example("pyproject")
doc = parse(content)
tool = doc["tool"]
assert "poetry" in tool
assert "black" in tool
def test_adding_an_element_to_existing_table_with_ws_remove_ws():
content = """[foo]
[foo.bar]
"""
doc = parse(content)
doc["foo"]["int"] = 34
expected = """[foo]
int = 34
[foo.bar]
"""
assert expected == doc.as_string()
def test_document_with_aot_after_sub_tables():
content = """[foo.bar]
name = "Bar"
[foo.bar.baz]
name = "Baz"
[[foo.bar.tests]]
name = "Test 1"
"""
doc = parse(content)
assert doc["foo"]["bar"]["tests"][0]["name"] == "Test 1"
def test_document_with_new_sub_table_after_other_table():
content = """[foo]
name = "Bar"
[bar]
name = "Baz"
[foo.baz]
name = "Test 1"
"""
doc = parse(content)
assert doc["foo"]["name"] == "Bar"
assert doc["bar"]["name"] == "Baz"
assert doc["foo"]["baz"]["name"] == "Test 1"
assert doc.as_string() == content
def test_document_with_new_sub_table_after_other_table_delete():
content = """[foo]
name = "Bar"
[bar]
name = "Baz"
[foo.baz]
name = "Test 1"
"""
doc = parse(content)
del doc["foo"]
assert (
doc.as_string()
== """[bar]
name = "Baz"
"""
)
def test_document_with_new_sub_table_after_other_table_replace():
content = """[foo]
name = "Bar"
[bar]
name = "Baz"
[foo.baz]
name = "Test 1"
"""
doc = parse(content)
doc["foo"] = {"a": "b"}
assert (
doc.as_string()
== """[foo]
a = "b"
[bar]
name = "Baz"
"""
)
def test_inserting_after_element_with_no_new_line_adds_a_new_line():
doc = parse("foo = 10")
doc["bar"] = 11
expected = """foo = 10
bar = 11
"""
assert expected == doc.as_string()
doc = parse("# Comment")
doc["bar"] = 11
expected = """# Comment
bar = 11
"""
assert expected == doc.as_string()
def test_inserting_after_deletion():
doc = parse("foo = 10\n")
del doc["foo"]
doc["bar"] = 11
expected = """bar = 11
"""
assert expected == doc.as_string()
def test_toml_document_with_dotted_keys_inside_table(example):
content = example("0.5.0")
doc = parse(content)
t = doc["table"]
assert "a" in t
assert t["a"]["b"]["c"] == 1
assert t["a"]["b"]["d"] == 2
assert t["a"]["c"] == 3
def test_toml_document_with_super_aot_after_super_table(example):
content = example("pyproject")
doc = parse(content)
aot = doc["tool"]["foo"]
assert isinstance(aot, list)
first = aot[0]
assert first["name"] == "first"
second = aot[1]
assert second["name"] == "second"
def test_toml_document_has_always_a_new_line_after_table_header():
content = """[section.sub]"""
doc = parse(content)
assert doc.as_string() == """[section.sub]"""
doc["section"]["sub"]["foo"] = "bar"
assert (
doc.as_string()
== """[section.sub]
foo = "bar"
"""
)
del doc["section"]["sub"]["foo"]
assert doc.as_string() == """[section.sub]"""
def test_toml_document_is_pickable(example):
content = example("example")
doc = parse(content)
assert pickle.loads(pickle.dumps(doc)).as_string() == content
def test_toml_document_set_super_table_element():
content = """[site.user]
name = "John"
"""
doc = parse(content)
doc["site"]["user"] = "Tom"
assert (
doc.as_string()
== """[site]
user = "Tom"
"""
)
def test_toml_document_can_be_copied():
content = "[foo]\nbar=1"
doc = parse(content)
doc = copy.copy(doc)
assert (
doc.as_string()
== """[foo]
bar=1"""
)
assert doc == {"foo": {"bar": 1}}
assert doc["foo"]["bar"] == 1
assert json.loads(json.dumps(doc)) == {"foo": {"bar": 1}}
doc = parse(content)
doc = doc.copy()
assert (
doc.as_string()
== """[foo]
bar=1"""
)
assert doc == {"foo": {"bar": 1}}
assert doc["foo"]["bar"] == 1
assert json.loads(json.dumps(doc)) == {"foo": {"bar": 1}}
def test_getting_inline_table_is_still_an_inline_table():
content = """\
[tool.poetry]
name = "foo"
[tool.poetry.dependencies]
[tool.poetry.dev-dependencies]
"""
doc = parse(content)
poetry_section = doc["tool"]["poetry"]
dependencies = poetry_section["dependencies"]
dependencies["foo"] = tomlkit.inline_table()
dependencies["foo"]["version"] = "^2.0"
dependencies["foo"]["source"] = "local"
dependencies["bar"] = tomlkit.inline_table()
dependencies["bar"]["version"] = "^3.0"
dependencies["bar"]["source"] = "remote"
dev_dependencies = poetry_section["dev-dependencies"]
dev_dependencies["baz"] = tomlkit.inline_table()
dev_dependencies["baz"]["version"] = "^4.0"
dev_dependencies["baz"]["source"] = "other"
assert (
"""\
[tool.poetry]
name = "foo"
[tool.poetry.dependencies]
foo = {version = "^2.0", source = "local"}
bar = {version = "^3.0", source = "remote"}
[tool.poetry.dev-dependencies]
baz = {version = "^4.0", source = "other"}
"""
== doc.as_string()
)
def test_declare_sub_table_with_intermediate_table():
content = """
[students]
tommy = 87
mary = 66
[subjects]
maths = "maths"
english = "english"
[students.bob]
score = 91
"""
doc = parse(content)
assert {"tommy": 87, "mary": 66, "bob": {"score": 91}} == doc["students"]
assert {"tommy": 87, "mary": 66, "bob": {"score": 91}} == doc.get("students")
def test_values_can_still_be_set_for_out_of_order_tables():
content = """
[a.a]
key = "value"
[a.b]
[a.a.c]
"""
doc = parse(content)
doc["a"]["a"]["key"] = "new_value"
assert "new_value" == doc["a"]["a"]["key"]
expected = """
[a.a]
key = "new_value"
[a.b]
[a.a.c]
"""
assert expected == doc.as_string()
doc["a"]["a"]["bar"] = "baz"
expected = """
[a.a]
key = "new_value"
bar = "baz"
[a.b]
[a.a.c]
"""
assert expected == doc.as_string()
del doc["a"]["a"]["key"]
expected = """
[a.a]
bar = "baz"
[a.b]
[a.a.c]
"""
assert expected == doc.as_string()
with pytest.raises(NonExistentKey):
doc["a"]["a"]["key"]
with pytest.raises(NonExistentKey):
del doc["a"]["a"]["key"]
def test_out_of_order_tables_are_still_dicts():
content = """
[a.a]
key = "value"
[a.b]
[a.a.c]
"""
doc = parse(content)
assert isinstance(doc["a"], dict)
assert isinstance(doc["a"]["a"], dict)
table = doc["a"]["a"]
assert "key" in table
assert "c" in table
assert "value" == table.get("key")
assert {} == table.get("c")
assert table.get("d") is None
assert "foo" == table.get("d", "foo")
assert "bar" == table.setdefault("d", "bar")
assert "bar" == table["d"]
assert "value" == table.pop("key")
assert "key" not in table
assert "baz" == table.pop("missing", default="baz")
with pytest.raises(KeyError):
table.pop("missing")
|