chalkpy 2.91.4__tar.gz → 2.93.1__tar.gz

{chalkpy-2.91.4 → chalkpy-2.93.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chalkpy
-Version: 2.91.4
+Version: 2.93.1
 Summary: Python SDK for Chalk
 Author: Chalk AI, Inc.
 Project-URL: Homepage, https://chalk.ai

{chalkpy-2.91.4 → chalkpy-2.93.1}/chalk/_gen/chalk/python/v1/types_pb2.py

@@ -17,7 +17,7 @@ from chalk._gen.chalk.arrow.v1 import arrow_pb2 as chalk_dot_arrow_dot_v1_dot_ar
 
 
 DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
-    b'\n\x1b\x63halk/python/v1/types.proto\x12\x0f\x63halk.python.v1\x1a\x1a\x63halk/arrow/v1/arrow.proto"2\n\x05TySet\x12)\n\x05items\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05items"3\n\x06TyList\x12)\n\x05items\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05items"7\n\nTyIterable\x12)\n\x05items\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05items"8\n\x0bTyGenerator\x12)\n\x05items\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05items"(\n\nTyDatetime\x12\x13\n\x02tz\x18\x01 \x01(\tH\x00R\x02tz\x88\x01\x01\x42\x05\n\x03_tz"Z\n\x06TyDict\x12%\n\x03key\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x03key\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05value"U\n\x07TyTuple\x12)\n\x05\x66ixed\x18\x01 \x03(\x0b\x32\x13.chalk.python.v1.TyR\x05\x66ixed\x12\x1f\n\x0bis_variable\x18\x02 \x01(\x08R\nisVariable"\xa7\x01\n\x0fTyLogicalStruct\x12\x44\n\x06\x66ields\x18\x01 \x03(\x0b\x32,.chalk.python.v1.TyLogicalStruct.FieldsEntryR\x06\x66ields\x1aN\n\x0b\x46ieldsEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05value:\x02\x38\x01"\xfb\x01\n\x0eTyFeatureClass\x12\x33\n\x15\x63onstructor_namespace\x18\x01 \x01(\tR\x14\x63onstructorNamespace\x12\\\n\x0f\x61ssigned_fields\x18\x02 \x03(\x0b\x32\x33.chalk.python.v1.TyFeatureClass.AssignedFieldsEntryR\x0e\x61ssignedFields\x1aV\n\x13\x41ssignedFieldsEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05value:\x02\x38\x01"\x84\x01\n\x06TyEnum\x12\x16\n\x06module\x18\x01 \x01(\tR\x06module\x12\x12\n\x04name\x18\x02 \x01(\tR\x04name\x12)\n\x05\x62\x61ses\x18\x03 \x03(\x0b\x32\x13.chalk.python.v1.TyR\x05\x62\x61ses\x12#\n\x02ty\x18\x04 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x02ty"\x89\t\n\x02Ty\x12\x1a\n\x08nullable\x18\x01 \x01(\x08R\x08nullable\x12\x31\n\x03int\x18\x02 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x03int\x12\x31\n\x03str\x18\x03 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x03str\x12\x33\n\x04\x62ool\x18\x04 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x04\x62ool\x12\x35\n\x05\x66loat\x18\x05 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x05\x66loat\x12-\n\x04list\x18\x06 \x01(\x0b\x32\x17.chalk.python.v1.TyListH\x00R\x04list\x12*\n\x03set\x18\x07 \x01(\x0b\x32\x16.chalk.python.v1.TySetH\x00R\x03set\x12\x33\n\x04none\x18\x08 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x04none\x12\x31\n\x03\x61ny\x18\t \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x03\x61ny\x12\x39\n\x08iterable\x18\n \x01(\x0b\x32\x1b.chalk.python.v1.TyIterableH\x00R\x08iterable\x12\x39\n\x08\x64\x61tetime\x18\x0b \x01(\x0b\x32\x1b.chalk.python.v1.TyDatetimeH\x00R\x08\x64\x61tetime\x12=\n\ttimedelta\x18\x0c \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\ttimedelta\x12\x33\n\x04\x64\x61te\x18\r \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x04\x64\x61te\x12\x30\n\x05tuple\x18\x0e \x01(\x0b\x32\x18.chalk.python.v1.TyTupleH\x00R\x05tuple\x12-\n\x04\x64ict\x18\x0f \x01(\x0b\x32\x17.chalk.python.v1.TyDictH\x00R\x04\x64ict\x12\x35\n\x05\x62ytes\x18\x10 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x05\x62ytes\x12I\n\x0elogical_struct\x18\x11 \x01(\x0b\x32 .chalk.python.v1.TyLogicalStructH\x00R\rlogicalStruct\x12\x46\n\rfeature_class\x18\x12 \x01(\x0b\x32\x1f.chalk.python.v1.TyFeatureClassH\x00R\x0c\x66\x65\x61tureClass\x12-\n\x04\x65num\x18\x13 \x01(\x0b\x32\x17.chalk.python.v1.TyEnumH\x00R\x04\x65num\x12J\n\x10sequence_matcher\x18\x14 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x0fsequenceMatcher\x12<\n\tgenerator\x18\x15 \x01(\x0b\x32\x1c.chalk.python.v1.TyGeneratorH\x00R\tgeneratorB\x04\n\x02ty"\x0e\n\x0c\x45mptyMessage"g\n\rSymbolicConst\x12#\n\x02ty\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x02ty\x12\x31\n\x05value\x18\x02 \x01(\x0b\x32\x1b.chalk.arrow.v1.ScalarValueR\x05value":\n\x0c\x43odeVariable\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name\x12\x16\n\x06module\x18\x02 \x01(\tR\x06module"\x84\x01\n\x11\x43odeVariableValue\x12\x39\n\x08variable\x18\x01 \x01(\x0b\x32\x1d.chalk.python.v1.CodeVariableR\x08variable\x12\x34\n\x05value\x18\x02 \x01(\x0b\x32\x1e.chalk.python.v1.SymbolicConstR\x05value"\x9e\x02\n\x13GlobalVariablesInfo\x12I\n\x0e\x63ode_variables\x18\x01 \x03(\x0b\x32".chalk.python.v1.CodeVariableValueR\rcodeVariables\x12s\n\x15\x65nvironment_variables\x18\x02 \x03(\x0b\x32>.chalk.python.v1.GlobalVariablesInfo.EnvironmentVariablesEntryR\x14\x65nvironmentVariables\x1aG\n\x19\x45nvironmentVariablesEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12\x14\n\x05value\x18\x02 \x01(\tR\x05value:\x02\x38\x01\x42\x7f\n\x13\x63om.chalk.python.v1B\nTypesProtoP\x01\xa2\x02\x03\x43PX\xaa\x02\x0f\x43halk.Python.V1\xca\x02\x0f\x43halk\\Python\\V1\xe2\x02\x1b\x43halk\\Python\\V1\\GPBMetadata\xea\x02\x11\x43halk::Python::V1b\x06proto3'
+    b'\n\x1b\x63halk/python/v1/types.proto\x12\x0f\x63halk.python.v1\x1a\x1a\x63halk/arrow/v1/arrow.proto"2\n\x05TySet\x12)\n\x05items\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05items"3\n\x06TyList\x12)\n\x05items\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05items"7\n\nTyIterable\x12)\n\x05items\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05items"8\n\x0bTyGenerator\x12)\n\x05items\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05items"(\n\nTyDatetime\x12\x13\n\x02tz\x18\x01 \x01(\tH\x00R\x02tz\x88\x01\x01\x42\x05\n\x03_tz"Z\n\x06TyDict\x12%\n\x03key\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x03key\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05value"U\n\x07TyTuple\x12)\n\x05\x66ixed\x18\x01 \x03(\x0b\x32\x13.chalk.python.v1.TyR\x05\x66ixed\x12\x1f\n\x0bis_variable\x18\x02 \x01(\x08R\nisVariable"\xa7\x01\n\x0fTyLogicalStruct\x12\x44\n\x06\x66ields\x18\x01 \x03(\x0b\x32,.chalk.python.v1.TyLogicalStruct.FieldsEntryR\x06\x66ields\x1aN\n\x0b\x46ieldsEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05value:\x02\x38\x01"\xfb\x01\n\x0eTyFeatureClass\x12\x33\n\x15\x63onstructor_namespace\x18\x01 \x01(\tR\x14\x63onstructorNamespace\x12\\\n\x0f\x61ssigned_fields\x18\x02 \x03(\x0b\x32\x33.chalk.python.v1.TyFeatureClass.AssignedFieldsEntryR\x0e\x61ssignedFields\x1aV\n\x13\x41ssignedFieldsEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x05value:\x02\x38\x01"\x84\x01\n\x06TyEnum\x12\x16\n\x06module\x18\x01 \x01(\tR\x06module\x12\x12\n\x04name\x18\x02 \x01(\tR\x04name\x12)\n\x05\x62\x61ses\x18\x03 \x03(\x0b\x32\x13.chalk.python.v1.TyR\x05\x62\x61ses\x12#\n\x02ty\x18\x04 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x02ty"\x97\n\n\x02Ty\x12\x1a\n\x08nullable\x18\x01 \x01(\x08R\x08nullable\x12\x31\n\x03int\x18\x02 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x03int\x12\x31\n\x03str\x18\x03 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x03str\x12\x33\n\x04\x62ool\x18\x04 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x04\x62ool\x12\x35\n\x05\x66loat\x18\x05 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x05\x66loat\x12-\n\x04list\x18\x06 \x01(\x0b\x32\x17.chalk.python.v1.TyListH\x00R\x04list\x12*\n\x03set\x18\x07 \x01(\x0b\x32\x16.chalk.python.v1.TySetH\x00R\x03set\x12\x33\n\x04none\x18\x08 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x04none\x12\x31\n\x03\x61ny\x18\t \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x03\x61ny\x12\x39\n\x08iterable\x18\n \x01(\x0b\x32\x1b.chalk.python.v1.TyIterableH\x00R\x08iterable\x12\x39\n\x08\x64\x61tetime\x18\x0b \x01(\x0b\x32\x1b.chalk.python.v1.TyDatetimeH\x00R\x08\x64\x61tetime\x12=\n\ttimedelta\x18\x0c \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\ttimedelta\x12\x33\n\x04\x64\x61te\x18\r \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x04\x64\x61te\x12\x30\n\x05tuple\x18\x0e \x01(\x0b\x32\x18.chalk.python.v1.TyTupleH\x00R\x05tuple\x12-\n\x04\x64ict\x18\x0f \x01(\x0b\x32\x17.chalk.python.v1.TyDictH\x00R\x04\x64ict\x12\x35\n\x05\x62ytes\x18\x10 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x05\x62ytes\x12I\n\x0elogical_struct\x18\x11 \x01(\x0b\x32 .chalk.python.v1.TyLogicalStructH\x00R\rlogicalStruct\x12\x46\n\rfeature_class\x18\x12 \x01(\x0b\x32\x1f.chalk.python.v1.TyFeatureClassH\x00R\x0c\x66\x65\x61tureClass\x12-\n\x04\x65num\x18\x13 \x01(\x0b\x32\x17.chalk.python.v1.TyEnumH\x00R\x04\x65num\x12J\n\x10sequence_matcher\x18\x14 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x0fsequenceMatcher\x12<\n\tgenerator\x18\x15 \x01(\x0b\x32\x1c.chalk.python.v1.TyGeneratorH\x00R\tgenerator\x12\x35\n\x05never\x18\x16 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x05never\x12U\n\x16requests_http_response\x18\x17 \x01(\x0b\x32\x1d.chalk.python.v1.EmptyMessageH\x00R\x14requestsHttpResponseB\x04\n\x02ty"\x0e\n\x0c\x45mptyMessage"g\n\rSymbolicConst\x12#\n\x02ty\x18\x01 \x01(\x0b\x32\x13.chalk.python.v1.TyR\x02ty\x12\x31\n\x05value\x18\x02 \x01(\x0b\x32\x1b.chalk.arrow.v1.ScalarValueR\x05value":\n\x0c\x43odeVariable\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name\x12\x16\n\x06module\x18\x02 \x01(\tR\x06module"\x84\x01\n\x11\x43odeVariableValue\x12\x39\n\x08variable\x18\x01 \x01(\x0b\x32\x1d.chalk.python.v1.CodeVariableR\x08variable\x12\x34\n\x05value\x18\x02 \x01(\x0b\x32\x1e.chalk.python.v1.SymbolicConstR\x05value"\x9e\x02\n\x13GlobalVariablesInfo\x12I\n\x0e\x63ode_variables\x18\x01 \x03(\x0b\x32".chalk.python.v1.CodeVariableValueR\rcodeVariables\x12s\n\x15\x65nvironment_variables\x18\x02 \x03(\x0b\x32>.chalk.python.v1.GlobalVariablesInfo.EnvironmentVariablesEntryR\x14\x65nvironmentVariables\x1aG\n\x19\x45nvironmentVariablesEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12\x14\n\x05value\x18\x02 \x01(\tR\x05value:\x02\x38\x01\x42\x7f\n\x13\x63om.chalk.python.v1B\nTypesProtoP\x01\xa2\x02\x03\x43PX\xaa\x02\x0f\x43halk.Python.V1\xca\x02\x0f\x43halk\\Python\\V1\xe2\x02\x1b\x43halk\\Python\\V1\\GPBMetadata\xea\x02\x11\x43halk::Python::V1b\x06proto3'
 )
 
 _globals = globals()
@@ -59,17 +59,17 @@ if _descriptor._USE_C_DESCRIPTORS == False:
     _globals["_TYENUM"]._serialized_start = 942
     _globals["_TYENUM"]._serialized_end = 1074
     _globals["_TY"]._serialized_start = 1077
-    _globals["_TY"]._serialized_end = 2238
-    _globals["_EMPTYMESSAGE"]._serialized_start = 2240
-    _globals["_EMPTYMESSAGE"]._serialized_end = 2254
-    _globals["_SYMBOLICCONST"]._serialized_start = 2256
-    _globals["_SYMBOLICCONST"]._serialized_end = 2359
-    _globals["_CODEVARIABLE"]._serialized_start = 2361
-    _globals["_CODEVARIABLE"]._serialized_end = 2419
-    _globals["_CODEVARIABLEVALUE"]._serialized_start = 2422
-    _globals["_CODEVARIABLEVALUE"]._serialized_end = 2554
-    _globals["_GLOBALVARIABLESINFO"]._serialized_start = 2557
-    _globals["_GLOBALVARIABLESINFO"]._serialized_end = 2843
-    _globals["_GLOBALVARIABLESINFO_ENVIRONMENTVARIABLESENTRY"]._serialized_start = 2772
-    _globals["_GLOBALVARIABLESINFO_ENVIRONMENTVARIABLESENTRY"]._serialized_end = 2843
+    _globals["_TY"]._serialized_end = 2380
+    _globals["_EMPTYMESSAGE"]._serialized_start = 2382
+    _globals["_EMPTYMESSAGE"]._serialized_end = 2396
+    _globals["_SYMBOLICCONST"]._serialized_start = 2398
+    _globals["_SYMBOLICCONST"]._serialized_end = 2501
+    _globals["_CODEVARIABLE"]._serialized_start = 2503
+    _globals["_CODEVARIABLE"]._serialized_end = 2561
+    _globals["_CODEVARIABLEVALUE"]._serialized_start = 2564
+    _globals["_CODEVARIABLEVALUE"]._serialized_end = 2696
+    _globals["_GLOBALVARIABLESINFO"]._serialized_start = 2699
+    _globals["_GLOBALVARIABLESINFO"]._serialized_end = 2985
+    _globals["_GLOBALVARIABLESINFO_ENVIRONMENTVARIABLESENTRY"]._serialized_start = 2914
+    _globals["_GLOBALVARIABLESINFO_ENVIRONMENTVARIABLESENTRY"]._serialized_end = 2985
 # @@protoc_insertion_point(module_scope)

{chalkpy-2.91.4 → chalkpy-2.93.1}/chalk/_gen/chalk/python/v1/types_pb2.pyi

@@ -133,6 +133,8 @@ class Ty(_message.Message):
         "enum",
         "sequence_matcher",
         "generator",
+        "never",
+        "requests_http_response",
     )
     NULLABLE_FIELD_NUMBER: _ClassVar[int]
     INT_FIELD_NUMBER: _ClassVar[int]
@@ -155,6 +157,8 @@ class Ty(_message.Message):
     ENUM_FIELD_NUMBER: _ClassVar[int]
     SEQUENCE_MATCHER_FIELD_NUMBER: _ClassVar[int]
     GENERATOR_FIELD_NUMBER: _ClassVar[int]
+    NEVER_FIELD_NUMBER: _ClassVar[int]
+    REQUESTS_HTTP_RESPONSE_FIELD_NUMBER: _ClassVar[int]
     nullable: bool
     int: EmptyMessage
     str: EmptyMessage
@@ -176,6 +180,8 @@ class Ty(_message.Message):
     enum: TyEnum
     sequence_matcher: EmptyMessage
     generator: TyGenerator
+    never: EmptyMessage
+    requests_http_response: EmptyMessage
     def __init__(
         self,
         nullable: bool = ...,
@@ -199,6 +205,8 @@ class Ty(_message.Message):
         enum: _Optional[_Union[TyEnum, _Mapping]] = ...,
         sequence_matcher: _Optional[_Union[EmptyMessage, _Mapping]] = ...,
         generator: _Optional[_Union[TyGenerator, _Mapping]] = ...,
+        never: _Optional[_Union[EmptyMessage, _Mapping]] = ...,
+        requests_http_response: _Optional[_Union[EmptyMessage, _Mapping]] = ...,
     ) -> None: ...
 
 class EmptyMessage(_message.Message):

chalkpy-2.93.1/chalk/_version.py

@@ -0,0 +1 @@
+__version__ = "2.93.1"

{chalkpy-2.91.4 → chalkpy-2.93.1}/chalk/client/client_async.py

@@ -9,11 +9,13 @@ from uuid import UUID
 from chalk import DataFrame
 from chalk.client.models import (
     BulkOnlineQueryResponse,
+    BulkOnlineQueryResult,
     FeatureReference,
     FeatureStatisticsResponse,
     OfflineQueryInputUri,
     OnlineQuery,
     OnlineQueryContext,
+    PlanQueryResponse,
     ResourceRequests,
     UploadFeaturesResponse,
     WhoAmIResponse,
@@ -26,6 +28,7 @@ from chalk.prompts import Prompt
 if TYPE_CHECKING:
     import pandas as pd
     import polars as pl
+    import pyarrow as pa
 
     QueryInput = Mapping[FeatureReference, Any] | pd.DataFrame | pl.DataFrame | DataFrame | str
 
@@ -467,6 +470,147 @@ class AsyncChalkClient:
         """
         ...
 
+    async def plan_query(
+        self,
+        input: Sequence[FeatureReference],
+        output: Sequence[FeatureReference],
+        staleness: Mapping[FeatureReference, str] | None = None,
+        environment: EnvironmentId | None = None,
+        tags: list[str] | None = None,
+        preview_deployment_id: str | None = None,
+        branch: Union[BranchId, None] = ...,
+        query_name: str | None = None,
+        query_name_version: str | None = None,
+        meta: Mapping[str, str] | None = None,
+        store_plan_stages: bool = False,
+        explain: bool = False,
+        num_input_rows: Optional[int] = None,
+        headers: Mapping[str, str] | None = None,
+    ) -> PlanQueryResponse:
+        """Plan a query without executing it.
+
+        Parameters
+        ----------
+        input
+            The features for which there are known values, mapped to those values.
+            For example, `{User.id: 1234}`. Features can also be expressed as snakecased strings,
+            e.g. `{"user.id": 1234}`
+        output
+            Outputs are the features that you'd like to compute from the inputs.
+            For example, `[User.age, User.name, User.email]`.
+        staleness
+            Maximum staleness overrides for any output features or intermediate features.
+            See https://docs.chalk.ai/docs/query-caching for more information.
+        environment
+            The environment under which to run the resolvers.
+            API tokens can be scoped to an environment.
+            If no environment is specified in the query,
+            but the token supports only a single environment,
+            then that environment will be taken as the scope
+            for executing the request.
+        tags
+            The tags used to scope the resolvers.
+            See https://docs.chalk.ai/docs/resolver-tags for more information.
+        branch
+            If specified, Chalk will route your request to the relevant branch.
+        preview_deployment_id
+            If specified, Chalk will route your request to the relevant preview deployment.
+        query_name
+            The semantic name for the query you're making, for example, `"loan_application_model"`.
+            Typically, each query that you make from your application should have a name.
+            Chalk will present metrics and dashboard functionality grouped by 'query_name'.
+            If your query name matches a `NamedQuery`, the query will automatically pull outputs
+            and options specified in the matching `NamedQuery`.
+        query_name_version
+            If `query_name` is specified, this specifies the version of the named query you're making.
+            This is only useful if you want your query to use a `NamedQuery` with a specific name and a
+            specific version. If a `query_name` has not been supplied, then this parameter is ignored.
+        meta
+            Arbitrary `key:value` pairs to associate with a query.
+        store_plan_stages
+            If true, the plan will store the intermediate values at each stage in the plan
+        explain
+            If true, the plan will emit additional output to assist with debugging.
+        num_input_rows:
+            The number of input rows that this plan will be run with. If unknown, specify `None`.
+        headers
+            Additional headers to provide with the request
+
+        Returns
+        -------
+        PlanQueryResponse
+            The query plan, including the resolver execution order and the
+            resolver execution plan for each resolver.
+
+        Examples
+        --------
+        >>> from chalk.client import AsyncChalkClient
+        >>> result = await AsyncChalkClient().plan_query(
+        ...     input=[User.id],
+        ...     output=[User.fico_score],
+        ...     staleness={User.fico_score: "10m"},
+        ... )
+        >>> result.rendered_plan
+        >>> result.output_schema
+        """
+        ...
+
+    async def _run_serialized_query(
+        self,
+        serialized_plan_bytes: bytes,
+        input: Union[Mapping[FeatureReference, Sequence[Any]], pa.Table],
+        output: Sequence[FeatureReference] = (),
+        staleness: Mapping[FeatureReference, str] | None = None,
+        context: OnlineQueryContext | None = None,
+        query_name: str | None = None,
+        query_name_version: str | None = None,
+        correlation_id: str | None = None,
+        include_meta: bool = False,
+        explain: bool = False,
+        store_plan_stages: bool = False,
+        meta: Mapping[str, str] | None = None,
+        headers: Mapping[str, str] | None = None,
+    ) -> BulkOnlineQueryResult:
+        """Run a query using a pre-serialized plan.
+
+        This is a protected method for internal use and testing.
+
+        Parameters
+        ----------
+        serialized_plan_bytes
+            The serialized BatchPlan protobuf bytes
+        input
+            The input data, either as a mapping of features to values or as a PyArrow table
+        output
+            The output features to compute
+        staleness
+            Maximum staleness overrides for features
+        context
+            Query context including environment and tags
+        query_name
+            The name of the query
+        query_name_version
+            The version of the query
+        correlation_id
+            Correlation ID for logging
+        include_meta
+            Whether to include metadata in the response
+        explain
+            Whether to include explain output
+        store_plan_stages
+            Whether to store plan stages
+        meta
+            Customer metadata tags
+        headers
+            Additional headers to provide with the request
+
+        Returns
+        -------
+        OnlineQueryResult
+            The query result
+        """
+        ...
+
     async def offline_query(
         self,
         input: Union[QueryInput, OfflineQueryInputUri] | None = None,

{chalkpy-2.91.4 → chalkpy-2.93.1}/chalk/client/client_async_impl.py

@@ -18,8 +18,10 @@ from chalk.client.client_impl import ChalkAPIClientImpl, OnlineQueryResponseImpl
 from chalk.client.dataset import Dataset, DatasetImpl
 from chalk.client.models import (
     BulkOnlineQueryResponse,
+    BulkOnlineQueryResult,
     ChalkError,
     FeatureStatisticsResponse,
+    PlanQueryResponse,
     UploadFeaturesResponse,
     WhoAmIResponse,
 )
@@ -142,6 +144,26 @@ class AsyncChalkClientImpl(AsyncChalkClient):
             partial(self._client.query_bulk, *args, **kwargs),
         )
 
+    async def plan_query(
+        self,
+        *args: Any,
+        **kwargs: Any,
+    ) -> PlanQueryResponse:
+        return await self._current_loop().run_in_executor(
+            self._executor,
+            partial(self._client.plan_query, *args, **kwargs),
+        )
+
+    async def _run_serialized_query(
+        self,
+        *args: Any,
+        **kwargs: Any,
+    ) -> BulkOnlineQueryResult:
+        return await self._current_loop().run_in_executor(
+            self._executor,
+            partial(self._client._run_serialized_query, *args, **kwargs),  # pyright: ignore[reportPrivateUsage]
+        )
+
     async def offline_query(
         self,
         *args: Any,

{chalkpy-2.91.4 → chalkpy-2.93.1}/chalk/client/client_grpc.py

@@ -212,29 +212,26 @@ def _parse_uri_for_engine(query_server_uri: str) -> ParsedUri:
     return ParsedUri(uri_without_scheme=uri_without_scheme, use_tls=use_tls)
 
 
-channel_options: List[tuple[str, str | int]] = [
-    ("grpc.max_send_message_length", 1024 * 1024 * 100),  # 100MB
-    ("grpc.max_receive_message_length", 1024 * 1024 * 100),  # 100MB
+default_channel_options: Dict[str, str | int] = {
+    "grpc.max_send_message_length": 1024 * 1024 * 100,  # 100MB
+    "grpc.max_receive_message_length": 1024 * 1024 * 100,  # 100MB
     # https://grpc.io/docs/guides/performance/#python
-    (grpc.experimental.ChannelOptions.SingleThreadedUnaryStream, 1),
-    (
-        "grpc.service_config",
-        json.dumps(
-            {
-                "methodConfig": [
-                    {
-                        "name": [{}],
-                        "maxAttempts": 5,
-                        "initialBackoff": "0.1s",
-                        "maxBackoff": "1s",
-                        "backoffMultiplier": 2,
-                        "retryableStatusCodes": ["UNAVAILABLE"],
-                    }
-                ]
-            }
-        ),
+    grpc.experimental.ChannelOptions.SingleThreadedUnaryStream: 1,
+    "grpc.service_config": json.dumps(
+        {
+            "methodConfig": [
+                {
+                    "name": [{}],
+                    "maxAttempts": 5,
+                    "initialBackoff": "0.1s",
+                    "maxBackoff": "1s",
+                    "backoffMultiplier": 2,
+                    "retryableStatusCodes": ["UNAVAILABLE"],
+                }
+            ]
+        }
     ),
-]
+}
 
 
 T = TypeVar("T")
@@ -337,17 +334,25 @@ class StubProvider:
         deployment_tag: str | None = None,
         skip_api_server: bool = False,
         additional_headers: List[tuple[str, str]] | None = None,
+        channel_options: List[tuple[str, str | int]] | None = None,
     ):
         super().__init__()
         additional_headers_nonempty: List[tuple[str, str]] = [] if additional_headers is None else additional_headers
         token_refresher: TokenRefresher | None = None
+        channel_options_merged: Dict[str, str | int] = default_channel_options.copy()
+        if channel_options:
+            channel_options_merged.update(dict(channel_options))
         if skip_api_server:
             # Omits the auth handshake with the API server. Primarily for internal use/testing -- if used in production,
             # this client will simply fail to connect. If True then query_server must be provided & point to
             # `localhost/127.0.0.1`.
             if query_server is None:
                 raise ValueError("If skipping API server auth, query_server URI must be provided.")
-            elif not (query_server.startswith("localhost") or query_server.startswith("127.0.0.1")):
+            parsed_uri = _parse_uri_for_engine(query_server)
+            if not (
+                parsed_uri.uri_without_scheme.startswith("localhost")
+                or parsed_uri.uri_without_scheme.startswith("127.0.0.1")
+            ):
                 warnings.warn(
                     "Skipping API server auth should only be enabled if query_server URI is localhost. It will fail to authenticate against a production engine."
                 )
@@ -363,13 +368,13 @@ class StubProvider:
             _unauthenticated_server_channel: grpc.Channel = (
                 grpc.insecure_channel(
                     target=server_host,
-                    options=channel_options,
+                    options=list(channel_options_merged.items()),
                 )
                 if server_host.startswith("localhost") or server_host.startswith("127.0.0.1")
                 else grpc.secure_channel(
                     target=server_host,
                     credentials=grpc.ssl_channel_credentials(),
-                    options=channel_options,
+                    options=list(channel_options_merged.items()),
                 )
             )
 
@@ -443,12 +448,12 @@ class StubProvider:
                     grpc.secure_channel(
                         target=parsed_uri.uri_without_scheme,
                         credentials=grpc.ssl_channel_credentials(),
-                        options=channel_options,
+                        options=list(channel_options_merged.items()),
                     )
                     if parsed_uri.use_tls
                     else grpc.insecure_channel(
                         target=parsed_uri.uri_without_scheme,
-                        options=channel_options,
+                        options=list(channel_options_merged.items()),
                     )
                 ),
                 *interceptors,
@@ -463,6 +468,7 @@ class StubRefresher:
         deployment_tag: str | None = None,
         skip_api_server: bool = False,
         additional_headers: List[tuple[str, str]] | None = None,
+        channel_options: List[tuple[str, str | int]] | None = None,
     ):
         super().__init__()
         self._token_config = token_config
@@ -470,6 +476,7 @@ class StubRefresher:
         self._deployment_tag = deployment_tag
         self._skip_api_server = skip_api_server
         self._additional_headers = additional_headers
+        self._channel_options = channel_options
         self._stub = self._refresh_stub()
 
     def _refresh_stub(self) -> StubProvider:
@@ -479,6 +486,7 @@ class StubRefresher:
             deployment_tag=self._deployment_tag,
             skip_api_server=self._skip_api_server,
             additional_headers=self._additional_headers,
+            channel_options=self._channel_options,
         )
         return self._stub
 
@@ -561,6 +569,7 @@ class ChalkGRPCClient:
         additional_headers: List[tuple[str, str]] | None = None,
         query_server: str | None = None,
         input_compression: typing.Literal["lz4", "zstd", "uncompressed"] = "lz4",
+        channel_options: List[Tuple[str, str | int]] | None = None,
         **kwargs: Any,
     ):
         """Create a `ChalkGRPCClient` with the given credentials.
@@ -616,6 +625,7 @@ class ChalkGRPCClient:
             deployment_tag=deployment_tag,
             additional_headers=additional_headers,
             skip_api_server=kwargs.get("_skip_api_server", False),
+            channel_options=channel_options,
         )
 
     _INPUT_ENCODE_OPTIONS = GRPC_ENCODE_OPTIONS
@@ -859,7 +869,7 @@ class ChalkGRPCClient:
 
     def online_query_bulk(
         self,
-        input: Union[Mapping[FeatureReference, Sequence[Any]], DataFrame],
+        input: Union[Mapping[FeatureReference, Sequence[Any]], DataFrame, None] = None,
         output: Sequence[FeatureReference] = (),
         now: Optional[Sequence[dt.datetime]] = None,
         staleness: Optional[Mapping[FeatureReference, str]] = None,
@@ -878,9 +888,17 @@ class ChalkGRPCClient:
         request_timeout: Optional[float] = None,
         headers: Mapping[str, str | bytes] | Sequence[tuple[str, str | bytes]] | None = None,
         query_context: Mapping[str, Union[str, int, float, bool, None]] | str | None = None,
+        *,
+        input_sql: str | None = None,
     ) -> BulkOnlineQueryResult:
+        if input is None and input_sql is None:
+            raise TypeError("One of `input` or `input_sql` is required")
+        if input is not None and input_sql is not None:
+            raise TypeError("`input` and `input_sql` are mutually exclusive")
+
         response, call = self._online_query_bulk_grpc_request(
             input=input,
+            input_sql=input_sql,
             output=output,
             now=now,
             staleness=staleness,
@@ -907,7 +925,8 @@ class ChalkGRPCClient:
     def _online_query_bulk_grpc_request(
         self,
         *,
-        input: Union[Mapping[FeatureReference, Sequence[Any]], DataFrame],
+        input: Union[Mapping[FeatureReference, Sequence[Any]], DataFrame, None] = None,
+        input_sql: str | None = None,
         output: Sequence[FeatureReference] = (),
         now: Optional[Sequence[dt.datetime]] = None,
         staleness: Optional[Mapping[FeatureReference, str]] = None,
@@ -928,8 +947,10 @@ class ChalkGRPCClient:
         query_context: Mapping[str, Union[str, int, float, bool, None]] | None = None,
     ) -> Tuple[online_query_pb2.OnlineQueryBulkResponse, grpc.Call]:
         """Returns the raw GRPC response and metadata"""
+
         request = self._make_query_bulk_request(
             input=input,
+            input_sql=input_sql,
             output=output,
             now=now or (),
             staleness=staleness or {},
@@ -1118,7 +1139,9 @@ class ChalkGRPCClient:
 
     def _make_query_bulk_request(
         self,
-        input: Mapping[FeatureReference, Sequence[Any]] | DataFrame,
+        *,
+        input: Mapping[FeatureReference, Sequence[Any]] | DataFrame | None = None,
+        input_sql: str | None = None,
         output: Sequence[FeatureReference],
         now: Sequence[dt.datetime],
         staleness: Mapping[FeatureReference, str],
@@ -1136,9 +1159,19 @@ class ChalkGRPCClient:
         planner_options: Mapping[str, str | int | bool],
         query_context: Mapping[str, Union[str, int, float, bool, None]] | str | None,
     ) -> online_query_pb2.OnlineQueryBulkRequest:
-        inputs_bytes = get_features_feather_bytes(
-            input, self._INPUT_ENCODE_OPTIONS, compression=self._input_compression
-        )
+        if input is None and input_sql is None:
+            raise TypeError("One of `input` or `input_sql` is required")
+        if input is not None and input_sql is not None:
+            raise TypeError("`input` and `input_sql` are mutually exclusive")
+
+        inputs_feather: bytes | None
+        if input is None:
+            inputs_feather = None
+        else:
+            inputs_feather = get_features_feather_bytes(
+                input, self._INPUT_ENCODE_OPTIONS, compression=self._input_compression
+            )
+
         encoded_outputs = encode_outputs(output)
         outputs = encoded_outputs.string_outputs
         # Currently assume every feature tag is just a fqn instead of a more complex expr.
@@ -1167,7 +1200,8 @@ class ChalkGRPCClient:
         query_context = _validate_context_dict(query_context)
         query_context_proto = {k: value_to_proto(v) for k, v in query_context.items()} if query_context else None
         return online_query_pb2.OnlineQueryBulkRequest(
-            inputs_feather=inputs_bytes,
+            inputs_feather=inputs_feather,
+            inputs_sql=input_sql,
             outputs=[online_query_pb2.OutputExpr(feature_fqn=o) for o in outputs]
             + [online_query_pb2.OutputExpr(feature_expression=o) for o in encoded_outputs.feature_expressions_proto],
             now=now_proto,