Skip to content

Commit ca67563

Browse files
committed
docs: register thread-safe types before root use
1 parent fe97d41 commit ca67563

2 files changed

Lines changed: 12 additions & 16 deletions

File tree

docs/object-serialization/python/configuration.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,21 +84,19 @@ class ThreadSafeFory:
8484
```python
8585
fory = pyfory.ThreadSafeFory(xlang=True)
8686

87+
# Complete registration before the first root operation. Choose one form:
88+
fory.register(MyClass, type_id=123)
89+
# fory.register(MyClass, name="my.package.MyClass")
90+
# fory.register(MyClass, type_id=123, serializer=MySerializer)
91+
# fory.register(MyClass, name="my.package.MyClass", serializer=MySerializer)
92+
8793
# Serialization (serialize/deserialize are identical to dumps/loads)
8894
data: bytes = fory.serialize(obj)
8995
obj = fory.deserialize(data)
9096

9197
# Alternative API (aliases)
9298
data: bytes = fory.dumps(obj)
9399
obj = fory.loads(data)
94-
95-
# Type registration by id
96-
fory.register(MyClass, type_id=123)
97-
fory.register(MyClass, type_id=123, serializer=custom_serializer)
98-
99-
# Type registration by name
100-
fory.register(MyClass, name="my.package.MyClass")
101-
fory.register(MyClass, name="my.package.MyClass", serializer=custom_serializer)
102100
```
103101

104102
## Xlang And Native Mode Comparison

python/README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -746,21 +746,19 @@ for t in threads: t.join()
746746
```python
747747
fory = pyfory.ThreadSafeFory(xlang=True)
748748

749+
# Complete registration before the first root operation. Choose one form:
750+
fory.register(MyClass, type_id=123)
751+
# fory.register(MyClass, name="my.package.MyClass")
752+
# fory.register(MyClass, type_id=123, serializer=MySerializer)
753+
# fory.register(MyClass, name="my.package.MyClass", serializer=MySerializer)
754+
749755
# Serialization (serialize/deserialize are identical to dumps/loads)
750756
data: bytes = fory.serialize(obj)
751757
obj = fory.deserialize(data)
752758

753759
# Alternative API (aliases)
754760
data: bytes = fory.dumps(obj)
755761
obj = fory.loads(data)
756-
757-
# Type registration by id
758-
fory.register(MyClass, type_id=123)
759-
fory.register(MyClass, type_id=123, serializer=custom_serializer)
760-
761-
# Type registration by name
762-
fory.register(MyClass, name="my.package.MyClass")
763-
fory.register(MyClass, name="my.package.MyClass", serializer=custom_serializer)
764762
```
765763

766764
### Xlang And Native Mode Comparison

0 commit comments

Comments
 (0)