bpo-45772: socket.socket should be a class instead of a function#23960

xuhdev · 2020-12-27T04:53:06Z

Currently socket.socket is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate socket.socket as a type.

https://bugs.python.org/issue45772

github-actions · 2021-01-27T00:28:48Z

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

xuhdev · 2021-01-27T00:44:30Z

Could someone review this, please? This should be quite quick to review.

github-actions · 2021-02-28T00:26:42Z

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

marsfan · 2021-11-09T17:51:40Z

I have been running into this same issue. It would be really nice to see this fixed.

arhadthedev · 2021-11-09T20:02:26Z

I created an entry for this pull request on bugs.python.org because most of people are there.

Actually, that's the very reason why authors should do it by themselves.

arhadthedev · 2021-11-09T20:08:42Z

In addition, status checks in the bottom of this GitHub page state the following:

bedevere/issue-number — No issue # in title or "skip issue" label found
bedevere/news — No news entry in Misc/NEWS.d/next/ or "skip news" label found

So you need to change a title of this issue to

(because that number was assigned to the entry I've created). Then you can look among already merged PR requests to see how other add to NEWS.d.

Edit: the bot replaced [bpo-...] with \[[bpo\](...), so I changed this part of a text with a screenshot.

Currently `socket.socket` is documented as a function, but it is really a class (and thus has function-like usage to construct an object). This correction would ensure that Python projects that are interlinking Python's documentation can properly locate `socket.socket` as a type.

xuhdev · 2021-11-09T21:11:42Z

Thanks @arhadthedev , I've updated the PR.

terryjreedy · 2021-11-12T22:10:38Z

@marsfan add your supporting comment on the issue, with explanation if possible.

Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst

…drM3t.rst

miss-islington · 2021-11-13T06:02:07Z

Thanks @xuhdev for the PR, and @asvetlov for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9, 3.10.
🐍🍒⛏🤖

bedevere-bot · 2021-11-13T06:02:30Z

GH-29542 is a backport of this pull request to the 3.10 branch.

…honGH-23960) * bpo-45772: socket.socket should be a class instead of a function Currently `socket.socket` is documented as a function, but it is really a class (and thus has function-like usage to construct an object). This correction would ensure that Python projects that are interlinking Python's documentation can properly locate `socket.socket` as a type. (cherry picked from commit 4c792f3) Co-authored-by: Hong Xu <hong@topbug.net>

bedevere-bot · 2021-11-13T06:02:36Z

GH-29543 is a backport of this pull request to the 3.9 branch.

bedevere-bot · 2021-11-13T06:02:40Z

GH-29544 is a backport of this pull request to the 3.8 branch.

…honGH-23960) * bpo-45772: socket.socket should be a class instead of a function Currently `socket.socket` is documented as a function, but it is really a class (and thus has function-like usage to construct an object). This correction would ensure that Python projects that are interlinking Python's documentation can properly locate `socket.socket` as a type. (cherry picked from commit 4c792f3) Co-authored-by: Hong Xu <hong@topbug.net>

…on (GH-23960) (GH-29542) * [bpo-45772](): socket.socket should be a class instead of a function Currently `socket.socket` is documented as a function, but it is really a class (and thus has function-like usage to construct an object). This correction would ensure that Python projects that are interlinking Python's documentation can properly locate `socket.socket` as a type. (cherry picked from commit 4c792f3) Co-authored-by: Hong Xu <hong@topbug.net> Automerge-Triggered-By: GH:asvetlov

GH-23960) (GH-29543) * [bpo-45772](): socket.socket should be a class instead of a function Currently `socket.socket` is documented as a function, but it is really a class (and thus has function-like usage to construct an object). This correction would ensure that Python projects that are interlinking Python's documentation can properly locate `socket.socket` as a type. (cherry picked from commit 4c792f3) Co-authored-by: Hong Xu <hong@topbug.net> Automerge-Triggered-By: GH:asvetlov

…honGH-23960) * bpo-45772: socket.socket should be a class instead of a function Currently `socket.socket` is documented as a function, but it is really a class (and thus has function-like usage to construct an object). This correction would ensure that Python projects that are interlinking Python's documentation can properly locate `socket.socket` as a type.

the-knights-who-say-ni added the CLA signed label Dec 27, 2020

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Dec 27, 2020

github-actionsbot added the stale Stale PR or inactive for long period of time. label Jan 27, 2021

xuhdev force-pushed the sock-class branch from 6a7c3ae to be232b8Compare January 27, 2021 00:43

github-actionsbot removed the stale Stale PR or inactive for long period of time. label Jan 28, 2021

github-actionsbot added the stale Stale PR or inactive for long period of time. label Feb 28, 2021

marsfan approved these changes Nov 9, 2021
View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Nov 9, 2021

xuhdev changed the title ~~socket.socket should be a class instead of a function~~[bpo-45772] socket.socket should be a class instead of a functionNov 9, 2021

xuhdev changed the title ~~[bpo-45772] socket.socket should be a class instead of a function~~bpo-45772: socket.socket should be a class instead of a functionNov 9, 2021

xuhdev force-pushed the sock-class branch from be232b8 to 0964fe4Compare November 9, 2021 21:11

marsfan approved these changes Nov 10, 2021
View reviewed changes

asvetlov reviewed Nov 13, 2021
View reviewed changes

Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst Outdated Show resolvedHide resolved

asvetlov added needs backport to 3.8 needs backport to 3.10 only security fixes labels Nov 13, 2021

Update Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.E…
d81f63a
…drM3t.rst

asvetlov merged commit 4c792f3 into python:mainNov 13, 2021

bedevere-bot removed the awaiting core review label Nov 13, 2021

bedevere-bot removed the needs backport to 3.10 only security fixes label Nov 13, 2021

bedevere-bot removed the needs backport to 3.9 label Nov 13, 2021

bedevere-bot removed the needs backport to 3.8 label Nov 13, 2021

AA-Turner mentioned this pull request Sep 30, 2023
GH-101100: Fix reference warnings for socket methods #110114
Merged

xuhdev deleted the sock-class branch January 10, 2025 23:10

Uh oh!

bpo-45772: socket.socket should be a class instead of a function#23960

bpo-45772: socket.socket should be a class instead of a function #23960

Uh oh!

Conversation

xuhdev commented Dec 27, 2020• edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actionsbot commented Jan 27, 2021

Uh oh!

xuhdev commented Jan 27, 2021

Uh oh!

github-actionsbot commented Feb 28, 2021

Uh oh!

marsfan commented Nov 9, 2021

Uh oh!

arhadthedev commented Nov 9, 2021

Uh oh!

arhadthedev commented Nov 9, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xuhdev commented Nov 9, 2021

Uh oh!

terryjreedy commented Nov 12, 2021

Uh oh!

Uh oh!

miss-islington commented Nov 13, 2021

Uh oh!

bedevere-bot commented Nov 13, 2021

Uh oh!

bedevere-bot commented Nov 13, 2021

Uh oh!

bedevere-bot commented Nov 13, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

xuhdev commented Dec 27, 2020•
edited by bedevere-bot
Loading

arhadthedev commented Nov 9, 2021•
edited
Loading