šŸ PySpeckle 2.0 is starting to take shape...be an early tester!

Making Speckle
9

Thanks a lot sharing your view! Going with dataclasses is definitely something to consider if the pydantic models do not provide the necessary flexibility. Iā€™m a bit biased in the other direction as Iā€™ve heavily used and enjoyed pydantic, but I am of course happy for a move to refactor this if it is the better solution for the majority of users!

Regarding properties, what you want to do is possible with a few tweaks to your code (and one addition I just merged into main! if youā€™re curious: I didnā€™t realise that __setattr__ takes precedence over properties, so Iā€™ve added a check to this so setters actually set what you think they should set.)

You are getting the AttributeError for __fields_set__ because you have not initialised the class before setting the base_line attribute. If you want to set attributes in the init function, you would do so after calling init on its parent:

def __init__(self, **kwargs) -> None:
    super().__init__(**kwargs)   # note: you must do this first!
    self.base_line = None

If you want to initialise the property in the class setup, you should be initialising the private/protected backing property, not the property itself since (as you noted) initialising the property as an attribute wonā€™t do anything useful.

class SpeckleBeam(Base):
    _base_line: SpeckleLine = None   # note: not setting `base_line`

    def __init__(self, **kwargs) -> None:
        super().__init__(**kwargs)

    @property
    def base_line(self):
        return self._base_line

    @base_line.setter
    def base_line(self, value: SpeckleLine):
        self._base_line = value

EDIT: oopsie I forgot to address your question re commits :sweat_smile:

A commit will itself only ever reference one referenceObject which is a Base object. However, this Base object can contain as many objects as you want. This means all the objects you want to add to the commit will be children of the parent Base object. If you make some of these detachable, the parent Base will be decomposed for you when you use operations.send() and will be recomposed for you upon calling operations.receive().

See this post for more on the base object and this post for more on the decomposition API.

1 Like