DEVEXP-766: Refactor Numbers domain as expected generated structure #51
Conversation
Signed-off-by: Jessica Matsuoka <jessica.akemi.matsuoka@sinch.com>
matsk-sinch
requested review from
Dovchik,
krogers0607,
asein-sinch and
JPPortier
as code owners
| from sinch.domains.numbers.models.numbers import ( | ||
| CapabilityTypeValuesList, NumberTypeValues, NumberSearchPatternTypeValues, OrderByValues, ActiveNumber | ||
| ) | ||
| from sinch.domains.numbers.models.v1.active_number import ActiveNumber |
There was a problem hiding this comment.
Do you think it would be worth to import all the public models from a single place?
There was a problem hiding this comment.
Yes. As discussed, the public shared models were moved to shared_params.
Note that I had to import some nested models using their full path to avoid circular import issues.
There was a problem hiding this comment.
As discussed, the pydantic models for the list responses aren't exposed and can be moved the the "internal" package
There was a problem hiding this comment.
Are the "_endpoint" could be stored within the "internal" location ?
There was a problem hiding this comment.
The naming convention for private files / attributes in Python uses a leading score (e.g., _utils.py). However, unlike Java, Python does not enforce privacy.
In this case here, we chose to use the internal/ directory as a way to organize what gets generated rather than marking it as private.
I didn't mark *_endpoints.py as public since *_apis.py already serves with public interface. Importing a private class should not (It's a convention, Python won't stop you) be used outside its defining module.
There was a problem hiding this comment.
About the "internal" location (/endpoints directory), is another keyword could be used ? (e.g. /internal, private, ...)
There was a problem hiding this comment.
Done. Moved the files to \internal folder
No description provided.