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

Warn about and discourage the use of pickle to save objects #942

Merged
merged 1 commit into from
Sep 9, 2024

Conversation

spjuhel
Copy link
Collaborator

@spjuhel spjuhel commented Aug 22, 2024

Changes proposed in this PR:

  • Warns and discourages users to use pickle for any long term saving in tutorial/documentation.
  • Adds a short section in Best Practice explaining the cons of using pickle.

Climada offers the possibility to use pickle to save most objects. Yet, this format is dependent on the python environment used when saving any object and thus offer very limited portability.

This is tied to SCRUM task 149 and User Story 148 (Improve saving conventions for Climada objects)

PR Author Checklist

PR Reviewer Checklist

@spjuhel spjuhel changed the title Warn about and discourage the usage of pickle to save objects Warn about and discourage the use of pickle to save objects Aug 28, 2024
@emanuel-schmid
Copy link
Collaborator

🤩 Very good. Real cool link definition (transient format)[saving-with-pickle)

@emanuel-schmid emanuel-schmid merged commit 5f092ab into develop Sep 9, 2024
18 checks passed
@spjuhel
Copy link
Collaborator Author

spjuhel commented Sep 10, 2024

🤩 Very good. Real cool link definition (transient format)[saving-with-pickle)

You have to thank @peanutfun for this nice format!

@emanuel-schmid emanuel-schmid deleted the feature/discourage-pickle-usage branch October 3, 2024 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants