chalkpy 2.97.1__py3-none-any.whl → 2.97.3__py3-none-any.whl

chalk/_gen/chalk/server/v1/named_query_pb2.py

@@ -18,7 +18,7 @@ from chalk._gen.chalk.graph.v1 import graph_pb2 as chalk_dot_graph_dot_v1_dot_gr
 
 
 DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
-    b'\n!chalk/server/v1/named_query.proto\x12\x0f\x63halk.server.v1\x1a\x1f\x63halk/auth/v1/permissions.proto\x1a\x1a\x63halk/graph/v1/graph.proto"@\n\x19GetAllNamedQueriesRequest\x12#\n\rdeployment_id\x18\x01 \x01(\tR\x0c\x64\x65ploymentId"0\n\x1aGetNamedQueryByNameRequest\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name"^\n\x1bGetNamedQueryByNameResponse\x12?\n\rnamed_queries\x18\x01 \x03(\x0b\x32\x1a.chalk.graph.v1.NamedQueryR\x0cnamedQueries"]\n\x1aGetAllNamedQueriesResponse\x12?\n\rnamed_queries\x18\x01 \x03(\x0b\x32\x1a.chalk.graph.v1.NamedQueryR\x0cnamedQueries"+\n)GetAllNamedQueriesActiveDeploymentRequest"m\n*GetAllNamedQueriesActiveDeploymentResponse\x12?\n\rnamed_queries\x18\x01 \x03(\x0b\x32\x1a.chalk.graph.v1.NamedQueryR\x0cnamedQueries2\xac\x03\n\x11NamedQueryService\x12u\n\x12GetAllNamedQueries\x12*.chalk.server.v1.GetAllNamedQueriesRequest\x1a+.chalk.server.v1.GetAllNamedQueriesResponse"\x06\x90\x02\x01\x80}\x0b\x12\xa5\x01\n"GetAllNamedQueriesActiveDeployment\x12:.chalk.server.v1.GetAllNamedQueriesActiveDeploymentRequest\x1a;.chalk.server.v1.GetAllNamedQueriesActiveDeploymentResponse"\x06\x90\x02\x01\x80}\x0b\x12x\n\x13GetNamedQueryByName\x12+.chalk.server.v1.GetNamedQueryByNameRequest\x1a,.chalk.server.v1.GetNamedQueryByNameResponse"\x06\x90\x02\x01\x80}\x0b\x42\x98\x01\n\x13\x63om.chalk.server.v1B\x0fNamedQueryProtoP\x01Z\x12server/v1;serverv1\xa2\x02\x03\x43SX\xaa\x02\x0f\x43halk.Server.V1\xca\x02\x0f\x43halk\\Server\\V1\xe2\x02\x1b\x43halk\\Server\\V1\\GPBMetadata\xea\x02\x11\x43halk::Server::V1b\x06proto3'
+    b'\n!chalk/server/v1/named_query.proto\x12\x0f\x63halk.server.v1\x1a\x1f\x63halk/auth/v1/permissions.proto\x1a\x1a\x63halk/graph/v1/graph.proto"@\n\x19GetAllNamedQueriesRequest\x12#\n\rdeployment_id\x18\x01 \x01(\tR\x0c\x64\x65ploymentId"l\n\x1aGetNamedQueryByNameRequest\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name\x12(\n\rquery_version\x18\x02 \x01(\tH\x00R\x0cqueryVersion\x88\x01\x01\x42\x10\n\x0e_query_version"^\n\x1bGetNamedQueryByNameResponse\x12?\n\rnamed_queries\x18\x01 \x03(\x0b\x32\x1a.chalk.graph.v1.NamedQueryR\x0cnamedQueries"]\n\x1aGetAllNamedQueriesResponse\x12?\n\rnamed_queries\x18\x01 \x03(\x0b\x32\x1a.chalk.graph.v1.NamedQueryR\x0cnamedQueries"+\n)GetAllNamedQueriesActiveDeploymentRequest"m\n*GetAllNamedQueriesActiveDeploymentResponse\x12?\n\rnamed_queries\x18\x01 \x03(\x0b\x32\x1a.chalk.graph.v1.NamedQueryR\x0cnamedQueries2\xac\x03\n\x11NamedQueryService\x12u\n\x12GetAllNamedQueries\x12*.chalk.server.v1.GetAllNamedQueriesRequest\x1a+.chalk.server.v1.GetAllNamedQueriesResponse"\x06\x90\x02\x01\x80}\x0b\x12\xa5\x01\n"GetAllNamedQueriesActiveDeployment\x12:.chalk.server.v1.GetAllNamedQueriesActiveDeploymentRequest\x1a;.chalk.server.v1.GetAllNamedQueriesActiveDeploymentResponse"\x06\x90\x02\x01\x80}\x0b\x12x\n\x13GetNamedQueryByName\x12+.chalk.server.v1.GetNamedQueryByNameRequest\x1a,.chalk.server.v1.GetNamedQueryByNameResponse"\x06\x90\x02\x01\x80}\x0b\x42\x98\x01\n\x13\x63om.chalk.server.v1B\x0fNamedQueryProtoP\x01Z\x12server/v1;serverv1\xa2\x02\x03\x43SX\xaa\x02\x0f\x43halk.Server.V1\xca\x02\x0f\x43halk\\Server\\V1\xe2\x02\x1b\x43halk\\Server\\V1\\GPBMetadata\xea\x02\x11\x43halk::Server::V1b\x06proto3'
 )
 
 _globals = globals()
@@ -40,15 +40,15 @@ if _descriptor._USE_C_DESCRIPTORS == False:
     _globals["_GETALLNAMEDQUERIESREQUEST"]._serialized_start = 115
     _globals["_GETALLNAMEDQUERIESREQUEST"]._serialized_end = 179
     _globals["_GETNAMEDQUERYBYNAMEREQUEST"]._serialized_start = 181
-    _globals["_GETNAMEDQUERYBYNAMEREQUEST"]._serialized_end = 229
-    _globals["_GETNAMEDQUERYBYNAMERESPONSE"]._serialized_start = 231
-    _globals["_GETNAMEDQUERYBYNAMERESPONSE"]._serialized_end = 325
-    _globals["_GETALLNAMEDQUERIESRESPONSE"]._serialized_start = 327
-    _globals["_GETALLNAMEDQUERIESRESPONSE"]._serialized_end = 420
-    _globals["_GETALLNAMEDQUERIESACTIVEDEPLOYMENTREQUEST"]._serialized_start = 422
-    _globals["_GETALLNAMEDQUERIESACTIVEDEPLOYMENTREQUEST"]._serialized_end = 465
-    _globals["_GETALLNAMEDQUERIESACTIVEDEPLOYMENTRESPONSE"]._serialized_start = 467
-    _globals["_GETALLNAMEDQUERIESACTIVEDEPLOYMENTRESPONSE"]._serialized_end = 576
-    _globals["_NAMEDQUERYSERVICE"]._serialized_start = 579
-    _globals["_NAMEDQUERYSERVICE"]._serialized_end = 1007
+    _globals["_GETNAMEDQUERYBYNAMEREQUEST"]._serialized_end = 289
+    _globals["_GETNAMEDQUERYBYNAMERESPONSE"]._serialized_start = 291
+    _globals["_GETNAMEDQUERYBYNAMERESPONSE"]._serialized_end = 385
+    _globals["_GETALLNAMEDQUERIESRESPONSE"]._serialized_start = 387
+    _globals["_GETALLNAMEDQUERIESRESPONSE"]._serialized_end = 480
+    _globals["_GETALLNAMEDQUERIESACTIVEDEPLOYMENTREQUEST"]._serialized_start = 482
+    _globals["_GETALLNAMEDQUERIESACTIVEDEPLOYMENTREQUEST"]._serialized_end = 525
+    _globals["_GETALLNAMEDQUERIESACTIVEDEPLOYMENTRESPONSE"]._serialized_start = 527
+    _globals["_GETALLNAMEDQUERIESACTIVEDEPLOYMENTRESPONSE"]._serialized_end = 636
+    _globals["_NAMEDQUERYSERVICE"]._serialized_start = 639
+    _globals["_NAMEDQUERYSERVICE"]._serialized_end = 1067
 # @@protoc_insertion_point(module_scope)

chalk/_gen/chalk/server/v1/named_query_pb2.pyi

@@ -20,10 +20,12 @@ class GetAllNamedQueriesRequest(_message.Message):
     def __init__(self, deployment_id: _Optional[str] = ...) -> None: ...
 
 class GetNamedQueryByNameRequest(_message.Message):
-    __slots__ = ("name",)
+    __slots__ = ("name", "query_version")
     NAME_FIELD_NUMBER: _ClassVar[int]
+    QUERY_VERSION_FIELD_NUMBER: _ClassVar[int]
     name: str
-    def __init__(self, name: _Optional[str] = ...) -> None: ...
+    query_version: str
+    def __init__(self, name: _Optional[str] = ..., query_version: _Optional[str] = ...) -> None: ...
 
 class GetNamedQueryByNameResponse(_message.Message):
     __slots__ = ("named_queries",)

chalk/_version.py

@@ -1 +1 @@
-__version__ = "2.97.1"
+__version__ = "2.97.3"

chalk/client/client.py

@@ -33,6 +33,7 @@ from chalk.client.models import (
     GetRegisteredModelResponse,
     GetRegisteredModelVersionResponse,
     ManualTriggerScheduledQueryResponse,
+    NamedQueryMetadata,
     OfflineQueryDeadlineOptions,
     OfflineQueryInputUri,
     OnlineQuery,
@@ -527,7 +528,7 @@ class ChalkClient:
         explain: bool = False,
         num_input_rows: Optional[int] = None,
         headers: Mapping[str, str] | None = None,
-        planner_options: Mapping[str, str | int | bool] | None = None,
+        planner_options: Mapping[str, Any] | None = None,
     ) -> PlanQueryResponse:
         """Plan a query without executing it.
 
@@ -1169,6 +1170,36 @@ class ChalkClient:
         """
         ...
 
+    def get_named_query_metadata(
+        self,
+        name: str,
+        query_version: str | None = None,
+    ) -> List[NamedQueryMetadata]:
+        """
+        Get the metadata associated with named queries.
+
+        Parameters
+        ----------
+        name
+            The name of the named query.
+        query_version
+            The query version of the named query. Returns all versions of the named query by default.
+
+        Returns
+        -------
+        list[ScheduledQueryRun]
+            A response message containing the list of metadata of named queries.
+
+        Examples
+        --------
+        >>> from chalk.client import ChalkClient
+        >>> ChalkClient().get_named_query_metadata(
+        ...     name="my_named_query",
+        ...     query_version="1.1.0",
+        ... )
+        """
+        ...
+
     def prompt_evaluation(
         self,
         prompts: list[Prompt | str],

chalk/client/client_async.py

@@ -487,7 +487,7 @@ class AsyncChalkClient:
         explain: bool = False,
         num_input_rows: Optional[int] = None,
         headers: Mapping[str, str] | None = None,
-        planner_options: Mapping[str, str | int | bool] | None = None,
+        planner_options: Mapping[str, Any] | None = None,
     ) -> PlanQueryResponse:
         """Plan a query without executing it.
 

chalk/client/client_grpc.py

@@ -74,6 +74,8 @@ from chalk._gen.chalk.server.v1.model_registry_pb2 import (
     GetModelVersionResponse,
 )
 from chalk._gen.chalk.server.v1.model_registry_pb2_grpc import ModelRegistryServiceStub
+from chalk._gen.chalk.server.v1.named_query_pb2 import GetNamedQueryByNameRequest
+from chalk._gen.chalk.server.v1.named_query_pb2_grpc import NamedQueryServiceStub
 from chalk._gen.chalk.server.v1.offline_queries_pb2_grpc import OfflineQueryMetadataServiceStub
 from chalk._gen.chalk.server.v1.scheduled_query_pb2_grpc import ScheduledQueryServiceStub
 from chalk._gen.chalk.server.v1.scheduled_query_run_pb2 import GetScheduledQueryRunsRequest
@@ -102,6 +104,7 @@ from chalk.client.models import (
 from chalk.client.models import ManualTriggerScheduledQueryResponse as ManualTriggerScheduledQueryResponseDataclass
 from chalk.client.models import (
     ModelUploadUrlResponse,
+    NamedQueryMetadata,
     OnlineQuery,
     OnlineQueryResponse,
     RegisterModelArtifactResponse,
@@ -310,6 +313,14 @@ class StubProvider:
             )
         return ScheduledQueryServiceStub(self._server_channel)
 
+    @cached_property
+    def named_query_stub(self) -> NamedQueryServiceStub:
+        if self._server_channel is None:
+            raise ValueError(
+                "The GRPC engine service is not available. If you would like to set up a GRPC service, please contact Chalk."
+            )
+        return NamedQueryServiceStub(self._server_channel)
+
     @cached_property
     def sql_stub(self) -> SqlServiceStub:
         if self._engine_channel is None:
@@ -568,6 +579,9 @@ class StubRefresher:
     def call_scheduled_query_run_stub(self, fn: Callable[[ScheduledQueryServiceStub], T]) -> T:
         return self._retry_callable(fn, lambda: self._stub.scheduled_query_run_stub)
 
+    def call_get_named_query_metadata(self, fn: Callable[[NamedQueryServiceStub], T]) -> T:
+        return self._retry_callable(fn, lambda: self._stub.named_query_stub)
+
     def call_sql_stub(self, fn: Callable[[SqlServiceStub], T]) -> T:
         return self._retry_callable(fn, lambda: self._stub.sql_stub)
 
@@ -1376,6 +1390,45 @@ class ChalkGRPCClient:
         )
         return [ScheduledQueryRun.from_proto(run) for run in proto_resp.runs]
 
+    def get_named_query_metadata(
+        self,
+        name: str,
+        query_version: str | None = None,
+    ) -> List[NamedQueryMetadata]:
+        """
+        Get the metadata associated with named queries.
+
+        Parameters
+        ----------
+        name
+            The name of the named query.
+        query_version
+            The query version of the named query. Returns all versions of the named query by default.
+
+        Returns
+        -------
+        list[ScheduledQueryRun]
+            A response message containing the list of metadata of named queries.
+
+        Examples
+        --------
+        >>> from chalk.client import ChalkClient
+        >>> ChalkClient().get_named_query_metadata(
+        ...     name="my_named_query",
+        ...     query_version="1.1.0",
+        ... )
+        """
+        proto_resp = self._stub_refresher.call_get_named_query_metadata(
+            lambda x: x.GetNamedQueryByName(
+                request=GetNamedQueryByNameRequest(
+                    name=name,
+                    query_version=query_version,
+                )
+            )
+        )
+
+        return [NamedQueryMetadata.from_proto(nq) for nq in proto_resp.named_queries]
+
     def get_graph(self, deployment: DeploymentId | None = None) -> Graph:
         """Get the graph for a given deployment.
 

chalk/client/client_impl.py

@@ -102,6 +102,7 @@ from chalk.client.models import (
     ManualTriggerScheduledQueryResponse,
     MultiUploadFeaturesRequest,
     MultiUploadFeaturesResponse,
+    NamedQueryMetadata,
     OfflineQueryContext,
     OfflineQueryDeadlineOptions,
     OfflineQueryInput,
@@ -1032,6 +1033,10 @@ class ChalkAPIClientImpl(ChalkClient):
         self._branch: str | None = branch
         self._skip_token_cache: bool = _skip_cache
         self._api_server: str | None = api_server
+        self._env_id_to_engine_url_map: Mapping[str, str] | None = None
+        self._env_id_to_env_name_map: Mapping[str, str] | None = None
+        self._env_name_to_env_id_map: Mapping[str, str] | None = None
+        self._access_token: str | None = None
 
         self._default_headers = {
             "Accept": "application/json",
@@ -1042,7 +1047,7 @@ class ChalkAPIClientImpl(ChalkClient):
         if additional_headers:
             self._default_headers.update(additional_headers)
 
-        self._primary_environment = environment
+        self._primary_environment: EnvironmentId | None = environment
 
         self.__class__.latest_client = self
         if notebook.is_notebook():
@@ -1115,11 +1120,16 @@ class ChalkAPIClientImpl(ChalkClient):
             creds = ExchangeCredentialsResponse(**response_json)
         except ValidationError:
             raise HTTPError(response=resp)
+        self._access_token = creds.access_token
         self._default_headers["Authorization"] = f"Bearer {creds.access_token}"
         # FIXME: We should NOT be using the X-Chalk-Client-Id for anything, as it is NOT authenticated
         self._default_headers["X-Chalk-Client-Id"] = self._client_id
         if self._primary_environment is None:
             self._primary_environment = creds.primary_environment
+        self._env_id_to_engine_url_map = creds.engines
+        self._env_id_to_env_name_map = creds.environment_id_to_name
+        if self._env_id_to_env_name_map is not None:
+            self._env_name_to_env_id_map = {v: k for k, v in self._env_id_to_env_name_map.items()}
 
     def _get_headers(
         self,
@@ -1382,6 +1392,48 @@ https://docs.chalk.ai/docs/debugging-queries#resolver-replay
             method=method, headers=headers, url=url, json=json_body, data=data, timeout=timeout_value
         )
 
+    def _get_engine_host(self, environment_override: Optional[str]) -> str | None:
+        """
+        Returns the host to use for data-plane requests to the engine. May fall back to
+        the metadata plane api server host if no engine host can be determined.
+        :param environment_override: Optional user-provided environment name or id.
+        :return: Host for direct engine (data-plane) requests
+        """
+
+        # always respect user-provided query_server override
+        if self._query_server is not None:
+            return self._query_server
+
+        # if we have no environment information, we likely have not done creds exchange yet.
+        # there's no way to determine an engine host here, so just fall back to api server
+        env_id_or_name: str | None = environment_override or self._primary_environment
+        if env_id_or_name is None:
+            return self._api_server
+
+        # get the correct engine url given a valid env id or env name
+        if self._env_id_to_engine_url_map is not None:
+            if env_id_or_name in self._env_id_to_engine_url_map:
+                return self._env_id_to_engine_url_map[env_id_or_name]
+            elif self._env_name_to_env_id_map is not None and env_id_or_name in self._env_name_to_env_id_map:
+                env_id = self._env_name_to_env_id_map[env_id_or_name]
+                return self._env_id_to_engine_url_map.get(env_id, self._api_server)
+
+        # env name or id is invalid, or we failed to auth, so fall back to api server
+        return self._api_server
+
+    def _get_request_host(self, metadata_request: bool, environment_override: Optional[str]) -> str | None:
+        """
+        Returns the hostname to use for any requests made by the Chalk Client, whether they are
+        metadata-plane-only requests or data-plane requests (to the engine).
+        :param metadata_request: Is this a metadata-plane-only request? If so, we always use the API server.
+        :param environment_override: Optional user-provided environment name or id.
+        :return: Host to use for any request made by the Chalk Client
+        """
+        if metadata_request:
+            return self._api_server
+        else:
+            return self._get_engine_host(environment_override)
+
     def _request(
         self,
         method: str,
@@ -1398,25 +1450,20 @@ https://docs.chalk.ai/docs/debugging-queries#resolver-replay
         timeout: float | None | ellipsis = ...,
         connect_timeout: float | None | ellipsis = ...,
     ) -> T | requests.Response:
+        # If we don't have an access token, we cannot make a request.
+        # Always fetch an access token if we do not have one before making a request.
+        # If we fetched an access token during this call and we get 401/403 on this request,
+        # then do not retry the credential exchange again.
         allow_credential_exchange: bool = True
-
-        if metadata_request or self._query_server is None:
-            host = self._api_server
-        else:
-            host = self._query_server
-
-        if host is None:
-            # We definitively need to exchange credentials to get a host
+        if self._access_token is None:
             self._exchange_credentials()
             allow_credential_exchange = False
 
-            # After exchanging credentials, the api server is never none
-            assert self._api_server is not None
+        host = self._get_request_host(metadata_request, environment_override)
 
-            if metadata_request or self._query_server is None:
-                host = self._api_server
-            else:
-                host = self._query_server
+        # After exchanging credentials, the api server is never null, and the request host
+        # helper function falls back to the api server if it cannot determine an engine url
+        assert host is not None, "After credential exchange, the request host must be non-null"
 
         r = self._do_request_inner(
             method=method,
@@ -1437,14 +1484,11 @@ https://docs.chalk.ai/docs/debugging-queries#resolver-replay
             # It is possible that credentials expired, or that we changed permissions since we last
             # got a token. Exchange them and try again
             self._exchange_credentials()
+            host = self._get_request_host(metadata_request, environment_override)
 
-            # After exchanging credentials, the api server is never null
-            assert self._api_server is not None
-
-            if metadata_request or self._query_server is None:
-                host = self._api_server
-            else:
-                host = self._query_server
+            # After exchanging credentials, the api server is never null, and the request host
+            # helper function falls back to the api server if it cannot determine an engine url
+            assert host is not None, "After credential exchange, the request host must be non-null"
 
             r = self._do_request_inner(
                 method=method,
@@ -2519,6 +2563,50 @@ https://docs.chalk.ai/cli/apply
             limit=limit,
         )
 
+    def get_named_query_metadata(
+        self,
+        name: str,
+        query_version: str | None = None,
+    ) -> List[NamedQueryMetadata]:
+        """
+        Get the metadata associated with named queries.
+
+        Parameters
+        ----------
+        name
+            The name of the named query.
+        query_version
+            The query version of the named query. Returns all versions of the named query by default.
+
+        Returns
+        -------
+        list[ScheduledQueryRun]
+            A response message containing the list of metadata of named queries.
+
+        Examples
+        --------
+        >>> from chalk.client import ChalkClient
+        >>> ChalkClient().get_named_query_metadata(
+        ...     name="my_named_query",
+        ...     query_version="1.1.0",
+        ... )
+        """
+        from chalk.client.client_grpc import ChalkGRPCClient
+
+        client_grpc = ChalkGRPCClient(
+            client_id=self._client_id,
+            client_secret=self._client_secret,
+            environment=self._primary_environment,
+            api_server=self._api_server,
+        )
+
+        resp = client_grpc.get_named_query_metadata(
+            name=name,
+            query_version=query_version,
+        )
+
+        return resp
+
     def prompt_evaluation(
         self,
         prompts: list[Prompt | str],
@@ -3942,9 +4030,8 @@ https://docs.chalk.ai/cli/apply
             environment_override=context.environment,
             preview_deployment_id=preview_deployment_id,
             branch=branch,
-            # If using multiple computers, then we must route through the metadata server
-            # So we can actually spin up multiple pods
-            metadata_request=request.use_multiple_computers,
+            # all offline query requests should be routed through api server
+            metadata_request=True,
         )
         return response
 
@@ -4020,19 +4107,6 @@ https://docs.chalk.ai/cli/apply
             branch=None,
         )
 
-    def _get_query_inputs(
-        self, job_id: uuid.UUID, environment: Optional[EnvironmentId], branch: Optional[BranchId]
-    ) -> GetOfflineQueryJobResponse:
-        return self._request(
-            method="GET",
-            uri=f"/v2/offline_query_inputs/{job_id}",
-            response=GetOfflineQueryJobResponse,
-            environment_override=environment,
-            json=None,
-            preview_deployment_id=None,
-            branch=branch,
-        )
-
     def _get_dataset_from_name_or_id(
         self,
         *,
@@ -4446,7 +4520,7 @@ https://docs.chalk.ai/cli/apply
         explain: bool = False,
         num_input_rows: Optional[int] = None,
         headers: Mapping[str, str] | None = None,
-        planner_options: Mapping[str, str | int | bool] | None = None,
+        planner_options: Mapping[str, Any] | None = None,
     ) -> PlanQueryResponse:
         encoded_inputs = encode_outputs(input).string_outputs
         outputs = encode_outputs(output).string_outputs

chalk/client/models.py

@@ -454,6 +454,8 @@ class ExchangeCredentialsResponse(BaseModel):
     api_server: str
     primary_environment: Optional[str] = None
     engines: Optional[Mapping[str, str]] = None
+    grpc_engines: Optional[Mapping[str, str]] = None
+    environment_id_to_name: Optional[Mapping[str, str]] = None
 
 
 class OfflineQueryInput(BaseModel):
@@ -1053,6 +1055,53 @@ class CreateOfflineQueryJobResponse(BaseModel):
     errors: Optional[List[ChalkError]] = None
 
 
+@dataclasses.dataclass
+class NamedQueryMetadata:
+    """Metadata for a named query returned from the API."""
+
+    name: str
+    input: List[str]
+    output: List[str]
+    query_version: Optional[str] = None
+    tags: Optional[List[str]] = None
+    description: Optional[str] = None
+    owner: Optional[str] = None
+    meta: Optional[Dict[str, str]] = None
+    staleness: Optional[Dict[str, timedelta]] = None
+    planner_options: Optional[Dict[str, str]] = None
+    additional_logged_features: Optional[List[str]] = None
+    valid_plan_not_required: Optional[bool] = None
+
+    @staticmethod
+    def from_proto(proto_nq: Any) -> "NamedQueryMetadata":
+        """Convert a proto NamedQuery to the dataclass version."""
+        # Convert proto Duration to timedelta
+        staleness = None
+        if proto_nq.staleness:
+            staleness = {
+                k: timedelta(seconds=v.seconds, microseconds=v.nanos / 1000) for k, v in proto_nq.staleness.items()
+            }
+
+        return NamedQueryMetadata(
+            name=proto_nq.name,
+            query_version=proto_nq.query_version if proto_nq.HasField("query_version") else None,
+            input=list(proto_nq.input),
+            output=list(proto_nq.output),
+            tags=list(proto_nq.tags) if proto_nq.tags else None,
+            description=proto_nq.description if proto_nq.HasField("description") else None,
+            owner=proto_nq.owner if proto_nq.HasField("owner") else None,
+            meta=dict(proto_nq.meta) if proto_nq.meta else None,
+            staleness=staleness,
+            planner_options=dict(proto_nq.planner_options) if proto_nq.planner_options else None,
+            additional_logged_features=list(proto_nq.additional_logged_features)
+            if proto_nq.additional_logged_features
+            else None,
+            valid_plan_not_required=proto_nq.valid_plan_not_required
+            if proto_nq.HasField("valid_plan_not_required")
+            else None,
+        )
+
+
 class CreateBranchResponse(BaseModel):
     branch_already_exists: bool
     errors: Optional[List[ChalkError]] = None
@@ -1696,7 +1745,7 @@ class PlanQueryRequest(BaseModel):
     explain: bool = False
     store_plan_stages: bool = False
     encoding_options: FeatureEncodingOptions = FeatureEncodingOptions()
-    planner_options: Mapping[str, str | int | bool | float] | None = None
+    planner_options: Mapping[str, Any] | None = None
 
 
 class FeatureSchema(BaseModel):

chalk/features/feature_set_decorator.py

@@ -1330,12 +1330,15 @@ def _process_class(
                     error_builder=error_builder,
                 )
 
-                # copy over expressions for default version
+                # copy over expressions and metadata for default version
                 if i == f.version.default:
                     if f.underscore_expression is None and f_i.underscore_expression is not None:
                         f.underscore_expression = f_i.underscore_expression
                     if f.offline_underscore_expression is None and f_i.offline_underscore_expression is not None:
                         f.offline_underscore_expression = f_i.offline_underscore_expression
+                    # Copy description from the explicitly defined default version
+                    if f.description is None and f_i.description is not None:
+                        f.description = f_i.description
 
                 f.version.reference[i] = f_i
                 # The default feature already exists.

{chalkpy-2.97.1.dist-info → chalkpy-2.97.3.dist-info}/METADATA

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

{chalkpy-2.97.1.dist-info → chalkpy-2.97.3.dist-info}/RECORD

@@ -1,5 +1,5 @@
 chalk/__init__.py,sha256=vKsx9-cl5kImlVWGHVRYO6bweBm79NAzGs3l36u71wM,2657
-chalk/_version.py,sha256=6qCfeI3PjUH5FsIClIHAaHVHYcn8ZfsURLCWNOVYMNE,23
+chalk/_version.py,sha256=svi3Ka1WRt3F0YuX1rlhRU-HxbWCqSYRydLO9H7Qj_w,23
 chalk/cli.py,sha256=ckqqfOI-A2mT23-rnZzDMmblYj-2x1VBX8ebHlIEn9A,5873
 chalk/importer.py,sha256=m4lMn1lSYj_euDq8CS7LYTBnek9JOcjGJf9-82dJHbA,64441
 chalk/prompts.py,sha256=2H9UomLAamdfRTNUdKs9i3VTpiossuyRhntqsAXUhhg,16117
@@ -468,8 +468,8 @@ chalk/_gen/chalk/server/v1/monitoring_pb2.py,sha256=6N-4AAGC7dZdyNVk2MPdXrK-OdNT
 chalk/_gen/chalk/server/v1/monitoring_pb2.pyi,sha256=vE8FBZYxSVYTB0TmJrAA5vnjF4WYK8ga7DRYY4HzN44,18625
 chalk/_gen/chalk/server/v1/monitoring_pb2_grpc.py,sha256=DX6HbDO1dy8eEuxVRKlYL_ymsTQIXoW1vWPeMee0UsQ,36169
 chalk/_gen/chalk/server/v1/monitoring_pb2_grpc.pyi,sha256=LQj-vgn0FRUMMTzQ7Nk1U5t21wwiOCLzFeG2vkAaG5I,7984
-chalk/_gen/chalk/server/v1/named_query_pb2.py,sha256=zI_GWCj0C9re3N4-rJwiqlEeRkJJ0AbwDRKolym0c1A,4563
-chalk/_gen/chalk/server/v1/named_query_pb2.pyi,sha256=InM5LShJ1PENmIqn63eC8Oa5JUsnVv6jtrnnBgbyLx8,2078
+chalk/_gen/chalk/server/v1/named_query_pb2.py,sha256=LiVui-Vk4uK4eeyw14eP2RD9YLBPCDLDcV9fkOUc3rY,4663
+chalk/_gen/chalk/server/v1/named_query_pb2.pyi,sha256=vPer7Oc9XJwxvv0wb_6sjwJ98BKMnwKzCvjB-i8UUUk,2201
 chalk/_gen/chalk/server/v1/named_query_pb2_grpc.py,sha256=YAm4u0fgfG94MvophF22rNh3tdrSE0z441vbfhmmBCo,6927
 chalk/_gen/chalk/server/v1/named_query_pb2_grpc.pyi,sha256=ouNIAaMdMNcebvbTvaqYbL5gNU2mPcPQhp_fsCi_tHs,1779
 chalk/_gen/chalk/server/v1/offline_queries_pb2.py,sha256=P5b14_zMkY9pYIjCTRk4_UPJGDXLiODroQ8PvhNUD-s,16582
@@ -612,14 +612,14 @@ chalk/_validation/validation.py,sha256=9cCMfZa9-1wxkXLme_ylmD5vIA1qExJD6aqbYvbmK
 chalk/byte_transmit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 chalk/byte_transmit/model.py,sha256=LFX8pj9X_CWXeap7fDnMl9YmXsYTgq7jBAbEWkxoYoE,13048
 chalk/client/__init__.py,sha256=wu3WQVzE5gRj6noQQDOdYJUgDaz_9QtbjXH4KuoIlXQ,1782
-chalk/client/client.py,sha256=59UYbIq7KHwNm1ZFw5TmCV2JvbJxn45Ar_AjfSkuzQ8,103907
-chalk/client/client_async.py,sha256=wD38RIkwVLaKYKj7K1bWDXnVZkLFYHsbY_5VhtflMvo,51559
+chalk/client/client.py,sha256=DcRJltVqWy_B3Qvbnjz3qOECT9TZ7KD0eovds2CNRIw,104746
+chalk/client/client_async.py,sha256=YmuExumlDkenlGc8ROtmPjUE2m6nQUZisUDvJmwTRdk,51546
 chalk/client/client_async_impl.py,sha256=ZphhgTB49JBWHCGXe-dI0wWWKc9zPcOczy02q_gFy50,6925
-chalk/client/client_grpc.py,sha256=skpSHYCyE8hg0T3Bcl5R8MMi92QjrFtxQRu_NxCSVlw,106952
-chalk/client/client_impl.py,sha256=3NDl1Vo7YJ0grraxJeN6vjFj1hBpU7YT_ikolK31D6k,212395
+chalk/client/client_grpc.py,sha256=z1WeFWjmKKCU8dK7fdvWEOsCUlBi-v_2-HijC2_oIVs,108854
+chalk/client/client_impl.py,sha256=0z6f9LK4t39VNazfJ9c140Szq3R1TcZlPe_uQh20wFw,216225
 chalk/client/dataset.py,sha256=LneWwaAOHCjtj7gaJjsSeVNruj-QJ51hjRi62zrFNVE,77561
 chalk/client/exc.py,sha256=kZJ80YbSeSRDmTLTh240j_eRdJFZBa7IaDsNSRoDroU,4145
-chalk/client/models.py,sha256=YwXywN6OSPOda1DKJuPVe6hgsHzf8ewvX2dYOBOZk7I,65534
+chalk/client/models.py,sha256=ApXv28A44dNXUULKFkG5L6e48vDscZyFGenaXItxL94,67598
 chalk/client/response.py,sha256=m8sQCOj7YVv3mZSZMIC1rIMzFMQ9rfMdBRLg5NRmOOE,53257
 chalk/client/_internal_models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 chalk/client/_internal_models/check.py,sha256=3Xfo4Ws4rvwjeVg0-5-kejfRfRBJeqHmnRhW-WEz784,917
@@ -650,7 +650,7 @@ chalk/features/_vector.py,sha256=jtJmUTtCaUFru4Fw17PYWozl3pPEdIOCYAuZOqIaN3Y,720
 chalk/features/feature_cache_strategy.py,sha256=bXV-tjHfPzUotMpZ3h_D9Xxq-V1CLj_UcVtGIGMpMkI,4942
 chalk/features/feature_field.py,sha256=x-B8CIt086xMOjtfpRMGcmfysS6G2vA_whsLZgGQeqI,93759
 chalk/features/feature_set.py,sha256=yNi0_J4CylAVkVp1Y67qV6i8vHMdE0p99DnyLPABPHI,12406
-chalk/features/feature_set_decorator.py,sha256=u92jAk0iVqdy3u-h_t6ieMDYpF-AWZRVpHaNrC33iqQ,65594
+chalk/features/feature_set_decorator.py,sha256=v3KXgTLVtYvB0_Z-8--M_pnkGhwqBFeYU0ncpvMpUV0,65824
 chalk/features/feature_time.py,sha256=iUk8NDelig81jP7QT3tguyzx5eOZ-YC84OVgJRRKVwo,1639
 chalk/features/feature_wrapper.py,sha256=OolNWGGX67IAEMHCObFvOCpH5EmwjbMvMygRSBJJtu0,19259
 chalk/features/filter.py,sha256=2ldMbqvXC-nJ0jc-OZ36qHtrej-Jkx4TNQ1W_NZodAs,11177
@@ -827,8 +827,8 @@ chalk/utils/tracing.py,sha256=NiiM-9dbuJhSCv6R1npR1uYNKWlkqTR6Ygm0Voi2NrY,13078
 chalk/utils/weak_set_by_identity.py,sha256=VmikA_laYwFeOphCwXJIuyOIkrdlQe0bSzaXq7onoQw,953
 chalk/utils/pydanticutil/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 chalk/utils/pydanticutil/pydantic_compat.py,sha256=O575lLYJ5GvZC4HMzR9yATxf9XwjC6NrDUXbNwZidlE,3031
-chalkpy-2.97.1.dist-info/METADATA,sha256=awY63EjhV6LnKScb_NPnebPtVa6MsCvwFHy8v_4e1gc,27754
-chalkpy-2.97.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-chalkpy-2.97.1.dist-info/entry_points.txt,sha256=Vg23sd8icwq-morJrljVFr-kQnMbm95rZfZj5wsZGis,42
-chalkpy-2.97.1.dist-info/top_level.txt,sha256=1Q6_19IGYfNxSw50W8tYKEJ2t5HKQ3W9Wiw4ia5yg2c,6
-chalkpy-2.97.1.dist-info/RECORD,,
+chalkpy-2.97.3.dist-info/METADATA,sha256=TX5qrwzj0rKzbqOTGjgFCyE1qyn78OZxG0sovL-ehCQ,27754
+chalkpy-2.97.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+chalkpy-2.97.3.dist-info/entry_points.txt,sha256=Vg23sd8icwq-morJrljVFr-kQnMbm95rZfZj5wsZGis,42
+chalkpy-2.97.3.dist-info/top_level.txt,sha256=1Q6_19IGYfNxSw50W8tYKEJ2t5HKQ3W9Wiw4ia5yg2c,6
+chalkpy-2.97.3.dist-info/RECORD,,