ManimCommunity/manim

Add tuple key support in `GenericGraph.__getitem__()`

Open

#3798 opened on Jun 9, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (17,820 stars) (1,378 forks)batch import
good first issuenew feature

Description

Description of proposed feature

vertices = [1, 2, 3, 4]
edges = [(1, 2), (2, 3), (3, 4), (1, 3), (1, 4)]
g = Graph(vertices, edges)
assert isinstance(g[1], Dot)  # This is OK
assert isinstance(g[(1, 2)], Line)  # But this will raise a KeyError

imo This is confusing. Why not add a support for edge mapping?

How can the new feature be used?

Every time people want to get or set a edge, just write g[(1, 2)] instead of g.edges[(1, 2)].

Contributor guide

Tech stack
python
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythongraph basicsspecial methods
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the `GenericGraph` class, likely in `manim/graph.py` (or similar). Implement ` getitem ` to handle tuple keys by returning the corresponding edge. Check existing edge retrieval methods in the `edges` attribute. Ensure backward compatibility with existing key behavior and update any relevant tests or documentation.