Skip to content

Commit

Permalink
feat(python): Pass dict to set_names
Browse files Browse the repository at this point in the history
  • Loading branch information
Anton Eriksson committed Sep 15, 2021
1 parent e6796c8 commit 0ed79e8
Showing 1 changed file with 27 additions and 6 deletions.
33 changes: 27 additions & 6 deletions interfaces/python/infomap.py
Expand Up @@ -549,27 +549,48 @@ def set_names(self, names):
Examples
--------
With tuples
>>> from infomap import Infomap
>>> im = Infomap()
>>> names = (
... (1, "Node 1"),
... (2, "Node 2")
... )
>>> im.set_names(names)
>>> im.names
{1: 'Node 1', 2: 'Node 2'}
With dict
>>> from infomap import Infomap
>>> im = Infomap()
>>> names = {
... 1: "Node 1",
... 2: "Node 2"
... }
>>> im.set_names(names)
>>> im.names
{1: 'Node 1', 2: 'Node 2'}
See Also
--------
set_name
set_name, names
Parameters
----------
names : iterable of tuples
Iterable of tuples on the form ``(node_id, name)``.
names : iterable of tuples or dict of int: str
Iterable of tuples on the form ``(node_id, name)``
or dict of the form ``{node_id: name}``.
"""
for name in names:
self.set_name(*name)
try:
for name in names.items():
self.set_name(*name)
except AttributeError:
for name in names:
self.set_name(*name)

def add_link(self, source_id, target_id, weight=1.0):
"""Add a link.
Expand Down

0 comments on commit 0ed79e8

Please sign in to comment.