Skip to content

Conversation

@gpauloski
Copy link
Collaborator

Description

Previously, populate_target defaulted to False in the Store. This changes the default to True, meaning that all proxies created by a Store will already be resolved. This will reduce unnecessary resolves of a proxy within the same process that created the proxy.

I consider this a breaking change because any code that assumed a created proxy was not resolved will break. However, this is certainly an edge case (and most likely only prevalent in tests) so I don't expect this to impact most users. If anything, it will remove an unnecessary resolve leading to slightly better performance.

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

Updated tests which expected a certain setting of populate_target.

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.

Previously, populate_target defaulted to False in the Store. This
changes the default to True, meaning that all proxies created by a Store
will already be resolved. This will reduce unnecessary resolves of a
proxy within the same process that created the proxy.
@gpauloski gpauloski added the breaking Backwards incompatible change to public interfaces label Jun 12, 2024
@gpauloski gpauloski merged commit f2d30bc into main Jun 12, 2024
@gpauloski gpauloski deleted the issue-557 branch June 12, 2024 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking Backwards incompatible change to public interfaces

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make populate_target=True the default in Store

2 participants