Create versioned Compute clients #1096
Merged
Conversation
This file contains 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
rjmello
requested review from
aaschaer,
ada-globus,
derek-globus,
kurtmckee,
m1yag1,
MaxTueckeGlobus and
sirosen
as code owners
rjmello
requested review from
ryanchard,
chris-janidlo,
joshbryan-globus,
khk-globus and
LeiGlobus
sirosen
previously requested changes
Oct 31, 2024
rjmello
force-pushed
the
versioned-compute-clients
branch
from
0ad25f6 to
fa05028
Compare
sirosen
force-pushed
the
versioned-compute-clients
branch
from
e0bf9ac to
88c4abf
Compare
khk-globus
approved these changes
Nov 4, 2024
derek-globus
reviewed
Nov 4, 2024
rjmello
force-pushed
the
versioned-compute-clients
branch
from
88c4abf to
b57bcbb
Compare
sirosen
dismissed
their stale review
As I have become a coauthor, recusing myself from review
Created `ComputeClientV2` and `ComputeClientV3` classes to support Globus Compute API versions 2 and 3, respectively. The canonical `ComputeClient` is now a subclass of `ComputeClientV2`, preserving backward compatibility.
When mapping client objects (by name) to directories in the _testing data modules, the current mapping inspects `service_name` and the method name. As a result, it's not possible to have multiple versioned clients with the same service name mapped to different fixture directories. To resolve, we need *some* solution which maps versioned clients to versioned fixtures. This change applies one particular solution, which will work in the near-term for ComputeClientV2 and ComputeClientV3, but may be refined further in the future (so long as the mapping of the V2 client to known fixture data is preserved). Rather than ignoring the possibility of structured information in the name of a client, if it ends with `V<N>` for some integer `N`, we can map this to a fixture dir named, similarly, `v<N>` (lowercased). This allows the V2 and V3 clients to get their own fixture directories. One downside of this approach is that it maps `ComputeClient` (which inherits from the V2 client) differently from `ComputeClientV2`, and there is no step here taken to rectify this. Effectively, this means that `ComputeClient` will get no fixture data, but `ComputeClientV2` will, even for identical usages. Alternative approaches abound -- e.g., we could attach a class-level attribute which declares a "test_fixture_subdir" or "api_version", and use that attribute when present. The current solution was chosen as - generic, in that it does not encode Compute-specific details into a helper buried in `_testing` - easy to implement and reason about (it's just a quick suffix match and string conversion) - easy to change or replace in the future, because it makes no changes to the classes which are fed into this mapping
rjmello
force-pushed
the
versioned-compute-clients
branch
from
b57bcbb to
7d63262
Compare
derek-globus
approved these changes
Nov 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Created
ComputeClientV2andComputeClientV3classes to support Globus Compute API versions 2 and 3, respectively. The canonicalComputeClientis now a subclass ofComputeClientV2, preserving backward compatibility.📚 Documentation preview 📚: https://globus-sdk-python--1096.org.readthedocs.build/en/1096/