Feature / Columnar Data helper function

[nitbharambe]

Implements #786

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
83.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[nitbharambe]

Issue with type hinting:

initialize_array now gives out row based data, hence the type is np.ndarray.
When we assign like how it is done in example, node["id"] = [1,2,3], we expect to use assignment of attribute within the array.

If we are to implement this feature, the return type is np.ndarray | dict[str, np.ndarray].
If user tries to do the same assignment in case of the columnar data, ie. when node is dict[str, np.ndarray], the [] operator refers to dictionary and thus a numpy array gets replaced with a list. Hence, this correctly gives out error with mypy.

Thus this helper function might end up confusing the user. If the user does the assigning / creation etc themselves via power_grid_meta_data, such operations might be more clear to them.

[nitbharambe]

Closed because of this reason. attribute_dtype and Attribute_empty implemented in #786

Issue with type hinting:

initialize_array now gives out row based data, hence the type is np.ndarray. When we assign like how it is done in example, node["id"] = [1,2,3], we expect to use assignment of attribute within the array.

If we are to implement this feature, the return type is np.ndarray | dict[str, np.ndarray]. If user tries to do the same assignment in case of the columnar data, ie. when node is dict[str, np.ndarray], the [] operator refers to dictionary and thus a numpy array gets replaced with a list. Hence, this correctly gives out error with mypy.

Thus this helper function might end up confusing the user. If the user does the assigning / creation etc themselves via power_grid_meta_data, such operations might be more clear to them.

[figueroa1395]

@nitbharambe Looks like you have to manually delete the branch due to unmerged commits. Don't forget :)