Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Infra: Use a list of authors in peps.json #4226

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Infra: Use a list of authors in peps.json #4226

wants to merge 4 commits into from

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Jan 24, 2025 •
edited
Loading

Closes #4211.

Alternatively, we could just use a different seperator (;)? The authors field of peps.json was originally intended for literal reproduction without any re-parsing, hence why I joined the alreay-parsed list of authors into a string.

A

📚 Documentation preview 📚: https://pep-previews--4226.org.readthedocs.build/peps.json

@AA-Turner AA-Turner added the infra Core infrastructure for building and rendering PEPs label Jan 24, 2025
@AA-Turner AA-Turner requested a review from a team as a code owner January 24, 2025 00:27
@AA-Turner AA-Turner requested review from hugovk and removed request for a team January 24, 2025 00:27
@hugovk
Copy link
Member

hugovk commented Jan 24, 2025

I think the first question is if we want to break backwards compatibility?

I lean to not breaking compatibility. If so, the other options are:

  • keep the authors string using a different separator (for example, ";")
  • keep the authors string and add a new array of author strings

@warsaw
Copy link
Member

warsaw commented Jan 24, 2025

keep the authors string and add a new array of author strings

I'd vote for keeping authors as is, and adding (something like) author_list as the array of author strings to keep backward compatibility.

@AA-Turner
Copy link
Member Author

From a cursory search, it seems the vast majority of instances of peps.json in the wild are reproductions of the 723 example:

https://github.com/search?q=%22https%3A%2F%2Fpeps.python.org%2Fapi%2Fpeps.json%22+NOT+is%3Afork+NOT+is%3Aarchived&type=code

But sure, happy to add as a new field. The only negative would be the file size (~15% increase).

A

hugovk
hugovk reviewed Jan 25, 2025
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From a cursory search, it seems the vast majority of instances of peps.json in the wild are reproductions of the 723 example:

github.com/search?q=%22https%3A%2F%2Fpeps.python.org%2Fapi%2Fpeps.json%22+NOT+is%3Afork+NOT+is%3Aarchived&type=code

Here's a couple that would have broken (but I'm sure we could have convinced the authors to update :)

But sure, happy to add as a new field. The only negative would be the file size (~15% increase).

Yep, I think 331K -> 368K is okay. Thanks!

pep_sphinx_extensions/pep_zero_generator/parser.py Show resolved Hide resolved
pep_sphinx_extensions/pep_zero_generator/parser.py Show resolved Hide resolved
peps/api/index.rst Show resolved Hide resolved
peps/api/index.rst Show resolved Hide resolved
@hugovk hugovk changed the title Use a list of authors in peps.json Infra: Use a list of authors in peps.json Jan 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk left review comments

Assignees
No one assigned
Labels
infra Core infrastructure for building and rendering PEPs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

PEPs API: handle name with commas in CSV author list
3 participants
@AA-Turner @hugovk @warsaw