GH-46: Fix "escape sequences are not flushed for line-buffered files" (…

…#49) Fix "escape sequences are not flushed for line-buffered files" (#46)
qexat · Jan 22, 2024 · 08f65fd · 08f65fd
1 parent 11ba8c5
commit 08f65fd
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 11 deletions.
diff --git a/src/coquille/prelude.py b/src/coquille/prelude.py
@@ -32,7 +32,7 @@
         P = ParamSpec("P")
 
     from coquille.typeshed import Self
-    from coquille.typeshed import SupportsWrite
+    from coquille.typeshed import SupportsWriteAndFlush
 
 
 @overload
@@ -74,15 +74,15 @@ def prepare(
 @overload
 def apply(
     sequence: EscapeSequence | EscapeSequenceName,
-    file: SupportsWrite[str] | None = None,
+    file: SupportsWriteAndFlush[str] | None = None,
 ) -> None:  # pragma: no cover
     pass
 
 
 @overload
 def apply(
     sequence: Callable[P, EscapeSequence],
-    file: SupportsWrite[str] | None = None,
+    file: SupportsWriteAndFlush[str] | None = None,
     *args: P.args,
     **kwargs: P.kwargs,
 ) -> None:  # pragma: no cover
@@ -91,7 +91,7 @@ def apply(
 
 def apply(
     sequence: EscapeSequence | EscapeSequenceName | Callable[P, EscapeSequence],
-    file: SupportsWrite[str] | None = None,
+    file: SupportsWriteAndFlush[str] | None = None,
     *args: P.args,
     **kwargs: P.kwargs,
 ) -> None:
@@ -102,11 +102,12 @@ def apply(
     string: EscapeSequence = prepare(sequence, *args, **kwargs)
     target = file or sys.stdout
     target.write(string)
+    target.flush()
 
 
 class CoquilleLike(Protocol):
     sequences: list[EscapeSequence]
-    file: SupportsWrite[str] | None
+    file: SupportsWriteAndFlush[str] | None
 
     @abstractmethod
     def print(
@@ -121,7 +122,7 @@ def print(
 @dataclass(slots=True)
 class _ContextCoquille:
     sequences: list[EscapeSequence]
-    file: SupportsWrite[str] | None
+    file: SupportsWriteAndFlush[str] | None
 
     def apply(self, sequence: EscapeSequence | EscapeSequenceName) -> None:
         """
@@ -165,7 +166,7 @@ def print(
 @dataclass(slots=True)
 class Coquille:
     sequences: list[EscapeSequence]
-    file: SupportsWrite[str] | None
+    file: SupportsWriteAndFlush[str] | None
 
     @overload
     @classmethod
@@ -180,15 +181,15 @@ def new(
     def new(
         cls: type[Self],
         *sequences: EscapeSequence | EscapeSequenceName,
-        file: SupportsWrite[str],
+        file: SupportsWriteAndFlush[str],
     ) -> Self:  # pragma: no cover
         pass
 
     @classmethod
     def new(
         cls: type[Self],
         *sequences: EscapeSequence | EscapeSequenceName,
-        file: SupportsWrite[str] | None = None,
+        file: SupportsWriteAndFlush[str] | None = None,
     ) -> Self:
         """
         Convenient constructor for a Coquille.
@@ -283,7 +284,7 @@ def write(
     text: str,
     *sequences: EscapeSequence | EscapeSequenceName,
     end: str | None = "\n",
-    file: SupportsWrite[str] | None = None,
+    file: SupportsWriteAndFlush[str] | None = None,
 ) -> None:
     """
     A function relatively similar to built-in `print`, but with

diff --git a/src/coquille/typeshed.py b/src/coquille/typeshed.py
@@ -10,10 +10,14 @@
 _T_contra = TypeVar("_T_contra", contravariant=True)
 
 
-class SupportsWrite(Protocol[_T_contra]):
+class SupportsWriteAndFlush(Protocol[_T_contra]):
     @abstractmethod
     def write(self, __s: _T_contra) -> object:
         pass
 
+    @abstractmethod
+    def flush(self) -> None:
+        pass
+
 
 Self = TypeVar("Self")