type stringclasses 5
values | name stringlengths 1 55 | qualified_name stringlengths 5 147 | docstring stringlengths 15 4.52k ⌀ | filepath stringclasses 206
values | is_public bool 2
classes | is_private bool 2
classes | line_start int64 0 1.99k ⌀ | line_end int64 0 2.01k ⌀ | annotation stringclasses 14
values | returns stringclasses 308
values | value stringclasses 152
values | parameters listlengths 0 117 ⌀ | bases listlengths 0 3 ⌀ | parent_class stringclasses 376
values | api_element_summary stringlengths 199 33.8k |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
attribute | __all__ | fenic.core.mcp.__all__ | null | null | false | false | 9 | 15 | null | null | ['BoundToolParam', 'UserDefinedTool', 'SystemTool', 'ToolParam'] | null | null | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.core.mcp.__all__
Docstring: none
Value: ['BoundToolParam', 'UserDefinedTool', 'SystemTool', 'ToolParam']
Annotation: none
is Public? : false
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | _binder | fenic.core.mcp._binder | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/mcp/_binder.py | false | true | null | null | null | null | null | null | null | null | Type: module
Member Name: _binder
Qualified Name: fenic.core.mcp._binder
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
function | collect_unresolved_parameters | fenic.core.mcp._binder.collect_unresolved_parameters | Return the set of parameter names referenced by UnresolvedLiteralExpr in the plan. | null | true | false | 18 | 21 | null | dict[str, UnresolvedLiteralExpr] | null | [
"plan"
] | null | null | Type: function
Member Name: collect_unresolved_parameters
Qualified Name: fenic.core.mcp._binder.collect_unresolved_parameters
Docstring: Return the set of parameter names referenced by UnresolvedLiteralExpr in the plan.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["plan"]
Returns: di... |
function | bind_parameters | fenic.core.mcp._binder.bind_parameters | Bind provided params into a LogicalPlan by replacing placeholder literals.
- Replaces every UnresolvedLiteralExpr with a LiteralExpr(value, data_type)
- Raises PlanError if any placeholder parameter is missing in params
- Raises TypeMismatchError if provided value does not match placeholder data_type
- Operates in-pla... | null | true | false | 24 | 128 | null | LogicalPlan | null | [
"plan",
"params",
"tool_params"
] | null | null | Type: function
Member Name: bind_parameters
Qualified Name: fenic.core.mcp._binder.bind_parameters
Docstring: Bind provided params into a LogicalPlan by replacing placeholder literals.
- Replaces every UnresolvedLiteralExpr with a LiteralExpr(value, data_type)
- Raises PlanError if any placeholder parameter is missing... |
module | _tools | fenic.core.mcp._tools | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/mcp/_tools.py | false | true | null | null | null | null | null | null | null | null | Type: module
Member Name: _tools
Qualified Name: fenic.core.mcp._tools
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
attribute | LIMIT_DESCRIPTION | fenic.core.mcp._tools.LIMIT_DESCRIPTION | null | null | true | false | 23 | 23 | null | null | 'The number of rows to return in the result set. Omit to return the maximum number of rows allowed by the tool.' | null | null | null | Type: attribute
Member Name: LIMIT_DESCRIPTION
Qualified Name: fenic.core.mcp._tools.LIMIT_DESCRIPTION
Docstring: none
Value: 'The number of rows to return in the result set. Omit to return the maximum number of rows allowed by the tool.'
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: ... |
attribute | TABLE_FORMAT_DESCRIPTION | fenic.core.mcp._tools.TABLE_FORMAT_DESCRIPTION | null | null | true | false | 24 | 24 | null | null | 'The format of the table to return in the response. If `structured`, the rows will be returned as a list of JSON objects. If `markdown`, the rows will be returned as a markdown-formatted table.' | null | null | null | Type: attribute
Member Name: TABLE_FORMAT_DESCRIPTION
Qualified Name: fenic.core.mcp._tools.TABLE_FORMAT_DESCRIPTION
Docstring: none
Value: 'The format of the table to return in the response. If `structured`, the rows will be returned as a list of JSON objects. If `markdown`, the rows will be returned as a markdown-for... |
attribute | logger | fenic.core.mcp._tools.logger | null | null | true | false | 26 | 26 | null | null | logging.getLogger(__name__) | null | null | null | Type: attribute
Member Name: logger
Qualified Name: fenic.core.mcp._tools.logger
Docstring: none
Value: logging.getLogger(__name__)
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
function | bind_tool | fenic.core.mcp._tools.bind_tool | Create a tool from a query and a set of parameters.
Raises PlanError if the logical plan contains unresolved parameters that are not in the tool parameters. | null | true | false | 28 | 98 | null | UserDefinedTool | null | [
"name",
"description",
"params",
"result_limit",
"query"
] | null | null | Type: function
Member Name: bind_tool
Qualified Name: fenic.core.mcp._tools.bind_tool
Docstring: Create a tool from a query and a set of parameters.
Raises PlanError if the logical plan contains unresolved parameters that are not in the tool parameters.
Value: none
Annotation: none
is Public? : true
is Private? : fals... |
function | create_pydantic_model_for_tool | fenic.core.mcp._tools.create_pydantic_model_for_tool | Create a Pydantic model for a tool. | null | true | false | 101 | 137 | null | type[BaseModel] | null | [
"tool"
] | null | null | Type: function
Member Name: create_pydantic_model_for_tool
Qualified Name: fenic.core.mcp._tools.create_pydantic_model_for_tool
Docstring: Create a Pydantic model for a tool.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["tool"]
Returns: type[BaseModel]
Parent Class: none |
module | types | fenic.core.mcp.types | Exported Types related to Parameterized View/MCP Tool Generation. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/mcp/types.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: types
Qualified Name: fenic.core.mcp.types
Docstring: Exported Types related to Parameterized View/MCP Tool Generation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | ToolParameterType | fenic.core.mcp.types.ToolParameterType | null | null | true | false | 13 | 13 | null | null | Union[str, int, float, bool, list, dict] | null | null | null | Type: attribute
Member Name: ToolParameterType
Qualified Name: fenic.core.mcp.types.ToolParameterType
Docstring: none
Value: Union[str, int, float, bool, list, dict]
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | TableFormat | fenic.core.mcp.types.TableFormat | null | null | true | false | 14 | 14 | null | null | Literal['structured', 'markdown'] | null | null | null | Type: attribute
Member Name: TableFormat
Qualified Name: fenic.core.mcp.types.TableFormat
Docstring: none
Value: Literal['structured', 'markdown']
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | ToolParam | fenic.core.mcp.types.ToolParam | A parameter for a parameterized view tool.
A parameter is a named value that can be passed to a tool. These are matched to the
parameter names of the `tool_param` UnresolvedLiteralExpr expressions captured in the Logical Plan.
Attributes:
name: The name of the parameter.
description: The description of the pa... | null | true | false | 17 | 50 | null | null | null | null | [
"BaseModel"
] | null | Type: class
Member Name: ToolParam
Qualified Name: fenic.core.mcp.types.ToolParam
Docstring: A parameter for a parameterized view tool.
A parameter is a named value that can be passed to a tool. These are matched to the
parameter names of the `tool_param` UnresolvedLiteralExpr expressions captured in the Logical Plan.... |
method | _check_default_value | fenic.core.mcp.types.ToolParam._check_default_value | null | null | false | true | 36 | 41 | null | null | null | [
"self"
] | null | ToolParam | Type: method
Member Name: _check_default_value
Qualified Name: fenic.core.mcp.types.ToolParam._check_default_value
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self"]
Returns: none
Parent Class: ToolParam |
class | BoundToolParam | fenic.core.mcp.types.BoundToolParam | A bound tool parameter.
A bound tool parameter is a parameter that has been bound to a specific, typed,
`tool_param` usage within a Dataframe. | null | true | false | 53 | 66 | null | null | null | null | [] | null | Type: class
Member Name: BoundToolParam
Qualified Name: fenic.core.mcp.types.BoundToolParam
Docstring: A bound tool parameter.
A bound tool parameter is a parameter that has been bound to a specific, typed,
`tool_param` usage within a Dataframe.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parame... |
class | UserDefinedTool | fenic.core.mcp.types.UserDefinedTool | A tool that has been bound to a specific Parameterized View. | null | true | false | 69 | 76 | null | null | null | null | [] | null | Type: class
Member Name: UserDefinedTool
Qualified Name: fenic.core.mcp.types.UserDefinedTool
Docstring: A tool that has been bound to a specific Parameterized View.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | SystemTool | fenic.core.mcp.types.SystemTool | A tool implemented as a regular Python function with explicit parameters.
The function must be a `Callable[..., LogicalPlan]`
(a function defined with `async def`). Collection/formatting is handled by
the MCP generator wrapper. | null | true | false | 79 | 96 | null | null | null | null | [] | null | Type: class
Member Name: SystemTool
Qualified Name: fenic.core.mcp.types.SystemTool
Docstring: A tool implemented as a regular Python function with explicit parameters.
The function must be a `Callable[..., LogicalPlan]`
(a function defined with `async def`). Collection/formatting is handled by
the MCP generator wrapp... |
module | _server | fenic.core.mcp._server | MCP server and tool integration for Fenic.
This module exposes a small wrapper that registers Tool Definitions
with FastMCP, collects results, and formats them as table-like output
for model consumption. FastMCP is an optional dependency.
Install with:
pip install "fenic[mcp]"
# or
pip install fastmcp | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/mcp/_server.py | false | true | null | null | null | null | null | null | null | null | Type: module
Member Name: _server
Qualified Name: fenic.core.mcp._server
Docstring: MCP server and tool integration for Fenic.
This module exposes a small wrapper that registers Tool Definitions
with FastMCP, collects results, and formats them as table-like output
for model consumption. FastMCP is an optional dependen... |
attribute | logger | fenic.core.mcp._server.logger | null | null | true | false | 45 | 45 | null | null | logging.getLogger(__name__) | null | null | null | Type: attribute
Member Name: logger
Qualified Name: fenic.core.mcp._server.logger
Docstring: none
Value: logging.getLogger(__name__)
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | MCPResultSet | fenic.core.mcp._server.MCPResultSet | Structured result returned to the MCP client. | null | true | false | 47 | 54 | null | null | null | null | [
"BaseModel"
] | null | Type: class
Member Name: MCPResultSet
Qualified Name: fenic.core.mcp._server.MCPResultSet
Docstring: Structured result returned to the MCP client.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | MCPTransport | fenic.core.mcp._server.MCPTransport | null | null | true | false | 56 | 56 | null | null | Literal['http', 'stdio'] | null | null | null | Type: attribute
Member Name: MCPTransport
Qualified Name: fenic.core.mcp._server.MCPTransport
Docstring: none
Value: Literal['http', 'stdio']
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | FenicMCPServer | fenic.core.mcp._server.FenicMCPServer | Register Fenic tools and serve them via FastMCP. | null | true | false | 58 | 331 | null | null | null | null | [] | null | Type: class
Member Name: FenicMCPServer
Qualified Name: fenic.core.mcp._server.FenicMCPServer
Docstring: Register Fenic tools and serve them via FastMCP.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic.core.mcp._server.FenicMCPServer.__init__ | Initialize the server with a Fenic session state and tool list.
Args:
session_state: Fenic session state to use for tool execution.
user_defined_tools: List of user-created tools
system_tools: List of auto-generated tools
server_name: Name of the MCP server.
concurrency_limit: Maximum number of con... | null | true | false | 61 | 113 | null | null | null | [
"self",
"session_state",
"user_defined_tools",
"system_tools",
"server_name",
"concurrency_limit"
] | null | FenicMCPServer | Type: method
Member Name: __init__
Qualified Name: fenic.core.mcp._server.FenicMCPServer.__init__
Docstring: Initialize the server with a Fenic session state and tool list.
Args:
session_state: Fenic session state to use for tool execution.
user_defined_tools: List of user-created tools
system_tools: List ... |
method | run_async | fenic.core.mcp._server.FenicMCPServer.run_async | Run the MCP server asynchronously.
Args:
transport: Transport protocol to use (http, stdio).
kwargs: Additional transport-specific arguments to pass to FastMCP. | null | true | false | 115 | 124 | null | null | null | [
"self",
"transport",
"kwargs"
] | null | FenicMCPServer | Type: method
Member Name: run_async
Qualified Name: fenic.core.mcp._server.FenicMCPServer.run_async
Docstring: Run the MCP server asynchronously.
Args:
transport: Transport protocol to use (http, stdio).
kwargs: Additional transport-specific arguments to pass to FastMCP.
Value: none
Annotation: none
is Public?... |
method | run | fenic.core.mcp._server.FenicMCPServer.run | Run the MCP server. This is a synchronous function.
Args:
transport: Transport protocol to use (http, stdio).
kwargs: Additional transport-specific arguments to pass to FastMCP. | null | true | false | 126 | 135 | null | null | null | [
"self",
"transport",
"kwargs"
] | null | FenicMCPServer | Type: method
Member Name: run
Qualified Name: fenic.core.mcp._server.FenicMCPServer.run
Docstring: Run the MCP server. This is a synchronous function.
Args:
transport: Transport protocol to use (http, stdio).
kwargs: Additional transport-specific arguments to pass to FastMCP.
Value: none
Annotation: none
is Pu... |
method | http_app | fenic.core.mcp._server.FenicMCPServer.http_app | Create a Starlette ASGI app for the MCP server. | null | true | false | 137 | 139 | null | null | null | [
"self",
"kwargs"
] | null | FenicMCPServer | Type: method
Member Name: http_app
Qualified Name: fenic.core.mcp._server.FenicMCPServer.http_app
Docstring: Create a Starlette ASGI app for the MCP server.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "kwargs"]
Returns: none
Parent Class: FenicMCPServer |
method | _handle_result_set | fenic.core.mcp._server.FenicMCPServer._handle_result_set | Handle the result set from a logical plan. | null | false | true | 141 | 170 | null | MCPResultSet | null | [
"self",
"plan",
"pl_df",
"effective_limit",
"table_format"
] | null | FenicMCPServer | Type: method
Member Name: _handle_result_set
Qualified Name: fenic.core.mcp._server.FenicMCPServer._handle_result_set
Docstring: Handle the result set from a logical plan.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "plan", "pl_df", "effective_limit", "table_format"]
Returns:... |
method | _build_user_defined_tool | fenic.core.mcp._server.FenicMCPServer._build_user_defined_tool | Build a keyword-argument tool function with per-field schema for FastMCP.
We still validate/coerce using a generated Pydantic model under the hood,
but expose individual keyword-only parameters in the function signature so
FastMCP generates a clean per-argument schema (no single params model). | null | false | true | 172 | 266 | null | Callable[..., Coroutine[Any, Any, MCPResultSet]] | null | [
"self",
"tool_definition"
] | null | FenicMCPServer | Type: method
Member Name: _build_user_defined_tool
Qualified Name: fenic.core.mcp._server.FenicMCPServer._build_user_defined_tool
Docstring: Build a keyword-argument tool function with per-field schema for FastMCP.
We still validate/coerce using a generated Pydantic model under the hood,
but expose individual keyword-... |
method | _build_system_tool | fenic.core.mcp._server.FenicMCPServer._build_system_tool | null | null | false | true | 268 | 331 | null | Callable[[...], Coroutine[Any, Any, MCPResultSet]] | null | [
"self",
"tool_definition"
] | null | FenicMCPServer | Type: method
Member Name: _build_system_tool
Qualified Name: fenic.core.mcp._server.FenicMCPServer._build_system_tool
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "tool_definition"]
Returns: Callable[[...], Coroutine[Any, Any, MCPResultSet]]
Parent Class: Fenic... |
function | _expose_keyword_param | fenic.core.mcp._server._expose_keyword_param | null | null | false | true | 336 | 365 | null | None | null | [
"param_name",
"wrapped",
"py_type",
"description",
"default_value"
] | null | null | Type: function
Member Name: _expose_keyword_param
Qualified Name: fenic.core.mcp._server._expose_keyword_param
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["param_name", "wrapped", "py_type", "description", "default_value"]
Returns: None
Parent Class: none |
function | _type_for_param | fenic.core.mcp._server._type_for_param | null | null | false | true | 368 | 385 | null | type | null | [
"p"
] | null | null | Type: function
Member Name: _type_for_param
Qualified Name: fenic.core.mcp._server._type_for_param
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["p"]
Returns: type
Parent Class: none |
function | _annotate_with_description | fenic.core.mcp._server._annotate_with_description | null | null | false | true | 387 | 390 | null | null | null | [
"base_ann",
"description"
] | null | null | Type: function
Member Name: _annotate_with_description
Qualified Name: fenic.core.mcp._server._annotate_with_description
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["base_ann", "description"]
Returns: none
Parent Class: none |
function | _render_markdown_preview | fenic.core.mcp._server._render_markdown_preview | null | null | false | true | 392 | 401 | null | str | null | [
"rows"
] | null | null | Type: function
Member Name: _render_markdown_preview
Qualified Name: fenic.core.mcp._server._render_markdown_preview
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["rows"]
Returns: str
Parent Class: none |
function | _calculate_effective_limit | fenic.core.mcp._server._calculate_effective_limit | null | null | false | true | 403 | 416 | null | Optional[int] | null | [
"tool",
"requested_limit"
] | null | null | Type: function
Member Name: _calculate_effective_limit
Qualified Name: fenic.core.mcp._server._calculate_effective_limit
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["tool", "requested_limit"]
Returns: Optional[int]
Parent Class: none |
module | _serde | fenic.core._serde | LogicalPlan serialization implementations. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/_serde/__init__.py | false | true | null | null | null | null | null | null | null | null | Type: module
Member Name: _serde
Qualified Name: fenic.core._serde
Docstring: LogicalPlan serialization implementations.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.core._serde.__all__ | null | null | false | false | 7 | 7 | null | null | ['CloudPickleSerde', 'LogicalPlanSerde', 'ProtoSerde'] | null | null | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.core._serde.__all__
Docstring: none
Value: ['CloudPickleSerde', 'LogicalPlanSerde', 'ProtoSerde']
Annotation: none
is Public? : false
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | serde_protocol | fenic.core._serde.serde_protocol | Protocol for serialization/deserialization of LogicalPlan objects. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/_serde/serde_protocol.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: serde_protocol
Qualified Name: fenic.core._serde.serde_protocol
Docstring: Protocol for serialization/deserialization of LogicalPlan objects.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | SupportsLogicalPlanSerde | fenic.core._serde.serde_protocol.SupportsLogicalPlanSerde | Protocol for LogicalPlan serialization. | null | true | false | 10 | 38 | null | null | null | null | [
"Protocol"
] | null | Type: class
Member Name: SupportsLogicalPlanSerde
Qualified Name: fenic.core._serde.serde_protocol.SupportsLogicalPlanSerde
Docstring: Protocol for LogicalPlan serialization.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | serialize | fenic.core._serde.serde_protocol.SupportsLogicalPlanSerde.serialize | Serialize a LogicalPlan to bytes.
Removes any local session state refs from the plan.
Args:
plan: The LogicalPlan to serialize
Returns:
bytes: The serialized plan | null | true | false | 14 | 26 | null | bytes | null | [
"plan"
] | null | SupportsLogicalPlanSerde | Type: method
Member Name: serialize
Qualified Name: fenic.core._serde.serde_protocol.SupportsLogicalPlanSerde.serialize
Docstring: Serialize a LogicalPlan to bytes.
Removes any local session state refs from the plan.
Args:
plan: The LogicalPlan to serialize
Returns:
bytes: The serialized plan
Value: none
Ann... |
method | deserialize | fenic.core._serde.serde_protocol.SupportsLogicalPlanSerde.deserialize | Deserialize bytes back into a LogicalPlan.
Args:
data: The serialized plan data
Returns:
The deserialized plan | null | true | false | 28 | 38 | null | LogicalPlan | null | [
"data"
] | null | SupportsLogicalPlanSerde | Type: method
Member Name: deserialize
Qualified Name: fenic.core._serde.serde_protocol.SupportsLogicalPlanSerde.deserialize
Docstring: Deserialize bytes back into a LogicalPlan.
Args:
data: The serialized plan data
Returns:
The deserialized plan
Value: none
Annotation: none
is Public? : true
is Private? : fal... |
module | cloudpickle_serde | fenic.core._serde.cloudpickle_serde | CloudPickle-based implementation of LogicalPlan serialization. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/_serde/cloudpickle_serde.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: cloudpickle_serde
Qualified Name: fenic.core._serde.cloudpickle_serde
Docstring: CloudPickle-based implementation of LogicalPlan serialization.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | CloudPickleSerde | fenic.core._serde.cloudpickle_serde.CloudPickleSerde | CloudPickle-based LogicalPlan serialization implementation. | null | true | false | 13 | 39 | null | null | null | null | [
"SupportsLogicalPlanSerde"
] | null | Type: class
Member Name: CloudPickleSerde
Qualified Name: fenic.core._serde.cloudpickle_serde.CloudPickleSerde
Docstring: CloudPickle-based LogicalPlan serialization implementation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | serialize | fenic.core._serde.cloudpickle_serde.CloudPickleSerde.serialize | Serialize a LogicalPlan to bytes using cloudpickle.
Args:
plan: The LogicalPlan to serialize
Returns:
bytes: The serialized plan | null | true | false | 16 | 26 | null | bytes | null | [
"plan"
] | null | CloudPickleSerde | Type: method
Member Name: serialize
Qualified Name: fenic.core._serde.cloudpickle_serde.CloudPickleSerde.serialize
Docstring: Serialize a LogicalPlan to bytes using cloudpickle.
Args:
plan: The LogicalPlan to serialize
Returns:
bytes: The serialized plan
Value: none
Annotation: none
is Public? : true
is Priva... |
method | deserialize | fenic.core._serde.cloudpickle_serde.CloudPickleSerde.deserialize | Deserialize bytes back into a LogicalPlan using cloudpickle.
Args:
data: The serialized plan data
Returns:
The deserialized plan | null | true | false | 28 | 39 | null | LogicalPlan | null | [
"data"
] | null | CloudPickleSerde | Type: method
Member Name: deserialize
Qualified Name: fenic.core._serde.cloudpickle_serde.CloudPickleSerde.deserialize
Docstring: Deserialize bytes back into a LogicalPlan using cloudpickle.
Args:
data: The serialized plan data
Returns:
The deserialized plan
Value: none
Annotation: none
is Public? : true
is P... |
module | serde | fenic.core._serde.serde | LogicalPlan serialization with pluggable backends. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/_serde/serde.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: serde
Qualified Name: fenic.core._serde.serde
Docstring: LogicalPlan serialization with pluggable backends.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | _default_serde_type | fenic.core._serde.serde._default_serde_type | null | null | false | true | 13 | 13 | null | null | ProtoSerde | null | null | null | Type: attribute
Member Name: _default_serde_type
Qualified Name: fenic.core._serde.serde._default_serde_type
Docstring: none
Value: ProtoSerde
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
class | LogicalPlanSerde | fenic.core._serde.serde.LogicalPlanSerde | Facade for LogicalPlan serialization with pluggable backends. | null | true | false | 16 | 32 | null | null | null | null | [
"SupportsLogicalPlanSerde"
] | null | Type: class
Member Name: LogicalPlanSerde
Qualified Name: fenic.core._serde.serde.LogicalPlanSerde
Docstring: Facade for LogicalPlan serialization with pluggable backends.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | serialize | fenic.core._serde.serde.LogicalPlanSerde.serialize | Serialize a LogicalPlan to bytes. | null | true | false | 21 | 24 | null | bytes | null | [
"cls",
"plan"
] | null | LogicalPlanSerde | Type: method
Member Name: serialize
Qualified Name: fenic.core._serde.serde.LogicalPlanSerde.serialize
Docstring: Serialize a LogicalPlan to bytes.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "plan"]
Returns: bytes
Parent Class: LogicalPlanSerde |
method | deserialize | fenic.core._serde.serde.LogicalPlanSerde.deserialize | Deserialize a LogicalPlan from bytes. | null | true | false | 26 | 32 | null | LogicalPlan | null | [
"cls",
"serialized_plan"
] | null | LogicalPlanSerde | Type: method
Member Name: deserialize
Qualified Name: fenic.core._serde.serde.LogicalPlanSerde.deserialize
Docstring: Deserialize a LogicalPlan from bytes.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "serialized_plan"]
Returns: LogicalPlan
Parent Class: LogicalPlanSerde |
module | proto | fenic.core._serde.proto | null | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/_serde/proto/__init__.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: proto
Qualified Name: fenic.core._serde.proto
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | proto_serde | fenic.core._serde.proto.proto_serde | Main API for logical plan and expression serialization/deserialization. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/_serde/proto/proto_serde.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: proto_serde
Qualified Name: fenic.core._serde.proto.proto_serde
Docstring: Main API for logical plan and expression serialization/deserialization.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | ProtoSerde | fenic.core._serde.proto.proto_serde.ProtoSerde | Proto Serde implementation.
This implementation uses the Protobuf specs defined in the `protos` package to serialize
and deserialize logical plans. Provides the main API for converting between LogicalPlan
objects and their binary protobuf representation. | null | true | false | 11 | 52 | null | null | null | null | [
"SupportsLogicalPlanSerde"
] | null | Type: class
Member Name: ProtoSerde
Qualified Name: fenic.core._serde.proto.proto_serde.ProtoSerde
Docstring: Proto Serde implementation.
This implementation uses the Protobuf specs defined in the `protos` package to serialize
and deserialize logical plans. Provides the main API for converting between LogicalPlan
obje... |
method | serialize | fenic.core._serde.proto.proto_serde.ProtoSerde.serialize | Serialize a logical plan to binary protobuf format.
Args:
logical_plan: The logical plan to serialize.
Returns:
Binary protobuf representation of the logical plan. | null | true | false | 22 | 34 | null | bytes | null | [
"cls",
"logical_plan"
] | null | ProtoSerde | Type: method
Member Name: serialize
Qualified Name: fenic.core._serde.proto.proto_serde.ProtoSerde.serialize
Docstring: Serialize a logical plan to binary protobuf format.
Args:
logical_plan: The logical plan to serialize.
Returns:
Binary protobuf representation of the logical plan.
Value: none
Annotation: no... |
method | deserialize | fenic.core._serde.proto.proto_serde.ProtoSerde.deserialize | Deserialize a logical plan from binary protobuf format.
Args:
data: Binary protobuf data to deserialize.
Returns:
The deserialized logical plan. | null | true | false | 36 | 52 | null | LogicalPlan | null | [
"cls",
"data"
] | null | ProtoSerde | Type: method
Member Name: deserialize
Qualified Name: fenic.core._serde.proto.proto_serde.ProtoSerde.deserialize
Docstring: Deserialize a logical plan from binary protobuf format.
Args:
data: Binary protobuf data to deserialize.
Returns:
The deserialized logical plan.
Value: none
Annotation: none
is Public? :... |
module | plan_serde | fenic.core._serde.proto.plan_serde | Logical plan serialization/deserialization using singledispatch.
This module provides the main dispatch functions for plan serialization.
The actual serialization implementations are organized in the plans/ subdirectory. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/_serde/proto/plan_serde.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: plan_serde
Qualified Name: fenic.core._serde.proto.plan_serde
Docstring: Logical plan serialization/deserialization using singledispatch.
This module provides the main dispatch functions for plan serialization.
The actual serialization implementations are organized in the plans/ subdirectory.... |
function | _serialize_logical_plan_helper | fenic.core._serde.proto.plan_serde._serialize_logical_plan_helper | Serialize a logical plan to a wrapper LogicalPlanProto (plan oneof set).
Plan-specific modules register implementations for this helper to return the
LogicalPlanProto with the appropriate oneof field set. Common fields (schema/cache_info)
are added by serialize_logical_plan(). | null | false | true | 21 | 35 | null | LogicalPlanProto | null | [
"logical_plan",
"context"
] | null | null | Type: function
Member Name: _serialize_logical_plan_helper
Qualified Name: fenic.core._serde.proto.plan_serde._serialize_logical_plan_helper
Docstring: Serialize a logical plan to a wrapper LogicalPlanProto (plan oneof set).
Plan-specific modules register implementations for this helper to return the
LogicalPlanProto ... |
function | serialize_logical_plan | fenic.core._serde.proto.plan_serde.serialize_logical_plan | Serialize a logical plan to the wrapper LogicalPlanProto.
This calls the helper to get a wrapper with the correct oneof set, then adds
common fields like schema and cache_info. | null | true | false | 38 | 58 | null | LogicalPlanProto | null | [
"logical_plan",
"context"
] | null | null | Type: function
Member Name: serialize_logical_plan
Qualified Name: fenic.core._serde.proto.plan_serde.serialize_logical_plan
Docstring: Serialize a logical plan to the wrapper LogicalPlanProto.
This calls the helper to get a wrapper with the correct oneof set, then adds
common fields like schema and cache_info.
Value:... |
function | deserialize_logical_plan | fenic.core._serde.proto.plan_serde.deserialize_logical_plan | Deserialize a logical plan from protobuf format.
This function determines which oneof field is set in the LogicalPlanProto
and delegates to the appropriate deserialization helper function.
Args:
logical_plan_proto: The protobuf representation to deserialize.
context: The serde context for error reporting and ... | null | true | false | 61 | 99 | null | Optional[LogicalPlan] | null | [
"logical_plan_proto",
"context"
] | null | null | Type: function
Member Name: deserialize_logical_plan
Qualified Name: fenic.core._serde.proto.plan_serde.deserialize_logical_plan
Docstring: Deserialize a logical plan from protobuf format.
This function determines which oneof field is set in the LogicalPlanProto
and delegates to the appropriate deserialization helper ... |
function | _deserialize_logical_plan_helper | fenic.core._serde.proto.plan_serde._deserialize_logical_plan_helper | Deserialize a logical plan. | null | false | true | 102 | 113 | null | Optional[LogicalPlan] | null | [
"underlying_proto",
"context",
"schema"
] | null | null | Type: function
Member Name: _deserialize_logical_plan_helper
Qualified Name: fenic.core._serde.proto.plan_serde._deserialize_logical_plan_helper
Docstring: Deserialize a logical plan.
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["underlying_proto", "context", "schema"]
Returns: Option... |
module | serde_context | fenic.core._serde.proto.serde_context | Helper utilities for path tracking in serde operations. | /private/var/folders/w2/dyfkx_354cqghs4b74vb_x380000gn/T/fenic-clone-0.11.0-a2lcuovw/fenic/src/fenic/core/_serde/proto/serde_context.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: serde_context
Qualified Name: fenic.core._serde.proto.serde_context
Docstring: Helper utilities for path tracking in serde operations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | EnumType | fenic.core._serde.proto.serde_context.EnumType | null | null | true | false | 61 | 61 | null | null | TypeVar('EnumType', bound=Enum) | null | null | null | Type: attribute
Member Name: EnumType
Qualified Name: fenic.core._serde.proto.serde_context.EnumType
Docstring: none
Value: TypeVar('EnumType', bound=Enum)
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | SerdeContext | fenic.core._serde.proto.serde_context.SerdeContext | Context for managing serialization/deserialization state and path tracking.
Provides centralized error handling, path tracking, and field-level serde operations
for protobuf serialization/deserialization. All serde operations should use this
context to ensure consistent error reporting and path information. | null | true | false | 64 | 968 | null | null | null | null | [] | null | Type: class
Member Name: SerdeContext
Qualified Name: fenic.core._serde.proto.serde_context.SerdeContext
Docstring: Context for managing serialization/deserialization state and path tracking.
Provides centralized error handling, path tracking, and field-level serde operations
for protobuf serialization/deserialization... |
method | __init__ | fenic.core._serde.proto.serde_context.SerdeContext.__init__ | Initialize a SerdeContext with an empty path tracker. | null | true | false | 92 | 94 | null | null | null | [
"self"
] | null | SerdeContext | 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. | null | true | false | 101 | 103 | null | None | null | [
"self"
] | null | SerdeContext | 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. | null | true | false | 105 | 112 | null | null | null | [
"self",
"field_name"
] | null | SerdeContext | 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 C... |
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. | null | true | false | 114 | 131 | null | SerdeError | null | [
"self",
"error_class",
"message",
"object_type"
] | null | SerdeContext | 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: Opt... |
method | _handle_serde_error | fenic.core._serde.proto.serde_context.SerdeContext._handle_serde_error | null | null | false | true | 133 | 153 | null | None | null | [
"self",
"e"
] | null | SerdeContext | 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. | null | true | false | 159 | 177 | null | LogicalExprProto | null | [
"self",
"field_name",
"expr"
] | null | SerdeContext | 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.
Re... |
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. | null | true | false | 179 | 197 | null | Optional[LogicalExpr] | null | [
"self",
"field_name",
"expr_proto"
] | null | SerdeContext | 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 representatio... |
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. | null | true | false | 199 | 219 | null | List[LogicalExprProto] | null | [
"self",
"field_name",
"expr_list"
] | null | SerdeContext | 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 logi... |
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. | null | true | false | 221 | 243 | null | List[LogicalExpr] | null | [
"self",
"field_name",
"expr_proto_list"
] | null | SerdeContext | 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: Th... |
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... | null | true | false | 245 | 274 | null | int | null | [
"self",
"field_name",
"value",
"target_proto"
] | null | SerdeContext | 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 Litera... |
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 fro... | null | true | false | 276 | 333 | null | Any | null | [
"self",
"field_name",
"value",
"target_type",
"proto_enum"
] | null | SerdeContext | 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... |
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. | null | true | false | 335 | 354 | null | int | null | [
"self",
"field_name",
"enum_value",
"target_proto"
] | null | SerdeContext | 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... |
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 de... | null | true | false | 356 | 382 | null | Optional[EnumType] | null | [
"self",
"field_name",
"target_type",
"proto_enum_type",
"serialized_value"
] | null | SerdeContext | 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 ... |
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. | null | true | false | 384 | 402 | null | LogicalPlanProto | null | [
"self",
"field_name",
"plan"
] | null | SerdeContext | 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:
T... |
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. | null | true | false | 404 | 424 | null | List[LogicalPlanProto] | null | [
"self",
"field_name",
"plan_list"
] | null | SerdeContext | 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 pl... |
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. | null | true | false | 426 | 446 | null | LogicalPlan | null | [
"self",
"field_name",
"plan_proto"
] | null | SerdeContext | 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 d... |
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. | null | true | false | 448 | 470 | null | List[LogicalPlan] | null | [
"self",
"field_name",
"plan_proto_list"
] | null | SerdeContext | 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... |
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. | null | true | false | 472 | 490 | null | DataTypeProto | null | [
"self",
"field_name",
"data_type"
] | null | SerdeContext | 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 seri... |
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. | null | true | false | 492 | 510 | null | Optional[DataType] | null | [
"self",
"field_name",
"data_type_proto"
] | null | SerdeContext | 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 deser... |
method | serialize_resolved_model_alias | fenic.core._serde.proto.serde_context.SerdeContext.serialize_resolved_model_alias | Serialize a resolved model alias. | null | true | false | 515 | 530 | null | ResolvedModelAliasProto | null | [
"self",
"field_name",
"model_alias"
] | null | SerdeContext | 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"]
Ret... |
method | deserialize_resolved_model_alias | fenic.core._serde.proto.serde_context.SerdeContext.deserialize_resolved_model_alias | Deserialize a resolved model alias. | null | true | false | 532 | 549 | null | ResolvedModelAlias | null | [
"self",
"field_name",
"model_alias_proto"
] | null | SerdeContext | 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... |
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. | null | true | false | 551 | 572 | null | ResolvedClassDefinitionProto | null | [
"self",
"field_name",
"class_definition"
] | null | SerdeContext | 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 d... |
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. | null | true | false | 574 | 599 | null | Optional[ResolvedClassDefinition] | null | [
"self",
"field_name",
"class_definition_proto"
] | null | SerdeContext | 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 pr... |
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. | null | true | false | 601 | 626 | null | ResolvedResponseFormatProto | null | [
"self",
"field_name",
"resolved_response_format"
] | null | SerdeContext | 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_forma... |
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. | null | true | false | 628 | 652 | null | Optional[ResolvedResponseFormat] | null | [
"self",
"field_name",
"resolved_response_format_proto"
] | null | SerdeContext | 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_resp... |
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. | null | true | false | 654 | 674 | null | NumpyArrayProto | null | [
"self",
"field_name",
"array"
] | null | SerdeContext | 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 repre... |
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. | null | true | false | 676 | 695 | null | np.ndarray | null | [
"self",
"field_name",
"serialized_array"
] | null | SerdeContext | 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:
... |
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 represent... | null | true | false | 697 | 760 | null | ScalarValueProto | null | [
"self",
"field_name",
"value"
] | null | SerdeContext | 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.
A... |
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 des... | null | true | false | 762 | 819 | null | Any | null | [
"self",
"field_name",
"scalar_value"
] | null | SerdeContext | 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 struct... |
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. | null | true | false | 821 | 849 | null | FenicSchemaProto | null | [
"self",
"schema",
"field_name"
] | null | SerdeContext | 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 ... |
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. | null | true | false | 851 | 877 | null | Schema | null | [
"self",
"schema_proto",
"field_name"
] | null | SerdeContext | 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:
... |
method | serialize_tool_parameter | fenic.core._serde.proto.serde_context.SerdeContext.serialize_tool_parameter | Serialize a ToolParameter. | null | true | false | 879 | 903 | null | ToolParameterProto | null | [
"self",
"tool_param",
"field_name"
] | null | SerdeContext | 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: ToolParameterP... |
method | deserialize_tool_parameter | fenic.core._serde.proto.serde_context.SerdeContext.deserialize_tool_parameter | Deserialize a ToolParameter. | null | true | false | 905 | 928 | null | BoundToolParam | null | [
"self",
"tool_param_proto",
"field_name"
] | null | SerdeContext | 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: Bo... |
method | serialize_tool_definition | fenic.core._serde.proto.serde_context.SerdeContext.serialize_tool_definition | null | null | true | false | 930 | 949 | null | ToolDefinitionProto | null | [
"self",
"tool_definition",
"field_name"
] | null | SerdeContext | 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 Cl... |
method | deserialize_tool_definition | fenic.core._serde.proto.serde_context.SerdeContext.deserialize_tool_definition | Deserialize a ToolDefinition. | null | true | false | 951 | 968 | null | UserDefinedTool | null | [
"self",
"tool_definition_proto",
"field_name"
] | null | SerdeContext | 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"]
Ret... |
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. | null | true | false | 971 | 980 | 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 Serde... |
class | PathTracker | fenic.core._serde.proto.serde_context.PathTracker | Path tracker for serde operations. | null | true | false | 983 | 1,006 | 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 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.