py4cytoscape.filters.export_filters

export_filters(filename='filters.json', base_url='http://127.0.0.1:1234/v1', *, overwrite_file=True)[source]

Saves filters to file in JSON format.

Parameters

  • filename (str) – Full path or path relative to current working directory, in addition to the name of the file. Default is “filters.json”.

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

  • overwrite_file (bool) – False allows an error to be generated if the file already exists; True allows Cytoscape to overwrite it without asking

Returns

[]

Return type

list

Raises

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

Examples

>>> export_filters() # Saves all filters in file 'filters.json'
[]
>>> export_filters('test.json') # Saves all filters in file 'test.json'
[]
>>> export_filters('test') # Saves all filters in file 'test.json'
[]
>>> export_filters('test', overwrite_file=False) # Save filters only if test.json doesn't already exist
[]