Skip to content

Mark positional-only parameters in the IcePy stub and docstrings #6607

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
pepone merged 4 commits into from
Aug 14, 2026
Merged

Mark positional-only parameters in the IcePy stub and docstrings #6607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
03e095c
Mark positional-only parameters in the IcePy stub and docstrings
pepone Aug 14, 2026
a32866c
Update changelog.d/python/6442.md
pepone Aug 14, 2026
1c93005
Mark the rich-comparison dunders positional-only as well
pepone Aug 14, 2026
2028637
Drop the IcePy changelog entry
pepone Aug 14, 2026
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
40 changes: 20 additions & 20 deletions python/modules/IcePy/Communicator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1409,12 +1409,12 @@ static PyMethodDef CommunicatorMethods[] = {
{"destroyAsync",
reinterpret_cast<PyCFunction>(communicatorDestroyAsync),
METH_VARARGS,
PyDoc_STR("destroyAsync(callable: Callable) -> None")},
PyDoc_STR("destroyAsync(callable: Callable, /) -> None")},
{"shutdown", reinterpret_cast<PyCFunction>(communicatorShutdown), METH_NOARGS, PyDoc_STR("shutdown() -> None")},
{"waitForShutdown",
reinterpret_cast<PyCFunction>(communicatorWaitForShutdown),
METH_VARARGS,
PyDoc_STR("waitForShutdown(timeout: int) -> bool")},
PyDoc_STR("waitForShutdown(timeout: int, /) -> bool")},
{"shutdownCompleted",
reinterpret_cast<PyCFunction>(communicatorShutdownCompleted),
METH_NOARGS,
Expand All @@ -1426,43 +1426,43 @@ static PyMethodDef CommunicatorMethods[] = {
{"stringToProxy",
reinterpret_cast<PyCFunction>(communicatorStringToProxy),
METH_VARARGS,
PyDoc_STR("stringToProxy(str: str) -> Ice.ObjectPrx | None")},
PyDoc_STR("stringToProxy(str: str, /) -> Ice.ObjectPrx | None")},
{"proxyToString",
reinterpret_cast<PyCFunction>(communicatorProxyToString),
METH_VARARGS,
PyDoc_STR("proxyToString(proxy: Ice.ObjectPrx | None) -> str")},
PyDoc_STR("proxyToString(proxy: Ice.ObjectPrx | None, /) -> str")},
{"propertyToProxy",
reinterpret_cast<PyCFunction>(communicatorPropertyToProxy),
METH_VARARGS,
PyDoc_STR("propertyToProxy(property: str) -> Ice.ObjectPrx | None")},
PyDoc_STR("propertyToProxy(property: str, /) -> Ice.ObjectPrx | None")},
{"proxyToProperty",
reinterpret_cast<PyCFunction>(communicatorProxyToProperty),
METH_VARARGS,
PyDoc_STR("proxyToProperty(proxy: Ice.ObjectPrx, property: str) -> dict[str, str]")},
PyDoc_STR("proxyToProperty(proxy: Ice.ObjectPrx, property: str, /) -> dict[str, str]")},
{"identityToString",
reinterpret_cast<PyCFunction>(communicatorIdentityToString),
METH_VARARGS,
PyDoc_STR("identityToString(identity: Ice.Identity) -> str")},
PyDoc_STR("identityToString(identity: Ice.Identity, /) -> str")},
{"createObjectAdapter",
reinterpret_cast<PyCFunction>(communicatorCreateObjectAdapter),
METH_VARARGS,
PyDoc_STR("createObjectAdapter(name: str) -> ObjectAdapter")},
PyDoc_STR("createObjectAdapter(name: str, /) -> ObjectAdapter")},
{"createObjectAdapterWithEndpoints",
reinterpret_cast<PyCFunction>(communicatorCreateObjectAdapterWithEndpoints),
METH_VARARGS,
PyDoc_STR("createObjectAdapterWithEndpoints(name: str, endpoints: str) -> ObjectAdapter")},
PyDoc_STR("createObjectAdapterWithEndpoints(name: str, endpoints: str, /) -> ObjectAdapter")},
{"createObjectAdapterWithRouter",
reinterpret_cast<PyCFunction>(communicatorCreateObjectAdapterWithRouter),
METH_VARARGS,
PyDoc_STR("createObjectAdapterWithRouter(name: str, router: Ice.RouterPrx) -> ObjectAdapter")},
PyDoc_STR("createObjectAdapterWithRouter(name: str, router: Ice.RouterPrx, /) -> ObjectAdapter")},
{"getDefaultObjectAdapter",
reinterpret_cast<PyCFunction>(communicatorGetDefaultObjectAdapter),
METH_NOARGS,
PyDoc_STR("getDefaultObjectAdapter() -> Ice.ObjectAdapter | None")},
{"setDefaultObjectAdapter",
reinterpret_cast<PyCFunction>(communicatorSetDefaultObjectAdapter),
METH_VARARGS,
PyDoc_STR("setDefaultObjectAdapter(adapter: Ice.ObjectAdapter | None) -> None")},
PyDoc_STR("setDefaultObjectAdapter(adapter: Ice.ObjectAdapter | None, /) -> None")},
{"getImplicitContext",
reinterpret_cast<PyCFunction>(communicatorGetImplicitContext),
METH_NOARGS,
Expand All @@ -1482,51 +1482,51 @@ static PyMethodDef CommunicatorMethods[] = {
{"setDefaultRouter",
reinterpret_cast<PyCFunction>(communicatorSetDefaultRouter),
METH_VARARGS,
PyDoc_STR("setDefaultRouter(router: Ice.RouterPrx | None) -> None")},
PyDoc_STR("setDefaultRouter(router: Ice.RouterPrx | None, /) -> None")},
{"getDefaultLocator",
reinterpret_cast<PyCFunction>(communicatorGetDefaultLocator),
METH_NOARGS,
PyDoc_STR("getDefaultLocator() -> Ice.LocatorPrx | None")},
{"setDefaultLocator",
reinterpret_cast<PyCFunction>(communicatorSetDefaultLocator),
METH_VARARGS,
PyDoc_STR("setDefaultLocator(locator: Ice.LocatorPrx | None) -> None")},
PyDoc_STR("setDefaultLocator(locator: Ice.LocatorPrx | None, /) -> None")},
{"flushBatchRequests",
reinterpret_cast<PyCFunction>(communicatorFlushBatchRequests),
METH_VARARGS,
PyDoc_STR("flushBatchRequests(compress: Ice.CompressBatch) -> None")},
PyDoc_STR("flushBatchRequests(compress: Ice.CompressBatch, /) -> None")},
{"flushBatchRequestsAsync",
reinterpret_cast<PyCFunction>(communicatorFlushBatchRequestsAsync),
METH_VARARGS,
PyDoc_STR("flushBatchRequestsAsync(compress: Ice.CompressBatch) -> Awaitable[None]")},
PyDoc_STR("flushBatchRequestsAsync(compress: Ice.CompressBatch, /) -> Awaitable[None]")},
{"createAdmin",
reinterpret_cast<PyCFunction>(communicatorCreateAdmin),
METH_VARARGS,
PyDoc_STR("createAdmin(adminAdapter: Ice.ObjectAdapter | None, adminIdentity: Ice.Identity) -> Ice.ObjectPrx")},
PyDoc_STR("createAdmin(adminAdapter: Ice.ObjectAdapter | None, adminIdentity: Ice.Identity, /) -> Ice.ObjectPrx")},
{"getAdmin",
reinterpret_cast<PyCFunction>(communicatorGetAdmin),
METH_NOARGS,
PyDoc_STR("getAdmin() -> Ice.ObjectPrx | None")},
{"addAdminFacet",
reinterpret_cast<PyCFunction>(communicatorAddAdminFacet),
METH_VARARGS,
PyDoc_STR("addAdminFacet(servant: Ice.Object, facet: str) -> None")},
PyDoc_STR("addAdminFacet(servant: Ice.Object, facet: str, /) -> None")},
{"findAdminFacet",
reinterpret_cast<PyCFunction>(communicatorFindAdminFacet),
METH_VARARGS,
PyDoc_STR("findAdminFacet(facet: str) -> Ice.Object | NativePropertiesAdmin | None")},
PyDoc_STR("findAdminFacet(facet: str, /) -> Ice.Object | NativePropertiesAdmin | None")},
{"findAllAdminFacets",
reinterpret_cast<PyCFunction>(communicatorFindAllAdminFacets),
METH_NOARGS,
PyDoc_STR("findAllAdminFacets() -> dict[str, Ice.Object | NativePropertiesAdmin]")},
{"removeAdminFacet",
reinterpret_cast<PyCFunction>(communicatorRemoveAdminFacet),
METH_VARARGS,
PyDoc_STR("removeAdminFacet(facet: str) -> Ice.Object | None")},
PyDoc_STR("removeAdminFacet(facet: str, /) -> Ice.Object | None")},
{"_setWrapper",
reinterpret_cast<PyCFunction>(communicatorSetWrapper),
METH_VARARGS,
PyDoc_STR("_setWrapper(wrapper: Ice.Communicator) -> None")},
PyDoc_STR("_setWrapper(wrapper: Ice.Communicator, /) -> None")},
{"_getWrapper",
reinterpret_cast<PyCFunction>(communicatorGetWrapper),
METH_NOARGS,
Expand Down
13 changes: 7 additions & 6 deletions python/modules/IcePy/Connection.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Awaitable[None]
A future that becomes available when the connection is closed. If the connection was lost or
aborted, awaiting this future raises the exception that caused the connection's closure.)";

constexpr const char* connectionCreateProxy_doc = R"(createProxy(identity: Ice.Identity) -> Ice.ObjectPrx
constexpr const char* connectionCreateProxy_doc = R"(createProxy(identity: Ice.Identity, /) -> Ice.ObjectPrx

Creates a special proxy (a 'fixed proxy') that always uses this connection.

Expand All @@ -94,7 +94,7 @@ Disables the inactivity check on this connection.
By default, Ice will close connections that remain inactive for a certain period.
This function disables that behavior for this connection.)";

constexpr const char* connectionSetAdapter_doc = R"(setAdapter(adapter: Ice.ObjectAdapter | None) -> None
constexpr const char* connectionSetAdapter_doc = R"(setAdapter(adapter: Ice.ObjectAdapter | None, /) -> None

Associates an object adapter with this connection.

Expand Down Expand Up @@ -125,7 +125,8 @@ Returns
Ice.ObjectAdapter | None
The object adapter associated with this connection.)";

constexpr const char* connectionFlushBatchRequests_doc = R"(flushBatchRequests(compress: Ice.CompressBatch) -> None
constexpr const char* connectionFlushBatchRequests_doc =
R"(flushBatchRequests(compress: Ice.CompressBatch, /) -> None

Flushes any pending batch requests for this connection.

Expand All @@ -143,7 +144,7 @@ LocalException
has been destroyed.)";

constexpr const char* connectionFlushBatchRequestsAsync_doc =
R"(flushBatchRequestsAsync(compress: Ice.CompressBatch) -> Awaitable[None]
R"(flushBatchRequestsAsync(compress: Ice.CompressBatch, /) -> Awaitable[None]

Flushes any pending batch requests for this connection asynchronously.

Expand All @@ -165,7 +166,7 @@ CommunicatorDestroyedException
If the communicator has been destroyed. This exception is raised synchronously.)";

constexpr const char* connectionSetCloseCallback_doc =
R"(setCloseCallback(callback: Callable[[Connection], None] | None) -> None
R"(setCloseCallback(callback: Callable[[Connection], None] | None, /) -> None

Sets a close callback on the connection. The callback is called by the connection when it's closed.
The callback is called from the Ice thread pool associated with the connection.
Expand Down Expand Up @@ -215,7 +216,7 @@ Returns
Ice.Endpoint
The endpoint from which the connection was created.)";

constexpr const char* connectionSetBufferSize_doc = R"(setBufferSize(rcvSize: int, sndSize: int) -> None
constexpr const char* connectionSetBufferSize_doc = R"(setBufferSize(rcvSize: int, sndSize: int, /) -> None

Sets the size of the receive and send buffers.

Expand Down
10 changes: 5 additions & 5 deletions python/modules/IcePy/ImplicitContext.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,20 +252,20 @@ static PyMethodDef ImplicitContextMethods[] = {
{"setContext",
reinterpret_cast<PyCFunction>(implicitContextSetContext),
METH_VARARGS,
PyDoc_STR("setContext(newContext: dict[str, str]) -> None")},
PyDoc_STR("setContext(newContext: dict[str, str], /) -> None")},
{"containsKey",
reinterpret_cast<PyCFunction>(implicitContextContainsKey),
METH_VARARGS,
PyDoc_STR("containsKey(key: str) -> bool")},
{"get", reinterpret_cast<PyCFunction>(implicitContextGet), METH_VARARGS, PyDoc_STR("get(key: str) -> str")},
PyDoc_STR("containsKey(key: str, /) -> bool")},
{"get", reinterpret_cast<PyCFunction>(implicitContextGet), METH_VARARGS, PyDoc_STR("get(key: str, /) -> str")},
{"put",
reinterpret_cast<PyCFunction>(implicitContextPut),
METH_VARARGS,
PyDoc_STR("put(key: str, value: str) -> str")},
PyDoc_STR("put(key: str, value: str, /) -> str")},
{"remove",
reinterpret_cast<PyCFunction>(implicitContextRemove),
METH_VARARGS,
PyDoc_STR("remove(key: str) -> str")},
PyDoc_STR("remove(key: str, /) -> str")},
{} /* sentinel */
};

Expand Down
30 changes: 15 additions & 15 deletions python/modules/IcePy/Init.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ int
The Ice version.)";

constexpr const char* IcePy_createProperties_doc =
R"(createProperties(args: list[str] | None = None, defaults: Ice.Properties | None = None) -> Properties
R"(createProperties(args: list[str] | None = None, defaults: Ice.Properties | None = None, /) -> Properties

Creates a property set initialized from command-line arguments and a default property set.

Expand All @@ -66,7 +66,7 @@ Returns
Properties
A new property set.)";

constexpr const char* IcePy_stringToIdentity_doc = R"(stringToIdentity(str: str) -> Ice.Identity
constexpr const char* IcePy_stringToIdentity_doc = R"(stringToIdentity(str: str, /) -> Ice.Identity

Converts a stringified identity into an Identity.

Expand All @@ -88,7 +88,7 @@ LocalException
If the resulting identity has an empty name.)";

constexpr const char* IcePy_identityToString_doc =
R"(identityToString(identity: Ice.Identity, toStringMode: Ice.ToStringMode | None = None) -> str
R"(identityToString(identity: Ice.Identity, toStringMode: Ice.ToStringMode | None = None, /) -> str

Converts an Identity into a string using the specified mode.

Expand All @@ -114,7 +114,7 @@ Returns
Ice.Logger | Logger
The current per-process logger instance.)";

constexpr const char* IcePy_setProcessLogger_doc = R"(setProcessLogger(logger: Ice.Logger) -> None
constexpr const char* IcePy_setProcessLogger_doc = R"(setProcessLogger(logger: Ice.Logger, /) -> None

Sets the per-process logger. Communicators created after this call use this logger unless a logger is set in
InitializationData or configured through logger properties such as Ice.LogFile.
Expand All @@ -124,7 +124,7 @@ Parameters
logger : Ice.Logger
The new per-process logger instance.)";

constexpr const char* IcePy_loadSlice_doc = R"(loadSlice(args: list[str]) -> None
constexpr const char* IcePy_loadSlice_doc = R"(loadSlice(args: list[str], /) -> None

Compiles Slice definitions and loads the generated code directly into the current Python environment.

Expand Down Expand Up @@ -158,7 +158,7 @@ Raises
RuntimeError
If an error occurs during Slice parsing or compilation.)";

constexpr const char* IcePy_compileSlice_doc = R"(compileSlice(args: list[str]) -> int
constexpr const char* IcePy_compileSlice_doc = R"(compileSlice(args: list[str], /) -> int

Compiles Slice definitions. The behavior is identical to that of the `slice2py` compiler.

Expand Down Expand Up @@ -208,41 +208,41 @@ static PyMethodDef methods[] = {
{"defineEnum",
reinterpret_cast<PyCFunction>(IcePy_defineEnum),
METH_VARARGS,
PyDoc_STR("defineEnum(sliceId: str, type: Type, meta: tuple, enumerators: dict)")},
PyDoc_STR("defineEnum(sliceId: str, type: Type, meta: tuple, enumerators: dict, /)")},
{"defineStruct",
reinterpret_cast<PyCFunction>(IcePy_defineStruct),
METH_VARARGS,
PyDoc_STR("defineStruct(sliceId: str, type: Type, meta: tuple, members: tuple)")},
PyDoc_STR("defineStruct(sliceId: str, type: Type, meta: tuple, members: tuple, /)")},
{"defineSequence",
reinterpret_cast<PyCFunction>(IcePy_defineSequence),
METH_VARARGS,
PyDoc_STR("defineSequence(sliceId: str, meta: tuple, elementType: TypeInfo)")},
PyDoc_STR("defineSequence(sliceId: str, meta: tuple, elementType: TypeInfo, /)")},
{"defineDictionary",
reinterpret_cast<PyCFunction>(IcePy_defineDictionary),
METH_VARARGS,
PyDoc_STR("defineDictionary(sliceId: str, meta: tuple, keyType: TypeInfo, valueType: TypeInfo)")},
PyDoc_STR("defineDictionary(sliceId: str, meta: tuple, keyType: TypeInfo, valueType: TypeInfo, /)")},
{"declareProxy",
reinterpret_cast<PyCFunction>(IcePy_declareProxy),
METH_VARARGS,
PyDoc_STR("declareProxy(sliceId: str)")},
PyDoc_STR("declareProxy(sliceId: str, /)")},
{"defineProxy",
reinterpret_cast<PyCFunction>(IcePy_defineProxy),
METH_VARARGS,
PyDoc_STR("defineProxy(sliceId: str, proxyType: Type[ObjectPrx])")},
PyDoc_STR("defineProxy(sliceId: str, proxyType: Type[ObjectPrx], /)")},
{"declareValue",
reinterpret_cast<PyCFunction>(IcePy_declareValue),
METH_VARARGS,
PyDoc_STR("declareValue(sliceId: str)")},
PyDoc_STR("declareValue(sliceId: str, /)")},
{"defineValue",
reinterpret_cast<PyCFunction>(IcePy_defineValue),
METH_VARARGS,
PyDoc_STR("defineValue(sliceId: str, valueType: Type[Ice.Value], compactId: int, meta: tuple, isInterface: bool, "
"baseType: Type[Ice.Value] | None, members: tuple)")},
"baseType: Type[Ice.Value] | None, members: tuple, /)")},
{"defineException",
reinterpret_cast<PyCFunction>(IcePy_defineException),
METH_VARARGS,
PyDoc_STR("defineException(sliceId: str, type: Type[BaseException], meta: tuple, base: Type[BaseException] | "
"None, members: tuple)")},
"None, members: tuple, /)")},
{"loadSlice", reinterpret_cast<PyCFunction>(IcePy_loadSlice), METH_VARARGS, PyDoc_STR(IcePy_loadSlice_doc)},
{"compileSlice",
reinterpret_cast<PyCFunction>(IcePy_compileSlice),
Expand Down
13 changes: 8 additions & 5 deletions python/modules/IcePy/Logger.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,18 +310,21 @@ loggerCloneWithPrefix(LoggerObject* self, PyObject* args)
}

static PyMethodDef LoggerMethods[] = {
{"print", reinterpret_cast<PyCFunction>(loggerPrint), METH_VARARGS, PyDoc_STR("print(message: str) -> None")},
{"print", reinterpret_cast<PyCFunction>(loggerPrint), METH_VARARGS, PyDoc_STR("print(message: str, /) -> None")},
{"trace",
reinterpret_cast<PyCFunction>(loggerTrace),
METH_VARARGS,
PyDoc_STR("trace(category: str, message: str) -> None")},
{"warning", reinterpret_cast<PyCFunction>(loggerWarning), METH_VARARGS, PyDoc_STR("warning(message: str) -> None")},
{"error", reinterpret_cast<PyCFunction>(loggerError), METH_VARARGS, PyDoc_STR("error(message: str) -> None")},
PyDoc_STR("trace(category: str, message: str, /) -> None")},
{"warning",
reinterpret_cast<PyCFunction>(loggerWarning),
METH_VARARGS,
PyDoc_STR("warning(message: str, /) -> None")},
{"error", reinterpret_cast<PyCFunction>(loggerError), METH_VARARGS, PyDoc_STR("error(message: str, /) -> None")},
{"getPrefix", reinterpret_cast<PyCFunction>(loggerGetPrefix), METH_NOARGS, PyDoc_STR("getPrefix() -> str")},
{"cloneWithPrefix",
reinterpret_cast<PyCFunction>(loggerCloneWithPrefix),
METH_VARARGS,
PyDoc_STR("cloneWithPrefix(prefix: str) -> Logger")},
PyDoc_STR("cloneWithPrefix(prefix: str, /) -> Logger")},
{} /* sentinel */
};

Expand Down
Loading
Loading