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

parse-render loop creates newline #198

Open
nschloe opened this issue Nov 13, 2023 · 3 comments
Open

parse-render loop creates newline #198

nschloe opened this issue Nov 13, 2023 · 3 comments
Labels

Comments

@nschloe
Copy link

nschloe commented Nov 13, 2023

MWE:

import mistletoe
from mistletoe.markdown_renderer import MarkdownRenderer

print(repr(MarkdownRenderer().render(mistletoe.Document("a"))))

Output:

'a\n'

Expected output:

'a'
@pbodnar
Copy link
Collaborator

pbodnar commented Nov 16, 2023

Hi @nschloe, the behavior you describe seems to be intentional, or say "by-design" to me. It is the Document class constructor which adds the new newline (\n) if it is missing in the input:

class Document(BlockToken):
    """
    Document token.
    This is a container block token. Its children are block tokens - container or leaf ones.

    Attributes:
        footnotes (dictionary): link reference definitions.
    """

    def __init__(self, lines):
        if isinstance(lines, str):
            lines = lines.splitlines(keepends=True)
        lines = [line if line.endswith('\n') else '{}\n'.format(line) for line in lines]
        # ...

I'm not sure if this should be / can be safely changed. So closing for now, but feel free to reopen this issue if needed.

@pbodnar pbodnar closed this as not planned Won't fix, can't repro, duplicate, stale Nov 16, 2023
@nschloe
Copy link
Author

nschloe commented Nov 16, 2023

Not sure why you put in this workaround. The only situation I could imagine where it does anything is to append a missing terminal "\n" and to add "\n" where "\r" is a line break. Don't know why you'd want either of those.

I'd always expect a parse-render loop to stay as faithful to the input as possible, unless it's illegal input; error out then. What's your take on this?

@pbodnar
Copy link
Collaborator

pbodnar commented Nov 17, 2023

Yeah, I'm not sure either why this was introduced by the original author 5 years ago. As you write, this could possibly deserve some investigation, so I'm reopening this...

@pbodnar pbodnar reopened this Nov 17, 2023
@pbodnar pbodnar added the bug label Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants