fix: account for explicit_start=False when handling whitelines #224
Conversation
rvause
changed the title
Pull Request Test Coverage Report for Build 4134059727Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
| @@ -673,7 +673,7 @@ def _replace_whitelines(match: Match[str], n_whitelines: int) -> str: | |||
|
|
|||
| def _fix_section_whitelines(self, source_code: str) -> str: | |||
| re_section = "\n*(^#.*\n)*\n*^[^ ].*:\n(\n|(^ .*))+\n*" | |||
| re_beginning_section = f"(?P<b>---\n{re_section})" | |||
| re_beginning_section = f"(?P<b>(?:---\n|\\A){re_section})" | |||
There was a problem hiding this comment.
I've never heard of the \A section beginning? Is this an official thing?.
Could you add a comment above the line pointing to a link in the official documentation where it explains it's use?
I'm trying to avoid the WTF moment in 6 months when we read this regexp
There was a problem hiding this comment.
Fair point. It was new to me too. I've linked to the Python regex syntax docs.
There was a problem hiding this comment.
Lol, I thought that the \A was a yaml thing not a regexp thing (facepalm). LGTM
The regex would check for `---\n` as the file start which would not necessarily apply if `explicit_start=False`. This change also considers `\A` as an alternative file start.
rvause
force-pushed
the
rv/fix-whitelines-at-start
branch
from
1272ef9
to
dda623a
Compare
| @@ -673,7 +673,7 @@ def _replace_whitelines(match: Match[str], n_whitelines: int) -> str: | |||
|
|
|||
| def _fix_section_whitelines(self, source_code: str) -> str: | |||
| re_section = "\n*(^#.*\n)*\n*^[^ ].*:\n(\n|(^ .*))+\n*" | |||
| re_beginning_section = f"(?P<b>---\n{re_section})" | |||
| re_beginning_section = f"(?P<b>(?:---\n|\\A){re_section})" | |||
There was a problem hiding this comment.
Lol, I thought that the \A was a yaml thing not a regexp thing (facepalm). LGTM
|
Available since |
The regex would check for
---\nas the file start which would not necessarily apply ifexplicit_start=False. This change also considers\Aas an alternative file start.I wasn't able to find an open issue to link this change to. Please advise if any documentation is required for this change.
Checklist