Synapse Python Client 2.3.0 Release Candidate Available

[Jordan Kiang]

A release candidate of Synapse Python Client version 2.3.0 is available for preview and testing.

It is available from test.pypi.org and can be installed e.g.

pip3 install --upgrade --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple "synapseclient>=2.3.0"

Highlights

• The index_files_for_migration and migrate_indexed_files functions are added to synapseutils to help migrate files in Synapse projects and folders between AWS S3 buckets in the same region. More details on using these utilities can be found here.

• This version supports login programatically and from the command line using personal access tokens which can be obtained from your synapse.org Settings. Additional documentation on login and be found here.

  # programmatic
  syn = synapseclient.login(authToken=<token>)
  

  # command line
  synapse login -p <token>
  

• The location of the where downloaded entities are cached can be customized to a location other than the user’s home directory. This is useful in environments where writing to a home directory is not appropriate (e.g. an AWS lambda).

  syn = synapseclient.Synapse(cache_root_dir=<directory path>)
  

• A helper method on the Synapse object has been added to enable obtaining the Synapse certification quiz status of a user.

  passed = syn.is_certified(<username or user_id>)
  

• This version has been tested with Python 3.9.

Bug Fixes

• [SYNPY-1039] - tableQuery asDataFrame() results with TYPE_LIST columns should be lists and not literal strings

• [SYNPY-1109] - unparseable synapse cacheMap raises JSONDecodeError

• [SYNPY-1110] - Cleanup on Windows console login

• [SYNPY-1112] - Concurrent migration of entities sharing the same file handle can result in an error

• [SYNPY-1114] - Mitigate new Rust compiler dependency on Linux via transitive cryptography dependency

New Features

• [SYNPY-1058] - Accept oauth access token for authentication to use synapse rest services

• [SYNPY-1103] - Multipart copy integration

• [SYNPY-1111] - Add function to get user certification status

Improvements

• [SYNPY-885] - Public interface to customize CACHE_ROOT_DIR

• [SYNPY-1102] - syncToSynapse adds empty annotation values

• [SYNPY-1104] - Python 3.9 support