Add recommendation for "escaping" quoted inline script metadata
Mantenedores costumam responder em até 5 dias
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Abra as recomendações sobre metadados de scripts inline em packaging.python.org e revise as orientações sobre como incorporar metadados em strings Python. Adicione um aviso de que strings multilinha entre aspas são detectadas como metadados, inclua a abordagem de concatenação de strings mostrada no issue e confirme que a recomendação é clara e precisa.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- Python
- Estrelas
- 1.7k
- Forks
- 1.8k
- Merge médio
- 5d 13h
- PRs com merge (30d)
- 2
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de pypa/packaging.python.org
-
Note greediness of PEP 723 reference parserTalvez já em andamento @jw9829 assumiu há 24 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
pypa/packaging.python.org#1960 · 4 comentários ·
Mantenedores costumam responder em até 5 dias
-
Document that sparse identifiers with whitespace are valid if quotedTalvez já em andamento @Herrtian assumiu há 164 dias. Abertacomponent: specifications good first issue type: enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
pypa/packaging.python.org#1226 · 3 comentários · 1 reação ·
Mantenedores costumam responder em até 5 dias
-
`test` vs. `tests`Talvez livre de novo Um pull request para esta issue foi fechado sem ser mesclado. Abertacomponent: guides component: tutorials type: enhancement type: task
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
pypa/packaging.python.org#1165 · 5 comentários ·
Mantenedores costumam responder em até 5 dias
-
type: task
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
pypa/packaging.python.org#792 · 2 comentários · 1 reação ·
Mantenedores costumam responder em até 5 dias
-
Add pip.conf heads-up to PyPI.org migration guideTalvez já em andamento @harshitethic assumiu há 52 dias. Abertagood first issue help wanted type: bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
pypa/packaging.python.org#463 · 5 comentários ·
Mantenedores costumam responder em até 5 dias
Todas as issues de pypa/packaging.python.org
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
zach-blumenfeld/aip#13 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 80/100
nathanmarlor/foxess_modbus#1287 ·
Mantenedores costumam responder em até 4 dias
-
bug good first issue help wanted
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
OpenLakeForge/openlakeforge#498 ·
Mantenedores costumam responder em até 1 dia
-
good first issue hacktoberfest help wanted python
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 73/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 69/100
pollen-robotics/reachy_mini#1493 ·
Mantenedores costumam responder em até 1 dia