Skip to content

Conversation

@gpauloski
Copy link
Collaborator

Description

Add warning to Store docstring about serialization. v0.7.1 made the Store explicitly non-pickleable because of the locks. My preference right now is to keep it this way since we provide the StoreConfig and registration tools for recreating a Store in another process. Inadvertently pickling the Store could result in users not being aware that they are not reusing the same instance within a process.

Fixes N/A

Type of Change

  • Breaking Change (fix or enhancement which changes existing semantics of the public interface)
  • Enhancement (new features or improvements to existing functionality)
  • Bug (fixes for a bug or issue)
  • Internal (refactoring, style changes, testing, optimizations)
  • Documentation update (changes to documentation or examples)
  • Package (dependencies, versions, package metadata)
  • Development (CI workflows, pre-commit, linters, templates)
  • Security (security related changes)

Testing

N/A

Pull Request Checklist

Please confirm the PR meets the following requirements.

  • Tags added to PR (e.g., breaking, bug, enhancement, internal, documentation, package, development, security).
  • Code changes pass pre-commit (e.g., mypy, ruff, etc.).
  • Tests have been added to show the fix is effective or that the new feature works.
  • New and existing unit tests pass locally with the changes.
  • Docs have been updated and reviewed if relevant.

@gpauloski gpauloski added the documentation Improvements or additions to documentation or examples label Sep 11, 2024
@gpauloski gpauloski merged commit ed8fb18 into main Sep 11, 2024
@gpauloski gpauloski deleted the store-serialization branch September 11, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation or examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants