This repository was archived by the owner on Apr 2, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
Convert backends from Protocol classes to sets of Callables #132
Merged
philvarner
merged 14 commits into
stapi-spec:main
from
pjhartzell:pjh/convert-backend-protocols-to-callables
Feb 4, 2025
Merged
Convert backends from Protocol classes to sets of Callables #132
philvarner
merged 14 commits into
stapi-spec:main
from
pjhartzell:pjh/convert-backend-protocols-to-callables
Feb 4, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change is in preparation for making product opportunity
searching and ordering optional and for introducing optional
asynchronous opportunity searching (which will require state).
A few notable changes to the test suite:
- The `backends` module has been removed from the `tests` directory.
Its contents were never actually being used. The contents in
`conftest` took precedence.
- The in-memory storage that was attached to the MockProductBackend
class is replaced with a FastAPI lifespan for storing state.
pjhartzell
commented
Jan 27, 2025
philvarner
reviewed
Jan 27, 2025
philvarner
reviewed
Jan 27, 2025
Contributor
|
Looks good, only a couple of doc fixes suggested. |
philvarner
approved these changes
Jan 27, 2025
jkeifer
reviewed
Jan 27, 2025
jkeifer
reviewed
Jan 27, 2025
jkeifer
reviewed
Jan 27, 2025
jkeifer
approved these changes
Jan 27, 2025
jkeifer
reviewed
Jan 27, 2025
jkeifer
reviewed
Jan 27, 2025
cc170f5 to
7a97081
Compare
7a97081 to
a9a7502
Compare
24f753a to
b34f8d9
Compare
b34f8d9 to
48e077b
Compare
48e077b to
833b871
Compare
833b871 to
7d03976
Compare
7d03976 to
f013ef3
Compare
61d6257 to
92bfb3f
Compare
philvarner
approved these changes
Feb 4, 2025
3 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR replaces the backend Protocol classes with Callable type aliases. The
Productmodel class and theRootRouterrouter class constructors now accept functions matching the newly defined Callable type aliases rather than the backend Protocol classes. This will enable (not in this PR) making these Callable constructor arguments optional, which will then allow product opportunity searching or product ordering to be disabled or enabled based on the presence/non-presence of constructor arguments. Similarly, this will also open the door to optional asynchronous (stateful) opportunity searching.A notable changes to the test suite:
MockProductBackendclass is replaced with a FastAPI lifespan for storing state. This was necessary since backends are no longer classes that arbitrary attributes can be attached to.Related Issue(s):
opportunitiesresource search to operate asynchronously stapi-spec#77Proposed Changes:
PR Checklist: