Gergő Jedlicska
52ab27e60f
### SUMMARY **sqlite transport** This transport now batches and bulk inserts objects when writing resulting in huge performance improvements (100x). **base object serializer** Batching in the sqlite transport necessitated some refactoring here in order to safely call end_write when not using operations.send/receive. This has been resolved by turning traverse_base into a wrapper for _traverse_base which can take care of calling begin/end_write and resetting the writer at the top level. This is not breaking since the top level methods to call have not changed names and the original method has just been prepended with a _ Additionally, missing referenced child objects in the read transport used to raise a SpeckleException. However, using the gql client to call objects.get() will return an object with missing references by design thus throwing an error in serialization. This has been resolved by instead raising a SpeckleWarning when child objects can't be found and just returning the reference + id. ((this method of interacting with objects is discouraged so it is not surprising to me that this bug was lurking for so long - but an oopsie nonetheless!)) **ci / dev** Updates for the ci config and the dev container to work with the recent changes in server. NOTE: dev container seems to be pulling an older version of server -- not resolved yet --- * quick and hacky sqlite batching * feat(transports): batching sqlite inserts * chore: upgrade gql3 also removed py-spy as it's not used and i was getting install errors :/ * ci: bump node version * ci: formatting * update CI versions * update to new circleci redis baseimage * update test fixture auth to non deprecated token based method * add start and finish write method calls to base object serialize * chore: dev container update * fix(serialization): move end and begin write * style: formatting * fix(serializer): warn but don't throw if ref not found this is _not_ an issue with the transports, but an issue with using the graphql api to fetch objects. since you are only receiving one obj and none of the children, the transport has no way to find them and should simply return the reference as is. idk why anyone would really use `object.get` so tbh i'm not surprised no one has found this bug yet lol * fix(client): don't parse obj create response * fix(serializer): wrap `traverse_base` moving `begin` and `end_write` to the seriazlier due to the new sqlite transport with batched writes necessitates a wrapper around `traverse_base` so end/begin write can be called once at the top level. just adding begin/end write to the original traversal method would make tons of calls to `end_write` since the traversal is recursive Co-authored-by: izzy lyseggen <izzy.lyseggen@gmail.com>
60 lines
1.9 KiB
Python
60 lines
1.9 KiB
Python
"""This is an example showcasing the usage of speckle `Base` class."""
|
|
|
|
# the speckle.objects module exposes all speckle provided classes
|
|
from specklepy.objects import Base
|
|
from specklepy.api import operations
|
|
from devtools import debug
|
|
|
|
|
|
class ExampleSub(Base):
|
|
"""
|
|
Inheriting from `Base` is done with in the standard way by default.
|
|
|
|
The syntax is similar to the stdlib dataclass syntax.
|
|
No __init__ method definition is required, that is done automatically by the base
|
|
type. Also the attributes defined this way are instance attributes despite they
|
|
might look like class attributes.
|
|
|
|
The speckle Base uses the pydantic BaseModel in the background, but ideally that
|
|
is not the consumers concern.
|
|
|
|
**Important note:** currently the way how serialization works, requires
|
|
each attribute to have a valid default value, just like `foo` has. This includes
|
|
default values for all primitives and complex datastructures.
|
|
Failing to provide a default, breaks the receiving end of the transport.
|
|
"""
|
|
|
|
foo: str = "bar"
|
|
|
|
|
|
class SpeckleSub(ExampleSub, speckle_type="custom_speckle_sub"):
|
|
"""
|
|
Example custom type name registration.
|
|
|
|
This is an optional feature.
|
|
The default value of the speckle_type is generated from the name of the class, but
|
|
optionally it may be overridden. This is useful, since the speckle_type has to be
|
|
unique for each subclass of speckle Base.
|
|
"""
|
|
|
|
magic: str = "trick"
|
|
|
|
|
|
if __name__ == "__main__":
|
|
# example usage
|
|
custom_sub = SpeckleSub(
|
|
foo=123,
|
|
magic="trick",
|
|
bar="baric",
|
|
extra=123,
|
|
)
|
|
# support for dynamic attributes
|
|
custom_sub.extra_extra = "what is this?"
|
|
debug(custom_sub)
|
|
|
|
serialized = operations.serialize(custom_sub)
|
|
deserialized = operations.deserialize(serialized)
|
|
# the only difference should be between the two data is that the deserialized
|
|
# instance id attribute is not None.
|
|
debug(deserialized)
|