Add recommendation for "escaping" quoted inline script metadata
Maintainer antworten meist innerhalb von 2 Tagen
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Öffne die Empfehlungen zu Metadaten in Inline-Skripten auf packaging.python.org und prüfe die Hinweise zum Einbetten von Metadaten in Python-Zeichenketten. Füge eine Warnung hinzu, dass in Anführungszeichen gesetzte mehrzeilige Zeichenketten als Metadaten erkannt werden, füge den im Issue gezeigten Ansatz zur Zeichenkettenverkettung ein und bestätige, dass die Empfehlung klar und korrekt ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Issue Description
As described in https://github.com/astral-sh/uv/issues/12303, inline script metadata added naively to a multi-line string will be incorrectly detected as being actual inline script metadata when parsed in accordance with PEP 723 (since the parsing rules are written to be compatible with a basic regex instead of requiring a full Python parser).
https://packaging.python.org/en/latest/specifications/inline-script-metadata/#recommendations should note the problem, and suggest ways to use Python's string quoting flexibility to avoid the misfire.
For example, replacing:
SOURCE_CODE = """
# /// script
# dependencies = ["pydantic", "email-validator"]
# ///
import pydantic
class Model(pydantic.BaseModel):
email: pydantic.EmailStr
print(Model(email='[email protected]'))
"""
with the following compile time string concatenation:
SOURCE_CODE = ("""
"""
"# /// script"
"""
# dependencies = ["pydantic", "email-validator"]
# ///
import pydantic
class Model(pydantic.BaseModel):
email: pydantic.EmailStr
print(Model(email='[email protected]'))
""")
Code of Conduct
- I am aware that participants in this repository must follow the PSF Code of Conduct.
- Vorherrschende Sprache
- Python
- Sterne
- 1.7k
- Forks
- 1.7k
- Ø Merge
- 8 T. 3 Std.
- Gemergte PRs (30 T.)
- 5
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus pypa/packaging.python.org
-
Note greediness of PEP 723 reference parserEvtl. vergeben @jw9829 hat das vor 9 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
pypa/packaging.python.org#1960 · 4 Kommentare ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Document that sparse identifiers with whitespace are valid if quotedEvtl. vergeben @Herrtian hat das vor 149 Tagen übernommen. Offencomponent: specifications good first issue type: enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
pypa/packaging.python.org#1226 · 3 Kommentare · 1 Reaktion ·
Maintainer antworten meist innerhalb von 2 Tagen
-
`test` vs. `tests`Evtl. wieder frei Ein Pull Request dazu wurde ohne Merge geschlossen. Offencomponent: guides component: tutorials type: enhancement type: task
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
pypa/packaging.python.org#1165 · 5 Kommentare ·
Maintainer antworten meist innerhalb von 2 Tagen
-
type: task
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
pypa/packaging.python.org#792 · 2 Kommentare · 1 Reaktion ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Add pip.conf heads-up to PyPI.org migration guideEvtl. vergeben @harshitethic hat das vor 37 Tagen übernommen. Offengood first issue help wanted type: bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
pypa/packaging.python.org#463 · 5 Kommentare ·
Maintainer antworten meist innerhalb von 2 Tagen
Alle Issues in pypa/packaging.python.org
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
Maintainer antworten meist innerhalb von 1 Tag
-
area:docs
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
RailtownAI/railtracks#1633 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
review-panel severity:low
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
kristovatlas/coin-accounting#152 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation :blue_book:
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
PennyLaneAI/pennylane#10280 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
`pipx reinstall` prints a Python traceback when the reinstall failsEvtl. vergeben @ParamTanna hat das heute übernommen. Offenbug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag