Emit a user warning when comment-style declarations are used.

Closes #97
jaraco · Feb 8, 2024 · f2db188 · f2db188
1 parent 084a418
commit f2db188
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/newsfragments/97.feature.rst b/newsfragments/97.feature.rst
@@ -0,0 +1 @@
+Comment-style declarations are now deprecated in favor of Python or TOML style.
diff --git a/pip_run/scripts.py b/pip_run/scripts.py
@@ -5,6 +5,7 @@
 import json
 import pathlib
 import re
+import warnings
 
 import jaraco.text
 import packaging.requirements
@@ -131,6 +132,10 @@ def read_comments(self):
 
         try:
             lines = match.group(1).splitlines()
+            warnings.warn(
+                "Comment-style script declarations are deprecated. "
+                "Please use Python style or PEP 723 TOML style."
+            )
         except AttributeError:
             lines = []
 

diff --git a/pytest.ini b/pytest.ini
@@ -29,3 +29,4 @@ filterwarnings=
 
     # known internal deprecations
     ignore:separate_dash is deprecated
+    ignore:Comment-style script declarations are deprecated