Skip to content

Commit 46494d1

Browse files
chaokunyangchaokunyang
committed
docs: remove stale split registration examples
1 parent 95dc44f commit 46494d1

17 files changed

Lines changed: 88 additions & 154 deletions

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ class Person:
370370
age: pyfory.Int32
371371

372372
fory = pyfory.Fory(xlang=True)
373-
fory.register_type(Person, typename="example.Person")
373+
fory.register_type(Person, name="example.Person")
374374

375375
data = fory.serialize(Person("Alice", 30))
376376
person = fory.deserialize(data)
@@ -525,7 +525,7 @@ void main() {
525525
PersonFory.register(
526526
fory,
527527
Person,
528-
typeName: 'example.Person',
528+
name: 'example.Person',
529529
);
530530
531531
final bytes = fory.serialize(Person()
@@ -555,7 +555,7 @@ struct Person {
555555
}
556556

557557
let fory = Fory()
558-
try fory.register(Person.self, namespace: "example", name: "Person")
558+
try fory.register(Person.self, name: "example.Person")
559559

560560
let bytes = try fory.serialize(Person(name: "Alice", age: 30))
561561
let person: Person = try fory.deserialize(bytes)

‎compiler/fory_compiler/tests/test_dart_generator.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def test_dart_generator_emits_annotated_structs_and_generated_part_registration(
6868
assert "int fixedValue = 0;" in file.content
6969
assert "Uint64 taggedValue = Uint64(0);" in file.content
7070
assert (
71-
"registerGeneratedStruct(fory, _scalarForySchema, id: 100, namespace: null, typeName: null);"
71+
"registerGeneratedStruct(fory, _scalarForySchema, id: 100, name: null);"
7272
in file.content
7373
)
7474
assert "abstract final class DemoForyModule" in file.content
@@ -98,7 +98,7 @@ def test_dart_generator_keeps_enum_helpers_in_source_and_uses_generated_enum_reg
9898
assert "static Status fromRawValue(int value) => switch (value) {" in file.content
9999
assert "_StatusForySerializer" not in file.content
100100
assert (
101-
"registerGeneratedEnum(fory, _statusForySchema, id: 101, namespace: null, typeName: null);"
101+
"registerGeneratedEnum(fory, _statusForySchema, id: 101, name: null);"
102102
in file.content
103103
)
104104

@@ -140,7 +140,7 @@ def test_dart_generator_keeps_union_serializers_direct_and_marks_union_types():
140140
assert "void write(" not in file.content
141141
assert "Animal read(" not in file.content
142142
assert (
143-
"fory.registerSerializer(Animal, const _AnimalForySerializer(), id: 101, namespace: null, typeName: null);"
143+
"fory.registerSerializer(Animal, const _AnimalForySerializer(), id: 101, name: null);"
144144
in file.content
145145
)
146146

@@ -330,11 +330,11 @@ def test_dart_generator_uses_name_registration_when_auto_id_disabled():
330330
)
331331

332332
assert (
333-
"registerGeneratedStruct(fory, _envelopeForySchema, id: null, namespace: 'demo', typeName: 'Envelope');"
333+
"registerGeneratedStruct(fory, _envelopeForySchema, id: null, name: 'demo.Envelope');"
334334
in file.content
335335
)
336336
assert (
337-
"registerGeneratedStruct(fory, _envelopePayloadForySchema, id: null, namespace: 'demo', typeName: 'Envelope.Payload');"
337+
"registerGeneratedStruct(fory, _envelopePayloadForySchema, id: null, name: 'demo.Envelope.Payload');"
338338
in file.content
339339
)
340340

‎dart/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Serialize and deserialize:
8787

8888
```dart
8989
final fory = Fory();
90-
PersonForyModule.register(fory, Person, typeName: 'example.Person');
90+
PersonForyModule.register(fory, Person, name: 'example.Person');
9191
9292
final bytes = fory.serialize(Person()..name = 'Ada'..age = 36);
9393
final roundTrip = fory.deserialize<Person>(bytes);

‎dart/packages/fory-test/lib/entity/xlang_test_manual.dart‎

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,13 @@ import 'package:fory/fory.dart';
2525

2626
import 'xlang_test_models.dart';
2727

28-
bool registerXlangManualType(
29-
Fory fory,
30-
Type type, {
31-
int? id,
32-
String? namespace,
33-
String? typeName,
34-
}) {
28+
bool registerXlangManualType(Fory fory, Type type, {int? id, String? name}) {
3529
if (type == MyExt) {
3630
fory.registerSerializer(
3731
MyExt,
3832
const _MyExtSerializer(),
3933
id: id,
40-
namespace: namespace,
41-
typeName: typeName,
34+
name: name,
4235
);
4336
return true;
4437
}
@@ -47,8 +40,7 @@ bool registerXlangManualType(
4740
Union2,
4841
const _Union2Serializer(),
4942
id: id,
50-
namespace: namespace,
51-
typeName: typeName,
43+
name: name,
5244
);
5345
return true;
5446
}
@@ -57,8 +49,7 @@ bool registerXlangManualType(
5749
fory,
5850
_refOverrideContainerForySchema,
5951
id: id,
60-
namespace: namespace,
61-
typeName: typeName,
52+
name: name,
6253
);
6354
return true;
6455
}

‎dart/packages/fory-test/lib/entity/xlang_test_models.dart‎

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -27,29 +27,11 @@ import 'xlang_test_manual.dart' as manual;
2727

2828
part 'xlang_test_models.fory.dart';
2929

30-
void registerXlangType(
31-
Fory fory,
32-
Type type, {
33-
int? id,
34-
String? namespace,
35-
String? typeName,
36-
}) {
37-
if (manual.registerXlangManualType(
38-
fory,
39-
type,
40-
id: id,
41-
namespace: namespace,
42-
typeName: typeName,
43-
)) {
30+
void registerXlangType(Fory fory, Type type, {int? id, String? name}) {
31+
if (manual.registerXlangManualType(fory, type, id: id, name: name)) {
4432
return;
4533
}
46-
XlangTestModelsForyModule.register(
47-
fory,
48-
type,
49-
id: id,
50-
namespace: namespace,
51-
typeName: typeName,
52-
);
34+
XlangTestModelsForyModule.register(fory, type, id: id, name: name);
5335
}
5436

5537
@ForyStruct()

‎dart/packages/fory-test/test/compatible_struct_read_test.dart‎

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -24,35 +24,21 @@ import 'package:test/test.dart';
2424
void main() {
2525
test('compatible named struct round trip preserves nested struct fields', () {
2626
final fory = Fory(compatible: true);
27-
registerXlangType(
28-
fory,
29-
Color,
30-
namespace: 'demo',
31-
typeName: 'color',
32-
);
33-
registerXlangType(
34-
fory,
35-
Item,
36-
namespace: 'demo',
37-
typeName: 'item',
38-
);
39-
registerXlangType(
40-
fory,
41-
SimpleStruct,
42-
namespace: 'demo',
43-
typeName: 'simple_struct',
44-
);
27+
registerXlangType(fory, Color, name: 'demo.color');
28+
registerXlangType(fory, Item, name: 'demo.item');
29+
registerXlangType(fory, SimpleStruct, name: 'demo.simple_struct');
4530

46-
final original = SimpleStruct()
47-
..f2 = (1)
48-
..f7 = (2)
49-
..f8 = (3)
50-
..last = (4)
51-
..f4 = 'outer'
52-
..f6 = <String>['a', 'b']
53-
..f1 = <int?, double?>{(7): 9.5}
54-
..f3 = (Item()..name = 'inner')
55-
..f5 = Color.blue;
31+
final original =
32+
SimpleStruct()
33+
..f2 = (1)
34+
..f7 = (2)
35+
..f8 = (3)
36+
..last = (4)
37+
..f4 = 'outer'
38+
..f6 = <String>['a', 'b']
39+
..f1 = <int?, double?>{(7): 9.5}
40+
..f3 = (Item()..name = 'inner')
41+
..f5 = Color.blue;
5642

5743
final firstBytes = fory.serialize(original);
5844
final decoded = fory.deserialize<SimpleStruct>(firstBytes);

‎dart/packages/fory-test/test/cross_lang_test/xlang_test_main.dart‎

Lines changed: 34 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -223,9 +223,10 @@ void _verifyMurmurCase() {
223223
final shortHash = murmurHash3X64_128(const <int>[1, 2, 8]);
224224
final textHash = murmurHash3X64_128(utf8.encode('01234567890123456789'));
225225
if (data.length == 32) {
226-
final expected = BytesBuilder(copy: false)
227-
..add(_hashBytes(shortHash.$1, shortHash.$2))
228-
..add(_hashBytes(textHash.$1, textHash.$2));
226+
final expected =
227+
BytesBuilder(copy: false)
228+
..add(_hashBytes(shortHash.$1, shortHash.$2))
229+
..add(_hashBytes(textHash.$1, textHash.$2));
229230
if (!_equalBytes(data, expected.toBytes())) {
230231
throw StateError('Unexpected MurmurHash3 byte payload.');
231232
}
@@ -287,36 +288,21 @@ void _registerSimpleById(Fory fory) {
287288
}
288289

289290
void _registerSimpleByName(Fory fory) {
290-
registerXlangType(fory, Color, namespace: 'demo', typeName: 'color');
291-
registerXlangType(fory, Item, namespace: 'demo', typeName: 'item');
292-
registerXlangType(
293-
fory,
294-
SimpleStruct,
295-
namespace: 'demo',
296-
typeName: 'simple_struct',
297-
);
291+
registerXlangType(fory, Color, name: 'demo.color');
292+
registerXlangType(fory, Item, name: 'demo.item');
293+
registerXlangType(fory, SimpleStruct, name: 'demo.simple_struct');
298294
}
299295

300296
void _registerStructEvolvingOverrideByName(Fory fory) {
301-
registerXlangType(
302-
fory,
303-
EvolvingOverrideStruct,
304-
namespace: 'test',
305-
typeName: 'evolving_yes',
306-
);
307-
registerXlangType(
308-
fory,
309-
FixedOverrideStruct,
310-
namespace: 'test',
311-
typeName: 'evolving_off',
312-
);
297+
registerXlangType(fory, EvolvingOverrideStruct, name: 'test.evolving_yes');
298+
registerXlangType(fory, FixedOverrideStruct, name: 'test.evolving_off');
313299
}
314300

315301
void _registerNamedCustomTypes(Fory fory) {
316-
registerXlangType(fory, Color, namespace: '', typeName: 'color');
317-
registerXlangType(fory, MyStruct, namespace: '', typeName: 'my_struct');
318-
registerXlangType(fory, MyExt, namespace: '', typeName: 'my_ext');
319-
registerXlangType(fory, MyWrapper, namespace: '', typeName: 'my_wrapper');
302+
registerXlangType(fory, Color, name: 'color');
303+
registerXlangType(fory, MyStruct, name: 'my_struct');
304+
registerXlangType(fory, MyExt, name: 'my_ext');
305+
registerXlangType(fory, MyWrapper, name: 'my_wrapper');
320306
}
321307

322308
void _runCollectionElementRefOverride() {
@@ -341,10 +327,11 @@ void _runCollectionElementRefOverride() {
341327
identical(container.mapField['k2'], setValue)) {
342328
throw StateError('mapField should honor remote ref=false metadata');
343329
}
344-
final output = RefOverrideContainer()
345-
..listField = <RefOverrideElement>[shared, shared]
346-
..setField = <RefOverrideElement>{shared}
347-
..mapField = <String, RefOverrideElement>{'k1': shared, 'k2': shared};
330+
final output =
331+
RefOverrideContainer()
332+
..listField = <RefOverrideElement>[shared, shared]
333+
..setField = <RefOverrideElement>{shared}
334+
..mapField = <String, RefOverrideElement>{'k1': shared, 'k2': shared};
348335
_writeFile(fory.serialize(output, trackRef: true));
349336
}
350337

@@ -353,17 +340,19 @@ void _runCollectionElementRefRemoteTracking() {
353340
registerXlangType(fory, RefOverrideElement, id: 701);
354341
registerXlangType(fory, RefOverrideContainer, id: 702);
355342

356-
final shared = RefOverrideElement()
357-
..id = 7
358-
..name = 'shared_element';
343+
final shared =
344+
RefOverrideElement()
345+
..id = 7
346+
..name = 'shared_element';
359347
// IMPORTANT: this peer intentionally writes a shared-reference payload with
360348
// its default local ref-tracked schema. The Java reader uses ref-disabled
361349
// element annotations and must still honor the wire metadata. DO NOT REMOVE
362350
// this comment.
363-
final output = RefOverrideContainer()
364-
..listField = <RefOverrideElement>[shared, shared]
365-
..setField = <RefOverrideElement>{shared}
366-
..mapField = <String, RefOverrideElement>{'k1': shared, 'k2': shared};
351+
final output =
352+
RefOverrideContainer()
353+
..listField = <RefOverrideElement>[shared, shared]
354+
..setField = <RefOverrideElement>{shared}
355+
..mapField = <String, RefOverrideElement>{'k1': shared, 'k2': shared};
367356
_writeFile(fory.serialize(output, trackRef: true));
368357
}
369358

@@ -419,7 +408,8 @@ void _runListArrayCompatibleNullableListToArrayError() {
419408
return;
420409
}
421410
throw StateError(
422-
'Expected nullable list payload to fail compatible array read.');
411+
'Expected nullable list payload to fail compatible array read.',
412+
);
423413
}
424414

425415
void _runCase(String caseName) {
@@ -492,8 +482,11 @@ void _runCase(String caseName) {
492482
return;
493483
case 'test_nested_annotated_container_schema_consistent':
494484
final fory = _newFory();
495-
registerXlangType(fory, NestedAnnotatedContainerSchemaConsistent,
496-
id: 801);
485+
registerXlangType(
486+
fory,
487+
NestedAnnotatedContainerSchemaConsistent,
488+
id: 801,
489+
);
497490
_roundTripFory(fory);
498491
return;
499492
case 'test_nested_annotated_container_compatible':

0 commit comments

Comments
 (0)