mirror of
https://github.com/python/cpython.git
synced 2025-07-08 03:45:36 +00:00
591f6754b5
This adds a new standard library module, `tomllib`, for parsing TOML. The implementation is based on Tomli (https://github.com/hukkin/tomli). ## Steps taken (converting `tomli` to `tomllib`) - Move everything in `tomli:src/tomli` to `Lib/tomllib`. Exclude `py.typed`. - Remove `__version__ = ...` line from `Lib/tomllib/__init__.py` - Move everything in `tomli:tests` to `Lib/test/test_tomllib`. Exclude the following test data dirs recursively: - `tomli:tests/data/invalid/_external/` - `tomli:tests/data/valid/_external/` - Create `Lib/test/test_tomllib/__main__.py`: ```python import unittest from . import load_tests unittest.main() ``` - Add the following to `Lib/test/test_tomllib/__init__.py`: ```python import os from test.support import load_package_tests def load_tests(*args): return load_package_tests(os.path.dirname(__file__), *args) ``` Also change `import tomli as tomllib` to `import tomllib`. - In `cpython/Lib/tomllib/_parser.py` replace `__fp` with `fp` and `__s` with `s`. Add the `/` to `load` and `loads` function signatures. - Run `make regen-stdlib-module-names` - Create `Doc/library/tomllib.rst` and reference it in `Doc/library/fileformats.rst`
120 lines
3.9 KiB
Python
120 lines
3.9 KiB
Python
# SPDX-License-Identifier: MIT
|
|
# SPDX-FileCopyrightText: 2021 Taneli Hukkinen
|
|
# Licensed to PSF under a Contributor Agreement.
|
|
|
|
"""Utilities for tests that are in the "burntsushi" format."""
|
|
|
|
import datetime
|
|
from typing import Any
|
|
|
|
# Aliases for converting TOML compliance format [1] to BurntSushi format [2]
|
|
# [1] https://github.com/toml-lang/compliance/blob/db7c3211fda30ff9ddb10292f4aeda7e2e10abc4/docs/json-encoding.md # noqa: E501
|
|
# [2] https://github.com/BurntSushi/toml-test/blob/4634fdf3a6ecd6aaea5f4cdcd98b2733c2694993/README.md # noqa: E501
|
|
_aliases = {
|
|
"boolean": "bool",
|
|
"offset datetime": "datetime",
|
|
"local datetime": "datetime-local",
|
|
"local date": "date-local",
|
|
"local time": "time-local",
|
|
}
|
|
|
|
|
|
def convert(obj): # noqa: C901
|
|
if isinstance(obj, str):
|
|
return {"type": "string", "value": obj}
|
|
elif isinstance(obj, bool):
|
|
return {"type": "bool", "value": str(obj).lower()}
|
|
elif isinstance(obj, int):
|
|
return {"type": "integer", "value": str(obj)}
|
|
elif isinstance(obj, float):
|
|
return {"type": "float", "value": _normalize_float_str(str(obj))}
|
|
elif isinstance(obj, datetime.datetime):
|
|
val = _normalize_datetime_str(obj.isoformat())
|
|
if obj.tzinfo:
|
|
return {"type": "datetime", "value": val}
|
|
return {"type": "datetime-local", "value": val}
|
|
elif isinstance(obj, datetime.time):
|
|
return {
|
|
"type": "time-local",
|
|
"value": _normalize_localtime_str(str(obj)),
|
|
}
|
|
elif isinstance(obj, datetime.date):
|
|
return {
|
|
"type": "date-local",
|
|
"value": str(obj),
|
|
}
|
|
elif isinstance(obj, list):
|
|
return [convert(i) for i in obj]
|
|
elif isinstance(obj, dict):
|
|
return {k: convert(v) for k, v in obj.items()}
|
|
raise Exception("unsupported type")
|
|
|
|
|
|
def normalize(obj: Any) -> Any:
|
|
"""Normalize test objects.
|
|
|
|
This normalizes primitive values (e.g. floats), and also converts from
|
|
TOML compliance format [1] to BurntSushi format [2].
|
|
|
|
[1] https://github.com/toml-lang/compliance/blob/db7c3211fda30ff9ddb10292f4aeda7e2e10abc4/docs/json-encoding.md # noqa: E501
|
|
[2] https://github.com/BurntSushi/toml-test/blob/4634fdf3a6ecd6aaea5f4cdcd98b2733c2694993/README.md # noqa: E501
|
|
"""
|
|
if isinstance(obj, list):
|
|
return [normalize(item) for item in obj]
|
|
if isinstance(obj, dict):
|
|
if "type" in obj and "value" in obj:
|
|
type_ = obj["type"]
|
|
norm_type = _aliases.get(type_, type_)
|
|
value = obj["value"]
|
|
if norm_type == "float":
|
|
norm_value = _normalize_float_str(value)
|
|
elif norm_type in {"datetime", "datetime-local"}:
|
|
norm_value = _normalize_datetime_str(value)
|
|
elif norm_type == "time-local":
|
|
norm_value = _normalize_localtime_str(value)
|
|
else:
|
|
norm_value = value
|
|
|
|
if norm_type == "array":
|
|
return [normalize(item) for item in value]
|
|
return {"type": norm_type, "value": norm_value}
|
|
return {k: normalize(v) for k, v in obj.items()}
|
|
raise AssertionError("Burntsushi fixtures should be dicts/lists only")
|
|
|
|
|
|
def _normalize_datetime_str(dt_str: str) -> str:
|
|
if dt_str[-1].lower() == "z":
|
|
dt_str = dt_str[:-1] + "+00:00"
|
|
|
|
date = dt_str[:10]
|
|
rest = dt_str[11:]
|
|
|
|
if "+" in rest:
|
|
sign = "+"
|
|
elif "-" in rest:
|
|
sign = "-"
|
|
else:
|
|
sign = ""
|
|
|
|
if sign:
|
|
time, _, offset = rest.partition(sign)
|
|
else:
|
|
time = rest
|
|
offset = ""
|
|
|
|
time = time.rstrip("0") if "." in time else time
|
|
return date + "T" + time + sign + offset
|
|
|
|
|
|
def _normalize_localtime_str(lt_str: str) -> str:
|
|
return lt_str.rstrip("0") if "." in lt_str else lt_str
|
|
|
|
|
|
def _normalize_float_str(float_str: str) -> str:
|
|
as_float = float(float_str)
|
|
|
|
# Normalize "-0.0" and "+0.0"
|
|
if as_float == 0:
|
|
return "0"
|
|
|
|
return str(as_float)
|