search

entropy-lab / entropy

BSD 3-Clause "New" or "Revised" License
30 stars 13 forks source link

Migrating ParamStore JSON file to v0.2 (where values are wrapped by Param instances) #246 #247

Closed urig closed 2 years ago

urig commented 2 years ago

This PR supersedes PR https://github.com/entropy-lab/entropy/pull/233

A previous PR (https://github.com/entropy-lab/entropy/pull/227) augmented the InProcessParamStore implementation to wrap values in instances of the Param class. This was done to enable adding bits of metadata to ParamStore values in the future. This change, however, is a breaking change in that ParamStore JSON files stored using the previous method can no longer be read by the new code.

This PR gives Entropy users a tool to automatically upgrade older ParamStore JSON files to the new format supporting Param instances. When users instantiate a new SqlAlchemy instance on an existing project they are stopped with a message asking them to upgrade.

Users can then upgrade their ParamStore JSON files by running the entropy upgrade <project dir path> CLI command. The command assumes the JSON file is present at its default location in <project dir path>/.entropy/params.json.

github-actions[bot] commented 2 years ago

Unit Test Results

    1 files      1 suites   55s :stopwatch: 220 tests 216 :heavy_check_mark: 4 :zzz: 0 :x:

Results for commit 00a0750b.

:recycle: This comment has been updated with latest results.