Skip to content

fix: use Self return type for Model.__from_data__#65

Open
dflorenzano wants to merge 2 commits into
BlockResearchGroup:mainfrom
dflorenzano:fix/model_class_method
Open

fix: use Self return type for Model.__from_data__#65
dflorenzano wants to merge 2 commits into
BlockResearchGroup:mainfrom
dflorenzano:fix/model_class_method

Conversation

@dflorenzano

Copy link
Copy Markdown
  • change return type to use Self in Model.from_data to enable subclasses to retain their type when deserialized.
  • used typing_extensions instead of typing to preserve python 3.9 compatibility.

What type of change is this?

  • Bug fix in a backwards-compatible manner.
  • New feature in a backwards-compatible manner.
  • Breaking change: bug fix or new feature that involve incompatible API changes.
  • Other (e.g. doc update, configuration, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
  • I ran all tests on my computer and it's all green (i.e. invoke test).
  • I ran lint on my computer and there are no errors (i.e. invoke lint).
  • I added new functions/classes and made them available on a second-level import, e.g. compas.datastructures.Mesh.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

@tomvanmele tomvanmele left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think the tests are wrong

Comment thread tests/test_model.py Outdated
Comment thread tests/test_model.py Outdated
Comment on lines +90 to +91
assert type(restored) is MyModel
assert restored._extra == "hello"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here. i don't think you are testing the behaviour you intend to test

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the other test, the two failure modes are separate, so i still kept it, should i directly cancel it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants