search

SuperDARNCanada / borealis

A control system for USRP based digital radars
GNU General Public License v3.0
13 stars 7 forks source link

Upgrade pydantic dependency #499

Open RemingtonRohel opened 2 months ago

RemingtonRohel commented 2 months ago

Pydantic v2 introduced breaking changes to the API, making it incompatible with the current usage in borealis with the ExperimentSlice class. The new API should be investigated, and borealis migrated to it if it is beneficial due to speed or simplicity.

RemingtonRohel commented 2 months ago

An additional thing we should do if upgrading pydantic is use it for function signatures, to validate inputs to functions. This could greatly simplify error-checking and highlight a swath of bugs that may be lingering in less-used parts of the code. Additionally, the type-hinting could simplify development. PyCharm is very good at giving auto-complete options for attributes of an object, given that it knows the type of the object. I find this to be very useful when developing, particularly if attribute names are sufficiently descriptive. While it would be a large job, it could be beneficial in the long run.

RemingtonRohel commented 2 weeks ago

The develop branch updates the pydantic version dependency to >=2, but still relies on features from pydantic v1. As suchs usage of those features should be reviewed to determine if they are necessary and how they might be migrated to v2.