v3.4.2

[3.4.2]

This version fixes the saving and loading of insertions parquet tables for offline processing.

Fixed

• the insertions table have the minimal meta-data to allow reloading after a cache dump

v3.4.1

[3.4.1]

This version fixes issues with corrupt REST cache and REST validation errors.

Modified

• corrupt REST cache files are deleted and re-fetched
• warning insteda of error when REST query param not in field names

v3.4.0

[3.4.0]

This version supports OpenAPI v3 REST endpoint documentation.

Modified

• support for updated Alyx /docs endpoint
• ONE API version now included in REST request header
• warning instead of error when no default revision found

Added

• ONE_REVISION_LAST_BEFORE environment variable may be set instead of passing revision args

v3.3.0

[3.3.0]

This version makes some performance improvements and supports local mode eid2pid/pid2eid.

Modified

• cache ALFPath properties
• improvements to OneAlyx.get_details performance
• update cache tables with calls to OneAlyx.eid2pid, pid2eid, eid2path, path2eid, get_details
• OneAlyx.eid2pid and pid2eid support local mode queries so long as the insertions table exists

Added

• AlyxClient.rest_cache_dir property allows users to change location of REST response cache

v3.2.1

[3.2.1]

Modified

• improved test coverage

v3.2.0

[3.2.0]

This version adds session part properties to the ALFPath class and turns off save on delete by default.

Added

• session part properties in one.alf.path.PureALFPath (lab, subject, date, sequence, collection, revision)
• with_* methods in one.alf.path.PureALFPath for replacing session parts

Modified

• by default, cache tables are not saved when One.__del__ is called

v3.1.1

[3.1.1]

This version fixes issues with saving cache files.

Modified

• HOTFIX: fixes TypeError: set is not JSON serializable in One.save_cache

v3.1.0

[3.1.0]

This version fixes issues with loading the local cache files built from remote queries.

Added

• one.alf.cache.default_cache function to generate initial cache Bunch with default tables

Modified

• bugfix: no longer skips cache tables built from remote queries during load
• one.alf.cache.merge_tables handles immutable arrays by making a copy when required
• better tracking of cache table data origins
• OneAlyx.eid2pid now supports Django filter args for e.g. reducing by probe name

v3.0.0

[3.0.0]

This version drops support for python 3.9 and below, and ONE is now in remote mode by default.
Also adds a new ALFPath class to replace alf path functions and now returns UUID objects instead of str.

Modified

• supports python >= 3.10 only
• OneAlyx uses remote mode by default, instead of auto
• OneAlyx.search now updates the cache tables in remote mode as paginated sessions are accessed
• datasets table file_size column nullable by default
• one.alf.io.save_metadata now returns the saved filepath
• paths returned by One methods and functions in one.alf.io are now ALFPath instances
• bugfix: one.alf.path.full_path_parts didn't always raise when invalid path passed
• one.alf.path module containing ALFPath class
• ALF cache table generation has lower memory footprint
• setup in silent mode now uses defaults if base url matches default one
• bugfix: error downloading from http server with keep_uuids=True
• one.alf.spec.readableALF and one.alf.spec._dromedary preserve plural acronyms, e.g. 'ROIs'
• UUID objects returned by to_eid, search, and search_insertions instead of str
• LazyId objects now handled correctly by One converter methods
• LazyId object only returned when greater than 1 page of results
• OneAlyx.search_insertions now updates local cache with query results
• bugfix: OneAlyx.list_datasets behaves the same as One.list_datasets w.r.t. revisions and default datasets
• default REST cache expiry reduced from 24 hours to 5 minutes
• One._update_cache_from_records -> one.alf.cache.merge_tables
• One.save_cache now updates any tables on disk unless clobber is True
• one.util.patch_cache -> one.alf.cache.patch_tables
• One object will save modified tables to disk upon delete
• bugfix: ONE_HTTP_DL_THREADS environment variable now works as intended

Added

• one.alf.cache.remove_table_files and One._remove_table_files for deleting cache table files
• one.alf.cache.EMPTY_DATASETS_FRAME and EMPTY_SESSION_FRAME vars for table column, index, and dtype template
• pyproject.toml replaces deprecated setup file
• one.alf.exceptions.InvalidALF exception
• one.params.delete_params
• One._search_insertions for offline query of insertions when cache table present
• one.alf.cache.load_tables function to load cache table files with correct index, etc.

Removed

• setup.py
• one.alf.files; use one.alf.path instead
• one.alf.io.remove_uuid_file
• one.alf.io.remove_uuid_recursive
• one.util.ensure_list; use iblutil.util.ensure_list instead
• one.remote.globus.create_globus_client; use one.remote.globus.Globus class instead
• 'auto' and 'refresh' cache modes have been removed
• One.refresh_cache
• dataset parameter removed from One.search. Use datasets instead.

v3.0 beta

[3.0β]

Important

This is a pre-release and may not be stable

This version drops support for python 3.9 and below, and ONE is now in remote mode by default.
Also adds a new ALFPath class to replace alf path functions and now returns UUID objects instead of str.

Modified

• supports python >= 3.10 only
• OneAlyx uses remote mode by default, instead of auto
• OneAlyx.search now updates the cache tables in remote mode as paginated sessions are accessed
• datasets table file_size column nullable by default
• one.alf.io.save_metadata now returns the saved filepath
• paths returned by One methods and functions in one.alf.io are now ALFPath instances
• bugfix: one.alf.path.full_path_parts didn't always raise when invalid path passed
• one.alf.path module containing ALFPath class
• ALF cache table generation has lower memory footprint
• setup in silent mode now uses defaults if base url matches default one
• bugfix: error downloading from http server with keep_uuids=True
• one.alf.spec.readableALF and one.alf.spec._dromedary preserve plural acronyms, e.g. 'ROIs'
• UUID objects returned by to_eid, search, and search_insertions instead of str
• LazyId objects now handled correctly by One converter methods
• LazyId object only returned when greater than 1 page of results
• OneAlyx.search_insertions now updates local cache with query results
• bugfix: OneAlyx.list_datasets behaves the same as One.list_datasets w.r.t. revisions and default datasets
• default REST cache expiry reduced from 24 hours to 5 minutes

Added

• one.alf.cache.remove_cache_table_files and One._remove_cache_table_files for deleting cache table files
• one.alf.cache.EMPTY_DATASETS_FRAME and EMPTY_SESSION_FRAME vars for table column, index, and dtype template
• pyproject.toml replaces deprecated setup file
• one.alf.exceptions.InvalidALF exception
• one.params.delete_params
• One._search_insertions for offline query of insertions when cache table present

Removed

• setup.py
• one.alf.files; use one.alf.path instead
• one.alf.io.remove_uuid_file
• one.alf.io.remove_uuid_recursive
• one.util.ensure_list; use iblutil.util.ensure_list instead
• one.remote.globus.create_globus_client; use one.remote.globus.Globus class instead