ipython / ipython/traitlets

traitlets.Set should support generic type annotations for type safety

Open
#927 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
2

Description

## Problem

`traitlets.Set` currently lacks generic type support, making it impossible to specify the type of elements it contains for proper type checking.

## Current Situation

```python
from traitlets import Set
import traitlets

class MyClass(traitlets.HasTraits):
# This works but provides no type information
my_set = Set()

# This doesn't work - no generic support
# my_set: Set[str] = Set() # Type error
```

## Desired Behavior

`traitlets.Set` should support generic type annotations similar to how Python's built-in collections work:

```python
from traitlets import Set
import traitlets

class MyClass(traitlets.HasTraits):
# Should be possible for type safety
room_ids: Set[str] = Set()
numbers: Set[int] = Set(default_value={1, 2, 3})
```

## Reference

The `Set` class is implemented in [`traitlets/traitlets.py`](https://github.com/ipython/traitlets/blob/main/traitlets/traitlets.py) as a container trait.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.