blob: e24450c158e58a763e810a5c180fbfbe826f4cda [file] [log] [blame] [view]
---
title: Cross-Language Serialization
sidebar_position: 10
id: python_cross_language
license: |
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
---
`pyfory` supports cross-language object graph serialization, allowing you to serialize data in Python and deserialize it in Java, Go, Rust, or other supported languages.
## Enable Cross-Language Mode
To use xlang mode, create `Fory` with `xlang=True`:
```python
import pyfory
fory = pyfory.Fory(xlang=True, ref=False, strict=True)
```
## Cross-Language Example
### Python (Serializer)
```python
import pyfory
from dataclasses import dataclass
# Cross-language mode for interoperability
f = pyfory.Fory(xlang=True, ref=True)
# Register type for cross-language compatibility
@dataclass
class Person:
name: str
age: pyfory.int32
f.register(Person, typename="example.Person")
person = Person("Charlie", 35)
binary_data = f.serialize(person)
# binary_data can now be sent to Java, Go, etc.
```
### Java (Deserializer)
```java
import org.apache.fory.*;
public class Person {
public String name;
public int age;
}
Fory fory = Fory.builder()
.withLanguage(Language.XLANG)
.withRefTracking(true)
.build();
fory.register(Person.class, "example.Person");
Person person = (Person) fory.deserialize(binaryData);
```
### Rust (Deserializer)
```rust
use fory::Fory;
use fory::ForyObject;
#[derive(ForyObject)]
struct Person {
name: String,
age: i32,
}
let mut fory = Fory::default()
.compatible(true)
.xlang(true);
fory.register_by_namespace::<Person>("example", "Person");
let person: Person = fory.deserialize(&binary_data)?;
```
## Type Annotations for Cross-Language
Use pyfory type annotations for explicit cross-language type mapping:
```python
from dataclasses import dataclass
import pyfory
@dataclass
class TypedData:
int_value: pyfory.int32 # 32-bit integer
long_value: pyfory.int64 # 64-bit integer
float_value: pyfory.float32 # 32-bit float
double_value: pyfory.float64 # 64-bit float
```
## Type Mapping
| Python | Java | Rust | Go |
| ---------------- | -------- | --------- | --------- |
| `str` | `String` | `String` | `string` |
| `int` | `long` | `i64` | `int64` |
| `pyfory.int32` | `int` | `i32` | `int32` |
| `pyfory.int64` | `long` | `i64` | `int64` |
| `float` | `double` | `f64` | `float64` |
| `pyfory.float32` | `float` | `f32` | `float32` |
| `list` | `List` | `Vec` | `[]T` |
| `dict` | `Map` | `HashMap` | `map[K]V` |
## Differences from Python Native Mode
The binary protocol and API are similar to `pyfory`'s python-native mode, but Python-native mode can serialize any Python object—including global functions, local functions, lambdas, local classes, and types with customized serialization using `__getstate__/__reduce__/__reduce_ex__`, which are **not allowed** in xlang mode.
## See Also
- [Cross-Language Serialization Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec)
- [Type Mapping Reference](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
- [Java Cross-Language Guide](../java/cross-language.md)
- [Rust Cross-Language Guide](../rust/cross-language.md)
## Related Topics
- [Configuration](configuration.md) - XLANG mode settings
- [Schema Evolution](schema-evolution.md) - Compatible mode
- [Type Registration](type-registration.md) - Registration patterns