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.

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

Handle multiple comments on a move/variation/game #1068

Open
wants to merge 27 commits into
base: master
Choose a base branch
from

Conversation

MarkZH
Copy link
Contributor

@MarkZH MarkZH commented Feb 23, 2024

Some chess programs that write PGN files (including lichess.org and others mentioned in the linked issue) will write multiple consecutive braced comments--e.g., 1. e4 { A very common opening } { Perhaps too common ... } { [%clk 0:00:01] }. Previously, when read by chess.pgn.read_game(), these comments would be joined into a single comment with a single space between them. This PR creates a new class to read, store, and write these comments while keeping them separate. The user interface is kept backwards compatible by using @property decorators to allow assignment and comparison of bare strings and string lists to game node comments.

Closes #946

@niklasf
Copy link
Owner

niklasf commented Apr 18, 2024

Hi. Good idea.

I think changing the property type in this way is not quite backwards compatible, even if __str__ is provided. Maybe something like

class GameNode:

    comments: List[Comment]

    @property
    def comment(self) -> str: ...

    @comment.setter
    def comment(self, value: str) -> None: ...

could work?

Or maybe it's also just time to consider 2.x at some point.

@MarkZH
Copy link
Contributor Author

MarkZH commented Apr 20, 2024

I tried to make GameNodeComment backwards compatible in terms of assignment and writing to a PGN file. The breaking change comes from getting comments from a node (with some allowances for comparing a single comment to a single string), since I didn't want users to accidentally miss comments. What would GameNode.comment return, just the first comment?

Saving this until 2.x would make things much easier. A new class wouldn't even be needed.

class GameNode:
    comments: list[str]

If you want to save this PR until 2.x, this would be an easy change.

@niklasf
Copy link
Owner

niklasf commented Apr 20, 2024

In 1.x, GameNode.comment would have to be the concatenation of all comments, to match the current behavior.

GameNode.comment now returns all comments as a single string with single
spaces separating the comments.

GameNode.comments (plural) returns all comments as a list of strings.
@MarkZH
Copy link
Contributor Author

MarkZH commented Apr 21, 2024

That should do it. GameNode.comments returns the GameNodeComment (a list[str] essentially), and GameNode.comment returns a single str formed from joining the strings with spaces.

@MarkZH
Copy link
Contributor Author

MarkZH commented May 16, 2024

Do you want to save this functionality for v2.0? I can make a new PR (not backwards compatible) that would be much simpler than this one--basically replacing all comment: str members of GameNode and ChildNode with comments: list[str] and changing the PGN comment functions.

@niklasf
Copy link
Owner

niklasf commented May 25, 2024

Let's do 2.x. So it would contain "small" breaking changes and clean-ups, and more ambitious plans and far-reaching changes would be pushed back to 3.x.

@MarkZH
Copy link
Contributor Author

MarkZH commented May 26, 2024

Updated changes:

  1. Rename GameNode comment field from comment to comments and starting_comment to starting_comments.
  2. Adapt methods that process comments (e.g., eval() and set_eval()).
  3. Adapt PGN reading and writing to handle moves/games with multiple comments.

The change from comment to comments is the breaking change. Assigning to node.comment no longer has any effect. I figured that using a plural name emphasizes that the field should be a list. Plus, assigning a string comment instead of a list of strings will cause problems with comment processing methods (Item 2, above).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Is there any way to write multiple comments on a move?
2 participants