Add dtypes to `HipscatEncoder`

troyraen commented 1 month ago

Needed for astronomy-commons/hipscat-import#316

Change Description

Adds functionality to convert relevant types to strings for json serialization.

astronomy-commons/hipscat-import#316 updates the file readers to return provenance info that includes all class attributes. It picks up attributes that were not previously being captured and results in some tests failing when the values cannot be json serialized. As far as I can tell, the best place to handle this is here, in hipscat.io.write_metadata.HipscatEncoder.

[x] My PR includes a link to the issue that I am addressing

Code Quality

[x] I have read the Contribution Guide
[x] My code follows the code style of this project
[ ] My code builds (or compiles) cleanly without any errors or warnings
[ ] My code contains relevant comments and necessary documentation

New Feature Checklist

[ ] I have added or updated the docstrings associated with my feature using the NumPy docstring format
[ ] I have updated the tutorial to highlight my new feature (if appropriate)
[ ] I have added unit/End-to-End (E2E) test cases to cover my new feature
[ ] My change includes a breaking change
- [ ] My change includes backwards compatibility and deprecation warnings (if possible)

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.20%. Comparing base (9d7dfdd) to head (bed065a).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #274 +/- ## ======================================= Coverage 94.19% 94.20% ======================================= Files 56 56 Lines 1965 1967 +2 ======================================= + Hits 1851 1853 +2 Misses 114 114 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

github-actions[bot] commented 1 month ago

Before [9d7dfddc] <v0.3.2>	After [b59da99a]	Ratio	Benchmark (Parameter)
80.7±0.7ms	82.8±1ms	1.03	benchmarks.MetadataSuite.time_load_partition_join_info
21.7±0.5ms	22.1±0.6ms	1.02	benchmarks.MetadataSuite.time_load_partition_info_order6
48.2±2ms	48.8±2ms	1.01	benchmarks.Suite.time_pixel_tree_creation
80.6±0.5ms	80.3±0.4ms	1	benchmarks.MetadataSuite.time_load_partition_info_order7
383±2ms	376±3ms	0.98	benchmarks.Suite.time_outer_pixel_alignment
128±0.5ms	125±0.8ms	0.98	benchmarks.time_test_alignment_even_sky
16.0±0.7ms	15.5±0.1ms	0.97	benchmarks.time_test_cone_filter_multiple_order
14.8±0.2ms	14.2±0.2ms	0.96	benchmarks.Suite.time_inner_pixel_alignment
87.9±3ms	81.7±3ms	0.93	benchmarks.Suite.time_paths_creation

Click here to view all benchmarks.

astronomy-commons / hipscat