Add suppoort for custom formatters via entrypoints.

Author: domdfcoding

formate.toml

@@ -39,6 +39,7 @@ known_third_party = [
     "coverage_pyver_pragma",
     "dom_toml",
     "domdf_python_tools",
+    "entrypoints",
     "formate",
     "importlib_metadata",
     "pytest",

requirements.txt

@@ -2,5 +2,6 @@ click>=8.0.1
 consolekit>=1.2.3
 dom-toml>=0.5.0
 domdf-python-tools>=3.0.0
+entrypoints>=0.3
 formate>=0.4.9
 typing-extensions>=3.10.0.0

snippet_fmt/__init__.py

@@ -38,6 +38,7 @@
 
 # 3rd party
 import click
+import entrypoints  # type: ignore
 from consolekit.terminal_colours import ColourTrilean, resolve_color_default
 from consolekit.utils import coloured_diff
 from domdf_python_tools.paths import PathPlus
@@ -73,16 +74,6 @@ class CodeBlockError(NamedTuple):
 	exc: Exception
 
 
-_formatters: Dict[str, Formatter] = {
-		"bash": noformat,
-		"python": format_python,
-		"python3": format_python,
-		"toml": format_toml,
-		"ini": format_ini,
-		"json": format_json,
-		}
-
-
 class RSTReformatter:
 	"""
 	Reformat code snippets in a reStructuredText file.
@@ -110,6 +101,16 @@ def __init__(self, filename: PathLike, config: SnippetFmtConfigDict):
 		self._reformatted_source: Optional[str] = None
 		self.errors = []
 
+		self._formatters: Dict[str, Formatter] = {
+				# "bash": noformat,
+				# "python": format_python,
+				"python3": format_python,
+				"toml": format_toml,
+				"ini": format_ini,
+				"json": format_json,
+				}
+		self.load_extra_formatters()
+
 	def run(self) -> bool:
 		"""
 		Run the reformatter.
@@ -152,7 +153,8 @@ def process_match(self, match: Match[str]) -> str:
 
 		if lang in self.config["languages"]:
 			lang_config = self.config["languages"][lang]
-			formatter = _formatters.get(lang.lower(), noformat)
+			# TODO: show warning if not found and in "strict" mode
+			formatter = self._formatters.get(lang.lower(), noformat)
 		else:
 			lang_config = {}
 			formatter = noformat
@@ -214,6 +216,17 @@ def _collect_error(self, match: Match[str]) -> Iterator[None]:
 		except Exception as e:
 			self.errors.append(CodeBlockError(match.start(), e))
 
+	def load_extra_formatters(self):
+		group = "snippet_fmt.formatters"
+
+		for distro_config, _ in entrypoints.iter_files_distros():
+			if group in distro_config:
+				for name, epstr in distro_config[group].items():
+					with contextlib.suppress(entrypoints.BadEntryPoint, ImportError):
+						# TODO: show warning for bad entry point if verbose, or "strict"?
+						ep = entrypoints.EntryPoint.from_string(epstr, name)
+						self._formatters[name] = ep.load()
+
 
 def reformat_file(
 		filename: PathLike,

tests/test_snippet_fmt.py

@@ -10,7 +10,7 @@
 from coincidence.params import param
 from consolekit.terminal_colours import strip_ansi
 from consolekit.testing import CliRunner, Result
-from domdf_python_tools.paths import PathPlus, in_directory
+from domdf_python_tools.paths import PathPlus, TemporaryPathPlus, in_directory
 
 # this package
 from snippet_fmt import SnippetFmtConfigDict, reformat_file
@@ -68,6 +68,26 @@
 filenames = pytest.mark.parametrize("filename", [param("example.rst", idx=0)])
 
 
+@pytest.fixture()
+def custom_entry_point(monkeypatch):
+	with TemporaryPathPlus() as tmpdir:
+		monkeypatch.syspath_prepend(str(tmpdir))
+
+		dist_info = tmpdir / "snippet_fmt_demo-0.0.0.dist-info"
+		dist_info.maybe_make(parents=True)
+		(dist_info / "entry_points.txt").write_lines([
+				"[snippet_fmt.formatters]",
+				"python3 = snippet_fmt_demo:fake_format",
+				])
+
+		(tmpdir / "snippet_fmt_demo.py").write_lines([
+				"def fake_format(*args, **kwargs):",
+				"\treturn 'Hello World'",
+				])
+
+		yield
+
+
 class TestReformatFile:
 
 	@directives
@@ -94,6 +114,31 @@ def test_snippet_fmt(
 		advanced_file_regression.check_file(tmp_pathplus / filename)
 		check_out(capsys.readouterr(), tmp_pathplus, advanced_data_regression)
 
+	@filenames
+	def test_snippet_fmt_custom_entry_point(
+			self,
+			filename: str,
+			tmp_pathplus: PathPlus,
+			advanced_file_regression: AdvancedFileRegressionFixture,
+			advanced_data_regression: AdvancedDataRegressionFixture,
+			capsys,
+			custom_entry_point
+			):
+
+		languages = {"python3": {"reformat": True}}
+		directives = ["code-block", "code-cell"]
+
+		(tmp_pathplus / filename).write_text((source_dir / filename).read_text())
+		(tmp_pathplus / "formate.toml").write_text((source_dir / "example_formate.toml").read_text())
+
+		config: SnippetFmtConfigDict = {"languages": languages, "directives": directives}
+
+		with in_directory(tmp_pathplus):
+			reformat_file(tmp_pathplus / filename, config)
+
+		advanced_file_regression.check_file(tmp_pathplus / filename)
+		check_out(capsys.readouterr(), tmp_pathplus, advanced_data_regression)
+
 
 class TestCLI:
 

tests/test_snippet_fmt_/test_snippet_fmt_custom_entry_point_example_rst_.rst

@@ -0,0 +1,116 @@
+
+.. code-block:: python
+
+	print (  'Hello World'
+
+	)
+
+	for   item in [a,b,c]   :
+				if item: print(item)
+
+
+.. code-block:: python3
+
+	Hello World
+
+
+.. code-cell:: python3
+	:count: 1
+
+	Hello World
+
+
+.. code:: python
+
+	print (  'Hello World'
+
+	)
+
+	for   item in [a,b,c]   :
+				if item: print(item)
+
+
+.. sourcecode:: python
+
+	print (  'Hello World'
+
+	)
+
+	for   item in [a,b,c]   :
+				if item: print(item)
+
+
+.. parsed-literal:: python
+
+	print (  'Hello World'
+
+	)
+
+	for   item in [a,b,c]   :
+				if item: print(item)
+
+
+.. code-block:: toml
+
+	[project]
+
+
+	name   =   'my-project'
+
+
+	version="1.2.3"
+	license = {file = "LICENSE"}
+
+
+.. code-block:: TOML
+
+	[project]
+
+
+	name   =   'my-project'
+
+
+	version="1.2.3"
+	license = {file = "LICENSE"}
+
+
+.. code:: TOML
+
+	[project]
+
+
+	name   =   'my-project'
+
+
+	version="1.2.3"
+	license = {
+		file = "LICENSE",
+	}
+
+.. sourcecode:: toml
+
+	[project]
+	name = 'my-project
+
+
+.. code-block:: JSON
+
+	{
+		"key": "value",
+		"key2": "value2",
+	}
+
+.. code-block:: json
+
+	{"key": "value", "key2": "value2"}
+
+
+.. code-block:: bash
+
+	echo "Hello World"
+
+
+.. code:: YAML
+
+	name: my-project
+	version: 1.2.3

tests/test_snippet_fmt_/test_snippet_fmt_custom_entry_point_example_rst_.yml

@@ -0,0 +1,33 @@
+err:
+- ''
+out:
+- "--- .../example.rst\t(original)"
+- "+++ .../example.rst\t(reformatted)"
+- '@@ -11,23 +11,13 @@'
+- ''
+- ' .. code-block:: python3'
+- ''
+- "-\tprint (  'Hello World'"
+- '-'
+- "-\t)"
+- '-'
+- "-\tfor   item in [a,b,c]   :"
+- "-\t\t\t\tif item: print(item)"
+- "+\tHello World"
+- ''
+- ''
+- ' .. code-cell:: python3'
+- " \t:count: 1"
+- ''
+- "-\tprint (  'Hello World'"
+- '-'
+- "-\t)"
+- '-'
+- "-\tfor   item in [a,b,c]   :"
+- "-\t\t\t\tif item: print(item)"
+- "+\tHello World"
+- ''
+- ''
+- ' .. code:: python'
+- ''
+- ''