Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

zulip: Standardize the names of bindings with OperationIDs. #712

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MSurfer20
Copy link
Member

@MSurfer20 MSurfer20 commented Aug 16, 2021

No description provided.

@MSurfer20
Copy link
Member Author

I have manually audited, and these are all the bindings whose names don't match the operationIDs as defined in zulip.yaml.

@MSurfer20 MSurfer20 changed the title zulip: Deprecate methods whose names don't match with OperationIDs an… zulip: Standardize the names of bindings with OperationIDs. Aug 16, 2021
@timabbott
Copy link
Sponsor Member

zulip/zulip/__init__.py Outdated Show resolved Hide resolved
zulip/zulip/__init__.py Outdated Show resolved Hide resolved
Some bindings had names that differed from the names that
were used in the OperationID. This commit deprecates the
older names, and changes the names of the bindings to
match operationIDs.
@timabbott
Copy link
Sponsor Member

This looks great; rebasing to get CI to run in case the new automated tests of the server implementation fail with the new deprecation warning logging output. I think we need to do one thing before merging:

  • Update the example scripts in zulip/zulip/examples to use the new functions, and potentially rename several of the example scripts accordingly.
  • Do git grep within this project to make sure that we don't have any calls to the now deprecated methods that need to be updated.

Once that happens, we can merge this and our TODO to finish this cleanup process will be:

  • Do a new release, which could be 0.9.0. @eeshangarg FYI -- if @MSurfer20 can do the renames above this weekend, we could potentially do that release early next week to also fix zulip 0.8.1 release on PyPI is missing py.typed #732.
  • Update zulip/zulip to use the new release.
  • Do a timely update of the zulip/zulip API documentation to use the non-deprecated method names.
  • File an issue with zulip-terminal to do the same update.

@MSurfer20 can you let @eeshangarg know when you expect to get to the examples/ work? If it'll be a while, then we might want to just do a 0.8.2 release to fix #732 without waiting for this.

@zulipbot
Copy link
Member

Heads up @MSurfer20, we just merged some commits that conflict with the changes your made in this pull request! You can review this repository's recent commits to see where the conflicts occur. Please rebase your feature branch against the upstream/main branch and resolve your pull request's merge conflicts accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants