py4cytoscape.networks.get_network_list

get_network_list(base_url='http://127.0.0.1:1234/v1', *, get_suids=False)[source]

Returns the list of Cytoscape network names in the current Cytoscape session.

Parameters

  • 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.

  • get_suids (bool) – False returns a list of network names; True returns names and SUIDs

Returns

network names or dictionaries (network name, SUID)

Return type

list

Raises

  • ValueError – if server response has no JSON

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

Examples

>>> get_network_list()
['yeastHighQuality.sif', 'galFiltered.sif']
>>> get_network_list(get_suids=True)
[{"name": 'yeastHighQuality.sif', 'suid':102003}, {"name": 'galFiltered.sif', 'suid':104002}]