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 | does_catalog_exist | fenic.core._interfaces.catalog.BaseCatalog.does_catalog_exist | Checks if a catalog with the specified name exists. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 15 | 18 | null | bool | [
"self",
"catalog_name"
] | BaseCatalog | null | null | Type: method
Member Name: does_catalog_exist
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.does_catalog_exist
Docstring: Checks if a catalog with the specified name exists.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "catalog_name"]
Returns: bool
Parent Class: Ba... |
method | get_current_catalog | fenic.core._interfaces.catalog.BaseCatalog.get_current_catalog | Get the name of the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 20 | 23 | null | str | [
"self"
] | BaseCatalog | null | null | Type: method
Member Name: get_current_catalog
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.get_current_catalog
Docstring: Get the name of the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: BaseCatalog |
method | set_current_catalog | fenic.core._interfaces.catalog.BaseCatalog.set_current_catalog | Set the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 25 | 28 | null | None | [
"self",
"catalog_name"
] | BaseCatalog | null | null | Type: method
Member Name: set_current_catalog
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.set_current_catalog
Docstring: Set the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "catalog_name"]
Returns: None
Parent Class: BaseCatalog |
method | list_catalogs | fenic.core._interfaces.catalog.BaseCatalog.list_catalogs | Get a list of all catalogs. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 30 | 33 | null | List[str] | [
"self"
] | BaseCatalog | null | null | Type: method
Member Name: list_catalogs
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.list_catalogs
Docstring: Get a list of all catalogs.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: BaseCatalog |
method | does_database_exist | fenic.core._interfaces.catalog.BaseCatalog.does_database_exist | Checks if a database with the specified name exists in the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 36 | 39 | null | bool | [
"self",
"database_name"
] | BaseCatalog | null | null | Type: method
Member Name: does_database_exist
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.does_database_exist
Docstring: Checks if a database with the specified name exists in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "database_name"]
Ret... |
method | get_current_database | fenic.core._interfaces.catalog.BaseCatalog.get_current_database | Get the name of the current database in the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 41 | 44 | null | str | [
"self"
] | BaseCatalog | null | null | Type: method
Member Name: get_current_database
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.get_current_database
Docstring: Get the name of the current database in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: BaseCa... |
method | set_current_database | fenic.core._interfaces.catalog.BaseCatalog.set_current_database | Set the current database in the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 46 | 49 | null | None | [
"self",
"database_name"
] | BaseCatalog | null | null | Type: method
Member Name: set_current_database
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.set_current_database
Docstring: Set the current database in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "database_name"]
Returns: None
Parent Class: ... |
method | list_databases | fenic.core._interfaces.catalog.BaseCatalog.list_databases | Get a list of all databases in the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 51 | 54 | null | List[str] | [
"self"
] | BaseCatalog | null | null | Type: method
Member Name: list_databases
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.list_databases
Docstring: Get a list of all databases in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: BaseCatalog |
method | create_database | fenic.core._interfaces.catalog.BaseCatalog.create_database | Create a new database in the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 56 | 61 | null | bool | [
"self",
"database_name",
"ignore_if_exists"
] | BaseCatalog | null | null | Type: method
Member Name: create_database
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.create_database
Docstring: Create a new database in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "database_name", "ignore_if_exists"]
Returns: bool
Parent ... |
method | drop_database | fenic.core._interfaces.catalog.BaseCatalog.drop_database | Drop a database from the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 63 | 71 | null | bool | [
"self",
"database_name",
"cascade",
"ignore_if_not_exists"
] | BaseCatalog | null | null | Type: method
Member Name: drop_database
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.drop_database
Docstring: Drop a database from the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "database_name", "cascade", "ignore_if_not_exists"]
Returns: bool
... |
method | does_table_exist | fenic.core._interfaces.catalog.BaseCatalog.does_table_exist | Checks if a table with the specified name exists in the current database. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 74 | 77 | null | bool | [
"self",
"table_name"
] | BaseCatalog | null | null | Type: method
Member Name: does_table_exist
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.does_table_exist
Docstring: Checks if a table with the specified name exists in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name"]
Returns: bool
... |
method | list_tables | fenic.core._interfaces.catalog.BaseCatalog.list_tables | Get a list of all tables in the current database. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 79 | 82 | null | List[str] | [
"self"
] | BaseCatalog | null | null | Type: method
Member Name: list_tables
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.list_tables
Docstring: Get a list of all tables in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: BaseCatalog |
method | describe_table | fenic.core._interfaces.catalog.BaseCatalog.describe_table | Get the schema and description of the specified table. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 84 | 87 | null | DatasetMetadata | [
"self",
"table_name"
] | BaseCatalog | null | null | Type: method
Member Name: describe_table
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.describe_table
Docstring: Get the schema and description of the specified table.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name"]
Returns: DatasetMetadata
Parent Class... |
method | drop_table | fenic.core._interfaces.catalog.BaseCatalog.drop_table | Drop a table from the current database. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 89 | 92 | null | bool | [
"self",
"table_name",
"ignore_if_not_exists"
] | BaseCatalog | null | null | Type: method
Member Name: drop_table
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.drop_table
Docstring: Drop a table from the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name", "ignore_if_not_exists"]
Returns: bool
Parent Class: BaseCata... |
method | create_table | fenic.core._interfaces.catalog.BaseCatalog.create_table | Create a new table in the current database. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 94 | 99 | null | bool | [
"self",
"table_name",
"schema",
"ignore_if_exists",
"description"
] | BaseCatalog | null | null | Type: method
Member Name: create_table
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.create_table
Docstring: Create a new table in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name", "schema", "ignore_if_exists", "description"]
Returns... |
method | set_table_description | fenic.core._interfaces.catalog.BaseCatalog.set_table_description | Set or clear the description for a table. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 101 | 104 | null | None | [
"self",
"table_name",
"description"
] | BaseCatalog | null | null | Type: method
Member Name: set_table_description
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.set_table_description
Docstring: Set or clear the description for a table.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "table_name", "description"]
Returns: None
Parent ... |
method | create_view | fenic.core._interfaces.catalog.BaseCatalog.create_view | Create a new view in the current database. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 106 | 115 | null | bool | [
"self",
"view_name",
"logical_plan",
"ignore_if_exists",
"description"
] | BaseCatalog | null | null | Type: method
Member Name: create_view
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.create_view
Docstring: Create a new view in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "view_name", "logical_plan", "ignore_if_exists", "description"]
Retur... |
method | drop_view | fenic.core._interfaces.catalog.BaseCatalog.drop_view | Drop a view from the current database. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 117 | 120 | null | bool | [
"self",
"view_name",
"ignore_if_not_exists"
] | BaseCatalog | null | null | Type: method
Member Name: drop_view
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.drop_view
Docstring: Drop a view from the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "view_name", "ignore_if_not_exists"]
Returns: bool
Parent Class: BaseCatalog |
method | get_view_plan | fenic.core._interfaces.catalog.BaseCatalog.get_view_plan | Get the serialized schema and logical plan of the specified view. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 122 | 125 | null | LogicalPlan | [
"self",
"view_name"
] | BaseCatalog | null | null | Type: method
Member Name: get_view_plan
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.get_view_plan
Docstring: Get the serialized schema and logical plan of the specified view.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "view_name"]
Returns: LogicalPlan
Parent C... |
method | list_views | fenic.core._interfaces.catalog.BaseCatalog.list_views | Get a list of all views in the current database. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 127 | 130 | null | List[str] | [
"self"
] | BaseCatalog | null | null | Type: method
Member Name: list_views
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.list_views
Docstring: Get a list of all views in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[str]
Parent Class: BaseCatalog |
method | does_view_exist | fenic.core._interfaces.catalog.BaseCatalog.does_view_exist | Checks if a view with the specified name exists in the current database. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 132 | 135 | null | bool | [
"self",
"view_name"
] | BaseCatalog | null | null | Type: method
Member Name: does_view_exist
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.does_view_exist
Docstring: Checks if a view with the specified name exists in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "view_name"]
Returns: bool
Pare... |
method | set_view_description | fenic.core._interfaces.catalog.BaseCatalog.set_view_description | Set the description for a view. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 137 | 140 | null | None | [
"self",
"view_name",
"description"
] | BaseCatalog | null | null | Type: method
Member Name: set_view_description
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.set_view_description
Docstring: Set the description for a view.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "view_name", "description"]
Returns: None
Parent Class: BaseCa... |
method | describe_view | fenic.core._interfaces.catalog.BaseCatalog.describe_view | Return view schema and description together. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 142 | 145 | null | DatasetMetadata | [
"self",
"view_name"
] | BaseCatalog | null | null | Type: method
Member Name: describe_view
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.describe_view
Docstring: Return view schema and description together.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "view_name"]
Returns: DatasetMetadata
Parent Class: BaseCatalog |
method | get_tool | fenic.core._interfaces.catalog.BaseCatalog.get_tool | Find and return the tool from the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 147 | 154 | null | ParameterizedToolDefinition | [
"self",
"tool_name",
"ignore_if_not_exists"
] | BaseCatalog | null | null | Type: method
Member Name: get_tool
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.get_tool
Docstring: Find and return the tool from the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "tool_name", "ignore_if_not_exists"]
Returns: ParameterizedToolDefi... |
method | create_tool | fenic.core._interfaces.catalog.BaseCatalog.create_tool | Create a new tool in the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 156 | 167 | null | bool | [
"self",
"tool_name",
"tool_description",
"tool_params",
"tool_query",
"result_limit",
"ignore_if_exists"
] | BaseCatalog | null | null | Type: method
Member Name: create_tool
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.create_tool
Docstring: Create a new tool in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "tool_name", "tool_description", "tool_params", "tool_query", "result_... |
method | drop_tool | fenic.core._interfaces.catalog.BaseCatalog.drop_tool | Drop a tool from the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 169 | 172 | null | bool | [
"self",
"tool_name",
"ignore_if_not_exists"
] | BaseCatalog | null | null | Type: method
Member Name: drop_tool
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.drop_tool
Docstring: Drop a tool from the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "tool_name", "ignore_if_not_exists"]
Returns: bool
Parent Class: BaseCatalog |
method | list_tools | fenic.core._interfaces.catalog.BaseCatalog.list_tools | Get a list of all tools in the current catalog. | site-packages/fenic/core/_interfaces/catalog.py | true | false | 174 | 177 | null | List[ParameterizedToolDefinition] | [
"self"
] | BaseCatalog | null | null | Type: method
Member Name: list_tools
Qualified Name: fenic.core._interfaces.catalog.BaseCatalog.list_tools
Docstring: Get a list of all tools in the current catalog.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: List[ParameterizedToolDefinition]
Parent Class: BaseCatal... |
module | execution | fenic.core._interfaces.execution | null | site-packages/fenic/core/_interfaces/execution.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: execution
Qualified Name: fenic.core._interfaces.execution
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | BaseExecution | fenic.core._interfaces.execution.BaseExecution | null | site-packages/fenic/core/_interfaces/execution.py | true | false | 15 | 80 | null | null | null | null | null | [
"ABC"
] | Type: class
Member Name: BaseExecution
Qualified Name: fenic.core._interfaces.execution.BaseExecution
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | collect | fenic.core._interfaces.execution.BaseExecution.collect | Execute a logical plan and return a Polars DataFrame and query metrics. | site-packages/fenic/core/_interfaces/execution.py | true | false | 16 | 21 | null | Tuple[pl.DataFrame, QueryMetrics] | [
"self",
"plan",
"n"
] | BaseExecution | null | null | Type: method
Member Name: collect
Qualified Name: fenic.core._interfaces.execution.BaseExecution.collect
Docstring: Execute a logical plan and return a Polars DataFrame and query metrics.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "plan", "n"]
Returns: Tuple[pl.DataFrame, Qu... |
method | show | fenic.core._interfaces.execution.BaseExecution.show | Execute a logical plan and return a string representation of the sample rows of the DataFrame and query metrics. | site-packages/fenic/core/_interfaces/execution.py | true | false | 23 | 26 | null | Tuple[str, QueryMetrics] | [
"self",
"plan",
"n"
] | BaseExecution | null | null | Type: method
Member Name: show
Qualified Name: fenic.core._interfaces.execution.BaseExecution.show
Docstring: Execute a logical plan and return a string representation of the sample rows of the DataFrame and query metrics.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "plan", "... |
method | count | fenic.core._interfaces.execution.BaseExecution.count | Execute a logical plan and return the number of rows in the DataFrame and query metrics. | site-packages/fenic/core/_interfaces/execution.py | true | false | 28 | 31 | null | Tuple[int, QueryMetrics] | [
"self",
"plan"
] | BaseExecution | null | null | Type: method
Member Name: count
Qualified Name: fenic.core._interfaces.execution.BaseExecution.count
Docstring: Execute a logical plan and return the number of rows in the DataFrame and query metrics.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "plan"]
Returns: Tuple[int, Que... |
method | build_lineage | fenic.core._interfaces.execution.BaseExecution.build_lineage | Build a lineage graph from a logical plan. | site-packages/fenic/core/_interfaces/execution.py | true | false | 33 | 36 | null | BaseLineage | [
"self",
"plan"
] | BaseExecution | null | null | Type: method
Member Name: build_lineage
Qualified Name: fenic.core._interfaces.execution.BaseExecution.build_lineage
Docstring: Build a lineage graph from a logical plan.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "plan"]
Returns: BaseLineage
Parent Class: BaseExecution |
method | save_as_table | fenic.core._interfaces.execution.BaseExecution.save_as_table | Execute the logical plan and save the result as a table in the current database. | site-packages/fenic/core/_interfaces/execution.py | true | false | 38 | 46 | null | QueryMetrics | [
"self",
"logical_plan",
"table_name",
"mode"
] | BaseExecution | null | null | Type: method
Member Name: save_as_table
Qualified Name: fenic.core._interfaces.execution.BaseExecution.save_as_table
Docstring: Execute the logical plan and save the result as a table in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "logical_plan", "table_... |
method | save_as_view | fenic.core._interfaces.execution.BaseExecution.save_as_view | Save the dataframe as a view in the current database. | site-packages/fenic/core/_interfaces/execution.py | true | false | 48 | 56 | null | None | [
"self",
"logical_plan",
"view_name",
"view_description"
] | BaseExecution | null | null | Type: method
Member Name: save_as_view
Qualified Name: fenic.core._interfaces.execution.BaseExecution.save_as_view
Docstring: Save the dataframe as a view in the current database.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "logical_plan", "view_name", "view_description"]
Ret... |
method | save_to_file | fenic.core._interfaces.execution.BaseExecution.save_to_file | Execute the logical plan and save the result to a file. | site-packages/fenic/core/_interfaces/execution.py | true | false | 58 | 66 | null | QueryMetrics | [
"self",
"logical_plan",
"file_path",
"mode"
] | BaseExecution | null | null | Type: method
Member Name: save_to_file
Qualified Name: fenic.core._interfaces.execution.BaseExecution.save_to_file
Docstring: Execute the logical plan and save the result to a file.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "logical_plan", "file_path", "mode"]
Returns: Quer... |
method | infer_schema_from_csv | fenic.core._interfaces.execution.BaseExecution.infer_schema_from_csv | Infer the schema of a CSV file. | site-packages/fenic/core/_interfaces/execution.py | true | false | 68 | 73 | null | Schema | [
"self",
"paths",
"options"
] | BaseExecution | null | null | Type: method
Member Name: infer_schema_from_csv
Qualified Name: fenic.core._interfaces.execution.BaseExecution.infer_schema_from_csv
Docstring: Infer the schema of a CSV file.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "paths", "options"]
Returns: Schema
Parent Class: BaseEx... |
method | infer_schema_from_parquet | fenic.core._interfaces.execution.BaseExecution.infer_schema_from_parquet | Infer the schema of a Parquet file. | site-packages/fenic/core/_interfaces/execution.py | true | false | 75 | 80 | null | Schema | [
"self",
"paths",
"options"
] | BaseExecution | null | null | Type: method
Member Name: infer_schema_from_parquet
Qualified Name: fenic.core._interfaces.execution.BaseExecution.infer_schema_from_parquet
Docstring: Infer the schema of a Parquet file.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "paths", "options"]
Returns: Schema
Parent C... |
module | session_state | fenic.core._interfaces.session_state | null | site-packages/fenic/core/_interfaces/session_state.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: session_state
Qualified Name: fenic.core._interfaces.session_state
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | BaseSessionState | fenic.core._interfaces.session_state.BaseSessionState | null | site-packages/fenic/core/_interfaces/session_state.py | true | false | 8 | 27 | null | null | null | null | null | [
"ABC"
] | Type: class
Member Name: BaseSessionState
Qualified Name: fenic.core._interfaces.session_state.BaseSessionState
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic.core._interfaces.session_state.BaseSessionState.__init__ | null | site-packages/fenic/core/_interfaces/session_state.py | true | false | 9 | 10 | null | null | [
"self",
"session_config"
] | BaseSessionState | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.core._interfaces.session_state.BaseSessionState.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "session_config"]
Returns: none
Parent Class: BaseSessionState |
method | stop | fenic.core._interfaces.session_state.BaseSessionState.stop | Clean up the session state. | site-packages/fenic/core/_interfaces/session_state.py | true | false | 24 | 27 | null | None | [
"self"
] | BaseSessionState | null | null | Type: method
Member Name: stop
Qualified Name: fenic.core._interfaces.session_state.BaseSessionState.stop
Docstring: Clean up the session state.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: None
Parent Class: BaseSessionState |
module | lineage | fenic.core._interfaces.lineage | null | site-packages/fenic/core/_interfaces/lineage.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: lineage
Qualified Name: fenic.core._interfaces.lineage
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | BaseLineage | fenic.core._interfaces.lineage.BaseLineage | Base class for lineage traversal implementations. | site-packages/fenic/core/_interfaces/lineage.py | true | false | 9 | 47 | null | null | null | null | null | [
"ABC"
] | Type: class
Member Name: BaseLineage
Qualified Name: fenic.core._interfaces.lineage.BaseLineage
Docstring: Base class for lineage traversal implementations.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | get_source_names | fenic.core._interfaces.lineage.BaseLineage.get_source_names | Get the names of all sources in the query plan. Used to determine where to start the lineage traversal. | site-packages/fenic/core/_interfaces/lineage.py | true | false | 12 | 15 | null | List[str] | [
"self"
] | BaseLineage | null | null | Type: method
Member Name: get_source_names
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.get_source_names
Docstring: Get the names of all sources in the query plan. Used to determine where to start the lineage traversal.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"... |
method | stringify_graph | fenic.core._interfaces.lineage.BaseLineage.stringify_graph | Print the operator tree of the query. | site-packages/fenic/core/_interfaces/lineage.py | true | false | 17 | 20 | null | str | [
"self"
] | BaseLineage | null | null | Type: method
Member Name: stringify_graph
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.stringify_graph
Docstring: Print the operator tree of the query.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: str
Parent Class: BaseLineage |
method | start_from_source | fenic.core._interfaces.lineage.BaseLineage.start_from_source | Set the current position to a specific source in the query plan. | site-packages/fenic/core/_interfaces/lineage.py | true | false | 22 | 25 | null | None | [
"self",
"source_name"
] | BaseLineage | null | null | Type: method
Member Name: start_from_source
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.start_from_source
Docstring: Set the current position to a specific source in the query plan.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "source_name"]
Returns: None
Parent... |
method | forwards | fenic.core._interfaces.lineage.BaseLineage.forwards | Trace rows forward to see how they are transformed by the next operation. | site-packages/fenic/core/_interfaces/lineage.py | true | false | 27 | 30 | null | pl.DataFrame | [
"self",
"ids"
] | BaseLineage | null | null | Type: method
Member Name: forwards
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.forwards
Docstring: Trace rows forward to see how they are transformed by the next operation.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "ids"]
Returns: pl.DataFrame
Parent Class: B... |
method | backwards | fenic.core._interfaces.lineage.BaseLineage.backwards | Trace rows backwards to see which input rows produced them. | site-packages/fenic/core/_interfaces/lineage.py | true | false | 32 | 37 | null | pl.DataFrame | [
"self",
"ids",
"branch_side"
] | BaseLineage | null | null | Type: method
Member Name: backwards
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.backwards
Docstring: Trace rows backwards to see which input rows produced them.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "ids", "branch_side"]
Returns: pl.DataFrame
Parent Class... |
method | get_result_df | fenic.core._interfaces.lineage.BaseLineage.get_result_df | Get the result of the query as a Polars DataFrame. | site-packages/fenic/core/_interfaces/lineage.py | true | false | 39 | 42 | null | pl.DataFrame | [
"self"
] | BaseLineage | null | null | Type: method
Member Name: get_result_df
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.get_result_df
Docstring: Get the result of the query as a Polars DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: pl.DataFrame
Parent Class: BaseLineage |
method | get_source_df | fenic.core._interfaces.lineage.BaseLineage.get_source_df | Get a query source by name as a Polars DataFrame. | site-packages/fenic/core/_interfaces/lineage.py | true | false | 44 | 47 | null | pl.DataFrame | [
"self",
"source_name"
] | BaseLineage | null | null | Type: method
Member Name: get_source_df
Qualified Name: fenic.core._interfaces.lineage.BaseLineage.get_source_df
Docstring: Get a query source by name as a Polars DataFrame.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "source_name"]
Returns: pl.DataFrame
Parent Class: BaseLin... |
module | _logical_plan | fenic.core._logical_plan | null | site-packages/fenic/core/_logical_plan/__init__.py | false | true | null | null | null | null | null | null | null | null | Type: module
Member Name: _logical_plan
Qualified Name: fenic.core._logical_plan
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: none
Returns: none
Parent Class: none |
attribute | __all__ | fenic.core._logical_plan.__all__ | null | site-packages/fenic/core/_logical_plan/__init__.py | false | false | 4 | 7 | null | null | null | null | ['LogicalPlan', 'LogicalExpr'] | null | Type: attribute
Member Name: __all__
Qualified Name: fenic.core._logical_plan.__all__
Docstring: none
Value: ['LogicalPlan', 'LogicalExpr']
Annotation: none
is Public? : false
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
module | resolved_types | fenic.core._logical_plan.resolved_types | null | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: resolved_types
Qualified Name: fenic.core._logical_plan.resolved_types
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | logger | fenic.core._logical_plan.resolved_types.logger | null | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 24 | 24 | null | null | null | null | logging.getLogger(__name__) | null | Type: attribute
Member Name: logger
Qualified Name: fenic.core._logical_plan.resolved_types.logger
Docstring: none
Value: logging.getLogger(__name__)
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | ResolvedModelAlias | fenic.core._logical_plan.resolved_types.ResolvedModelAlias | A resolved model alias with an optional profile name.
Attributes:
name: The name of the model.
profile: The optional name of a profile configuration to use for the model. | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 27 | 36 | null | null | null | null | null | [] | Type: class
Member Name: ResolvedModelAlias
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedModelAlias
Docstring: A resolved model alias with an optional profile name.
Attributes:
name: The name of the model.
profile: The optional name of a profile configuration to use for the model.
Value: non... |
method | __init__ | fenic.core._logical_plan.resolved_types.ResolvedModelAlias.__init__ | null | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 0 | 0 | null | None | [
"self",
"name",
"profile"
] | ResolvedModelAlias | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedModelAlias.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "name", "profile"]
Returns: None
Parent Class: ResolvedModelAlias |
class | ResolvedClassDefinition | fenic.core._logical_plan.resolved_types.ResolvedClassDefinition | null | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 39 | 42 | null | null | null | null | null | [] | Type: class
Member Name: ResolvedClassDefinition
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedClassDefinition
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic.core._logical_plan.resolved_types.ResolvedClassDefinition.__init__ | null | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 0 | 0 | null | None | [
"self",
"label",
"description"
] | ResolvedClassDefinition | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedClassDefinition.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "label", "description"]
Returns: None
Parent Class: ResolvedClassDefinition |
class | ResolvedResponseFormat | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat | Internal representation of a JSON schema for structured output.
This class wraps a JSON schema dictionary to make it clear that this is
the resolved format used for model client communication, as opposed to
the original Pydantic model type.
Attributes:
raw_schema: The raw JSON schema dictionary from the pydantic ... | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 45 | 210 | null | null | null | null | null | [] | Type: class
Member Name: ResolvedResponseFormat
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat
Docstring: Internal representation of a JSON schema for structured output.
This class wraps a JSON schema dictionary to make it clear that this is
the resolved format used for model client com... |
method | from_json_schema | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.from_json_schema | Create a ResolvedResponseFormat from a Pydantic model. | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 68 | 84 | null | 'ResolvedResponseFormat' | [
"cls",
"raw_schema",
"prompt_schema_definition",
"struct_type"
] | ResolvedResponseFormat | null | null | Type: method
Member Name: from_json_schema
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.from_json_schema
Docstring: Create a ResolvedResponseFormat from a Pydantic model.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "raw_schema", "prompt_schema... |
method | from_pydantic_model | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.from_pydantic_model | Create a ResolvedResponseFormat from a Pydantic model. | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 86 | 104 | null | 'ResolvedResponseFormat' | [
"cls",
"model",
"generate_struct_type"
] | ResolvedResponseFormat | null | null | Type: method
Member Name: from_pydantic_model
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.from_pydantic_model
Docstring: Create a ResolvedResponseFormat from a Pydantic model.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["cls", "model", "generate_str... |
method | _create_validator | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat._create_validator | null | site-packages/fenic/core/_logical_plan/resolved_types.py | false | true | 106 | 110 | null | Validator | [
"cls",
"schema"
] | ResolvedResponseFormat | null | null | Type: method
Member Name: _create_validator
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat._create_validator
Docstring: none
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["cls", "schema"]
Returns: Validator
Parent Class: ResolvedResponseFormat |
method | __eq__ | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.__eq__ | null | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 112 | 115 | null | bool | [
"self",
"other"
] | ResolvedResponseFormat | null | null | Type: method
Member Name: __eq__
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.__eq__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "other"]
Returns: bool
Parent Class: ResolvedResponseFormat |
method | __hash__ | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.__hash__ | null | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 117 | 118 | null | int | [
"self"
] | ResolvedResponseFormat | null | null | Type: method
Member Name: __hash__
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.__hash__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: int
Parent Class: ResolvedResponseFormat |
method | validate_structured_response | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.validate_structured_response | null | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 129 | 130 | null | None | [
"self",
"response"
] | ResolvedResponseFormat | null | null | Type: method
Member Name: validate_structured_response
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.validate_structured_response
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "response"]
Returns: None
Parent Class: ResolvedRespo... |
method | parse_structured_response | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.parse_structured_response | Validate and parse a structured JSON response using ResolvedResponseFormat's json schema.
Args:
json_resp: The JSON response string from the LLM (can be None)
operator_name: Name of the operation (for logging purposes)
Returns:
Validated dictionary representation of the model, or None if validation fails | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 132 | 176 | null | Optional[Dict[str, Any]] | [
"self",
"json_resp",
"operator_name"
] | ResolvedResponseFormat | null | null | Type: method
Member Name: parse_structured_response
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.parse_structured_response
Docstring: Validate and parse a structured JSON response using ResolvedResponseFormat's json schema.
Args:
json_resp: The JSON response string from the LLM (c... |
method | _apply_defaults | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat._apply_defaults | Apply default values from schema into data recursively (for objects and arrays). | site-packages/fenic/core/_logical_plan/resolved_types.py | false | true | 178 | 210 | null | dict[str, Any] | [
"self",
"schema",
"data"
] | ResolvedResponseFormat | null | null | Type: method
Member Name: _apply_defaults
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat._apply_defaults
Docstring: Apply default values from schema into data recursively (for objects and arrays).
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["self", "sc... |
method | __init__ | fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.__init__ | null | site-packages/fenic/core/_logical_plan/resolved_types.py | true | false | 0 | 0 | null | None | [
"self",
"raw_schema",
"strict_schema",
"schema_validator",
"prompt_schema_definition",
"struct_type"
] | ResolvedResponseFormat | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.core._logical_plan.resolved_types.ResolvedResponseFormat.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "raw_schema", "strict_schema", "schema_validator", "prompt_schema_definition", "struct_type"]... |
module | walker | fenic.core._logical_plan.walker | Utilities for walking logical plans and searching expressions.
These helpers provide traversal to find `LogicalExpr` instances contained in a
`LogicalPlan` tree. They do not mutate plans or expressions; they only collect
references that match a predicate.
Traversal strategy:
- For each plan node, introspect attribute... | site-packages/fenic/core/_logical_plan/walker.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: walker
Qualified Name: fenic.core._logical_plan.walker
Docstring: Utilities for walking logical plans and searching expressions.
These helpers provide traversal to find `LogicalExpr` instances contained in a
`LogicalPlan` tree. They do not mutate plans or expressions; they only collect
refere... |
function | iter_plan_expressions | fenic.core._logical_plan.walker.iter_plan_expressions | Yield (plan_node, expr) pairs for every LogicalExpr reachable from the plan.
For each plan node:
- find attribute-attached expression roots
- traverse each root's expression tree
- recurse into child plan nodes | site-packages/fenic/core/_logical_plan/walker.py | true | false | 21 | 42 | null | Generator[Tuple[LogicalPlan, LogicalExpr], None, None] | [
"plan"
] | null | null | null | Type: function
Member Name: iter_plan_expressions
Qualified Name: fenic.core._logical_plan.walker.iter_plan_expressions
Docstring: Yield (plan_node, expr) pairs for every LogicalExpr reachable from the plan.
For each plan node:
- find attribute-attached expression roots
- traverse each root's expression tree
- recurse... |
function | find_expressions | fenic.core._logical_plan.walker.find_expressions | Collect expressions in the plan tree that satisfy the predicate. | site-packages/fenic/core/_logical_plan/walker.py | true | false | 45 | 51 | null | List[LogicalExpr] | [
"plan",
"predicate"
] | null | null | null | Type: function
Member Name: find_expressions
Qualified Name: fenic.core._logical_plan.walker.find_expressions
Docstring: Collect expressions in the plan tree that satisfy the predicate.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["plan", "predicate"]
Returns: List[LogicalExpr]
Parent... |
function | _iter_expr_tree | fenic.core._logical_plan.walker._iter_expr_tree | Depth-first traversal of an expression tree using expr.children(). | site-packages/fenic/core/_logical_plan/walker.py | false | true | 54 | 66 | null | Generator[LogicalExpr, None, None] | [
"expr"
] | null | null | null | Type: function
Member Name: _iter_expr_tree
Qualified Name: fenic.core._logical_plan.walker._iter_expr_tree
Docstring: Depth-first traversal of an expression tree using expr.children().
Value: none
Annotation: none
is Public? : false
is Private? : true
Parameters: ["expr"]
Returns: Generator[LogicalExpr, None, None]
Pa... |
module | utils | fenic.core._logical_plan.utils | null | site-packages/fenic/core/_logical_plan/utils.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: utils
Qualified Name: fenic.core._logical_plan.utils
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
function | parse_model_alias | fenic.core._logical_plan.utils.parse_model_alias | Parse a model alias to extract base model and profile name.
Args:
model_alias: Model alias in format 'model' or 'model.profile'
Returns:
Tuple of (base_model_alias, profile_name)
If no dot present, profile_name will be None | site-packages/fenic/core/_logical_plan/utils.py | true | false | 18 | 32 | null | Tuple[str, Optional[str]] | [
"model_alias"
] | null | null | null | Type: function
Member Name: parse_model_alias
Qualified Name: fenic.core._logical_plan.utils.parse_model_alias
Docstring: Parse a model alias to extract base model and profile name.
Args:
model_alias: Model alias in format 'model' or 'model.profile'
Returns:
Tuple of (base_model_alias, profile_name)
If no... |
function | validate_completion_parameters | fenic.core._logical_plan.utils.validate_completion_parameters | Validates that the provided temperature and max_tokens are within the limits allowed by the specified language model.
If no model alias is provided, the session's default language model is used.
Parameters:
model_alias (Optional[ResolvedModelAlias]):
ResolvedModelAlias object containing model name and opt... | site-packages/fenic/core/_logical_plan/utils.py | true | false | 35 | 86 | null | null | [
"model_alias",
"resolved_session_config",
"temperature",
"max_tokens"
] | null | null | null | Type: function
Member Name: validate_completion_parameters
Qualified Name: fenic.core._logical_plan.utils.validate_completion_parameters
Docstring: Validates that the provided temperature and max_tokens are within the limits allowed by the specified language model.
If no model alias is provided, the session's default ... |
function | validate_scalar_expr | fenic.core._logical_plan.utils.validate_scalar_expr | null | site-packages/fenic/core/_logical_plan/utils.py | true | false | 88 | 98 | null | null | [
"expr",
"function_name"
] | null | null | null | Type: function
Member Name: validate_scalar_expr
Qualified Name: fenic.core._logical_plan.utils.validate_scalar_expr
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["expr", "function_name"]
Returns: none
Parent Class: none |
module | jinja_validation | fenic.core._logical_plan.jinja_validation | null | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | null | null | null | null | null | null | null | null | Type: module
Member Name: jinja_validation
Qualified Name: fenic.core._logical_plan.jinja_validation
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | logger | fenic.core._logical_plan.jinja_validation.logger | null | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 17 | 17 | null | null | null | null | logging.getLogger(__name__) | null | Type: attribute
Member Name: logger
Qualified Name: fenic.core._logical_plan.jinja_validation.logger
Docstring: none
Value: logging.getLogger(__name__)
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
attribute | ALLOWED_JINJA_NODES | fenic.core._logical_plan.jinja_validation.ALLOWED_JINJA_NODES | null | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 24 | 35 | null | null | null | null | (nodes.Template, nodes.Output, nodes.Name, nodes.Getattr, nodes.Getitem, nodes.If, nodes.For, nodes.Not, nodes.TemplateData, nodes.Const) | null | Type: attribute
Member Name: ALLOWED_JINJA_NODES
Qualified Name: fenic.core._logical_plan.jinja_validation.ALLOWED_JINJA_NODES
Docstring: none
Value: (nodes.Template, nodes.Output, nodes.Name, nodes.Getattr, nodes.Getitem, nodes.If, nodes.For, nodes.Not, nodes.TemplateData, nodes.Const)
Annotation: none
is Public? : tr... |
attribute | VALID_LOOP_ATTRIBUTES | fenic.core._logical_plan.jinja_validation.VALID_LOOP_ATTRIBUTES | null | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 37 | 41 | null | null | null | null | {'index', 'index0', 'revindex', 'revindex0', 'first', 'last', 'length', 'depth', 'depth0', 'previtem', 'nextitem'} | null | Type: attribute
Member Name: VALID_LOOP_ATTRIBUTES
Qualified Name: fenic.core._logical_plan.jinja_validation.VALID_LOOP_ATTRIBUTES
Docstring: none
Value: {'index', 'index0', 'revindex', 'revindex0', 'first', 'last', 'length', 'depth', 'depth0', 'previtem', 'nextitem'}
Annotation: none
is Public? : true
is Private? : fa... |
class | TypeRequirement | fenic.core._logical_plan.jinja_validation.TypeRequirement | Expected data type for a variable based on how it's used in the template. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 47 | 50 | null | null | null | null | null | [
"Enum"
] | Type: class
Member Name: TypeRequirement
Qualified Name: fenic.core._logical_plan.jinja_validation.TypeRequirement
Docstring: Expected data type for a variable based on how it's used in the template.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | VariableNode | fenic.core._logical_plan.jinja_validation.VariableNode | A variable in the Jinja template with its expected data type. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 52 | 75 | null | null | null | null | null | [] | Type: class
Member Name: VariableNode
Qualified Name: fenic.core._logical_plan.jinja_validation.VariableNode
Docstring: A variable in the Jinja template with its expected data type.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | set_requirement | fenic.core._logical_plan.jinja_validation.VariableNode.set_requirement | Set the type requirement, validating consistency with previous uses. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 59 | 69 | null | None | [
"self",
"req",
"line_no"
] | VariableNode | null | null | Type: method
Member Name: set_requirement
Qualified Name: fenic.core._logical_plan.jinja_validation.VariableNode.set_requirement
Docstring: Set the type requirement, validating consistency with previous uses.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "req", "line_no"]
Retur... |
method | get_or_create_child | fenic.core._logical_plan.jinja_validation.VariableNode.get_or_create_child | Get or create a child node for nested fields like user.name or items[*]. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 71 | 75 | null | VariableNode | [
"self",
"name"
] | VariableNode | null | null | Type: method
Member Name: get_or_create_child
Qualified Name: fenic.core._logical_plan.jinja_validation.VariableNode.get_or_create_child
Docstring: Get or create a child node for nested fields like user.name or items[*].
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "name"]
Ret... |
method | __init__ | fenic.core._logical_plan.jinja_validation.VariableNode.__init__ | null | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 0 | 0 | null | None | [
"self",
"requirement",
"children",
"line_no"
] | VariableNode | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.core._logical_plan.jinja_validation.VariableNode.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "requirement", "children", "line_no"]
Returns: None
Parent Class: VariableNode |
class | LoopDefinition | fenic.core._logical_plan.jinja_validation.LoopDefinition | A loop variable definition mapping the variable name to the array being iterated. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 77 | 81 | null | null | null | null | null | [] | Type: class
Member Name: LoopDefinition
Qualified Name: fenic.core._logical_plan.jinja_validation.LoopDefinition
Docstring: A loop variable definition mapping the variable name to the array being iterated.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: no... |
method | __init__ | fenic.core._logical_plan.jinja_validation.LoopDefinition.__init__ | null | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 0 | 0 | null | None | [
"self",
"var_name",
"array_path"
] | LoopDefinition | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.core._logical_plan.jinja_validation.LoopDefinition.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "var_name", "array_path"]
Returns: None
Parent Class: LoopDefinition |
class | ReferenceAccessContext | fenic.core._logical_plan.jinja_validation.ReferenceAccessContext | How a variable is used in the template. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 83 | 87 | null | null | null | null | null | [
"Enum"
] | Type: class
Member Name: ReferenceAccessContext
Qualified Name: fenic.core._logical_plan.jinja_validation.ReferenceAccessContext
Docstring: How a variable is used in the template.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
class | TemplateReference | fenic.core._logical_plan.jinja_validation.TemplateReference | A resolved variable access or output marker in the template.
Attributes:
var_path: Variable path as a list (e.g., ["user", "name"] for user.name).
Empty list [] indicates output without schema variable access (constants, loop.index).
context: How this is used - OUTPUT (displayed), CONDITION (if state... | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 89 | 102 | null | null | null | null | null | [] | Type: class
Member Name: TemplateReference
Qualified Name: fenic.core._logical_plan.jinja_validation.TemplateReference
Docstring: A resolved variable access or output marker in the template.
Attributes:
var_path: Variable path as a list (e.g., ["user", "name"] for user.name).
Empty list [] indicates outp... |
method | __init__ | fenic.core._logical_plan.jinja_validation.TemplateReference.__init__ | null | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 0 | 0 | null | None | [
"self",
"var_path",
"context",
"line_no"
] | TemplateReference | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.core._logical_plan.jinja_validation.TemplateReference.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "var_path", "context", "line_no"]
Returns: None
Parent Class: TemplateReference |
class | ReferenceWithDeps | fenic.core._logical_plan.jinja_validation.ReferenceWithDeps | A variable access with its control flow dependencies. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 104 | 108 | null | null | null | null | null | [] | Type: class
Member Name: ReferenceWithDeps
Qualified Name: fenic.core._logical_plan.jinja_validation.ReferenceWithDeps
Docstring: A variable access with its control flow dependencies.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic.core._logical_plan.jinja_validation.ReferenceWithDeps.__init__ | null | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 0 | 0 | null | None | [
"self",
"access",
"control_dependencies"
] | ReferenceWithDeps | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.core._logical_plan.jinja_validation.ReferenceWithDeps.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "access", "control_dependencies"]
Returns: None
Parent Class: ReferenceWithDeps |
class | LoopStack | fenic.core._logical_plan.jinja_validation.LoopStack | Manages loop variable scoping during template traversal. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 110 | 137 | null | null | null | null | null | [] | Type: class
Member Name: LoopStack
Qualified Name: fenic.core._logical_plan.jinja_validation.LoopStack
Docstring: Manages loop variable scoping during template traversal.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: none
Returns: none
Parent Class: none |
method | __init__ | fenic.core._logical_plan.jinja_validation.LoopStack.__init__ | null | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 113 | 114 | null | null | [
"self"
] | LoopStack | null | null | Type: method
Member Name: __init__
Qualified Name: fenic.core._logical_plan.jinja_validation.LoopStack.__init__
Docstring: none
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: none
Parent Class: LoopStack |
method | push_loop_var | fenic.core._logical_plan.jinja_validation.LoopStack.push_loop_var | Push a new loop variable (may shadow existing ones with the same name). | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 116 | 118 | null | None | [
"self",
"var_name",
"array_path"
] | LoopStack | null | null | Type: method
Member Name: push_loop_var
Qualified Name: fenic.core._logical_plan.jinja_validation.LoopStack.push_loop_var
Docstring: Push a new loop variable (may shadow existing ones with the same name).
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "var_name", "array_path"]
R... |
method | pop_loop_var | fenic.core._logical_plan.jinja_validation.LoopStack.pop_loop_var | Pop the most recent loop variable. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 120 | 122 | null | None | [
"self"
] | LoopStack | null | null | Type: method
Member Name: pop_loop_var
Qualified Name: fenic.core._logical_plan.jinja_validation.LoopStack.pop_loop_var
Docstring: Pop the most recent loop variable.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: None
Parent Class: LoopStack |
method | resolve_variable | fenic.core._logical_plan.jinja_validation.LoopStack.resolve_variable | Resolve a variable name to its array path, or None if not a loop variable. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 124 | 133 | null | Optional[List[str]] | [
"self",
"var_name"
] | LoopStack | null | null | Type: method
Member Name: resolve_variable
Qualified Name: fenic.core._logical_plan.jinja_validation.LoopStack.resolve_variable
Docstring: Resolve a variable name to its array path, or None if not a loop variable.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self", "var_name"]
Return... |
method | is_in_loop | fenic.core._logical_plan.jinja_validation.LoopStack.is_in_loop | Check if a variable is defined in any loop. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 135 | 137 | null | bool | [
"self"
] | LoopStack | null | null | Type: method
Member Name: is_in_loop
Qualified Name: fenic.core._logical_plan.jinja_validation.LoopStack.is_in_loop
Docstring: Check if a variable is defined in any loop.
Value: none
Annotation: none
is Public? : true
is Private? : false
Parameters: ["self"]
Returns: bool
Parent Class: LoopStack |
class | VariableTree | fenic.core._logical_plan.jinja_validation.VariableTree | Root of the schema tree containing all top-level variables. | site-packages/fenic/core/_logical_plan/jinja_validation.py | true | false | 139 | 580 | null | null | null | null | null | [] | Type: class
Member Name: VariableTree
Qualified Name: fenic.core._logical_plan.jinja_validation.VariableTree
Docstring: Root of the schema tree containing all top-level variables.
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.