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

Fix several issues #12

Merged
merged 12 commits into from
May 1, 2024
Merged

Fix several issues #12

merged 12 commits into from
May 1, 2024

Conversation

gonzalocasas
Copy link
Member

@gonzalocasas gonzalocasas commented Apr 30, 2024

Solves #11

This PR fixes several things: first of all, the base case of the Message class was removed and re-based to object because UserDict is an old-style class and that creates a ton of problems.

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)

@gonzalocasas
Copy link
Member Author

/cc @jckenny59

Copy link
Member

@chenkasirer chenkasirer left a comment

Choose a reason for hiding this comment

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

Generally LTGM, but I am a bit confused by some things. Mostly the (de)serialization of Message objects, just seems like a parallel system to the compas.data. But if it's nonsense feel free to go ahead :)

src/compas_eve/core.py Outdated Show resolved Hide resolved
@@ -103,6 +113,26 @@ def __init__(self, name, message_type, **options):
self.message_type = message_type
self.options = options

def _message_to_json(self, message):
"""Convert a message to a JSON string.
Copy link
Member

Choose a reason for hiding this comment

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

should this (and _message_from_json) maybe made public? I see they are only used externally.
more generally, aren't these two doing something very similar to compas.data?

Copy link
Member Author

Choose a reason for hiding this comment

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

they are doing something similar to compas.data but not exactly, a message can be a simple dictionary, an instance of Message, or a subclass of compas.data.Data and needs to support compas 1.x and compas 2.x

except (KeyError, AttributeError):
try:
data = dict(message)
except Exception:
Copy link
Member

Choose a reason for hiding this comment

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

maybe catch more specific errors like ValueError and TypeError?

Copy link
Member Author

Choose a reason for hiding this comment

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

true, I was too lazy to think which one is the correct exception here :P

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed at d2caf2c

src/compas_eve/ghpython/background.py Show resolved Hide resolved
src/compas_eve/ghpython/background.py Outdated Show resolved Hide resolved
src/compas_eve/ghpython/background.py Outdated Show resolved Hide resolved
tests/integration/test_mqtt.py Outdated Show resolved Hide resolved
@gonzalocasas
Copy link
Member Author

Generally LTGM, but I am a bit confused by some things. Mostly the (de)serialization of Message objects, just seems like a parallel system to the compas.data. But if it's nonsense feel free to go ahead :)

Thanks! I think I fixed all the review findings. About the (de)serialization of Message, the idea is not to go entirely parallel to compas.data, but to support it without forcing it to be the case. So, a message can be an instance of Message without implementing compas.data.Data as well. Ideally, it's also possible to send/receive even a simple dictionary.

@gonzalocasas gonzalocasas merged commit f69c7fc into main May 1, 2024
13 checks passed
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