Skip to content

gh-76785: Clean Up the Channels Module #110568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericsnowcurrently merged 19 commits into from
Oct 17, 2023
Merged

gh-76785: Clean Up the Channels Module #110568

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
2ab929c
Fix the function name prefix for module functions.
ericsnowcurrently Sep 21, 2023
7b2a190
Fix function names related to channel end types.
ericsnowcurrently Sep 21, 2023
4f7d3ef
Fix section dividers.
ericsnowcurrently Sep 21, 2023
90a0376
_channel_from_cid -> _channelobj_from_cid.
ericsnowcurrently Sep 21, 2023
4ca411d
ChannelIDType_spec -> channelid_typespec
ericsnowcurrently Sep 21, 2023
41a8e82
Drop leading _ from high-level functions.
ericsnowcurrently Sep 21, 2023
33c0007
Add some doc comments.
ericsnowcurrently Sep 21, 2023
031d767
Add TODO comments.
ericsnowcurrently Sep 21, 2023
6e77543
Fix some doc comments.
ericsnowcurrently Sep 21, 2023
d834e16
Use "cid" consistently.
ericsnowcurrently Sep 21, 2023
a416dc0
drop -> release
ericsnowcurrently Sep 21, 2023
9d4d8d6
interp -> interpid
ericsnowcurrently Sep 21, 2023
23077c2
Add a separator line.
ericsnowcurrently Sep 21, 2023
2e0fc2a
close_all -> release_all
ericsnowcurrently Sep 21, 2023
cff8dcf
Use "release", "close", and "clear" consistently.
ericsnowcurrently Sep 21, 2023
84c4387
_channelends_close_end() -> _channelends_release_end()
ericsnowcurrently Sep 21, 2023
bdb450e
Use typedefs.
ericsnowcurrently Sep 21, 2023
b85ea26
_PyChannelState -> _channel_state
ericsnowcurrently Sep 21, 2023
e1ba74c
Add some comments.
ericsnowcurrently Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix function names related to channel end types.
  • Loading branch information
@ericsnowcurrently
ericsnowcurrently committed Oct 17, 2023
commit 7b2a190e2a6e8ed2a3d3cb239986386a56bee6e0
23 changes: 12 additions & 11 deletions Modules/_xxinterpchannelsmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2317,12 +2317,12 @@ channelid_richcompare(PyObject *self, PyObject *other, int op)
return res;
}

static PyTypeObject * _get_current_channel_end_type(int end);
static PyTypeObject * _get_current_channelend_type(int end);

static PyObject *
_channel_from_cid(PyObject *cid, int end)
{
PyObject *cls = (PyObject *)_get_current_channel_end_type(end);
PyObject *cls = (PyObject *)_get_current_channelend_type(end);
if (cls == NULL) {
return NULL;
}
Expand Down Expand Up @@ -2483,7 +2483,7 @@ static PyType_Spec ChannelIDType_spec = {
// XXX Use a new __xid__ protocol instead?

static PyTypeObject *
_get_current_channel_end_type(int end)
_get_current_channelend_type(int end)
{
module_state *state = _get_current_module_state();
if (state == NULL) {
Expand Down Expand Up @@ -2519,13 +2519,13 @@ _get_current_channel_end_type(int end)
}

static PyObject *
_channel_end_from_xid(_PyCrossInterpreterData *data)
_channelend_from_xid(_PyCrossInterpreterData *data)
{
channelid *cid = (channelid *)_channelid_from_xid(data);
if (cid == NULL) {
return NULL;
}
PyTypeObject *cls = _get_current_channel_end_type(cid->end);
PyTypeObject *cls = _get_current_channelend_type(cid->end);
if (cls == NULL) {
Py_DECREF(cid);
return NULL;
Expand All @@ -2536,7 +2536,7 @@ _channel_end_from_xid(_PyCrossInterpreterData *data)
}

static int
_channel_end_shared(PyThreadState *tstate, PyObject *obj,
_channelend_shared(PyThreadState *tstate, PyObject *obj,
_PyCrossInterpreterData *data)
{
PyObject *cidobj = PyObject_GetAttrString(obj, "_id");
Expand All @@ -2548,12 +2548,12 @@ _channel_end_shared(PyThreadState *tstate, PyObject *obj,
if (res < 0) {
return -1;
}
data->new_object = _channel_end_from_xid;
data->new_object = _channelend_from_xid;
return 0;
}

static int
set_channel_end_types(PyObject *mod, PyTypeObject *send, PyTypeObject *recv)
set_channelend_types(PyObject *mod, PyTypeObject *send, PyTypeObject *recv)
{
module_state *state = get_module_state(mod);
if (state == NULL) {
Expand All @@ -2570,16 +2570,17 @@ set_channel_end_types(PyObject *mod, PyTypeObject *send, PyTypeObject *recv)
state->send_channel_type = (PyTypeObject *)Py_NewRef(send);
state->recv_channel_type = (PyTypeObject *)Py_NewRef(recv);

if (register_xid_class(send, _channel_end_shared, xid_classes)) {
if (register_xid_class(send, _channelend_shared, xid_classes)) {
return -1;
}
if (register_xid_class(recv, _channel_end_shared, xid_classes)) {
if (register_xid_class(recv, _channelend_shared, xid_classes)) {
return -1;
}

return 0;
}


/* module level code ********************************************************/

/* globals is the process-global state for the module. It holds all
Expand Down Expand Up @@ -3079,7 +3080,7 @@ channelsmod__register_end_types(PyObject *self, PyObject *args, PyObject *kwds)
PyTypeObject *cls_send = (PyTypeObject *)send;
PyTypeObject *cls_recv = (PyTypeObject *)recv;

if (set_channel_end_types(self, cls_send, cls_recv) < 0) {
if (set_channelend_types(self, cls_send, cls_recv) < 0) {
return NULL;
}

Expand Down