Skip to content

Conversation

@MaxTueckeGlobus
Copy link
Contributor

@MaxTueckeGlobus MaxTueckeGlobus commented May 9, 2025

sc-26346

Changes

  • All base_path declarations have been removed from all client classes.
  • All methods on a client class that call an API for the corresponding service have been updated to include the base path explicitly in their path string.

Reviewer notes:

  • Much of the test suite broke when removing base_path since many tests were not including the base_path for a service when creating a RegisteredResponse. Rather than update each individual test, I chose to update RegisteredResponse to always add a particular services base_path to the path if it was not included.
  • To preserve the previous behavior of BaseClient, BaseClient.base_url will always have a trailing slash added if needed.

📚 Documentation preview 📚: https://globus-sdk-python--1185.org.readthedocs.build/en/1185/

Copy link
Member

@sirosen sirosen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a couple of minor adjustments I'd like to make. One is definitely debatable (trailing slash). Overall, excited for getting this into v4!

@sirosen
Copy link
Member

sirosen commented May 12, 2025

The updated changes look good, but we need a changelog for this.
Since it's going into v4, I'd phrase this as a "removed" item. e.g.,

Removed
~~~~~~~

- SDK clients no longer define a ``base_path`` attribute which they prefix to paths.
  Make sure to use the full path when using client methods. (:pr:`1185`)

@MaxTueckeGlobus
Copy link
Contributor Author

The updated changes look good, but we need a changelog for this. Since it's going into v4, I'd phrase this as a "removed" item. e.g.,

Do we want to have some special naming convention for the v4 changelogs / update the workflow to check for new changelogs against the correct branch?

@sirosen
Copy link
Member

sirosen commented May 12, 2025

I don't think we need any special naming for the changelog files or contents -- by being in the 4.x-dev branch they'll be isolated from any changes made in 3.x/main.

We should fix the changelog checking workflow, but I don't think it's a blocker right now.

Copy link
Member

@kurtmckee kurtmckee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I left feedback regarding the changelog fragment phrasing but approve of the changes already here.

As noted in a comment, I don't think that more work needs to be done in this particular PR, which is well-targeted and sized.

Copy link
Member

@sirosen sirosen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with this, but recommend resolving the changelog thread before merging -- I think we could also merge and fix the changelog in follow-up, potentially along with an upgrading doc section.

@MaxTueckeGlobus MaxTueckeGlobus merged commit 45b6909 into 4.x-dev May 13, 2025
7 checks passed
@MaxTueckeGlobus MaxTueckeGlobus deleted the sc-26346-remove-base-path-from-clients branch May 13, 2025 16:01
@sirosen sirosen mentioned this pull request Oct 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants