Improvements to schema and enum naming #31
Merged
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
dbanty
requested changes
Apr 15, 2020
Comment on lines
+169
to
+180
| if "properties" in d: | ||
| for key, value in d["properties"].items(): | ||
| required = key in required_set | ||
| p = property_from_dict(name=key, required=required, data=value) | ||
| if required: | ||
| required_properties.append(p) | ||
| else: | ||
| optional_properties.append(p) | ||
| if isinstance(p, (ReferenceListProperty, EnumListProperty, RefProperty, EnumProperty)) and p.reference: | ||
| # don't add an import for self-referencing schemas | ||
| if p.reference.class_name != ref.class_name: | ||
| relative_imports.add(import_string_from_reference(p.reference)) |
There was a problem hiding this comment.
Just a personal preference, I try to avoid multiple layers as much as possible. Something about "cognitive complexity" I read in a book 🧠🤓. Feel free to disagree and leave as is.
Suggested change
| if "properties" in d: | |
| for key, value in d["properties"].items(): | |
| required = key in required_set | |
| p = property_from_dict(name=key, required=required, data=value) | |
| if required: | |
| required_properties.append(p) | |
| else: | |
| optional_properties.append(p) | |
| if isinstance(p, (ReferenceListProperty, EnumListProperty, RefProperty, EnumProperty)) and p.reference: | |
| # don't add an import for self-referencing schemas | |
| if p.reference.class_name != ref.class_name: | |
| relative_imports.add(import_string_from_reference(p.reference)) | |
| for key, value in d.get("properties", {}).items(): | |
| required = key in required_set | |
| p = property_from_dict(name=key, required=required, data=value) | |
| if required: | |
| required_properties.append(p) | |
| else: | |
| optional_properties.append(p) | |
| if ( | |
| isinstance(p, (ReferenceListProperty, EnumListProperty, RefProperty, EnumProperty)) | |
| and p.reference | |
| and p.reference.class_name != ref.class_name # don't add an import for self-referencing schemas | |
| ): | |
| relative_imports.add(import_string_from_reference(p.reference)) |
|
|
||
| if class_name in class_overrides: | ||
| return class_overrides[class_name] | ||
|
|
||
| return Reference(class_name=class_name, module_name=stringcase.snakecase(ref_value),) | ||
| return Reference(class_name=class_name, module_name=stringcase.snakecase(class_name),) |
There was a problem hiding this comment.
This will conflict with #29 most likely, so whichever one gets merged first will trigger an update in the other. Just to be aware.
Comment on lines
-280
to
+284
| models_dir.__truediv__.side_effect = lambda x: module_paths[x] | ||
|
|
||
| def models_dir_get(x): | ||
| return module_paths[x] | ||
|
|
||
| models_dir.__truediv__.side_effect = models_dir_get |
There was a problem hiding this comment.
I assume this change was because it was difficult to read. Maybe I should be using itemgetter for this, would that be better / more Pythonic you think?
Pretty sure I do this in several tests.
Codecov Report
@@ Coverage Diff @@
## master #31 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 8 9 +1
Lines 532 573 +41
=========================================
+ Hits 532 573 +41
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
name schemas using the declaring property name if no
"title"property is available. Currently the generator breaks when processing cases such as :This will use
CoolFunModelas the schema name in these cases.Conversely, for enum properties, if a
titleproperty is available in the property schema then ths this is used to name the enum. This also addresses Allow defining Enums ahead of time #21 - in the case where repeated property enums are derived from a single enum in a typed language (e.g. Java), if they have the sametitlethey will be merged back into a single Python enum in the client.