py4cytoscape.groups.list_groups

list_groups(network=None, base_url='http://127.0.0.1:1234/v1')[source]

Retrieve a list of all group SUIDs in a network.

Parameters

  • network (SUID or str or None) – Name or SUID of a network. Default is the “current” network active in Cytoscape.

  • base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://127.0.0.1:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

{groups: [SUID list]} as list of SUIDs for group nodes

Return type

dict

Raises

  • CyError – if network name or SUID doesn’t exist

  • requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> list_groups()
{'groups': [94214, 94038, 94122]}