False positive on missing region for endregion comment

[ItsDrike]

Describe the bug
After an update from 1.1.286 to 1.1.290, I'm experiencing a bug that falsly marks any # endregion comment as not having a matching # region , even though it is present.

To Reproduce
Create file with the following content:

# region: foo

x = 5

# endregion

Run pyright and notice an error on line 4, stating that endregion is missing a region.

Expected behavior
Pyright should be able to find the region tag above properly, and not report this error.

Screenshots or Code

[erictraut]

@debonte, any thoughts on this one?

[ItsDrike]

However doing

# region: foo

x = 5

# endregion: anything (not just 'foo')

works just fine and doesn't produce the error, and this also works:

# region

x = 5

# endregion

[debonte]

We changed how we decide if a comment is a region/endregion for this issue: microsoft/pylance-release#3765.

Seems like that may need some tweaking still.

[debonte]

Thanks for the bug report. This will be addressed in the next release.

[rchl]

I'll just add that this error has also triggered in a code that just had a comment that happened to start with a "region" word.

            for diagnostic, candidate in diagnostics:
                # Checking against points is inclusive unlike checking whether region intersects another
                # region which is exclusive (at region end) and we want an inclusive behavior in this case.

It's obviously easy to workaround by changing the position of the "region" word but just wanted to point it out, in case this is not supposed to trigger the error.

I'm not sure if there is any spec for how those markers should work but I guess the match pattern could be a bit stricter and require the comment to either end after # region or be directly followed by a semicolon.

[debonte]

@rchl, unfortunately there's no standard for formatting #region/#endregion that I'm aware of. Perhaps there should be though. It would be nice if the behavior was consistent across editors.

Since the Pylance team owns this functionality, could you please file a new issue on this in the Pylance repo? https://github.com/microsoft/pylance-release/issues/new/choose

[rchl]

microsoft/pylance-release#3857

[erictraut]

This is included in pyright 1.1.291, which I just published. It will also be included in a future release of pylance.