Add PEP 8 compliant api, and add deprecation warnings to camel case api methods. #55
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
…n the snake case function variants
…eprecated api feature is used
…em to the regular logger
aphedges
reviewed
Dec 15, 2023
…ones were originally, and moved the camelCase wrappers to the end of the class
MarcCote
approved these changes
Dec 15, 2023
Collaborator
MarcCote
left a comment
MarcCote
left a comment
There was a problem hiding this comment.
That looks good to me. I added others things that can be done to improve the framework (see #54 (comment)).
I think setting up a Github Action to run the (very) few tests we have would be the next step. Along with another that runs flake8 on the Python code.
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.
The camel case python API does not follow PEP 8, and I found it a little tricky to tell between scala and python methods. To fix this, I added new, duplicate methods, that follow (in my opinion) pythonic naming convention. Some of the duplicate methods can be seen below:
I also added a deprecated_api_warning method to utils.py.
I then stuck it in to every camel case method.
Potential follow ups:
Any feedback would be greatly appreciated!