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

Refactor camelCase to lowercase_underscored? #19

Open
kshepherd opened this issue Jun 11, 2024 · 2 comments
Open

Refactor camelCase to lowercase_underscored? #19

kshepherd opened this issue Jun 11, 2024 · 2 comments
Assignees
Labels
help wanted Extra attention is needed

Comments

@kshepherd
Copy link
Collaborator

kshepherd commented Jun 11, 2024

I used camelCase to more closely mirror the REST API JSON, but it's generally not considered good/proper Python naming convention, and it should be possible to parse/format to and from each anyway...

So I think we should change all our camelCase class member variable names, e.g. shortDescription -> short_description in the Python objects themselves... then, what about the dict? Or do we just rewrite the dict back to camelCase just before doing a POST or PUT?

(I'm not convinced it's worth it, so leaving this issue open for input from others - it would be a breaking change for a major release in the future)

@kshepherd kshepherd added the help wanted Extra attention is needed label Jun 11, 2024
@kshepherd kshepherd self-assigned this Jun 11, 2024
@dpk
Copy link
Contributor

dpk commented Dec 19, 2024

Grep \b[a-z]+[A-Z] to find instances of this. Mostly in strings which are required for us by the API, but also some in object property names.

@dpk
Copy link
Contributor

dpk commented Dec 19, 2024

The inflection library would be one way to do this. It looks still maintained, although I'm kind of meh on the idea of adding an extra dependency for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants