Skip to content

Conversation

@gpauloski
Copy link
Collaborator

Description

Adds the register flag to auto-register a Store after initialization. The default is False to remain backwards compatible, but the docs have been update to suggest use of the flag over register_store.

Per #547, I considered make Store a singleton when register=True but decided against it the singleton constructor would thrown away initialized Connector instances without closing them properly.

Fixes

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

Added new unit tests.

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 enhancement New features or improvements to existing functionality label Apr 23, 2024
@gpauloski gpauloski merged commit 7483f4c into main Apr 23, 2024
@gpauloski gpauloski deleted the issue-547 branch April 23, 2024 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New features or improvements to existing functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add register flag for Store instantiation

2 participants