py4cytoscape.network_views.get_network_view_suid

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

Retrieve the SUID of a network view.

Parameters

  • network (str or SUID or None) – Name or SUID of the network or view. Default is the “current” network active in Cytoscape. If a network view SUID is provided, then it is validated and returned.

  • 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

SUID of the view for the network, or None if no view. The first (presummably only) view associated a network is returned.

Return type

int or None

Raises

  • CyError – if network or view doesn’t exist

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

Examples

>>> get_network_view_suid()
130223
>>> get_network_view_suid(51)
130223
>>> get_network_view_suid(network='galFiltered.sif')
130223
Dev Notes:

analogous to getNetworkSuid, this function attempts to handle all of the multiple ways we support network view referencing (e.g., title, SUID, ‘current’, and NULL). These functions are then used by functions that take a “network” argument and requires a view SUID.