Add annotation for endpoints to indicate minimum supported API version #124
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
t8y8
commented
Jan 6, 2017
| '''Annotate the minimum supported version for an endpoint. | ||
| Checks the version on the server object and does a float comparison. | ||
| It will raise an exception if the server vesion is > the version specified. |
Collaborator
Author
There was a problem hiding this comment.
'vesion' -> 'version' typo
graysonarts
suggested changes
Jan 6, 2017
| @wraps(func) | ||
| def wrapper(self, *args, **kwargs): | ||
| server_version = self.parent_srv.version | ||
| if float(server_version) < version: |
Contributor
There was a problem hiding this comment.
Please use https://docs.python.org/3.6/distutils/apiref.html#module-distutils.version to compare version numbers. Casting to float will break if/when we decide to be more nuanced with your version numbers.
| @@ -1,4 +1,4 @@ | |||
| from .endpoint import Endpoint | |||
| from .endpoint import Endpoint, api | |||
Contributor
There was a problem hiding this comment.
Do you actually use api anywhere?
Collaborator
Author
There was a problem hiding this comment.
oops, this was left over from my manual test script
t8y8
force-pushed
the
55-feature-api-decorator
branch
from
245f88e to
87d0686
Compare
bryceglarsen
pushed a commit
to bryceglarsen/server-client-python
that referenced
this pull request
Dec 28, 2023
* Fix tableau#117 by only attempting files with the right extension inside the archive (tableau#118) * Commenting and Docstring cleanup. A few very small code cleanups (tableau#120) Add docstrings and remove clutter. I also made some very tiny tweaks to some code for clarity. * Small cleanups for various editors. Play nice with built in test-runners (tableau#121) * Add Py36, update travis to use pycodestyle (tableau#124) * Add `initial sql` and `query band` support (tableau#123) Addresses tableau#109 and tableau#110 * Prep for release of 0.6 (tableau#125) * Prep for release of 0.6 * wordsmithing the changelog
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Addresses #55
This is just the decorator, I manually tested with the
users.getendpoint and a script.Once we add the annotation to the actual endpoints this will get automagically covered by all existing tests. I can make a unittest that mocks everything to test this method, but that doesn't feel super useful (It'd literally be testing does
<work).I think I'd like to break it into two PRs, add this method first, and in the second PR add the annotations and and ensure existing tests still pass
Open to feedback on the exception name and where I put this method -- but endpoint felt like the most natural place for it
/cc @RussTheAerialist @LGraber