feat: Make windows-compatible

pytest_examples/config.py

@@ -29,6 +29,8 @@ class ExamplesConfig:
     ruff_ignore: list[str] | None = None
     white_space_dot: bool = False
     """If True, replace spaces with `·` in example diffs."""
+    encoding: str | None = 'utf-8'
+    """File encoding to use for write file operations. Default is 'utf-8'."""
 
     def black_mode(self):
         return BlackMode(

pytest_examples/eval_example.py

@@ -43,6 +43,7 @@ def set_config(
         ruff_line_length: int | None = None,
         ruff_select: list[str] | None = None,
         ruff_ignore: list[str] | None = None,
+        encoding: str | None = 'utf-8',
     ):
         """Set the config for lints.
 
@@ -56,6 +57,7 @@ def set_config(
             ruff_line_length: In general, we disable line-length checks in ruff, to let black take care of them.
             ruff_select: Ruff rules to select
             ruff_ignore: Ruff rules to ignore
+            encoding: File encoding to use for write file operations, defaults to 'utf-8'.
         """
         self.config = ExamplesConfig(
             line_length=line_length,
@@ -67,6 +69,7 @@ def set_config(
             ruff_line_length=ruff_line_length,
             ruff_select=ruff_select,
             ruff_ignore=ruff_ignore,
+            encoding=encoding,
         )
 
     @property
@@ -269,5 +272,5 @@ def _mark_for_update(self, example: CodeExample) -> None:
 
     def _write_file(self, example: CodeExample) -> Path:
         python_file = self.tmp_path / f'{example.module_name}.py'
-        python_file.write_text(example.source)
+        python_file.write_text(example.source, encoding=self.config.encoding)
         return python_file

pytest_examples/lint.py

@@ -51,7 +51,7 @@ def ruff_check(
     ruff = find_ruff_bin()
     args = ruff, 'check', '-', *config.ruff_config(), *extra_ruff_args
 
-    p = Popen(args, stdin=PIPE, stdout=PIPE, stderr=PIPE, universal_newlines=True)
+    p = Popen(args, stdin=PIPE, stdout=PIPE, stderr=PIPE, encoding=config.encoding)
     stdout, stderr = p.communicate(example.source, timeout=10)
     if p.returncode == 1 and stdout:
 

pytest_examples/modify_files.py

@@ -9,7 +9,7 @@
     from .find_examples import CodeExample
 
 
-def _modify_files(examples: list[CodeExample]) -> str:
+def _modify_files(examples: list[CodeExample], encoding: str | None = 'utf-8') -> str:
     """Internal use only, update examples in place."""
     # The same example shouldn't appear more than once
     unique_examples: set[str] = set()
@@ -34,7 +34,7 @@ def _modify_files(examples: list[CodeExample]) -> str:
     msg = [f'pytest-examples: {len(examples)} examples to update in {len(files)} file(s)...']
 
     for path, g in groupby(examples, key=lambda ex: ex.path):
-        content = path.read_text()
+        content = path.read_text(encoding=encoding)
         count = 0
         for ex in g:
             example: CodeExample = ex
@@ -45,6 +45,6 @@ def _modify_files(examples: list[CodeExample]) -> str:
             count += 1
 
         msg.append(f'  {path} {count} examples updated')
-        path.write_text(content)
+        path.write_text(content, encoding=encoding)
 
     return '\n'.join(msg)

tests/test_run_examples.py

@@ -370,3 +370,23 @@ def test_find_run_examples(example: CodeExample, eval_example: EvalExample):
 
     result = pytester.runpytest('-p', 'no:pretty', '-v')
     result.assert_outcomes(passed=1)
+
+
+def test_unicode_emoji(pytester: pytest.Pytester):
+    pytester.makefile(
+        '.md',
+        my_file="```py\nprint('🚀 ✓')\n#> 🚀 ✓\n```",
+    )
+    pytester.makepyfile(
+        """
+from pytest_examples import find_examples, CodeExample, EvalExample
+import pytest
+
+@pytest.mark.parametrize('example', find_examples('.'), ids=str)
+def test_find_run_examples(example: CodeExample, eval_example: EvalExample):
+    eval_example.run_print_check(example)
+"""
+    )
+
+    result = pytester.runpytest('-p', 'no:pretty', '-v')
+    result.assert_outcomes(passed=1)