py4cytoscape.commands.command_echo

command_echo(variable_name='*', base_url='http://127.0.0.1:1234/v1')[source]

Command Echo.

The echo command will display the value of the variable specified by the variableName argument, or all variables if variableName is not provided.

Parameters

  • variable_name (str) – The name of the variable to display. Default is to display all variable values using “*”.

  • 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

a list containing as single string containing the variable_name value

Return type

list

Raises

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

Examples

>>> command_echo('Hi there')
['Hi there']
>>> command_echo()
['*']