Skip to content

gh-41872: Parse docstrings with ast instead of string manipulation#127520

Merged
serhiy-storchaka merged 29 commits into
python:mainfrom
srinivasreddy:gh-41872
Jan 8, 2025
Merged

gh-41872: Parse docstrings with ast instead of string manipulation#127520
serhiy-storchaka merged 29 commits into
python:mainfrom
srinivasreddy:gh-41872

Conversation

@srinivasreddy

@srinivasreddy srinivasreddy commented Dec 2, 2024 •
edited by merwok
Loading

Copy link
Copy Markdown
Contributor

gh-41872: Instead of manual parsing of docstrings, use ast to parse both single quote docstrings and double quote docstrings

@bedevere-app bedevere-app Bot mentioned this pull request Dec 2, 2024
Closed
@srinivasreddy srinivasreddy changed the title gh-41872: Instead of manual parsing of doc strongs, use ast.literal_eval to parse both single quote doc strings, and double quote doc strings gh-41872: Instead of manual parsing of doc strings, use ast.literal_eval to parse both single quote doc strings, and double quote doc strings Dec 2, 2024
@srinivasreddy
srinivasreddy marked this pull request as ready for review December 2, 2024 16:29
merwok
merwok reviewed Dec 2, 2024
View reviewed changes
Comment thread Lib/pydoc.py
Comment thread Lib/pydoc.py Outdated
@srinivasreddy srinivasreddy changed the title gh-41872: Instead of manual parsing of doc strings, use ast.literal_eval to parse both single quote doc strings, and double quote doc strings gh-41872: Instead of manual parsing of doc strings, use ast to parse both single quote doc strings, and double quote doc strings Dec 3, 2024
@srinivasreddy
srinivasreddy requested a review from merwok December 3, 2024 13:50
@srinivasreddy

srinivasreddy commented Dec 3, 2024

Copy link
Copy Markdown
Contributor Author

I have changed the solution, please let me know your thoughts on it? @merwok

@merwok

merwok commented Dec 4, 2024

Copy link
Copy Markdown
Member

Please avoid force pushes, as indicated in the devguide 🙂

merwok
merwok reviewed Dec 4, 2024
View reviewed changes
Comment thread Lib/pydoc.py Outdated
merwok
merwok reviewed Dec 4, 2024
View reviewed changes
Comment thread Lib/pydoc.py Outdated
@merwok merwok changed the title gh-41872: Instead of manual parsing of doc strings, use ast to parse both single quote doc strings, and double quote doc strings gh-41872: Parse docstrings with ast instead of string manipulation Dec 4, 2024
srinivasreddy
srinivasreddy commented Dec 5, 2024
View reviewed changes
Comment thread Lib/pydoc.py Outdated
srinivasreddy
srinivasreddy commented Dec 5, 2024
View reviewed changes
Comment thread Lib/pydoc.py Outdated
ZeroIntensity
ZeroIntensity reviewed Dec 13, 2024
View reviewed changes

@ZeroIntensity ZeroIntensity left a comment

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.

Needs a blurb entry, by the way.

srinivasreddy and others added 3 commits December 18, 2024 22:56
@srinivasreddy @serhiy-storchaka
Update Lib/test/test_pydoc/test_pydoc.py
233fbd6 
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@srinivasreddy @serhiy-storchaka
Update Lib/test/test_pydoc/test_pydoc.py
ec7e431 
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@srinivasreddy @serhiy-storchaka
Update Lib/test/test_pydoc/test_pydoc.py
c004506 
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@srinivasreddy

srinivasreddy commented Dec 18, 2024

Copy link
Copy Markdown
Contributor Author

@serhiy-storchaka Thanks for the suggestions I was in a hurry , left for the day without fixing them .

@srinivasreddy
srinivasreddy marked this pull request as draft January 6, 2025 14:31
merwok
merwok reviewed Jan 6, 2025
View reviewed changes
Comment thread Lib/test/test_pydoc/test_pydoc.py Outdated
@srinivasreddy
srinivasreddy marked this pull request as ready for review January 8, 2025 06:32
@srinivasreddy

srinivasreddy commented Jan 8, 2025

Copy link
Copy Markdown
Contributor Author

@serhiy-storchaka Thanks for the commit.

@serhiy-storchaka
serhiy-storchaka enabled auto-merge (squash) January 8, 2025 10:12
@serhiy-storchaka
serhiy-storchaka merged commit 474e419 into python:main Jan 8, 2025
@miss-islington-app

miss-islington-app Bot commented Jan 8, 2025

Copy link
Copy Markdown

Thanks @srinivasreddy for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 8, 2025
@srinivasreddy @merwok
@serhiy-storchaka @miss-islington
pythongh-41872: Fix quick extraction of module docstrings from a file…
75ff5f6 
… in pydoc (pythonGH-127520)

It now supports docstrings with single quotes, escape sequences,
raw string literals, and other Python syntax.

(cherry picked from commit 474e419)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app

bedevere-app Bot commented Jan 8, 2025

Copy link
Copy Markdown

GH-128620 is a backport of this pull request to the 3.13 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 8, 2025
@srinivasreddy @merwok
@serhiy-storchaka @miss-islington
pythongh-41872: Fix quick extraction of module docstrings from a file…
2b6a81b 
… in pydoc (pythonGH-127520)

It now supports docstrings with single quotes, escape sequences,
raw string literals, and other Python syntax.

(cherry picked from commit 474e419)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Jan 8, 2025
@bedevere-app

bedevere-app Bot commented Jan 8, 2025

Copy link
Copy Markdown

GH-128621 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Jan 8, 2025
@srinivasreddy
srinivasreddy deleted the gh-41872 branch January 8, 2025 11:03
serhiy-storchaka added a commit that referenced this pull request Jan 8, 2025
@miss-islington @srinivasreddy
@merwok @serhiy-storchaka
[3.13] gh-41872: Fix quick extraction of module docstrings from a fil…
dda55cc 
…e in pydoc (GH-127520) (GH-128620)

It now supports docstrings with single quotes, escape sequences,
raw string literals, and other Python syntax.

(cherry picked from commit 474e419)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka added a commit that referenced this pull request Jan 8, 2025
@miss-islington @srinivasreddy
@merwok @serhiy-storchaka
[3.12] gh-41872: Fix quick extraction of module docstrings from a fil…
b69b9da 
…e in pydoc (GH-127520) (GH-128621)

It now supports docstrings with single quotes, escape sequences,
raw string literals, and other Python syntax.

(cherry picked from commit 474e419)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@merwok merwok merwok left review comments
@serhiy-storchaka serhiy-storchaka serhiy-storchaka left review comments
@ZeroIntensity ZeroIntensity Awaiting requested review from ZeroIntensity
@ambv ambv Awaiting requested review from ambv

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@srinivasreddy @merwok @ZeroIntensity @serhiy-storchaka