Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAINT: remove support for meta children and 2d pandas #1143

Merged
merged 19 commits into from
Oct 6, 2023

Conversation

jklenzing
Copy link
Member

@jklenzing jklenzing commented Oct 3, 2023

Description

Addresses #789 and #913

Removes the support for storing pandas DataFrames within other DataFrames, including

  • the pysat_testing2d instrument
  • children in Meta objects

Type of change

  • Breaking change (fix or feature that would cause existing functionality
    to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Tested against other pysat packages (ran vs this branch and pysat develop to see if new errors occur)

  • pysatCDAAC -- passes
  • pysatMadrigal -- no new errors vs develop
  • pysatMissions -- passes
  • pysatModels -- no new errors vs develop
  • pysatNASA -- no new errors vs develop
  • pysatSeasons -- passes with changes at MAINT: pysat deprecations pysatSeasons#40
  • pysatSpaceWeather -- no new errors vs develop

Test Configuration:

  • Operating system: Monterrey
  • Version number: Python 3.10.9

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to CHANGELOG.md, summarizing the changes

If this is a release PR, replace the first item of the above checklist with the release
checklist on the wiki: https://github.com/pysat/pysat/wiki/Checklist-for-Release

@jklenzing jklenzing marked this pull request as ready for review October 4, 2023 16:24
Copy link
Member

@aburrell aburrell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some feedback as an intermediate review.

pysat/_meta.py Show resolved Hide resolved
pysat/tests/test_meta.py Outdated Show resolved Hide resolved
Copy link
Member

@aburrell aburrell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_meta.py lines 401 and 442 are newly uncovered, recommend adding an instance where meta is setting bytes instead of a string.

Also have a new uncovered line in io.py on line 1615 that could be addressed with a test for inst_to_netcdf that has a DataFrame of DataFrames to trip the ValueError.

pysat/tests/test_meta.py Outdated Show resolved Hide resolved
Co-authored-by: Angeline Burrell <aburrell@users.noreply.github.com>
@jklenzing
Copy link
Member Author

_meta.py lines 401 and 442 are newly uncovered, recommend adding an instance where meta is setting bytes instead of a string.

Not sure why these show up as newly uncovered. Neither are covered in develop according to coveralls.

@jklenzing
Copy link
Member Author

Also have a new uncovered line in io.py on line 1615 that could be addressed with a test for inst_to_netcdf that has a DataFrame of DataFrames to trip the ValueError.

Looking at this one, other errors get tripped before we get here since this format is not allowed. I think we can delete this line.

Copy link
Collaborator

@JonathonMSmith JonathonMSmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are more lines uncovered that haven't been discussed, but I can't think of straightforward ways to test them

@aburrell
Copy link
Member

aburrell commented Oct 6, 2023

@JonathonMSmith yeah, there are a few things that could be done, but since there aren't new uncovered lines, I think that's best addressed in another branch.

@jklenzing jklenzing merged commit 1c0662e into develop Oct 6, 2023
15 of 17 checks passed
@jklenzing jklenzing deleted the maint/789_913_meta_children branch October 6, 2023 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DEP: Remove 2D pandas support Remove support for children in Meta
3 participants