From 7a915113f6456f8f5590859ef1af0ed04c8a4856 Mon Sep 17 00:00:00 2001
From: Andy Kipp <anki-code@users.noreply.github.com>
Date: Sun, 25 Feb 2024 00:42:50 +0100
Subject: [PATCH] Pin prompt-toolkit version (#5288)

* Update pyproject.toml

* Create pin-ptk.rst

* chore: strip whitespace

---------

Co-authored-by: Gil Forsyth <gil@forsyth.dev>
---
 .github/pull_request_template.md |  6 +++---
 news/pin-ptk.rst                 | 23 +++++++++++++++++++++++
 pyproject.toml                   |  4 ++--
 3 files changed, 28 insertions(+), 5 deletions(-)
 create mode 100644 news/pin-ptk.rst

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 79c15c009..42ebad3d0 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,11 +1,11 @@
-<!--- 
+<!---
 
-Thanks for opening a PR on xonsh! 
+Thanks for opening a PR on xonsh!
 
 Please do this:
 
 1. Include a news file with your PR (https://xon.sh/devguide.html#changelog).
-2. Add the documentation for your feature into `/docs`. 
+2. Add the documentation for your feature into `/docs`.
 3. Add the example of usage or before-after behavior.
 4. Mention the issue that this PR is addressing e.g. `#1234`.
 
diff --git a/news/pin-ptk.rst b/news/pin-ptk.rst
new file mode 100644
index 000000000..4014bd0e7
--- /dev/null
+++ b/news/pin-ptk.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* Pinned prompt-toolkit version 3.0.29-3.0.40 to workaround upstream issue. More info in issue 5241.
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
diff --git a/pyproject.toml b/pyproject.toml
index 47d34e882..c78509078 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -83,7 +83,7 @@ changelog = "https://github.com/xonsh/xonsh/blob/main/CHANGELOG.rst"
 
 [project.optional-dependencies]
 ptk = [
-    "prompt-toolkit>=3.0.29",
+    "prompt-toolkit>=3.0.29,<3.0.41",
     "pyperclip",
 ]
 pygments = ["pygments>=2.2"]
@@ -110,7 +110,7 @@ test = [
     "pytest-timeout",
     "pytest-subprocess",
     "pytest-rerunfailures",
-    "prompt-toolkit>=3.0.29",
+    "prompt-toolkit>=3.0.29,<3.0.41",
     "pygments>=2.2",
     "coverage>=5.3.1",
     "pyte>=0.8.0",