type
stringclasses 5
values | name
stringlengths 1
55
| qualified_name
stringlengths 5
143
| docstring
stringlengths 0
3.59k
⌀ | filepath
stringclasses 180
values | is_public
bool 2
classes | is_private
bool 2
classes | line_start
float64 0
1.54k
⌀ | line_end
float64 0
1.56k
⌀ | annotation
stringclasses 8
values | returns
stringclasses 236
values | parameters
listlengths 0
74
⌀ | parent_class
stringclasses 298
values | value
stringclasses 112
values | bases
listlengths 0
3
⌀ | api_element_summary
stringlengths 199
23k
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
method
|
__init__
|
fenic.core._serde.proto.serde_context.SerdeContext.__init__
|
Initialize a SerdeContext with an empty path tracker.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 88 | 90 | null | null |
[
"self"
] |
SerdeContext
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.__init__
Docstring: Initialize a SerdeContext with an empty path tracker.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: SerdeContext
|
method
|
clear_path
|
fenic.core._serde.proto.serde_context.SerdeContext.clear_path
|
Clear the current serde path.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 97 | 99 | null |
None
|
[
"self"
] |
SerdeContext
| null | null |
Type: method
Member Name: clear_path
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.clear_path
Docstring: Clear the current serde path.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: None
Parent Class: SerdeContext
|
method
|
path_context
|
fenic.core._serde.proto.serde_context.SerdeContext.path_context
|
Context manager for tracking field paths during serde operations.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 101 | 108 | null | null |
[
"self",
"field_name"
] |
SerdeContext
| null | null |
Type: method
Member Name: path_context
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.path_context
Docstring: Context manager for tracking field paths during serde operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name"]
Returns: none
Parent Class: SerdeContext
|
method
|
create_serde_error
|
fenic.core._serde.proto.serde_context.SerdeContext.create_serde_error
|
Create a serde error with the current path automatically included.
Args:
error_class: The type of serde error to create.
message: The error message.
object_type: Optional type information for the error.
Returns:
A serde error with path information included.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 110 | 127 | null |
SerdeError
|
[
"self",
"error_class",
"message",
"object_type"
] |
SerdeContext
| null | null |
Type: method
Member Name: create_serde_error
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.create_serde_error
Docstring: Create a serde error with the current path automatically included.
Args:
error_class: The type of serde error to create.
message: The error message.
object_type: Optional type information for the error.
Returns:
A serde error with path information included.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "error_class", "message", "object_type"]
Returns: SerdeError
Parent Class: SerdeContext
|
method
|
_handle_serde_error
|
fenic.core._serde.proto.serde_context.SerdeContext._handle_serde_error
| null |
site-packages/fenic/core/_serde/proto/serde_context.py
| false | true | 129 | 149 | null |
None
|
[
"self",
"e"
] |
SerdeContext
| null | null |
Type: method
Member Name: _handle_serde_error
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext._handle_serde_error
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "e"]
Returns: None
Parent Class: SerdeContext
|
method
|
serialize_logical_expr
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_logical_expr
|
Serialize a logical expression with field path tracking.
Args:
field_name: The name of the field being serialized.
expr: The logical expression to serialize.
Returns:
The serialized protobuf representation.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 155 | 173 | null |
LogicalExprProto
|
[
"self",
"field_name",
"expr"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_logical_expr
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_logical_expr
Docstring: Serialize a logical expression with field path tracking.
Args:
field_name: The name of the field being serialized.
expr: The logical expression to serialize.
Returns:
The serialized protobuf representation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "expr"]
Returns: LogicalExprProto
Parent Class: SerdeContext
|
method
|
deserialize_logical_expr
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_logical_expr
|
Deserialize a logical expression with field path tracking.
Args:
field_name: The name of the field being deserialized.
expr_proto: The protobuf representation to deserialize.
Returns:
The deserialized logical expression.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 175 | 193 | null |
Optional[LogicalExpr]
|
[
"self",
"field_name",
"expr_proto"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_logical_expr
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_logical_expr
Docstring: Deserialize a logical expression with field path tracking.
Args:
field_name: The name of the field being deserialized.
expr_proto: The protobuf representation to deserialize.
Returns:
The deserialized logical expression.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "expr_proto"]
Returns: Optional[LogicalExpr]
Parent Class: SerdeContext
|
method
|
serialize_logical_expr_list
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_logical_expr_list
|
Serialize a list of logical expressions with field path tracking.
Args:
field_name: The name of the field being serialized.
expr_list: The list of logical expressions to serialize.
Returns:
A list of serialized protobuf representations.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 195 | 215 | null |
List[LogicalExprProto]
|
[
"self",
"field_name",
"expr_list"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_logical_expr_list
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_logical_expr_list
Docstring: Serialize a list of logical expressions with field path tracking.
Args:
field_name: The name of the field being serialized.
expr_list: The list of logical expressions to serialize.
Returns:
A list of serialized protobuf representations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "expr_list"]
Returns: List[LogicalExprProto]
Parent Class: SerdeContext
|
method
|
deserialize_logical_expr_list
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_logical_expr_list
|
Deserialize a list of logical expressions with field path tracking.
Args:
field_name: The name of the field being deserialized.
expr_proto_list: The list of protobuf representations to deserialize.
Returns:
A list of deserialized logical expressions.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 217 | 239 | null |
List[LogicalExpr]
|
[
"self",
"field_name",
"expr_proto_list"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_logical_expr_list
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_logical_expr_list
Docstring: Deserialize a list of logical expressions with field path tracking.
Args:
field_name: The name of the field being deserialized.
expr_proto_list: The list of protobuf representations to deserialize.
Returns:
A list of deserialized logical expressions.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "expr_proto_list"]
Returns: List[LogicalExpr]
Parent Class: SerdeContext
|
method
|
serialize_python_literal
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_python_literal
|
Serialize a python literal with field path tracking.
Args:
field_name: The name of the field being serialized.
value: The string value from the Python Literal type.
target_proto: The protobuf enum type wrapper to convert to.
Returns:
The protobuf enum integer value.
Raises:
SerializationError: If the value cannot be safely serialized.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 241 | 270 | null |
int
|
[
"self",
"field_name",
"value",
"target_proto"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_python_literal
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_python_literal
Docstring: Serialize a python literal with field path tracking.
Args:
field_name: The name of the field being serialized.
value: The string value from the Python Literal type.
target_proto: The protobuf enum type wrapper to convert to.
Returns:
The protobuf enum integer value.
Raises:
SerializationError: If the value cannot be safely serialized.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "value", "target_proto"]
Returns: int
Parent Class: SerdeContext
|
method
|
deserialize_python_literal
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_python_literal
|
Deserialize a python literal with field path tracking.
Args:
field_name: The name of the field being deserialized.
value: The protobuf enum integer value.
target_type: The target Python Literal type.
proto_enum: The protobuf enum type wrapper to convert int to string.
Returns:
The string value from the literal type.
Raises:
DeserializationError: If the value cannot be safely deserialized.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 272 | 329 | null |
Any
|
[
"self",
"field_name",
"value",
"target_type",
"proto_enum"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_python_literal
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_python_literal
Docstring: Deserialize a python literal with field path tracking.
Args:
field_name: The name of the field being deserialized.
value: The protobuf enum integer value.
target_type: The target Python Literal type.
proto_enum: The protobuf enum type wrapper to convert int to string.
Returns:
The string value from the literal type.
Raises:
DeserializationError: If the value cannot be safely deserialized.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "value", "target_type", "proto_enum"]
Returns: Any
Parent Class: SerdeContext
|
method
|
serialize_enum_value
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_enum_value
|
Serialize an enum value with field path tracking.
Args:
field_name: The name of the field being serialized.
enum_value: The enum value to serialize.
target_proto: The protobuf enum type wrapper.
Returns:
The protobuf int representation of the enum value.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 331 | 350 | null |
int
|
[
"self",
"field_name",
"enum_value",
"target_proto"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_enum_value
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_enum_value
Docstring: Serialize an enum value with field path tracking.
Args:
field_name: The name of the field being serialized.
enum_value: The enum value to serialize.
target_proto: The protobuf enum type wrapper.
Returns:
The protobuf int representation of the enum value.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "enum_value", "target_proto"]
Returns: int
Parent Class: SerdeContext
|
method
|
deserialize_enum_value
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_enum_value
|
Deserialize an enum value with field path tracking.
Args:
field_name: The name of the field being deserialized.
target_type: The target enum type to deserialize to.
proto_enum_type: The protobuf enum type wrapper.
serialized_value: The protobuf int representation of the enum value.
Returns:
The deserialized enum value.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 352 | 378 | null |
Optional[EnumType]
|
[
"self",
"field_name",
"target_type",
"proto_enum_type",
"serialized_value"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_enum_value
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_enum_value
Docstring: Deserialize an enum value with field path tracking.
Args:
field_name: The name of the field being deserialized.
target_type: The target enum type to deserialize to.
proto_enum_type: The protobuf enum type wrapper.
serialized_value: The protobuf int representation of the enum value.
Returns:
The deserialized enum value.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "target_type", "proto_enum_type", "serialized_value"]
Returns: Optional[EnumType]
Parent Class: SerdeContext
|
method
|
serialize_logical_plan
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_logical_plan
|
Serialize a logical plan with field path tracking.
Args:
field_name: The name of the field being serialized.
plan: The logical plan to serialize.
Returns:
The serialized protobuf representation of the logical plan.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 380 | 398 | null |
LogicalPlanProto
|
[
"self",
"field_name",
"plan"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_logical_plan
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_logical_plan
Docstring: Serialize a logical plan with field path tracking.
Args:
field_name: The name of the field being serialized.
plan: The logical plan to serialize.
Returns:
The serialized protobuf representation of the logical plan.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "plan"]
Returns: LogicalPlanProto
Parent Class: SerdeContext
|
method
|
serialize_logical_plan_list
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_logical_plan_list
|
Serialize a list of logical plans with field path tracking.
Args:
field_name: The name of the field being serialized.
plan_list: The list of logical plans to serialize.
Returns:
A list of serialized protobuf representations of logical plans.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 400 | 420 | null |
List[LogicalPlanProto]
|
[
"self",
"field_name",
"plan_list"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_logical_plan_list
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_logical_plan_list
Docstring: Serialize a list of logical plans with field path tracking.
Args:
field_name: The name of the field being serialized.
plan_list: The list of logical plans to serialize.
Returns:
A list of serialized protobuf representations of logical plans.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "plan_list"]
Returns: List[LogicalPlanProto]
Parent Class: SerdeContext
|
method
|
deserialize_logical_plan
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_logical_plan
|
Deserialize a logical plan with field path tracking.
Args:
field_name: The name of the field being deserialized.
plan_proto: The protobuf representation to deserialize.
Returns:
The deserialized logical plan.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 422 | 442 | null |
LogicalPlan
|
[
"self",
"field_name",
"plan_proto"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_logical_plan
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_logical_plan
Docstring: Deserialize a logical plan with field path tracking.
Args:
field_name: The name of the field being deserialized.
plan_proto: The protobuf representation to deserialize.
Returns:
The deserialized logical plan.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "plan_proto"]
Returns: LogicalPlan
Parent Class: SerdeContext
|
method
|
deserialize_logical_plan_list
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_logical_plan_list
|
Deserialize a list of logical plans with field path tracking.
Args:
field_name: The name of the field being deserialized.
plan_proto_list: The list of protobuf representations to deserialize.
Returns:
A list of deserialized logical plans.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 444 | 466 | null |
List[LogicalPlan]
|
[
"self",
"field_name",
"plan_proto_list"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_logical_plan_list
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_logical_plan_list
Docstring: Deserialize a list of logical plans with field path tracking.
Args:
field_name: The name of the field being deserialized.
plan_proto_list: The list of protobuf representations to deserialize.
Returns:
A list of deserialized logical plans.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "plan_proto_list"]
Returns: List[LogicalPlan]
Parent Class: SerdeContext
|
method
|
serialize_data_type
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_data_type
|
Serialize a data type with field path tracking.
Args:
field_name: The name of the field being serialized.
data_type: The data type to serialize.
Returns:
The serialized protobuf representation of the data type.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 468 | 486 | null |
DataTypeProto
|
[
"self",
"field_name",
"data_type"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_data_type
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_data_type
Docstring: Serialize a data type with field path tracking.
Args:
field_name: The name of the field being serialized.
data_type: The data type to serialize.
Returns:
The serialized protobuf representation of the data type.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "data_type"]
Returns: DataTypeProto
Parent Class: SerdeContext
|
method
|
deserialize_data_type
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_data_type
|
Deserialize a data type with field path tracking.
Args:
field_name: The name of the field being deserialized.
data_type_proto: The protobuf representation to deserialize.
Returns:
The deserialized data type.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 488 | 506 | null |
Optional[DataType]
|
[
"self",
"field_name",
"data_type_proto"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_data_type
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_data_type
Docstring: Deserialize a data type with field path tracking.
Args:
field_name: The name of the field being deserialized.
data_type_proto: The protobuf representation to deserialize.
Returns:
The deserialized data type.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "data_type_proto"]
Returns: Optional[DataType]
Parent Class: SerdeContext
|
method
|
serialize_resolved_model_alias
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_resolved_model_alias
|
Serialize a resolved model alias.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 511 | 526 | null |
ResolvedModelAliasProto
|
[
"self",
"field_name",
"model_alias"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_resolved_model_alias
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_resolved_model_alias
Docstring: Serialize a resolved model alias.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "model_alias"]
Returns: ResolvedModelAliasProto
Parent Class: SerdeContext
|
method
|
deserialize_resolved_model_alias
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_resolved_model_alias
|
Deserialize a resolved model alias.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 528 | 545 | null |
ResolvedModelAlias
|
[
"self",
"field_name",
"model_alias_proto"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_resolved_model_alias
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_resolved_model_alias
Docstring: Deserialize a resolved model alias.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "model_alias_proto"]
Returns: ResolvedModelAlias
Parent Class: SerdeContext
|
method
|
serialize_resolved_class_definition
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_resolved_class_definition
|
Serialize a resolved class definition.
Args:
field_name: The name of the field being serialized.
class_definition: The resolved class definition to serialize.
Returns:
The serialized protobuf representation of the class definition.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 547 | 568 | null |
ResolvedClassDefinitionProto
|
[
"self",
"field_name",
"class_definition"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_resolved_class_definition
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_resolved_class_definition
Docstring: Serialize a resolved class definition.
Args:
field_name: The name of the field being serialized.
class_definition: The resolved class definition to serialize.
Returns:
The serialized protobuf representation of the class definition.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "class_definition"]
Returns: ResolvedClassDefinitionProto
Parent Class: SerdeContext
|
method
|
deserialize_resolved_class_definition
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_resolved_class_definition
|
Deserialize a resolved class definition.
Args:
field_name: The name of the field being deserialized.
class_definition_proto: The protobuf representation to deserialize.
Returns:
The deserialized resolved class definition.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 570 | 595 | null |
Optional[ResolvedClassDefinition]
|
[
"self",
"field_name",
"class_definition_proto"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_resolved_class_definition
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_resolved_class_definition
Docstring: Deserialize a resolved class definition.
Args:
field_name: The name of the field being deserialized.
class_definition_proto: The protobuf representation to deserialize.
Returns:
The deserialized resolved class definition.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "class_definition_proto"]
Returns: Optional[ResolvedClassDefinition]
Parent Class: SerdeContext
|
method
|
serialize_resolved_response_format
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_resolved_response_format
|
Serialize a ResolvedResponseFormat to a protobuf model.
Args:
field_name: The name of the field being serialized.
resolved_response_format: The ResolvedResponseFormat to serialize.
Returns:
The serialized protobuf representation containing the JSON schema.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 597 | 621 | null |
ResolvedResponseFormatProto
|
[
"self",
"field_name",
"resolved_response_format"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_resolved_response_format
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_resolved_response_format
Docstring: Serialize a ResolvedResponseFormat to a protobuf model.
Args:
field_name: The name of the field being serialized.
resolved_response_format: The ResolvedResponseFormat to serialize.
Returns:
The serialized protobuf representation containing the JSON schema.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "resolved_response_format"]
Returns: ResolvedResponseFormatProto
Parent Class: SerdeContext
|
method
|
deserialize_resolved_response_format
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_resolved_response_format
|
Deserialize a ResolvedResponseFormat from a protobuf model.
Args:
field_name: The name of the field being deserialized.
resolved_response_format_proto: The protobuf representation to deserialize.
Returns:
The deserialized Pydantic model type, or None if empty.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 623 | 647 | null |
Optional[ResolvedResponseFormat]
|
[
"self",
"field_name",
"resolved_response_format_proto"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_resolved_response_format
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_resolved_response_format
Docstring: Deserialize a ResolvedResponseFormat from a protobuf model.
Args:
field_name: The name of the field being deserialized.
resolved_response_format_proto: The protobuf representation to deserialize.
Returns:
The deserialized Pydantic model type, or None if empty.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "resolved_response_format_proto"]
Returns: Optional[ResolvedResponseFormat]
Parent Class: SerdeContext
|
method
|
serialize_numpy_array
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_numpy_array
|
Serialize a numpy array.
Args:
field_name: The name of the field being serialized.
array: The numpy array to serialize.
Returns:
The serialized protobuf representation of the numpy array.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 649 | 669 | null |
NumpyArrayProto
|
[
"self",
"field_name",
"array"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_numpy_array
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_numpy_array
Docstring: Serialize a numpy array.
Args:
field_name: The name of the field being serialized.
array: The numpy array to serialize.
Returns:
The serialized protobuf representation of the numpy array.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "array"]
Returns: NumpyArrayProto
Parent Class: SerdeContext
|
method
|
deserialize_numpy_array
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_numpy_array
|
Deserialize a numpy array.
Args:
field_name: The name of the field being deserialized.
serialized_array: The protobuf representation to deserialize.
Returns:
The deserialized numpy array.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 671 | 690 | null |
np.ndarray
|
[
"self",
"field_name",
"serialized_array"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_numpy_array
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_numpy_array
Docstring: Deserialize a numpy array.
Args:
field_name: The name of the field being deserialized.
serialized_array: The protobuf representation to deserialize.
Returns:
The deserialized numpy array.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "serialized_array"]
Returns: np.ndarray
Parent Class: SerdeContext
|
method
|
serialize_scalar_value
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_scalar_value
|
Serialize a Python value to ScalarValue oneof.
Supports primitive types (str, int, float, bool, bytes), arrays, and structs.
Recursively serializes nested structures.
Args:
field_name: The name of the field being serialized.
value: The Python value to serialize.
Returns:
The serialized protobuf representation of the scalar value.
Raises:
SerializationError: If the value type is not supported or is None.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 692 | 749 | null |
ScalarValueProto
|
[
"self",
"field_name",
"value"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_scalar_value
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_scalar_value
Docstring: Serialize a Python value to ScalarValue oneof.
Supports primitive types (str, int, float, bool, bytes), arrays, and structs.
Recursively serializes nested structures.
Args:
field_name: The name of the field being serialized.
value: The Python value to serialize.
Returns:
The serialized protobuf representation of the scalar value.
Raises:
SerializationError: If the value type is not supported or is None.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "value"]
Returns: ScalarValueProto
Parent Class: SerdeContext
|
method
|
deserialize_scalar_value
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_scalar_value
|
Deserialize a ScalarValue oneof to Python value.
Supports primitive types (str, int, float, bool, bytes), arrays, and structs.
Recursively deserializes nested structures.
Args:
field_name: The name of the field being deserialized.
scalar_value: The protobuf representation to deserialize.
Returns:
The deserialized Python value.
Raises:
DeserializationError: If the value type is unknown or unsupported.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 751 | 804 | null |
Any
|
[
"self",
"field_name",
"scalar_value"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_scalar_value
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_scalar_value
Docstring: Deserialize a ScalarValue oneof to Python value.
Supports primitive types (str, int, float, bool, bytes), arrays, and structs.
Recursively deserializes nested structures.
Args:
field_name: The name of the field being deserialized.
scalar_value: The protobuf representation to deserialize.
Returns:
The deserialized Python value.
Raises:
DeserializationError: If the value type is unknown or unsupported.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name", "scalar_value"]
Returns: Any
Parent Class: SerdeContext
|
method
|
serialize_fenic_schema
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_fenic_schema
|
Serialize a Fenic schema.
Args:
schema: The Fenic schema to serialize.
field_name: The name of the field being serialized.
Returns:
The serialized protobuf representation of the schema.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 806 | 834 | null |
FenicSchemaProto
|
[
"self",
"schema",
"field_name"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_fenic_schema
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_fenic_schema
Docstring: Serialize a Fenic schema.
Args:
schema: The Fenic schema to serialize.
field_name: The name of the field being serialized.
Returns:
The serialized protobuf representation of the schema.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "schema", "field_name"]
Returns: FenicSchemaProto
Parent Class: SerdeContext
|
method
|
deserialize_fenic_schema
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_fenic_schema
|
Deserialize a Fenic schema.
Args:
schema_proto: The protobuf representation to deserialize.
field_name: The name of the field being deserialized.
Returns:
The deserialized Fenic schema.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 836 | 862 | null |
Schema
|
[
"self",
"schema_proto",
"field_name"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_fenic_schema
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_fenic_schema
Docstring: Deserialize a Fenic schema.
Args:
schema_proto: The protobuf representation to deserialize.
field_name: The name of the field being deserialized.
Returns:
The deserialized Fenic schema.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "schema_proto", "field_name"]
Returns: Schema
Parent Class: SerdeContext
|
method
|
serialize_tool_parameter
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_tool_parameter
|
Serialize a ToolParameter.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 864 | 888 | null |
ToolParameterProto
|
[
"self",
"tool_param",
"field_name"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_tool_parameter
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_tool_parameter
Docstring: Serialize a ToolParameter.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "tool_param", "field_name"]
Returns: ToolParameterProto
Parent Class: SerdeContext
|
method
|
deserialize_tool_parameter
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_tool_parameter
|
Deserialize a ToolParameter.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 890 | 913 | null |
BoundToolParam
|
[
"self",
"tool_param_proto",
"field_name"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_tool_parameter
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_tool_parameter
Docstring: Deserialize a ToolParameter.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "tool_param_proto", "field_name"]
Returns: BoundToolParam
Parent Class: SerdeContext
|
method
|
serialize_tool_definition
|
fenic.core._serde.proto.serde_context.SerdeContext.serialize_tool_definition
| null |
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 915 | 934 | null |
ToolDefinitionProto
|
[
"self",
"tool_definition",
"field_name"
] |
SerdeContext
| null | null |
Type: method
Member Name: serialize_tool_definition
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.serialize_tool_definition
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "tool_definition", "field_name"]
Returns: ToolDefinitionProto
Parent Class: SerdeContext
|
method
|
deserialize_tool_definition
|
fenic.core._serde.proto.serde_context.SerdeContext.deserialize_tool_definition
|
Deserialize a ToolDefinition.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 936 | 953 | null |
ParameterizedToolDefinition
|
[
"self",
"tool_definition_proto",
"field_name"
] |
SerdeContext
| null | null |
Type: method
Member Name: deserialize_tool_definition
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext.deserialize_tool_definition
Docstring: Deserialize a ToolDefinition.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "tool_definition_proto", "field_name"]
Returns: ParameterizedToolDefinition
Parent Class: SerdeContext
|
function
|
create_serde_context
|
fenic.core._serde.proto.serde_context.create_serde_context
|
Create a new SerdeContext instance.
This is the preferred way to get a context for serde operations.
Each context is independent and can be used concurrently.
Returns:
A new SerdeContext instance ready for serde operations.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 956 | 965 | null |
SerdeContext
|
[] | null | null | null |
Type: function
Member Name: create_serde_context
Qualified Name: fenic.core._serde.proto.serde_context.create_serde_context
Docstring: Create a new SerdeContext instance.
This is the preferred way to get a context for serde operations.
Each context is independent and can be used concurrently.
Returns:
A new SerdeContext instance ready for serde operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: []
Returns: SerdeContext
Parent Class: none
|
class
|
PathTracker
|
fenic.core._serde.proto.serde_context.PathTracker
|
Path tracker for serde operations.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 968 | 991 | null | null | null | null | null |
[] |
Type: class
Member Name: PathTracker
Qualified Name: fenic.core._serde.proto.serde_context.PathTracker
Docstring: Path tracker for serde operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__init__
|
fenic.core._serde.proto.serde_context.PathTracker.__init__
|
Initialize a PathTracker.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 971 | 973 | null | null |
[
"self"
] |
PathTracker
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core._serde.proto.serde_context.PathTracker.__init__
Docstring: Initialize a PathTracker.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: PathTracker
|
method
|
push
|
fenic.core._serde.proto.serde_context.PathTracker.push
|
Push a field name onto the path stack.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 980 | 982 | null |
None
|
[
"self",
"field_name"
] |
PathTracker
| null | null |
Type: method
Member Name: push
Qualified Name: fenic.core._serde.proto.serde_context.PathTracker.push
Docstring: Push a field name onto the path stack.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "field_name"]
Returns: None
Parent Class: PathTracker
|
method
|
pop
|
fenic.core._serde.proto.serde_context.PathTracker.pop
|
Pop the last field name from the path stack.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 984 | 987 | null |
None
|
[
"self"
] |
PathTracker
| null | null |
Type: method
Member Name: pop
Qualified Name: fenic.core._serde.proto.serde_context.PathTracker.pop
Docstring: Pop the last field name from the path stack.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: None
Parent Class: PathTracker
|
method
|
clear
|
fenic.core._serde.proto.serde_context.PathTracker.clear
|
Clear the entire path stack.
|
site-packages/fenic/core/_serde/proto/serde_context.py
| true | false | 989 | 991 | null |
None
|
[
"self"
] |
PathTracker
| null | null |
Type: method
Member Name: clear
Qualified Name: fenic.core._serde.proto.serde_context.PathTracker.clear
Docstring: Clear the entire path stack.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: None
Parent Class: PathTracker
|
module
|
types
|
fenic.core._serde.proto.types
|
Protobuf type imports with Proto suffix for use in serialization.
This module imports all generated protobuf classes with a 'Proto' suffix
to avoid naming conflicts with the Python classes they serialize.
|
site-packages/fenic/core/_serde/proto/types.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: types
Qualified Name: fenic.core._serde.proto.types
Docstring: Protobuf type imports with Proto suffix for use in serialization.
This module imports all generated protobuf classes with a 'Proto' suffix
to avoid naming conflicts with the Python classes they serialize.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
attribute
|
__all__
|
fenic.core._serde.proto.types.__all__
| null |
site-packages/fenic/core/_serde/proto/types.py
| false | false | 444 | 600 | null | null | null | null |
['DataTypeProto', 'StringTypeProto', 'IntegerTypeProto', 'FloatTypeProto', 'DoubleTypeProto', 'BooleanTypeProto', 'ArrayTypeProto', 'StructTypeProto', 'StructFieldProto', 'EmbeddingTypeProto', 'TranscriptTypeProto', 'DocumentPathTypeProto', 'MarkdownTypeProto', 'HTMLTypeProto', 'JSONTypeProto', 'OperatorProto', 'ChunkLengthFunctionProto', 'ChunkCharacterSetProto', 'NumpyArrayProto', 'KeyPointsProto', 'ParagraphProto', 'SummarizationFormatProto', 'MapExampleProto', 'MapExampleCollectionProto', 'ClassifyExampleProto', 'ClassifyExampleCollectionProto', 'PredicateExampleProto', 'PredicateExampleCollectionProto', 'JoinExampleProto', 'JoinExampleCollectionProto', 'ResolvedClassDefinitionProto', 'ResolvedModelAliasProto', 'ResolvedResponseFormatProto', 'UnresolvedLiteralExprProto', 'LogicalExprProto', 'ColumnExprProto', 'LiteralExprProto', 'ScalarValueProto', 'ScalarArrayProto', 'ScalarStructProto', 'ScalarStructFieldProto', 'AliasExprProto', 'SortExprProto', 'IndexExprProto', 'ArrayExprProto', 'StructExprProto', 'CastExprProto', 'NotExprProto', 'CoalesceExprProto', 'InExprProto', 'IsNullExprProto', 'ArrayLengthExprProto', 'ArrayContainsExprProto', 'GreatestExprProto', 'LeastExprProto', 'ArithmeticExprProto', 'BooleanExprProto', 'NumericComparisonExprProto', 'EqualityComparisonExprProto', 'SemanticMapExprProto', 'SemanticExtractExprProto', 'SemanticPredExprProto', 'SemanticReduceExprProto', 'SemanticClassifyExprProto', 'AnalyzeSentimentExprProto', 'EmbeddingsExprProto', 'SemanticSummarizeExprProto', 'EmbeddingNormalizeExprProto', 'EmbeddingSimilarityExprProto', 'TextractExprProto', 'TextChunkExprProto', 'RecursiveTextChunkExprProto', 'CountTokensExprProto', 'ConcatExprProto', 'ArrayJoinExprProto', 'ContainsExprProto', 'ContainsAnyExprProto', 'RLikeExprProto', 'LikeExprProto', 'ILikeExprProto', 'TsParseExprProto', 'StartsWithExprProto', 'EndsWithExprProto', 'RegexpSplitExprProto', 'SplitPartExprProto', 'StringCasingExprProto', 'StripCharsExprProto', 'ReplaceExprProto', 'StrLengthExprProto', 'ByteLengthExprProto', 'JinjaExprProto', 'FuzzyRatioExprProto', 'FuzzySimilarityMethodProto', 'FuzzyTokenSortRatioExprProto', 'FuzzyTokenSetRatioExprProto', 'JqExprProto', 'JsonTypeExprProto', 'JsonContainsExprProto', 'MdToJsonExprProto', 'MdGetCodeBlocksExprProto', 'MdGenerateTocExprProto', 'MdExtractHeaderChunksProto', 'WhenExprProto', 'OtherwiseExprProto', 'SumExprProto', 'AvgExprProto', 'CountExprProto', 'MaxExprProto', 'MinExprProto', 'FirstExprProto', 'ListExprProto', 'StdDevExprProto', 'LogicalPlanProto', 'FenicSchemaProto', 'ColumnFieldProto', 'CacheInfoProto', 'InMemorySourceProto', 'FileSourceProto', 'TableSourceProto', 'DocSourceProto', 'ProjectionProto', 'FilterProto', 'JoinProto', 'AggregateProto', 'UnionProto', 'LimitProto', 'ExplodeProto', 'DropDuplicatesProto', 'SortProto', 'UnnestProto', 'SQLProto', 'SemanticClusterProto', 'SemanticJoinProto', 'SemanticSimilarityJoinProto', 'FileSinkProto', 'TableSinkProto', 'ToolParameterProto', 'ToolDefinitionProto']
| null |
Type: attribute
Member Name: __all__
Qualified Name: fenic.core._serde.proto.types.__all__
Docstring: none
Value: ['DataTypeProto', 'StringTypeProto', 'IntegerTypeProto', 'FloatTypeProto', 'DoubleTypeProto', 'BooleanTypeProto', 'ArrayTypeProto', 'StructTypeProto', 'StructFieldProto', 'EmbeddingTypeProto', 'TranscriptTypeProto', 'DocumentPathTypeProto', 'MarkdownTypeProto', 'HTMLTypeProto', 'JSONTypeProto', 'OperatorProto', 'ChunkLengthFunctionProto', 'ChunkCharacterSetProto', 'NumpyArrayProto', 'KeyPointsProto', 'ParagraphProto', 'SummarizationFormatProto', 'MapExampleProto', 'MapExampleCollectionProto', 'ClassifyExampleProto', 'ClassifyExampleCollectionProto', 'PredicateExampleProto', 'PredicateExampleCollectionProto', 'JoinExampleProto', 'JoinExampleCollectionProto', 'ResolvedClassDefinitionProto', 'ResolvedModelAliasProto', 'ResolvedResponseFormatProto', 'UnresolvedLiteralExprProto', 'LogicalExprProto', 'ColumnExprProto', 'LiteralExprProto', 'ScalarValueProto', 'ScalarArrayProto', 'ScalarStructProto', 'ScalarStructFieldProto', 'AliasExprProto', 'SortExprProto', 'IndexExprProto', 'ArrayExprProto', 'StructExprProto', 'CastExprProto', 'NotExprProto', 'CoalesceExprProto', 'InExprProto', 'IsNullExprProto', 'ArrayLengthExprProto', 'ArrayContainsExprProto', 'GreatestExprProto', 'LeastExprProto', 'ArithmeticExprProto', 'BooleanExprProto', 'NumericComparisonExprProto', 'EqualityComparisonExprProto', 'SemanticMapExprProto', 'SemanticExtractExprProto', 'SemanticPredExprProto', 'SemanticReduceExprProto', 'SemanticClassifyExprProto', 'AnalyzeSentimentExprProto', 'EmbeddingsExprProto', 'SemanticSummarizeExprProto', 'EmbeddingNormalizeExprProto', 'EmbeddingSimilarityExprProto', 'TextractExprProto', 'TextChunkExprProto', 'RecursiveTextChunkExprProto', 'CountTokensExprProto', 'ConcatExprProto', 'ArrayJoinExprProto', 'ContainsExprProto', 'ContainsAnyExprProto', 'RLikeExprProto', 'LikeExprProto', 'ILikeExprProto', 'TsParseExprProto', 'StartsWithExprProto', 'EndsWithExprProto', 'RegexpSplitExprProto', 'SplitPartExprProto', 'StringCasingExprProto', 'StripCharsExprProto', 'ReplaceExprProto', 'StrLengthExprProto', 'ByteLengthExprProto', 'JinjaExprProto', 'FuzzyRatioExprProto', 'FuzzySimilarityMethodProto', 'FuzzyTokenSortRatioExprProto', 'FuzzyTokenSetRatioExprProto', 'JqExprProto', 'JsonTypeExprProto', 'JsonContainsExprProto', 'MdToJsonExprProto', 'MdGetCodeBlocksExprProto', 'MdGenerateTocExprProto', 'MdExtractHeaderChunksProto', 'WhenExprProto', 'OtherwiseExprProto', 'SumExprProto', 'AvgExprProto', 'CountExprProto', 'MaxExprProto', 'MinExprProto', 'FirstExprProto', 'ListExprProto', 'StdDevExprProto', 'LogicalPlanProto', 'FenicSchemaProto', 'ColumnFieldProto', 'CacheInfoProto', 'InMemorySourceProto', 'FileSourceProto', 'TableSourceProto', 'DocSourceProto', 'ProjectionProto', 'FilterProto', 'JoinProto', 'AggregateProto', 'UnionProto', 'LimitProto', 'ExplodeProto', 'DropDuplicatesProto', 'SortProto', 'UnnestProto', 'SQLProto', 'SemanticClusterProto', 'SemanticJoinProto', 'SemanticSimilarityJoinProto', 'FileSinkProto', 'TableSinkProto', 'ToolParameterProto', 'ToolDefinitionProto']
Annotation: none
is Public? : false
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
module
|
enum_serde
|
fenic.core._serde.proto.enum_serde
|
Enum serialization/deserialization. Handles the serialization of enums to and from protobuf ints.
|
site-packages/fenic/core/_serde/proto/enum_serde.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: enum_serde
Qualified Name: fenic.core._serde.proto.enum_serde
Docstring: Enum serialization/deserialization. Handles the serialization of enums to and from protobuf ints.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
function
|
serialize_enum_value
|
fenic.core._serde.proto.enum_serde.serialize_enum_value
|
Serialize an enum value to the protobuf int representation.
This function uses singledispatch to handle different enum types. If the enum names
are 1:1 matches to the proto enum names, this auto-serde function can be used.
Otherwise, define a `_serialize_<type>` function below to add custom enum mappings.
Args:
value: The enum value to serialize.
target_proto: The protobuf enum type wrapper containing the target enum values.
context: The serde context for error reporting and path tracking.
Returns:
int: The protobuf int representation of the enum value.
Raises:
SerializationError: If the enum value does not have a corresponding protobuf value.
|
site-packages/fenic/core/_serde/proto/enum_serde.py
| true | false | 13 | 43 | null |
int
|
[
"value",
"target_proto",
"context"
] | null | null | null |
Type: function
Member Name: serialize_enum_value
Qualified Name: fenic.core._serde.proto.enum_serde.serialize_enum_value
Docstring: Serialize an enum value to the protobuf int representation.
This function uses singledispatch to handle different enum types. If the enum names
are 1:1 matches to the proto enum names, this auto-serde function can be used.
Otherwise, define a `_serialize_<type>` function below to add custom enum mappings.
Args:
value: The enum value to serialize.
target_proto: The protobuf enum type wrapper containing the target enum values.
context: The serde context for error reporting and path tracking.
Returns:
int: The protobuf int representation of the enum value.
Raises:
SerializationError: If the enum value does not have a corresponding protobuf value.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["value", "target_proto", "context"]
Returns: int
Parent Class: none
|
function
|
deserialize_enum_value
|
fenic.core._serde.proto.enum_serde.deserialize_enum_value
|
Deserialize an enum value from its protobuf int representation.
This function uses singledispatch to handle different enum types. If the enum names
are 1:1 matches to the proto enum names, this auto-serde function can be used.
Otherwise, define a `_deserialize_<type>` function below to add custom enum mappings.
Args:
target_type: The target enum type to deserialize to.
proto_enum_type: The protobuf enum type wrapper containing the source enum values.
_serialized_value: The protobuf int representation of the enum value.
context: The serde context for error reporting and path tracking.
Returns:
Optional[EnumType]: The deserialized enum value
Raises:
DeserializationError: If the protobuf enum name is not present in the target enum type.
|
site-packages/fenic/core/_serde/proto/enum_serde.py
| true | false | 46 | 90 | null |
Optional[Enum]
|
[
"target_type",
"proto_enum_type",
"_serialized_value",
"context"
] | null | null | null |
Type: function
Member Name: deserialize_enum_value
Qualified Name: fenic.core._serde.proto.enum_serde.deserialize_enum_value
Docstring: Deserialize an enum value from its protobuf int representation.
This function uses singledispatch to handle different enum types. If the enum names
are 1:1 matches to the proto enum names, this auto-serde function can be used.
Otherwise, define a `_deserialize_<type>` function below to add custom enum mappings.
Args:
target_type: The target enum type to deserialize to.
proto_enum_type: The protobuf enum type wrapper containing the source enum values.
_serialized_value: The protobuf int representation of the enum value.
context: The serde context for error reporting and path tracking.
Returns:
Optional[EnumType]: The deserialized enum value
Raises:
DeserializationError: If the protobuf enum name is not present in the target enum type.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["target_type", "proto_enum_type", "_serialized_value", "context"]
Returns: Optional[Enum]
Parent Class: none
|
module
|
datatype_serde
|
fenic.core._serde.proto.datatype_serde
|
Data type serialization/deserialization using singledispatch.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: datatype_serde
Qualified Name: fenic.core._serde.proto.datatype_serde
Docstring: Data type serialization/deserialization using singledispatch.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
function
|
serialize_data_type
|
fenic.core._serde.proto.datatype_serde.serialize_data_type
|
Serialize a data type to its protobuf representation.
This function uses singledispatch to handle different data type classes.
Each data type class should have a corresponding register function that
implements the specific serialization logic.
Args:
data_type: The data type to serialize. Must be a registered type.
context: The serde context for error reporting and path tracking.
Returns:
DataTypeProto: The serialized protobuf representation of the data type.
Raises:
SerializationError: If the data type is not registered or serialization fails.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| true | false | 60 | 82 | null |
DataTypeProto
|
[
"data_type",
"context"
] | null | null | null |
Type: function
Member Name: serialize_data_type
Qualified Name: fenic.core._serde.proto.datatype_serde.serialize_data_type
Docstring: Serialize a data type to its protobuf representation.
This function uses singledispatch to handle different data type classes.
Each data type class should have a corresponding register function that
implements the specific serialization logic.
Args:
data_type: The data type to serialize. Must be a registered type.
context: The serde context for error reporting and path tracking.
Returns:
DataTypeProto: The serialized protobuf representation of the data type.
Raises:
SerializationError: If the data type is not registered or serialization fails.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["data_type", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
deserialize_data_type
|
fenic.core._serde.proto.datatype_serde.deserialize_data_type
|
Deserialize a data type from its protobuf representation.
This function determines which oneof field is set in the DataTypeProto
and delegates to the appropriate deserialization helper function.
Args:
data_type_proto: The protobuf representation to deserialize.
context: The serde context for error reporting and path tracking.
Returns:
DataType: The deserialized data type.
Raises:
DeserializationError: If the protobuf is empty or deserialization fails.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| true | false | 85 | 108 | null |
DataType
|
[
"data_type_proto",
"context"
] | null | null | null |
Type: function
Member Name: deserialize_data_type
Qualified Name: fenic.core._serde.proto.datatype_serde.deserialize_data_type
Docstring: Deserialize a data type from its protobuf representation.
This function determines which oneof field is set in the DataTypeProto
and delegates to the appropriate deserialization helper function.
Args:
data_type_proto: The protobuf representation to deserialize.
context: The serde context for error reporting and path tracking.
Returns:
DataType: The deserialized data type.
Raises:
DeserializationError: If the protobuf is empty or deserialization fails.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["data_type_proto", "context"]
Returns: DataType
Parent Class: none
|
function
|
_deserialize_data_type_helper
|
fenic.core._serde.proto.datatype_serde._deserialize_data_type_helper
|
Deserialize a data type from its underlying protobuf message.
This function uses singledispatch to handle different protobuf message types.
Each protobuf message type should have a corresponding register function that
implements the specific deserialization logic.
Args:
underlying_proto: The underlying protobuf message to deserialize.
context: The serde context for error reporting and path tracking.
Returns:
DataType: The deserialized data type.
Raises:
DeserializationError: If the protobuf type is not registered or deserialization fails.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 111 | 135 | null |
DataType
|
[
"underlying_proto",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_data_type_helper
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_data_type_helper
Docstring: Deserialize a data type from its underlying protobuf message.
This function uses singledispatch to handle different protobuf message types.
Each protobuf message type should have a corresponding register function that
implements the specific deserialization logic.
Args:
underlying_proto: The underlying protobuf message to deserialize.
context: The serde context for error reporting and path tracking.
Returns:
DataType: The deserialized data type.
Raises:
DeserializationError: If the protobuf type is not registered or deserialization fails.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["underlying_proto", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_string_type
|
fenic.core._serde.proto.datatype_serde._serialize_string_type
|
Serialize a string type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 143 | 146 | null |
DataTypeProto
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_string_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_string_type
Docstring: Serialize a string type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_string_type
|
fenic.core._serde.proto.datatype_serde._deserialize_string_type
|
Deserialize a string type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 149 | 152 | null |
DataType
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_string_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_string_type
Docstring: Deserialize a string type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_integer_type
|
fenic.core._serde.proto.datatype_serde._serialize_integer_type
|
Serialize an integer type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 160 | 163 | null |
DataTypeProto
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_integer_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_integer_type
Docstring: Serialize an integer type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_integer_type
|
fenic.core._serde.proto.datatype_serde._deserialize_integer_type
|
Deserialize an integer type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 166 | 169 | null |
DataType
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_integer_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_integer_type
Docstring: Deserialize an integer type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_float_type
|
fenic.core._serde.proto.datatype_serde._serialize_float_type
|
Serialize a float type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 177 | 180 | null |
DataTypeProto
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_float_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_float_type
Docstring: Serialize a float type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_float_type
|
fenic.core._serde.proto.datatype_serde._deserialize_float_type
|
Deserialize a float type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 183 | 186 | null |
DataType
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_float_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_float_type
Docstring: Deserialize a float type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_double_type
|
fenic.core._serde.proto.datatype_serde._serialize_double_type
|
Serialize a double type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 194 | 197 | null |
DataTypeProto
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_double_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_double_type
Docstring: Serialize a double type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_double_type
|
fenic.core._serde.proto.datatype_serde._deserialize_double_type
|
Deserialize a double type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 200 | 203 | null |
DataType
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_double_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_double_type
Docstring: Deserialize a double type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_boolean_type
|
fenic.core._serde.proto.datatype_serde._serialize_boolean_type
|
Serialize a boolean type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 211 | 214 | null |
DataTypeProto
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_boolean_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_boolean_type
Docstring: Serialize a boolean type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_boolean_type
|
fenic.core._serde.proto.datatype_serde._deserialize_boolean_type
|
Deserialize a boolean type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 217 | 220 | null |
DataType
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_boolean_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_boolean_type
Docstring: Deserialize a boolean type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_array_type
|
fenic.core._serde.proto.datatype_serde._serialize_array_type
|
Serialize an array type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 228 | 236 | null |
DataTypeProto
|
[
"array_type",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_array_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_array_type
Docstring: Serialize an array type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["array_type", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_array_type
|
fenic.core._serde.proto.datatype_serde._deserialize_array_type
|
Deserialize an array type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 239 | 247 | null |
DataType
|
[
"array_proto",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_array_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_array_type
Docstring: Deserialize an array type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["array_proto", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_struct_type
|
fenic.core._serde.proto.datatype_serde._serialize_struct_type
|
Serialize a struct type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 255 | 268 | null |
DataTypeProto
|
[
"struct_type",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_struct_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_struct_type
Docstring: Serialize a struct type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["struct_type", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_struct_type
|
fenic.core._serde.proto.datatype_serde._deserialize_struct_type
|
Deserialize a struct type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 271 | 284 | null |
DataType
|
[
"struct_proto",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_struct_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_struct_type
Docstring: Deserialize a struct type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["struct_proto", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_embedding_type
|
fenic.core._serde.proto.datatype_serde._serialize_embedding_type
|
Serialize an embedding type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 292 | 302 | null |
DataTypeProto
|
[
"embedding_type",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_embedding_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_embedding_type
Docstring: Serialize an embedding type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["embedding_type", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_embedding_type
|
fenic.core._serde.proto.datatype_serde._deserialize_embedding_type
|
Deserialize an embedding type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 305 | 313 | null |
DataType
|
[
"embedding_proto",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_embedding_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_embedding_type
Docstring: Deserialize an embedding type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["embedding_proto", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_transcript_type
|
fenic.core._serde.proto.datatype_serde._serialize_transcript_type
|
Serialize a transcript type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 321 | 326 | null |
DataTypeProto
|
[
"transcript_type",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_transcript_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_transcript_type
Docstring: Serialize a transcript type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["transcript_type", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_transcript_type
|
fenic.core._serde.proto.datatype_serde._deserialize_transcript_type
|
Deserialize a transcript type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 329 | 334 | null |
DataType
|
[
"transcript_proto",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_transcript_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_transcript_type
Docstring: Deserialize a transcript type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["transcript_proto", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_document_path_type
|
fenic.core._serde.proto.datatype_serde._serialize_document_path_type
|
Serialize a document path type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 342 | 349 | null |
DataTypeProto
|
[
"document_path_type",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_document_path_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_document_path_type
Docstring: Serialize a document path type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["document_path_type", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_document_path_type
|
fenic.core._serde.proto.datatype_serde._deserialize_document_path_type
|
Deserialize a document path type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 352 | 357 | null |
DataType
|
[
"document_path_proto",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_document_path_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_document_path_type
Docstring: Deserialize a document path type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["document_path_proto", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_markdown_type
|
fenic.core._serde.proto.datatype_serde._serialize_markdown_type
|
Serialize a markdown type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 365 | 368 | null |
DataTypeProto
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_markdown_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_markdown_type
Docstring: Serialize a markdown type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_markdown_type
|
fenic.core._serde.proto.datatype_serde._deserialize_markdown_type
|
Deserialize a markdown type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 371 | 374 | null |
DataType
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_markdown_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_markdown_type
Docstring: Deserialize a markdown type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_html_type
|
fenic.core._serde.proto.datatype_serde._serialize_html_type
|
Serialize an HTML type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 382 | 385 | null |
DataTypeProto
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_html_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_html_type
Docstring: Serialize an HTML type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_html_type
|
fenic.core._serde.proto.datatype_serde._deserialize_html_type
|
Deserialize an HTML type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 388 | 391 | null |
DataType
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_html_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_html_type
Docstring: Deserialize an HTML type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataType
Parent Class: none
|
function
|
_serialize_json_type
|
fenic.core._serde.proto.datatype_serde._serialize_json_type
|
Serialize a JSON type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 399 | 402 | null |
DataTypeProto
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_json_type
Qualified Name: fenic.core._serde.proto.datatype_serde._serialize_json_type
Docstring: Serialize a JSON type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataTypeProto
Parent Class: none
|
function
|
_deserialize_json_type
|
fenic.core._serde.proto.datatype_serde._deserialize_json_type
|
Deserialize a JSON type.
|
site-packages/fenic/core/_serde/proto/datatype_serde.py
| false | true | 405 | 408 | null |
DataType
|
[
"_",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_json_type
Qualified Name: fenic.core._serde.proto.datatype_serde._deserialize_json_type
Docstring: Deserialize a JSON type.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["_", "context"]
Returns: DataType
Parent Class: none
|
module
|
errors
|
fenic.core._serde.proto.errors
|
Errors for the proto serde module.
|
site-packages/fenic/core/_serde/proto/errors.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: errors
Qualified Name: fenic.core._serde.proto.errors
Docstring: Errors for the proto serde module.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
class
|
SerdeError
|
fenic.core._serde.proto.errors.SerdeError
|
Base exception for serialization/deserialization errors.
All serde-specific exceptions inherit from this class. Provides
consistent error handling with optional path and type information.
|
site-packages/fenic/core/_serde/proto/errors.py
| true | false | 8 | 15 | null | null | null | null | null |
[
"Exception"
] |
Type: class
Member Name: SerdeError
Qualified Name: fenic.core._serde.proto.errors.SerdeError
Docstring: Base exception for serialization/deserialization errors.
All serde-specific exceptions inherit from this class. Provides
consistent error handling with optional path and type information.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
class
|
DeserializationError
|
fenic.core._serde.proto.errors.DeserializationError
|
Errors during deserialization from protobuf format.
|
site-packages/fenic/core/_serde/proto/errors.py
| true | false | 18 | 39 | null | null | null | null | null |
[
"SerdeError"
] |
Type: class
Member Name: DeserializationError
Qualified Name: fenic.core._serde.proto.errors.DeserializationError
Docstring: Errors during deserialization from protobuf format.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__init__
|
fenic.core._serde.proto.errors.DeserializationError.__init__
|
Initialize a DeserializationError.
Args:
message: The error message.
object_type: Optional type information for the error.
field_path: Optional field path where the error occurred.
|
site-packages/fenic/core/_serde/proto/errors.py
| true | false | 21 | 39 | null | null |
[
"self",
"message",
"object_type",
"field_path"
] |
DeserializationError
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core._serde.proto.errors.DeserializationError.__init__
Docstring: Initialize a DeserializationError.
Args:
message: The error message.
object_type: Optional type information for the error.
field_path: Optional field path where the error occurred.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "message", "object_type", "field_path"]
Returns: none
Parent Class: DeserializationError
|
class
|
SerializationError
|
fenic.core._serde.proto.errors.SerializationError
|
Errors during serialization to protobuf format.
|
site-packages/fenic/core/_serde/proto/errors.py
| true | false | 42 | 63 | null | null | null | null | null |
[
"SerdeError"
] |
Type: class
Member Name: SerializationError
Qualified Name: fenic.core._serde.proto.errors.SerializationError
Docstring: Errors during serialization to protobuf format.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__init__
|
fenic.core._serde.proto.errors.SerializationError.__init__
|
Initialize a SerializationError.
Args:
message: The error message.
object_type: Optional type information for the error.
field_path: Optional field path where the error occurred.
|
site-packages/fenic/core/_serde/proto/errors.py
| true | false | 45 | 63 | null | null |
[
"self",
"message",
"object_type",
"field_path"
] |
SerializationError
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core._serde.proto.errors.SerializationError.__init__
Docstring: Initialize a SerializationError.
Args:
message: The error message.
object_type: Optional type information for the error.
field_path: Optional field path where the error occurred.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "message", "object_type", "field_path"]
Returns: none
Parent Class: SerializationError
|
class
|
UnsupportedTypeError
|
fenic.core._serde.proto.errors.UnsupportedTypeError
|
Errors for unsupported types.
|
site-packages/fenic/core/_serde/proto/errors.py
| true | false | 65 | 86 | null | null | null | null | null |
[
"SerdeError"
] |
Type: class
Member Name: UnsupportedTypeError
Qualified Name: fenic.core._serde.proto.errors.UnsupportedTypeError
Docstring: Errors for unsupported types.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
method
|
__init__
|
fenic.core._serde.proto.errors.UnsupportedTypeError.__init__
|
Initialize an UnsupportedType error.
Args:
reason: The reason why the type is unsupported.
object_type: The unsupported type.
field_path: Optional field path where the error occurred.
|
site-packages/fenic/core/_serde/proto/errors.py
| true | false | 68 | 86 | null | null |
[
"self",
"reason",
"object_type",
"field_path"
] |
UnsupportedTypeError
| null | null |
Type: method
Member Name: __init__
Qualified Name: fenic.core._serde.proto.errors.UnsupportedTypeError.__init__
Docstring: Initialize an UnsupportedType error.
Args:
reason: The reason why the type is unsupported.
object_type: The unsupported type.
field_path: Optional field path where the error occurred.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "reason", "object_type", "field_path"]
Returns: none
Parent Class: UnsupportedTypeError
|
module
|
expression_serde
|
fenic.core._serde.proto.expression_serde
|
Expression serialization/deserialization using singledispatch.
This module provides the main dispatch functions for expression serialization.
The actual serialization implementations are organized in the expressions/ subdirectory.
|
site-packages/fenic/core/_serde/proto/expression_serde.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: expression_serde
Qualified Name: fenic.core._serde.proto.expression_serde
Docstring: Expression serialization/deserialization using singledispatch.
This module provides the main dispatch functions for expression serialization.
The actual serialization implementations are organized in the expressions/ subdirectory.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
function
|
serialize_logical_expr
|
fenic.core._serde.proto.expression_serde.serialize_logical_expr
|
Serialize a logical expression to protobuf format.
This function uses singledispatch to handle different logical expression types.
Each expression type should have a corresponding register function that implements
the specific serialization logic.
Args:
logical: The logical expression to serialize.
context: The serde context for error reporting and path tracking.
Returns:
LogicalExprProto: The serialized protobuf representation.
Raises:
SerializationError: If the expression type is not registered or serialization fails.
|
site-packages/fenic/core/_serde/proto/expression_serde.py
| true | false | 21 | 47 | null |
LogicalExprProto
|
[
"logical",
"context"
] | null | null | null |
Type: function
Member Name: serialize_logical_expr
Qualified Name: fenic.core._serde.proto.expression_serde.serialize_logical_expr
Docstring: Serialize a logical expression to protobuf format.
This function uses singledispatch to handle different logical expression types.
Each expression type should have a corresponding register function that implements
the specific serialization logic.
Args:
logical: The logical expression to serialize.
context: The serde context for error reporting and path tracking.
Returns:
LogicalExprProto: The serialized protobuf representation.
Raises:
SerializationError: If the expression type is not registered or serialization fails.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["logical", "context"]
Returns: LogicalExprProto
Parent Class: none
|
function
|
deserialize_logical_expr
|
fenic.core._serde.proto.expression_serde.deserialize_logical_expr
|
Deserialize a logical expression from protobuf format.
This function determines which oneof field is set in the LogicalExprProto
and delegates to the appropriate deserialization helper function.
Args:
logical_proto: The protobuf representation to deserialize.
context: The serde context for error reporting and path tracking.
Returns:
LogicalExpr: The deserialized logical expression, or None if empty.
Raises:
DeserializationError: If the protobuf is invalid or deserialization fails.
|
site-packages/fenic/core/_serde/proto/expression_serde.py
| true | false | 50 | 73 | null |
Optional[LogicalExpr]
|
[
"logical_proto",
"context"
] | null | null | null |
Type: function
Member Name: deserialize_logical_expr
Qualified Name: fenic.core._serde.proto.expression_serde.deserialize_logical_expr
Docstring: Deserialize a logical expression from protobuf format.
This function determines which oneof field is set in the LogicalExprProto
and delegates to the appropriate deserialization helper function.
Args:
logical_proto: The protobuf representation to deserialize.
context: The serde context for error reporting and path tracking.
Returns:
LogicalExpr: The deserialized logical expression, or None if empty.
Raises:
DeserializationError: If the protobuf is invalid or deserialization fails.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["logical_proto", "context"]
Returns: Optional[LogicalExpr]
Parent Class: none
|
function
|
_deserialize_logical_expr_helper
|
fenic.core._serde.proto.expression_serde._deserialize_logical_expr_helper
|
Deserialize a logical expression helper.
The actual deserialization implementations are registered in the expressions/ submodules.
|
site-packages/fenic/core/_serde/proto/expression_serde.py
| false | true | 76 | 87 | null |
LogicalExpr
|
[
"logical_proto",
"context"
] | null | null | null |
Type: function
Member Name: _deserialize_logical_expr_helper
Qualified Name: fenic.core._serde.proto.expression_serde._deserialize_logical_expr_helper
Docstring: Deserialize a logical expression helper.
The actual deserialization implementations are registered in the expressions/ submodules.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["logical_proto", "context"]
Returns: LogicalExpr
Parent Class: none
|
module
|
plans
|
fenic.core._serde.proto.plans
|
Plan serialization/deserialization modules.
This module organizes plan serde functions according to the same structure
as the logical plan modules in _logical_plan/plans.
|
site-packages/fenic/core/_serde/proto/plans/__init__.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: plans
Qualified Name: fenic.core._serde.proto.plans
Docstring: Plan serialization/deserialization modules.
This module organizes plan serde functions according to the same structure
as the logical plan modules in _logical_plan/plans.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
module
|
aggregate
|
fenic.core._serde.proto.plans.aggregate
|
Aggregate plan serialization/deserialization.
|
site-packages/fenic/core/_serde/proto/plans/aggregate.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: aggregate
Qualified Name: fenic.core._serde.proto.plans.aggregate
Docstring: Aggregate plan serialization/deserialization.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
function
|
_serialize_aggregate
|
fenic.core._serde.proto.plans.aggregate._serialize_aggregate
|
Serialize an aggregate (wrapper).
|
site-packages/fenic/core/_serde/proto/plans/aggregate.py
| false | true | 17 | 29 | null |
LogicalPlanProto
|
[
"aggregate",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_aggregate
Qualified Name: fenic.core._serde.proto.plans.aggregate._serialize_aggregate
Docstring: Serialize an aggregate (wrapper).
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["aggregate", "context"]
Returns: LogicalPlanProto
Parent Class: none
|
function
|
_deserialize_aggregate
|
fenic.core._serde.proto.plans.aggregate._deserialize_aggregate
|
Deserialize an Aggregate LogicalPlan Node.
|
site-packages/fenic/core/_serde/proto/plans/aggregate.py
| false | true | 32 | 44 | null |
Aggregate
|
[
"aggregate",
"context",
"schema"
] | null | null | null |
Type: function
Member Name: _deserialize_aggregate
Qualified Name: fenic.core._serde.proto.plans.aggregate._deserialize_aggregate
Docstring: Deserialize an Aggregate LogicalPlan Node.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["aggregate", "context", "schema"]
Returns: Aggregate
Parent Class: none
|
module
|
sink
|
fenic.core._serde.proto.plans.sink
|
Sink plan serialization/deserialization.
|
site-packages/fenic/core/_serde/proto/plans/sink.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: sink
Qualified Name: fenic.core._serde.proto.plans.sink
Docstring: Sink plan serialization/deserialization.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
function
|
_serialize_file_sink
|
fenic.core._serde.proto.plans.sink._serialize_file_sink
|
Serialize a file sink (wrapper).
|
site-packages/fenic/core/_serde/proto/plans/sink.py
| false | true | 21 | 33 | null |
LogicalPlanProto
|
[
"file_sink",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_file_sink
Qualified Name: fenic.core._serde.proto.plans.sink._serialize_file_sink
Docstring: Serialize a file sink (wrapper).
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["file_sink", "context"]
Returns: LogicalPlanProto
Parent Class: none
|
function
|
_deserialize_file_sink
|
fenic.core._serde.proto.plans.sink._deserialize_file_sink
|
Deserialize a FileSink LogicalPlan Node.
|
site-packages/fenic/core/_serde/proto/plans/sink.py
| false | true | 36 | 47 | null |
FileSink
|
[
"file_sink",
"context",
"schema"
] | null | null | null |
Type: function
Member Name: _deserialize_file_sink
Qualified Name: fenic.core._serde.proto.plans.sink._deserialize_file_sink
Docstring: Deserialize a FileSink LogicalPlan Node.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["file_sink", "context", "schema"]
Returns: FileSink
Parent Class: none
|
function
|
_serialize_table_sink
|
fenic.core._serde.proto.plans.sink._serialize_table_sink
|
Serialize a table sink (wrapper).
|
site-packages/fenic/core/_serde/proto/plans/sink.py
| false | true | 55 | 66 | null |
LogicalPlanProto
|
[
"table_sink",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_table_sink
Qualified Name: fenic.core._serde.proto.plans.sink._serialize_table_sink
Docstring: Serialize a table sink (wrapper).
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["table_sink", "context"]
Returns: LogicalPlanProto
Parent Class: none
|
function
|
_deserialize_table_sink
|
fenic.core._serde.proto.plans.sink._deserialize_table_sink
|
Deserialize a TableSink LogicalPlan Node.
|
site-packages/fenic/core/_serde/proto/plans/sink.py
| false | true | 69 | 78 | null | null |
[
"table_sink",
"context",
"schema"
] | null | null | null |
Type: function
Member Name: _deserialize_table_sink
Qualified Name: fenic.core._serde.proto.plans.sink._deserialize_table_sink
Docstring: Deserialize a TableSink LogicalPlan Node.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["table_sink", "context", "schema"]
Returns: none
Parent Class: none
|
module
|
join
|
fenic.core._serde.proto.plans.join
|
Join plan serialization/deserialization.
|
site-packages/fenic/core/_serde/proto/plans/join.py
| true | false | null | null | null | null | null | null | null | null |
Type: module
Member Name: join
Qualified Name: fenic.core._serde.proto.plans.join
Docstring: Join plan serialization/deserialization.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none
|
function
|
_serialize_join
|
fenic.core._serde.proto.plans.join._serialize_join
|
Serialize a join (wrapper).
|
site-packages/fenic/core/_serde/proto/plans/join.py
| false | true | 32 | 43 | null |
LogicalPlanProto
|
[
"join",
"context"
] | null | null | null |
Type: function
Member Name: _serialize_join
Qualified Name: fenic.core._serde.proto.plans.join._serialize_join
Docstring: Serialize a join (wrapper).
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["join", "context"]
Returns: LogicalPlanProto
Parent Class: none
|
function
|
_deserialize_join
|
fenic.core._serde.proto.plans.join._deserialize_join
|
Deserialize a Join LogicalPlan Node.
|
site-packages/fenic/core/_serde/proto/plans/join.py
| false | true | 46 | 56 | null |
Join
|
[
"join",
"context",
"schema"
] | null | null | null |
Type: function
Member Name: _deserialize_join
Qualified Name: fenic.core._serde.proto.plans.join._deserialize_join
Docstring: Deserialize a Join LogicalPlan Node.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["join", "context", "schema"]
Returns: Join
Parent Class: none
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.