Parse toml files with tomllib/tomli

Author: domdfcoding

.pre-commit-config.yaml

@@ -87,7 +87,7 @@ repos:
  exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$
 
  - repo: https://github.com/domdfcoding/dep_checker
- rev: v0.7.0
+ rev: v0.7.1
  hooks:
  - id: dep_checker
  args:

pyproject_parser/__init__.py

@@ -54,6 +54,7 @@
 ProjectDict,
 _PyProjectAsTomlDict
 )
+from pyproject_parser.utils import _load_toml
 
 __author__: str = "Dominic Davis-Foster"
 __copyright__: str = "2021 Dominic Davis-Foster"
@@ -173,7 +174,7 @@ def load(
 filename = PathPlus(filename)
 
 project_dir = filename.parent
-config = dom_toml.load(filename)
+config = _load_toml(filename)
 
 keys = set(config.keys())
 

pyproject_parser/__main__.py

@@ -7,7 +7,7 @@
 .. versionadded:: 0.2.0
 """
 #
-# Copyright © 2021-2022 Dominic Davis-Foster <dominic@davis-foster.co.uk>
+# Copyright © 2021-2023 Dominic Davis-Foster <dominic@davis-foster.co.uk>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -53,6 +53,7 @@
 # 3rd party
 from consolekit.terminal_colours import ColourTrilean
 from domdf_python_tools.typing import PathLike
+from toml import TomlEncoder
 
 __all__ = ["main", "reformat", "check"]
 
@@ -99,7 +100,6 @@ def check(
 """
 
 # 3rd party
-import dom_toml
 from dom_toml.parser import BadConfigError
 from domdf_python_tools.paths import PathPlus
 from domdf_python_tools.words import Plural, word_join
@@ -108,6 +108,7 @@ def check(
 from pyproject_parser import PyProject
 from pyproject_parser.cli import ConfigTracebackHandler, resolve_class
 from pyproject_parser.parsers import BuildSystemParser, PEP621Parser
+from pyproject_parser.utils import _load_toml
 
 if not show_traceback:
 prettify_deprecation_warning()
@@ -120,7 +121,7 @@ def check(
 parser: Type[PyProject] = resolve_class(parser_class, "parser-class")
 parser.load(filename=pyproject_file)
 
-raw_config = dom_toml.load(pyproject_file)
+raw_config = _load_toml(pyproject_file)
 
 _keys = Plural("key", "keys")
 
@@ -198,7 +199,6 @@ def info(
 import re
 
 # 3rd party
-import dom_toml
 import sdjson # nodep
 from domdf_python_tools.paths import PathPlus, in_directory
 
@@ -207,6 +207,7 @@ def info(
 from pyproject_parser.cli import _json_encoders # noqa: F401
 from pyproject_parser.cli import ConfigTracebackHandler, resolve_class
 from pyproject_parser.type_hints import Readme
+from pyproject_parser.utils import _load_toml
 
 if not show_traceback:
 prettify_deprecation_warning()
@@ -229,7 +230,7 @@ def info(
 with in_directory(pyproject_file.parent):
 config.resolve_files()
 
-raw_config = dom_toml.load(pyproject_file)
+raw_config = _load_toml(pyproject_file)
 
 output: Any
 
@@ -294,7 +295,6 @@ def reformat(
 from consolekit.terminal_colours import resolve_color_default # nodep
 from consolekit.utils import coloured_diff # nodep
 from domdf_python_tools.paths import PathPlus
-from toml import TomlEncoder
 
 # this package
 from pyproject_parser import PyProject, _NormalisedName
@@ -309,7 +309,7 @@ def reformat(
 
 with handle_tracebacks(show_traceback, ConfigTracebackHandler):
 parser: Type[PyProject] = resolve_class(parser_class, "parser-class")
-encoder: Type[TomlEncoder] = resolve_class(encoder_class, "encoder-class")
+encoder: Type["TomlEncoder"] = resolve_class(encoder_class, "encoder-class")
 
 original_content: List[str] = pyproject_file.read_lines()
 

pyproject_parser/utils.py

@@ -31,13 +31,20 @@
 import io
 import os
 import sys
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING, Any, Dict, Optional
 
 # 3rd party
 from dom_toml.parser import BadConfigError
 from domdf_python_tools.paths import PathPlus
 from domdf_python_tools.typing import PathLike
 
+if sys.version_info < (3, 11):
+# 3rd party
+import tomli as tomllib
+else:
+# 3rd party
+import tomllib
+
 if TYPE_CHECKING:
 # this package
 from pyproject_parser.type_hints import ContentTypes
@@ -173,3 +180,15 @@ class PyProjectDeprecationWarning(Warning):
 
 .. versionadded:: 0.5.0
 """
+
+
+def _load_toml(filename: PathLike, ) -> Dict[str, Any]:
+r"""
+Parse TOML from the given file.
+
+:param filename: The filename to read from to.
+
+:returns: A mapping containing the ``TOML`` data.
+"""
+
+return tomllib.loads(PathPlus(filename).read_text())

requirements.txt

@@ -6,4 +6,5 @@ natsort>=7.1.1
 packaging>=20.9
 shippinglabel>=1.0.0
 toml>=0.10.2
+tomli>=1.2.3; python_version < "3.11"
 typing-extensions>=3.7.4.3

tests/test_config.py

@@ -18,7 +18,7 @@
 
 # this package
 from pyproject_parser.parsers import BuildSystemParser, PEP621Parser, RequiredKeysConfigParser
-from pyproject_parser.utils import PyProjectDeprecationWarning
+from pyproject_parser.utils import PyProjectDeprecationWarning, _load_toml
 
 
 @pytest.mark.parametrize("set_defaults", [True, False])
@@ -40,7 +40,7 @@ def test_pep621_class_valid_config(
 
 with in_directory(tmp_pathplus):
 config = PEP621Parser().parse(
-dom_toml.load(tmp_pathplus / "pyproject.toml")["project"],
+_load_toml(tmp_pathplus / "pyproject.toml")["project"],
 set_defaults=set_defaults,
 )
 
@@ -61,7 +61,7 @@ def test_pep621_subclass(
 (tmp_pathplus / "pyproject.toml").write_clean(toml_config)
 
 with in_directory(tmp_pathplus):
-config = ReducedPEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+config = ReducedPEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 advanced_data_regression.check(config)
 
@@ -82,7 +82,7 @@ def test_pep621_class_valid_config_readme(
 (tmp_pathplus / filename).write_text("This is the readme.")
 
 with in_directory(tmp_pathplus):
-config = PEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+config = PEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 advanced_data_regression.check(config)
 
@@ -125,7 +125,7 @@ def test_pep621_class_valid_config_readme_dict(
 (tmp_pathplus / "README").write_text("This is the README.")
 
 with in_directory(tmp_pathplus):
-config = PEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+config = PEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 advanced_data_regression.check(config)
 
@@ -213,7 +213,7 @@ def test_pep621_class_bad_config_readme(
 ])
 
 with in_directory(tmp_pathplus), pytest.raises(exception, match=expected):
-PEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+PEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 
 @pytest.mark.parametrize("filename", ["LICENSE.rst", "LICENSE.md", "LICENSE.txt", "LICENSE"])
@@ -232,7 +232,7 @@ def test_pep621_class_valid_config_license(
 (tmp_pathplus / filename).write_text("This is the license.")
 
 with in_directory(tmp_pathplus):
-config = PEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+config = PEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 advanced_data_regression.check(config)
 
@@ -250,7 +250,7 @@ def test_pep621_class_valid_config_license_dict(
 ])
 
 with in_directory(tmp_pathplus):
-config = PEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+config = PEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 advanced_data_regression.check(config)
 
@@ -284,7 +284,7 @@ def test_pep621_class_bad_config_license(
 ])
 
 with in_directory(tmp_pathplus), pytest.raises(BadConfigError, match=expected):
-PEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+PEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 
 @pytest.mark.parametrize(
@@ -320,7 +320,7 @@ def test_pep621_class_bad_config(
 (tmp_pathplus / "pyproject.toml").write_clean(config)
 
 with in_directory(tmp_pathplus), pytest.raises(expects, match=match):
-PEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+PEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 
 @pytest.mark.parametrize(
@@ -352,7 +352,7 @@ def test_extra_deprecation(
 (tmp_pathplus / "pyproject.toml").write_clean(config)
 
 with in_directory(tmp_pathplus), pytest.warns(PyProjectDeprecationWarning, match=match):
-PEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+PEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 
 @pytest.mark.parametrize("filename", ["README", "README.rtf"])
@@ -367,7 +367,7 @@ def test_parse_config_readme_errors(filename: str, tmp_pathplus: PathPlus):
 (tmp_pathplus / filename).write_text("This is the readme.")
 
 with in_directory(tmp_pathplus), pytest.raises(ValueError, match=f"Unsupported extension for '{filename}'"):
-PEP621Parser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["project"])
+PEP621Parser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["project"])
 
 
 @pytest.mark.parametrize("set_defaults", [True, False])
@@ -380,7 +380,7 @@ def test_buildsystem_parser_valid_config(
 ):
 (tmp_pathplus / "pyproject.toml").write_clean(toml_config)
 config = BuildSystemParser().parse(
-dom_toml.load(tmp_pathplus / "pyproject.toml")["build-system"],
+_load_toml(tmp_pathplus / "pyproject.toml")["build-system"],
 set_defaults=set_defaults,
 )
 
@@ -394,7 +394,7 @@ def test_buildsystem_parser_errors(config: str, expects: Type[Exception], match:
 (tmp_pathplus / "pyproject.toml").write_clean(config)
 
 with in_directory(tmp_pathplus), pytest.raises(expects, match=match):
-BuildSystemParser().parse(dom_toml.load(tmp_pathplus / "pyproject.toml")["build-system"])
+BuildSystemParser().parse(_load_toml(tmp_pathplus / "pyproject.toml")["build-system"])
 
 
 def test_RequiredKeysConfigParser():