馃敭 Generated Objects classes using JSON schemas from speckle-sharp #1
Conversation
This file contains 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
just geometry classes for now TODO: consolidation after generating the classes. this is the raw generation which creates duplicates as it defines all required classes in the same file
there is loads of repetition since a whole class and it's references are defined in the same file. need to figure out a way to get them to generate with references. just uploading this for now so it is visible for ppl to check out
izzylys
changed the title
izzylys
added
documentation
iainsproat
pushed a commit
that referenced
this pull request
Aug 9, 2022
Moved relevant files to .github/ folder
|
is this for #237? the issue is much newer though. |
|
Well... @majidaldo it is definitely related, but this draft is so old that we may have to start from scratch the whole idea. I remember there were some not so nice conclusions Izzy reached when doing this, that made it not a very good candidate overall. #237 is more on the lines of creating some tests that will let us know when objects from one language cannot be deserialised in another, which would still be needed even if we generated all code from a "single source of truth". But good catch! I hadn't linked to this PR on my issue, thx! |
|
Yup, I'm closing this and we'll rethink when we get there. |
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.
This is super duper wip, but I'm making a PR as a discussion point.
Schemas for objects should be generated rather than hand crafted as the development effort required to keep them in step with speckle-sharp and any future kits we'd want to support would be a bit ridiculous. One option would be to generate JSON schemas from speckle-sharp/objects and then use these here in speckle-py (and wherever else we need them).
As an initial experiment, JSON schemas were generated from sharp/objects using Newtonsoft and the classes were generated here with pydantic's datamodel codegen. Minimal customisations were used to get the results shown here.
The classes here are stupid simple and references were all generated in the same file which obv we would want to change, but I didn't get into the weeds with how to do this. I wanted to put them up though to show something tangible and start a discussion.
Pinging @tsvilans as we were chatting about this previously!