Skip to content

Add __repr__ to core API classes and consolidate object protocol tests #1538

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

Open
Andy-Jost wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add __repr__ to core API classes and consolidate object protocol tests #1538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
197da96
Add __repr__ to core API classes and consolidate object protocol tests
Andy-Jost Jan 28, 2026
763005c
Merge origin/main into object-protocol-tests
Andy-Jost Jan 28, 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
5 changes: 4 additions & 1 deletion cuda_core/cuda/core/_context.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down Expand Up @@ -48,6 +48,9 @@ cdef class Context:
def __hash__(self) -> int:
return hash(as_intptr(self._h_context))

def __repr__(self) -> str:
return f"Context(handle={as_intptr(self._h_context):#x}, device={self._device_id})"


@dataclass
class ContextOptions:
Expand Down
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_cpp/resource_handles.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
//
// SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_cpp/resource_handles.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
//
// SPDX-License-Identifier: Apache-2.0

Expand Down
5 changes: 4 additions & 1 deletion cuda_core/cuda/core/_event.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down Expand Up @@ -178,6 +178,9 @@ cdef class Event:
cdef Event _other = <Event>other
return as_intptr(self._h_event) == as_intptr(_other._h_event)

def __repr__(self) -> str:
return f"Event(handle={as_intptr(self._h_event):#x})"

def get_ipc_descriptor(self) -> IPCEventDescriptor:
"""Export an event allocated for sharing between processes."""
if self._ipc_descriptor is not None:
Expand Down
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_launch_config.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_launcher.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_linker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down
5 changes: 4 additions & 1 deletion cuda_core/cuda/core/_memory/_buffer.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down Expand Up @@ -334,6 +334,9 @@ cdef class Buffer:
def __hash__(self) -> int:
return hash((as_intptr(self._h_ptr), self._size))

def __repr__(self) -> str:
return f"Buffer(ptr={as_intptr(self._h_ptr):#x}, size={self._size})"
Copy link
Collaborator

@kkraus14 kkraus14 Jan 29, 2026

Choose a reason for hiding this comment

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

Given we have a stream associated to the Buffer that we ultimately deallocate with, it may be nice to include that in the repr?


@property
def is_device_accessible(self) -> bool:
"""Return True if this buffer can be accessed by the GPU, otherwise False."""
Expand Down
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_memory/_memory_pool.pxd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_memory/_memory_pool.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_module.pxd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down
10 changes: 9 additions & 1 deletion cuda_core/cuda/core/_module.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down Expand Up @@ -613,6 +613,9 @@ cdef class Kernel:
def __hash__(self) -> int:
return hash(as_intptr(self._h_kernel))

def __repr__(self) -> str:
return f"Kernel(handle={as_intptr(self._h_kernel):#x})"


CodeTypeT = bytes | bytearray | str

Expand Down Expand Up @@ -864,3 +867,8 @@ cdef class ObjectCode:
# Trigger lazy load to get the handle
self._lazy_load_module()
return hash(as_intptr(self._h_library))

def __repr__(self) -> str:
# Trigger lazy load to get the handle
self._lazy_load_module()
Copy link
Collaborator

@rwgk rwgk Jan 28, 2026

Choose a reason for hiding this comment

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

Hm ... this could trigger "interesting" error scenarios.

Is the lazy loading really needed? How was the handle generated (if it exists)? Didn't that trigger the import already? If the handle does not exist, maybe we should just show <not imported> or similar in the repr, because that's what the actual state is?

Copy link
Collaborator

@kkraus14 kkraus14 Jan 29, 2026

Choose a reason for hiding this comment

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

My 2c: trigger lazy execution on __repr__ is a relatively common pattern in Python where I think this makes sense.

return f"ObjectCode(handle={as_intptr(self._h_library):#x}, code_type='{self._code_type}')"
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_resource_handles.pxd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion cuda_core/cuda/core/_resource_handles.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down
5 changes: 4 additions & 1 deletion cuda_core/cuda/core/_stream.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

Expand Down Expand Up @@ -221,6 +221,9 @@ cdef class Stream:
return NotImplemented
return as_intptr(self._h_stream) == as_intptr((<Stream>other)._h_stream)

def __repr__(self) -> str:
return f"Stream(handle={as_intptr(self._h_stream):#x})"
Copy link
Collaborator

@kkraus14 kkraus14 Jan 29, 2026

Choose a reason for hiding this comment

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

Because streams are tied to a specific context, does it make sense to capture the context here as well? Similar question for other types tied to a specific context.


@property
def handle(self) -> cuda.bindings.driver.CUstream:
"""Return the underlying ``CUstream`` object.
Expand Down
157 changes: 0 additions & 157 deletions cuda_core/tests/test_comparable.py
View file
Open in desktop

This file was deleted.

Loading
Loading