squirrels 0.4.0__py3-none-any.whl → 0.5.0rc0__py3-none-any.whl

squirrels/__init__.py

@@ -1,7 +1,7 @@
 from ._version import __version__
 
-from .arguments.init_time_args import ConnectionsArgs, ParametersArgs
-from .arguments.run_time_args import AuthArgs, ContextArgs, ModelDepsArgs, ModelArgs, DashboardArgs
+from .arguments.init_time_args import ConnectionsArgs, ParametersArgs, BuildModelArgs
+from .arguments.run_time_args import AuthLoginArgs, AuthTokenArgs, ContextArgs, ModelArgs, DashboardArgs
 
 from .parameter_options import SelectParameterOption, DateParameterOption, DateRangeParameterOption
 from .parameter_options import NumberParameterOption, NumberRangeParameterOption, TextParameterOption
@@ -9,11 +9,15 @@ from .parameter_options import NumberParameterOption, NumberRangeParameterOption
 from .parameters import SingleSelectParameter, MultiSelectParameter, DateParameter, DateRangeParameter
 from .parameters import NumberParameter, NumberRangeParameter, TextParameter, TextValue
 
-from .data_sources import SingleSelectDataSource, MultiSelectDataSource, SelectDataSource, DateDataSource, DateRangeDataSource
+from .data_sources import SelectDataSource, DateDataSource, DateRangeDataSource
 from .data_sources import NumberDataSource, NumberRangeDataSource, TextDataSource
 
-from .user_base import User, WrongPassword
-
 from .dashboards import PngDashboard, HtmlDashboard
 
-from .project import SquirrelsProject
+from ._auth import BaseUser
+
+from ._manifest import ConnectionProperties, ConnectionType
+
+from ._project import SquirrelsProject
+
+from .dataset_result import DatasetResult

squirrels/_api_response_models.py

@@ -1,43 +1,18 @@
-from typing import Annotated
+from typing import Annotated, Literal
 from pydantic import BaseModel, Field
 from datetime import datetime, date
 
+from . import _model_configs as mc, _sources as s
+
 
 class LoginReponse(BaseModel):
     access_token: Annotated[str, Field(examples=["encoded_jwt_token"], description="An encoded JSON web token to use subsequent API requests")]
     token_type: Annotated[str, Field(examples=["bearer"], description='Always "bearer" for Bearer token')]
     username: Annotated[str, Field(examples=["johndoe"], description='The username authenticated with from the form data')]
+    is_admin: Annotated[bool, Field(examples=[False], description="A boolean for whether the user is an admin")]
     expiry_time: Annotated[datetime, Field(examples=["2023-08-01T12:00:00.000000Z"], description="The expiry time of the access token in yyyy-MM-dd'T'hh:mm:ss.SSSSSS'Z' format")]
 
 
-## Datasets / Dashboards Catalog Response Models
-
-name_description = "The name of the dataset / dashboard (usually in snake case)"
-label_description = "The human-friendly display name for the dataset / dashboard"
-description_description = "The description of the dataset / dashboard"
-parameters_path_description = "The API path to the parameters for the dataset / dashboard"
-result_path_description = "The API path to the results for the dataset / dashboard"
-
-class DatasetItemModel(BaseModel):
-    name: Annotated[str, Field(examples=["mydataset"], description=name_description)]
-    label: Annotated[str, Field(examples=["My Dataset"], description=label_description)]
-    description: Annotated[str, Field(examples=[""], description=description_description)]
-    parameters_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dataset/mydataset/parameters"], description=parameters_path_description)]
-    result_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dataset/mydataset"], description=result_path_description)]
-
-class DashboardItemModel(BaseModel):
-    name: Annotated[str, Field(examples=["mydashboard"], description=name_description)]
-    label: Annotated[str, Field(examples=["My Dashboard"], description=label_description)]
-    description: Annotated[str, Field(examples=[""], description=description_description)]
-    parameters_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dashboard/mydashboard/parameters"], description=parameters_path_description)]
-    result_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dashboard/mydashboard"], description=result_path_description)]
-    result_format: Annotated[str, Field(examples=["png", "html"], description="The format of the dashboard's result API response (one of 'png' or 'html')")]
-
-class CatalogModel(BaseModel):
-    datasets: Annotated[list[DatasetItemModel], Field(description="The list of accessible datasets")]
-    dashboards: Annotated[list[DashboardItemModel], Field(description="The list of accessible dashboards")]
-
-
 ## Parameters Response Models
 
 class ParameterOptionModel(BaseModel):
@@ -45,7 +20,7 @@ class ParameterOptionModel(BaseModel):
     label: Annotated[str, Field(examples=["My Option"], description="The human-friendly display name for the option")]
 
 class ParameterModelBase(BaseModel):
-    widget_type: Annotated[str, Field(examples=["none"], description="The parameter type (set to 'none' for this model)")]
+    widget_type: Annotated[str, Field(examples=["disabled"], description="The parameter type")]
     name: Annotated[str, Field(examples=["my_unique_param_name"], description="The name of the parameter. Use this as the key when providing the API request parameters")]
     label: Annotated[str, Field(examples=["My Parameter"], description="The human-friendly display name for the parameter")]
     description: Annotated[str, Field(examples=[""], description="The description of the parameter")]
@@ -102,27 +77,101 @@ class TextParameterModel(ParameterModelBase):
         description='A string for the input type (one of "text", "textarea", "number", "date", "datetime-local", "month", "time", "color", or "password")'
     )]
 
+ParametersListType = list[
+    NoneParameterModel | SingleSelectParameterModel | MultiSelectParameterModel | DateParameterModel | DateRangeParameterModel | 
+    NumberParameterModel | NumberRangeParameterModel | TextParameterModel
+]
+
 class ParametersModel(BaseModel):
-    parameters: list[
-        NoneParameterModel | SingleSelectParameterModel | MultiSelectParameterModel | DateParameterModel | DateRangeParameterModel | 
-        NumberParameterModel | NumberRangeParameterModel | TextParameterModel
-    ]
+    parameters: Annotated[ParametersListType, Field(description="The list of parameters for the dataset / dashboard")]
 
 
-## Dataset Results Response Models
+## Datasets / Dashboards Catalog Response Models
+
+name_description = "The name of the dataset / dashboard (usually in snake case)"
+label_description = "The human-friendly display name for the dataset / dashboard"
+description_description = "The description of the dataset / dashboard"
+parameters_path_description = "The API path to the parameters for the dataset / dashboard"
+metadata_path_description = "The API path to the metadata (i.e., description and schema) for the dataset"
+result_path_description = "The API path to the results for the dataset / dashboard"
 
 class ColumnModel(BaseModel):
     name: Annotated[str, Field(examples=["mycol"], description="Name of column")]
-    type: Annotated[str, Field(examples=["string", "number", "integer", "boolean", "datetime"], description='Column type. One of "string", "number", "integer", "boolean", and "datetime"')]
+    type: Annotated[str, Field(examples=["string", "integer", "boolean", "datetime"], description='Column type (such as "string", "integer", "boolean", "datetime", etc.)')]
+    description: Annotated[str, Field(examples=["My column description"], description="The description of the column")]
+    category: Annotated[str, Field(examples=["dimension", "measure", "misc"], description="The category of the column (such as 'dimension', 'measure', or 'misc')")]
+
+class ColumnWithConditionModel(ColumnModel):
+    condition: Annotated[str | None, Field(None, examples=["My condition"], description="The condition of when the column is included (such as based on a parameter selection)")]
 
 class SchemaModel(BaseModel):
     fields: Annotated[list[ColumnModel], Field(description="A list of JSON objects containing the 'name' and 'type' for each of the columns in the result")]
-    dimensions: Annotated[list[str], Field(examples=[["mycol"]], description="A list of column names that are dimensions")]
+
+class SchemaWithConditionModel(BaseModel):
+    fields: Annotated[list[ColumnWithConditionModel], Field(description="A list of JSON objects containing the 'name' and 'type' for each of the columns in the result")]
+
+class DatasetItemModel(BaseModel):
+    name: Annotated[str, Field(examples=["mydataset"], description=name_description)]
+    label: Annotated[str, Field(examples=["My Dataset"], description=label_description)]
+    description: Annotated[str, Field(examples=[""], description=description_description)]
+    parameters: Annotated[list[str], Field(examples=["myparam1", "myparam2"], description="The list of parameter names used by the dataset")]
+    data_schema: Annotated[SchemaWithConditionModel, Field(alias="schema", description="JSON object describing the schema of the dataset")]
+    parameters_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dataset/mydataset/parameters"], description=parameters_path_description)]
+    result_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dataset/mydataset"], description=result_path_description)]
+
+class DashboardItemModel(ParametersModel):
+    name: Annotated[str, Field(examples=["mydashboard"], description=name_description)]
+    label: Annotated[str, Field(examples=["My Dashboard"], description=label_description)]
+    description: Annotated[str, Field(examples=[""], description=description_description)]
+    parameters: Annotated[list[str], Field(examples=["myparam1", "myparam2"], description="The list of parameter names used by the dashboard")]
+    parameters_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dashboard/mydashboard/parameters"], description=parameters_path_description)]
+    result_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dashboard/mydashboard"], description=result_path_description)]
+    result_format: Annotated[str, Field(examples=["png", "html"], description="The format of the dashboard's result API response (one of 'png' or 'html')")]
+
+ModelConfigType = mc.ModelConfig | s.Source | mc.SeedConfig | mc.BuildModelConfig | mc.DbviewModelConfig | mc.FederateModelConfig
+
+class ConnectionItemModel(BaseModel):
+    name: Annotated[str, Field(examples=["myconnection"], description="The name of the connection")]
+    label: Annotated[str, Field(examples=["My Connection"], description="The human-friendly display name for the connection")]
+
+class DataModelItem(BaseModel):
+    name: Annotated[str, Field(examples=["model_name"], description="The name of the model")]
+    model_type: Annotated[Literal["source", "dbview", "federate", "seed", "build"], Field(
+        examples=["source", "dbview", "federate", "seed", "build"], description="The type of the model"
+    )]
+    config: Annotated[ModelConfigType, Field(description="The configuration of the model")]
+    is_queryable: Annotated[bool, Field(examples=[True], description="Whether the model is queryable")]
+
+class LineageNode(BaseModel):
+    name: str
+    type: Literal["model", "dataset", "dashboard"]
+
+class LineageRelation(BaseModel):
+    type: Literal["buildtime", "runtime"]
+    source: LineageNode
+    target: LineageNode
+
+class CatalogModel(BaseModel):
+    parameters: Annotated[ParametersListType, Field(description="The list of all parameters in the project")]
+    datasets: Annotated[list[DatasetItemModel], Field(description="The list of accessible datasets")]
+    dashboards: Annotated[list[DashboardItemModel], Field(description="The list of accessible dashboards")]
+    connections: Annotated[list[ConnectionItemModel], Field(description="The list of connections in the project (only provided for admin users)")]
+    models: Annotated[list[DataModelItem], Field(description="The list of data models in the project (only provided for admin users)")]
+    lineage: Annotated[list[LineageRelation], Field(description="The lineage information between data assets (only provided for admin users)")]
+
+
+## Dataset Results Response Models
+
+class DataDetailsModel(BaseModel):
+    num_rows: Annotated[int, Field(examples=[2], description="The number of rows in the data field")]
+    orientation: Annotated[Literal["records", "rows", "columns"], Field(examples=["records", "rows", "columns"], description="The orientation of the data field")]
 
 class DatasetResultModel(BaseModel):
     data_schema: Annotated[SchemaModel, Field(alias="schema", description="JSON object describing the schema of the dataset")]
-    data: Annotated[list[dict], Field(
-        examples=[[{"mycol": "myval"}]],
+    total_num_rows: Annotated[int, Field(examples=[2], description="The total number of rows for the dataset")]
+    data_details: Annotated[DataDetailsModel, Field(description="A JSON object containing the details of the data field")]
+    data: Annotated[list[dict] | list[list] | dict[str, list], Field(
+        examples=[[{"mycol": "col_value1"}, {"mycol": "col_value2"}], [["col_value1"], ["col_value2"]], {"mycol": ["col_value1", "col_value2"]}],
         description="A list of JSON objects where each object is a row of the tabular results. The keys and values of the object are column names (described in fields) and values of the row."
     )]
 
@@ -130,12 +179,12 @@ class DatasetResultModel(BaseModel):
 ## Project Metadata Response Models
 
 class ProjectVersionModel(BaseModel):
-    major_version: int
-    minor_versions: list[int]
-    token_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/token"])]
-    data_catalog_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/datasets"])]
+    major_version: Annotated[int, Field(examples=[1])]
+    data_catalog_path: Annotated[str, Field(examples=["/squirrels-v0/project/myproject/v1/data-catalog"])]
 
 class ProjectModel(BaseModel):
     name: Annotated[str, Field(examples=["myproject"])]
+    version: Annotated[str, Field(examples=["v1"])]
     label: Annotated[str, Field(examples=["My Project"])]
-    versions: list[ProjectVersionModel]
+    description: Annotated[str, Field(examples=["My project description"])]
+    squirrels_version: Annotated[str, Field(examples=["0.1.0"])]