Skip to content

gh-105895: Add match and case to help topics#132784

Open
dzherb wants to merge 9 commits into
python:mainfrom
dzherb:gh-132783-match-help
Open

gh-105895: Add match and case to help topics#132784
dzherb wants to merge 9 commits into
python:mainfrom
dzherb:gh-132783-match-help

Conversation

@dzherb
Copy link
Copy Markdown
Contributor

@dzherb dzherb commented Apr 21, 2025

@dzherb dzherb requested review from AA-Turner and hugovk as code owners April 21, 2025 18:33
@python-cla-bot
Copy link
Copy Markdown

python-cla-bot Bot commented Apr 21, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Apr 21, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@dzherb
Copy link
Copy Markdown
Contributor Author

dzherb commented Apr 21, 2025

I'm not sure if I should also commit the autogenerated topics.py

@dzherb
Copy link
Copy Markdown
Contributor Author

dzherb commented Apr 21, 2025

This test case fails not due to unsorted keywords, but because match and case are not present in keyword.kwlist. Instead, they are listed in keyword.softkwlist, along with entries like type and _.

class TestHelper(unittest.TestCase):
    def test_keywords(self):
        self.assertEqual(sorted(pydoc.Helper.keywords),
                         sorted(keyword.kwlist))

I suggest splitting this into two separate cases:

class TestHelper(unittest.TestCase):
    def test_keywords_are_sorted(self):
        self.assertEqual(
            sorted(pydoc.Helper.keywords),
            list(pydoc.Helper.keywords),
        )

    def test_keywords_in_grammar(self):
        all_keywords = set(keyword.kwlist) | set(keyword.softkwlist)
        for kw in pydoc.Helper.keywords:
            self.assertIn(kw, all_keywords)

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 5, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

Copy link
Copy Markdown
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

I checked out this PR and tried:

Снимок экрана 2025-05-06 в 15 21 31

I think that you need to regen pydoc-topics with: make -C Doc pydoc-topics

It might take a while.

Also, add a NEWS entry (see #132784 (comment) about how to do that) and change the issue number :) I will update you PR title for you to match the original issue #132783

@sobolevn sobolevn changed the title gh-132783: Add match and case to help topics gh-105895: Add match and case to help topics May 6, 2025
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 6, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

Comment thread Lib/pydoc.py Outdated
@dzherb dzherb requested a review from sobolevn May 7, 2025 11:57
@dzherb
Copy link
Copy Markdown
Contributor Author

dzherb commented May 9, 2025

@sobolevn could you please look at the last changes? Is everything ok?

Copy link
Copy Markdown
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

LGTM, but I can't merge this PR. Since I am not an expert in pydoc and I need someone who knows how it actually works to verify :)

Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

There are conflicts that need to be fixed.

Comment thread Lib/pydoc_data/topics.py
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please revert changes to this file, they will be automatically done before a release.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please move to "Library"

@hugovk hugovk removed their request for review April 6, 2026 12:45
@github-actions
Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review stale Stale PR or inactive for long period of time.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants