squirrels 0.1.0__py3-none-any.whl → 0.6.0.post0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- dateutils/__init__.py +6 -0
- dateutils/_enums.py +25 -0
- squirrels/dateutils.py → dateutils/_implementation.py +409 -380
- dateutils/types.py +6 -0
- squirrels/__init__.py +21 -18
- squirrels/_api_routes/__init__.py +5 -0
- squirrels/_api_routes/auth.py +337 -0
- squirrels/_api_routes/base.py +196 -0
- squirrels/_api_routes/dashboards.py +156 -0
- squirrels/_api_routes/data_management.py +148 -0
- squirrels/_api_routes/datasets.py +220 -0
- squirrels/_api_routes/project.py +289 -0
- squirrels/_api_server.py +552 -134
- squirrels/_arguments/__init__.py +0 -0
- squirrels/_arguments/init_time_args.py +83 -0
- squirrels/_arguments/run_time_args.py +111 -0
- squirrels/_auth.py +777 -0
- squirrels/_command_line.py +239 -107
- squirrels/_compile_prompts.py +147 -0
- squirrels/_connection_set.py +94 -0
- squirrels/_constants.py +141 -64
- squirrels/_dashboards.py +179 -0
- squirrels/_data_sources.py +570 -0
- squirrels/_dataset_types.py +91 -0
- squirrels/_env_vars.py +209 -0
- squirrels/_exceptions.py +29 -0
- squirrels/_http_error_responses.py +52 -0
- squirrels/_initializer.py +319 -110
- squirrels/_logging.py +121 -0
- squirrels/_manifest.py +357 -187
- squirrels/_mcp_server.py +578 -0
- squirrels/_model_builder.py +69 -0
- squirrels/_model_configs.py +74 -0
- squirrels/_model_queries.py +52 -0
- squirrels/_models.py +1201 -0
- squirrels/_package_data/base_project/.env +7 -0
- squirrels/_package_data/base_project/.env.example +44 -0
- squirrels/_package_data/base_project/connections.yml +16 -0
- squirrels/_package_data/base_project/dashboards/dashboard_example.py +40 -0
- squirrels/_package_data/base_project/dashboards/dashboard_example.yml +22 -0
- squirrels/_package_data/base_project/docker/.dockerignore +16 -0
- squirrels/_package_data/base_project/docker/Dockerfile +16 -0
- squirrels/_package_data/base_project/docker/compose.yml +7 -0
- squirrels/_package_data/base_project/duckdb_init.sql +10 -0
- squirrels/_package_data/base_project/gitignore +13 -0
- squirrels/_package_data/base_project/macros/macros_example.sql +17 -0
- squirrels/_package_data/base_project/models/builds/build_example.py +26 -0
- squirrels/_package_data/base_project/models/builds/build_example.sql +16 -0
- squirrels/_package_data/base_project/models/builds/build_example.yml +57 -0
- squirrels/_package_data/base_project/models/dbviews/dbview_example.sql +17 -0
- squirrels/_package_data/base_project/models/dbviews/dbview_example.yml +32 -0
- squirrels/_package_data/base_project/models/federates/federate_example.py +51 -0
- squirrels/_package_data/base_project/models/federates/federate_example.sql +21 -0
- squirrels/_package_data/base_project/models/federates/federate_example.yml +65 -0
- squirrels/_package_data/base_project/models/sources.yml +38 -0
- squirrels/_package_data/base_project/parameters.yml +142 -0
- squirrels/_package_data/base_project/pyconfigs/connections.py +19 -0
- squirrels/_package_data/base_project/pyconfigs/context.py +96 -0
- squirrels/_package_data/base_project/pyconfigs/parameters.py +141 -0
- squirrels/_package_data/base_project/pyconfigs/user.py +56 -0
- squirrels/_package_data/base_project/resources/expenses.db +0 -0
- squirrels/_package_data/base_project/resources/public/.gitkeep +0 -0
- squirrels/_package_data/base_project/resources/weather.db +0 -0
- squirrels/_package_data/base_project/seeds/seed_categories.csv +6 -0
- squirrels/_package_data/base_project/seeds/seed_categories.yml +15 -0
- squirrels/_package_data/base_project/seeds/seed_subcategories.csv +15 -0
- squirrels/_package_data/base_project/seeds/seed_subcategories.yml +21 -0
- squirrels/_package_data/base_project/squirrels.yml.j2 +61 -0
- squirrels/_package_data/base_project/tmp/.gitignore +2 -0
- squirrels/_package_data/templates/login_successful.html +53 -0
- squirrels/_package_data/templates/squirrels_studio.html +22 -0
- squirrels/_package_loader.py +29 -0
- squirrels/_parameter_configs.py +592 -0
- squirrels/_parameter_options.py +348 -0
- squirrels/_parameter_sets.py +207 -0
- squirrels/_parameters.py +1703 -0
- squirrels/_project.py +796 -0
- squirrels/_py_module.py +122 -0
- squirrels/_request_context.py +33 -0
- squirrels/_schemas/__init__.py +0 -0
- squirrels/_schemas/auth_models.py +83 -0
- squirrels/_schemas/query_param_models.py +70 -0
- squirrels/_schemas/request_models.py +26 -0
- squirrels/_schemas/response_models.py +286 -0
- squirrels/_seeds.py +97 -0
- squirrels/_sources.py +112 -0
- squirrels/_utils.py +540 -149
- squirrels/_version.py +1 -3
- squirrels/arguments.py +7 -0
- squirrels/auth.py +4 -0
- squirrels/connections.py +3 -0
- squirrels/dashboards.py +3 -0
- squirrels/data_sources.py +14 -282
- squirrels/parameter_options.py +13 -189
- squirrels/parameters.py +14 -801
- squirrels/types.py +18 -0
- squirrels-0.6.0.post0.dist-info/METADATA +148 -0
- squirrels-0.6.0.post0.dist-info/RECORD +101 -0
- {squirrels-0.1.0.dist-info → squirrels-0.6.0.post0.dist-info}/WHEEL +1 -2
- {squirrels-0.1.0.dist-info → squirrels-0.6.0.post0.dist-info}/entry_points.txt +1 -0
- squirrels-0.6.0.post0.dist-info/licenses/LICENSE +201 -0
- squirrels/_credentials_manager.py +0 -87
- squirrels/_module_loader.py +0 -37
- squirrels/_parameter_set.py +0 -151
- squirrels/_renderer.py +0 -286
- squirrels/_timed_imports.py +0 -37
- squirrels/connection_set.py +0 -126
- squirrels/package_data/base_project/.gitignore +0 -4
- squirrels/package_data/base_project/connections.py +0 -21
- squirrels/package_data/base_project/database/sample_database.db +0 -0
- squirrels/package_data/base_project/database/seattle_weather.db +0 -0
- squirrels/package_data/base_project/datasets/sample_dataset/context.py +0 -8
- squirrels/package_data/base_project/datasets/sample_dataset/database_view1.py +0 -23
- squirrels/package_data/base_project/datasets/sample_dataset/database_view1.sql.j2 +0 -7
- squirrels/package_data/base_project/datasets/sample_dataset/final_view.py +0 -10
- squirrels/package_data/base_project/datasets/sample_dataset/final_view.sql.j2 +0 -2
- squirrels/package_data/base_project/datasets/sample_dataset/parameters.py +0 -30
- squirrels/package_data/base_project/datasets/sample_dataset/selections.cfg +0 -6
- squirrels/package_data/base_project/squirrels.yaml +0 -26
- squirrels/package_data/static/favicon.ico +0 -0
- squirrels/package_data/static/script.js +0 -234
- squirrels/package_data/static/style.css +0 -110
- squirrels/package_data/templates/index.html +0 -32
- squirrels-0.1.0.dist-info/LICENSE +0 -22
- squirrels-0.1.0.dist-info/METADATA +0 -67
- squirrels-0.1.0.dist-info/RECORD +0 -40
- squirrels-0.1.0.dist-info/top_level.txt +0 -1
squirrels/_command_line.py
CHANGED
|
@@ -1,107 +1,239 @@
|
|
|
1
|
-
from
|
|
2
|
-
from
|
|
3
|
-
|
|
4
|
-
sys
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
from
|
|
9
|
-
from
|
|
10
|
-
from
|
|
11
|
-
from
|
|
12
|
-
from
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
1
|
+
from argparse import ArgumentParser, _SubParsersAction
|
|
2
|
+
from pathlib import Path
|
|
3
|
+
from update_checker import UpdateChecker
|
|
4
|
+
import sys, asyncio, traceback, io, subprocess
|
|
5
|
+
|
|
6
|
+
sys.path.append('.')
|
|
7
|
+
|
|
8
|
+
from ._version import __version__
|
|
9
|
+
from ._api_server import ApiServer
|
|
10
|
+
from ._initializer import Initializer
|
|
11
|
+
from ._package_loader import PackageLoaderIO
|
|
12
|
+
from ._project import SquirrelsProject
|
|
13
|
+
from . import _constants as c, _utils as u
|
|
14
|
+
from ._compile_prompts import prompt_compile_options
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
def _run_duckdb_cli(project: SquirrelsProject, ui: bool):
|
|
18
|
+
init_sql = u._read_duckdb_init_sql(datalake_db_path=project._vdl_catalog_db_path)
|
|
19
|
+
|
|
20
|
+
target_init_path = None
|
|
21
|
+
if init_sql:
|
|
22
|
+
target_init_path = Path(c.TARGET_FOLDER, c.DUCKDB_INIT_FILE)
|
|
23
|
+
target_init_path.parent.mkdir(parents=True, exist_ok=True)
|
|
24
|
+
target_init_path.write_text(init_sql)
|
|
25
|
+
|
|
26
|
+
init_args = ["-init", str(target_init_path)] if target_init_path else []
|
|
27
|
+
command = ['duckdb']
|
|
28
|
+
if ui:
|
|
29
|
+
command.append('-ui')
|
|
30
|
+
if init_args:
|
|
31
|
+
command.extend(init_args)
|
|
32
|
+
|
|
33
|
+
print("Starting DuckDB CLI with command:")
|
|
34
|
+
print(f"$ {' '.join(command)}")
|
|
35
|
+
print()
|
|
36
|
+
print("To exit the DuckDB CLI, enter '.exit'")
|
|
37
|
+
print()
|
|
38
|
+
|
|
39
|
+
try:
|
|
40
|
+
subprocess.run(command, check=True)
|
|
41
|
+
except FileNotFoundError:
|
|
42
|
+
print("DuckDB CLI not found. Please install it from: https://duckdb.org/install")
|
|
43
|
+
except subprocess.CalledProcessError:
|
|
44
|
+
pass # ignore errors that occured on duckdb shell commands
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
def main():
|
|
48
|
+
"""
|
|
49
|
+
Main entry point for the squirrels command line utilities.
|
|
50
|
+
"""
|
|
51
|
+
# Create a parent parser with common logging options
|
|
52
|
+
parent_parser = ArgumentParser(add_help=False)
|
|
53
|
+
parent_parser.add_argument('-h', '--help', action="help", help="Show this help message and exit")
|
|
54
|
+
parent_parser.add_argument('--log-level', type=str, choices=["DEBUG", "INFO", "WARNING"], help='Level of logging to use. Default is from SQRL_LOGGING__LEVEL environment variable or INFO.')
|
|
55
|
+
parent_parser.add_argument('--log-format', type=str, choices=["text", "json"], help='Format of the log records. Default is from SQRL_LOGGING__FORMAT environment variable or text.')
|
|
56
|
+
parent_parser.add_argument(
|
|
57
|
+
'--log-to-file', action='store_true',
|
|
58
|
+
help='Enable logging to file(s) in the "logs/" folder (or a custom folder) with rotation and retention policies. '
|
|
59
|
+
'Default is False unless overridden by the SQRL_LOGGING__TO_FILE environment variable.'
|
|
60
|
+
)
|
|
61
|
+
|
|
62
|
+
parser = ArgumentParser(description="Command line utilities from the squirrels python package", add_help=False, parents=[parent_parser])
|
|
63
|
+
parser.add_argument('-V', '--version', action='store_true', help='Show the version and exit')
|
|
64
|
+
subparsers = parser.add_subparsers(title='commands', dest='command')
|
|
65
|
+
|
|
66
|
+
def add_subparser(subparsers: _SubParsersAction, cmd: str, help_text: str):
|
|
67
|
+
subparser: ArgumentParser = subparsers.add_parser(cmd, description=help_text, help=help_text, add_help=False, parents=[parent_parser])
|
|
68
|
+
return subparser
|
|
69
|
+
|
|
70
|
+
new_parser = add_subparser(subparsers, c.NEW_CMD, 'Create a new squirrels project')
|
|
71
|
+
|
|
72
|
+
new_parser.add_argument('name', nargs='?', type=str, help='The name of the project folder to create. Ignored if --curr-dir is used')
|
|
73
|
+
new_parser.add_argument('--curr-dir', action='store_true', help='Create the project in the current directory')
|
|
74
|
+
new_parser.add_argument('--use-defaults', action='store_true', help='Use default values for unspecified options (except project folder name) instead of prompting for input')
|
|
75
|
+
new_parser.add_argument('--connections', type=str, choices=c.CONF_FORMAT_CHOICES, help=f'Configure database connections as yaml (default) or python')
|
|
76
|
+
new_parser.add_argument('--parameters', type=str, choices=c.CONF_FORMAT_CHOICES, help=f'Configure parameters as python (default) or yaml')
|
|
77
|
+
new_parser.add_argument('--build', type=str, choices=c.FILE_TYPE_CHOICES, help='Create build model as sql (default) or python file')
|
|
78
|
+
new_parser.add_argument('--federate', type=str, choices=c.FILE_TYPE_CHOICES, help='Create federated model as sql (default) or python file')
|
|
79
|
+
new_parser.add_argument('--dashboard', type=str, choices=['y', 'n'], help=f'Include (y) or exclude (n, default) a sample dashboard file')
|
|
80
|
+
new_parser.add_argument('--admin-password', type=str, help='The password for the admin user. If --use-defaults is used, then a random password is generated')
|
|
81
|
+
|
|
82
|
+
init_parser = add_subparser(subparsers, c.INIT_CMD, 'Create a new squirrels project in the current directory (alias for "new --curr-dir")')
|
|
83
|
+
init_parser.add_argument('--use-defaults', action='store_true', help='Use default values for unspecified options instead of prompting for input')
|
|
84
|
+
init_parser.add_argument('--connections', type=str, choices=c.CONF_FORMAT_CHOICES, help=f'Configure database connections as yaml (default) or python')
|
|
85
|
+
init_parser.add_argument('--parameters', type=str, choices=c.CONF_FORMAT_CHOICES, help=f'Configure parameters as python (default) or yaml')
|
|
86
|
+
init_parser.add_argument('--build', type=str, choices=c.FILE_TYPE_CHOICES, help='Create build model as sql (default) or python file')
|
|
87
|
+
init_parser.add_argument('--federate', type=str, choices=c.FILE_TYPE_CHOICES, help='Create federated model as sql (default) or python file')
|
|
88
|
+
init_parser.add_argument('--dashboard', type=str, choices=['y', 'n'], help=f'Include (y) or exclude (n, default) a sample dashboard file')
|
|
89
|
+
init_parser.add_argument('--admin-password', type=str, help='The password for the admin user. By default, a random password is generated')
|
|
90
|
+
|
|
91
|
+
def with_file_format_options(parser: ArgumentParser):
|
|
92
|
+
help_text = "Create model as sql (default) or python file"
|
|
93
|
+
parser.add_argument('--format', type=str, choices=c.FILE_TYPE_CHOICES, default=c.SQL_FILE_TYPE, help=help_text)
|
|
94
|
+
return parser
|
|
95
|
+
|
|
96
|
+
get_file_help_text = "Get a sample file for the squirrels project. If the file name already exists, it will be suffixed with a timestamp."
|
|
97
|
+
get_file_parser = add_subparser(subparsers, c.GET_FILE_CMD, get_file_help_text)
|
|
98
|
+
get_file_subparsers = get_file_parser.add_subparsers(title='file_name', dest='file_name')
|
|
99
|
+
add_subparser(get_file_subparsers, c.DOTENV_FILE, f'Creates sample {c.DOTENV_FILE} and {c.DOTENV_FILE}.example files')
|
|
100
|
+
add_subparser(get_file_subparsers, c.GITIGNORE_FILE, f'Creates a sample {c.GITIGNORE_FILE} file')
|
|
101
|
+
manifest_parser = add_subparser(get_file_subparsers, c.MANIFEST_FILE, f'Creates a sample {c.MANIFEST_FILE} file')
|
|
102
|
+
manifest_parser.add_argument("--no-connections", action='store_true', help=f'Exclude the connections section')
|
|
103
|
+
manifest_parser.add_argument("--parameters", action='store_true', help=f'Include the parameters section')
|
|
104
|
+
manifest_parser.add_argument("--dashboards", action='store_true', help=f'Include the dashboards section')
|
|
105
|
+
add_subparser(get_file_subparsers, c.USER_FILE, f'Creates a sample {c.USER_FILE} file')
|
|
106
|
+
add_subparser(get_file_subparsers, c.CONNECTIONS_FILE, f'Creates a sample {c.CONNECTIONS_FILE} file')
|
|
107
|
+
add_subparser(get_file_subparsers, c.PARAMETERS_FILE, f'Creates a sample {c.PARAMETERS_FILE} file')
|
|
108
|
+
add_subparser(get_file_subparsers, c.CONTEXT_FILE, f'Creates a sample {c.CONTEXT_FILE} file')
|
|
109
|
+
add_subparser(get_file_subparsers, c.MACROS_FILE, f'Creates a sample {c.MACROS_FILE} file')
|
|
110
|
+
add_subparser(get_file_subparsers, c.SOURCES_FILE, f'Creates a sample {c.SOURCES_FILE} file')
|
|
111
|
+
with_file_format_options(add_subparser(get_file_subparsers, c.BUILD_FILE_STEM, f'Creates a sample build model file'))
|
|
112
|
+
add_subparser(get_file_subparsers, c.DBVIEW_FILE_STEM, f'Creates a sample dbview model file')
|
|
113
|
+
with_file_format_options(add_subparser(get_file_subparsers, c.FEDERATE_FILE_STEM, f'Creates a sample federate model file'))
|
|
114
|
+
add_subparser(get_file_subparsers, c.DASHBOARD_FILE_STEM, f'Creates a sample dashboard file')
|
|
115
|
+
add_subparser(get_file_subparsers, c.EXPENSES_DB, f'Creates the sample SQLite database on expenses')
|
|
116
|
+
add_subparser(get_file_subparsers, c.WEATHER_DB, f'Creates the sample SQLite database on weather')
|
|
117
|
+
add_subparser(get_file_subparsers, c.SEED_CATEGORY_FILE_STEM, f'Creates the sample seed files for categories lookup')
|
|
118
|
+
add_subparser(get_file_subparsers, c.SEED_SUBCATEGORY_FILE_STEM, f'Creates the sample seed files for subcategories lookup')
|
|
119
|
+
|
|
120
|
+
deps_parser = add_subparser(subparsers, c.DEPS_CMD, f'Load all packages specified in {c.MANIFEST_FILE} (from git)')
|
|
121
|
+
|
|
122
|
+
compile_parser = add_subparser(subparsers, c.COMPILE_CMD, 'Create rendered SQL files in the folder "./target/compile"')
|
|
123
|
+
compile_parser.add_argument('-y', '--yes', action='store_true', help='Disable prompts and assume the default for all settings not overridden by CLI options')
|
|
124
|
+
compile_parser.add_argument('-c', '--clear', action='store_true', help='Clear the "target/compile/" folder before compiling')
|
|
125
|
+
compile_scope_group = compile_parser.add_mutually_exclusive_group(required=False)
|
|
126
|
+
compile_scope_group.add_argument('--buildtime-only', action='store_true', help='Compile only buildtime models')
|
|
127
|
+
compile_scope_group.add_argument('--runtime-only', action='store_true', help='Compile only runtime models')
|
|
128
|
+
compile_test_set_group = compile_parser.add_mutually_exclusive_group(required=False)
|
|
129
|
+
compile_test_set_group.add_argument('-t', '--test-set', type=str, help="The selection test set to use. If not specified, default selections are used (unless using --all-test-sets). Not applicable for buildtime models")
|
|
130
|
+
compile_test_set_group.add_argument('-T', '--all-test-sets', action="store_true", help="Compile models for all selection test sets. Not applicable for buildtime models")
|
|
131
|
+
compile_parser.add_argument('-s', '--select', type=str, help="Select single model to compile. If not specified, all models are compiled")
|
|
132
|
+
compile_parser.add_argument('-r', '--runquery', action='store_true', help='Run runtime models and write CSV outputs too. Does not apply to buildtime models')
|
|
133
|
+
|
|
134
|
+
build_parser = add_subparser(subparsers, c.BUILD_CMD, 'Build the Virtual Data Lake (VDL) for the project')
|
|
135
|
+
build_parser.add_argument('-f', '--full-refresh', action='store_true', help='Drop all tables before building')
|
|
136
|
+
build_parser.add_argument('-s', '--select', type=str, help="Select one static model to build. If not specified, all models are built")
|
|
137
|
+
|
|
138
|
+
duckdb_parser = add_subparser(subparsers, c.DUCKDB_CMD, 'Run the duckdb command line tool')
|
|
139
|
+
duckdb_parser.add_argument('--ui', action='store_true', help='Run the duckdb local UI')
|
|
140
|
+
|
|
141
|
+
run_parser = add_subparser(subparsers, c.RUN_CMD, 'Run the API server')
|
|
142
|
+
run_parser.add_argument('--build', action='store_true', help='Build the VDL first (without full refresh) before running the API server')
|
|
143
|
+
run_parser.add_argument('--no-cache', action='store_true', help='Do not cache any api results')
|
|
144
|
+
run_parser.add_argument('--host', type=str, default='127.0.0.1', help="The host to run on")
|
|
145
|
+
run_parser.add_argument('--port', type=int, default=8000, help="The port to run on")
|
|
146
|
+
run_parser.add_argument(
|
|
147
|
+
'--forwarded-allow-ips', type=str, default=None,
|
|
148
|
+
help="Comma-separated list of IP Addresses, IP Networks, or literals (e.g. UNIX Socket path) to trust with proxy headers. "
|
|
149
|
+
"Defaults to the FORWARDED_ALLOW_IPS environment variable if available, or '127.0.0.1'. The literal '*' means trust everything."
|
|
150
|
+
)
|
|
151
|
+
|
|
152
|
+
args, _ = parser.parse_known_args()
|
|
153
|
+
|
|
154
|
+
update_checker_result = UpdateChecker().check("squirrels", __version__)
|
|
155
|
+
if update_checker_result:
|
|
156
|
+
current_version = update_checker_result.running_version
|
|
157
|
+
latest_version = update_checker_result.available_version
|
|
158
|
+
print("\033[1;33mA newer version of Squirrels is available!\033[0m")
|
|
159
|
+
print(f"{current_version} -> \033[1;32m{latest_version}\033[0m (released on {update_checker_result.release_date.date()})")
|
|
160
|
+
print()
|
|
161
|
+
print("See \033[4mhttps://docs.pysquirrels.com/releases\033[0m for release notes.")
|
|
162
|
+
print()
|
|
163
|
+
|
|
164
|
+
if args.version:
|
|
165
|
+
print(f"Squirrels version: \033[1;32m{__version__}\033[0m")
|
|
166
|
+
elif args.command == c.NEW_CMD:
|
|
167
|
+
Initializer(project_name=args.name, use_curr_dir=args.curr_dir).init_project(args)
|
|
168
|
+
elif args.command == c.INIT_CMD:
|
|
169
|
+
Initializer(project_name=None, use_curr_dir=True).init_project(args)
|
|
170
|
+
elif args.command == c.GET_FILE_CMD:
|
|
171
|
+
Initializer().get_file(args)
|
|
172
|
+
elif args.command is None:
|
|
173
|
+
print(f'Command is missing. Enter "squirrels -h" for help.')
|
|
174
|
+
else:
|
|
175
|
+
project = SquirrelsProject(
|
|
176
|
+
load_dotenv_globally=True,
|
|
177
|
+
log_level=args.log_level,
|
|
178
|
+
log_format=args.log_format,
|
|
179
|
+
log_to_file=args.log_to_file
|
|
180
|
+
)
|
|
181
|
+
try:
|
|
182
|
+
if args.command == c.DEPS_CMD:
|
|
183
|
+
PackageLoaderIO.load_packages(project._logger, project._manifest_cfg, reload=True)
|
|
184
|
+
elif args.command == c.BUILD_CMD:
|
|
185
|
+
task = project.build(full_refresh=args.full_refresh, select=args.select)
|
|
186
|
+
asyncio.run(task)
|
|
187
|
+
print()
|
|
188
|
+
elif args.command == c.DUCKDB_CMD:
|
|
189
|
+
_run_duckdb_cli(project, args.ui)
|
|
190
|
+
elif args.command == c.RUN_CMD:
|
|
191
|
+
if args.build:
|
|
192
|
+
task = project.build(full_refresh=True)
|
|
193
|
+
asyncio.run(task)
|
|
194
|
+
server = ApiServer(args.no_cache, project)
|
|
195
|
+
server.run(args)
|
|
196
|
+
elif args.command == c.COMPILE_CMD:
|
|
197
|
+
# Derive final options with optional interactive prompts (unless --yes is provided)
|
|
198
|
+
buildtime_only = args.buildtime_only
|
|
199
|
+
runtime_only = args.runtime_only
|
|
200
|
+
test_set = args.test_set
|
|
201
|
+
do_all_test_sets = args.all_test_sets
|
|
202
|
+
selected_model = args.select
|
|
203
|
+
|
|
204
|
+
try:
|
|
205
|
+
if not args.yes:
|
|
206
|
+
buildtime_only, runtime_only, test_set, do_all_test_sets, selected_model = prompt_compile_options(
|
|
207
|
+
project,
|
|
208
|
+
buildtime_only=buildtime_only,
|
|
209
|
+
runtime_only=runtime_only,
|
|
210
|
+
test_set=test_set,
|
|
211
|
+
do_all_test_sets=do_all_test_sets,
|
|
212
|
+
selected_model=selected_model,
|
|
213
|
+
)
|
|
214
|
+
|
|
215
|
+
task = project.compile(
|
|
216
|
+
selected_model=selected_model, test_set=test_set, do_all_test_sets=do_all_test_sets, runquery=args.runquery,
|
|
217
|
+
clear=args.clear, buildtime_only=buildtime_only, runtime_only=runtime_only
|
|
218
|
+
)
|
|
219
|
+
asyncio.run(task)
|
|
220
|
+
|
|
221
|
+
except KeyError:
|
|
222
|
+
pass
|
|
223
|
+
else:
|
|
224
|
+
print(f'Error: No such command "{args.command}". Enter "squirrels -h" for help.')
|
|
225
|
+
|
|
226
|
+
except KeyboardInterrupt:
|
|
227
|
+
pass
|
|
228
|
+
except Exception as e:
|
|
229
|
+
buffer = io.StringIO()
|
|
230
|
+
traceback.print_exception(e, file=buffer)
|
|
231
|
+
err_msg = buffer.getvalue()
|
|
232
|
+
print(err_msg)
|
|
233
|
+
project._logger.error(err_msg)
|
|
234
|
+
finally:
|
|
235
|
+
project.close()
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
if __name__ == '__main__':
|
|
239
|
+
main()
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
from typing import Tuple, Optional
|
|
2
|
+
import inquirer
|
|
3
|
+
|
|
4
|
+
from ._project import SquirrelsProject
|
|
5
|
+
from . import _constants as c, _models as m
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def prompt_compile_options(
|
|
9
|
+
project: SquirrelsProject,
|
|
10
|
+
*,
|
|
11
|
+
buildtime_only: bool,
|
|
12
|
+
runtime_only: bool,
|
|
13
|
+
test_set: Optional[str],
|
|
14
|
+
do_all_test_sets: bool,
|
|
15
|
+
selected_model: Optional[str],
|
|
16
|
+
) -> Tuple[bool, bool, Optional[str], bool, Optional[str]]:
|
|
17
|
+
"""
|
|
18
|
+
Interactive prompts to derive compile options when --yes is not provided.
|
|
19
|
+
|
|
20
|
+
Returns updated values for:
|
|
21
|
+
(buildtime_only, runtime_only, test_set, do_all_test_sets, selected_model)
|
|
22
|
+
"""
|
|
23
|
+
# 1) Scope prompt (skip if explicit flags provided)
|
|
24
|
+
if not buildtime_only and not runtime_only:
|
|
25
|
+
scope_answer = inquirer.prompt([
|
|
26
|
+
inquirer.List(
|
|
27
|
+
'scope',
|
|
28
|
+
message='Select scope',
|
|
29
|
+
choices=[
|
|
30
|
+
('All models', 'all'),
|
|
31
|
+
('Buildtime models only', 'buildtime'),
|
|
32
|
+
('Runtime models only', 'runtime'),
|
|
33
|
+
],
|
|
34
|
+
default='all',
|
|
35
|
+
)
|
|
36
|
+
]) or {}
|
|
37
|
+
scope_val = scope_answer['scope']
|
|
38
|
+
if scope_val == 'buildtime':
|
|
39
|
+
buildtime_only, runtime_only = True, False
|
|
40
|
+
elif scope_val == 'runtime':
|
|
41
|
+
buildtime_only, runtime_only = False, True
|
|
42
|
+
else:
|
|
43
|
+
buildtime_only, runtime_only = False, False
|
|
44
|
+
|
|
45
|
+
# 2) Runtime test set prompt (only if runtime is included and -t/-T not provided)
|
|
46
|
+
runtime_included, buildtime_included = not buildtime_only, not runtime_only
|
|
47
|
+
if runtime_included and not test_set and not do_all_test_sets:
|
|
48
|
+
test_mode_answer = inquirer.prompt([
|
|
49
|
+
inquirer.List(
|
|
50
|
+
'ts_mode',
|
|
51
|
+
message='Runtime selections for parameters, configurables, and user attributes?',
|
|
52
|
+
choices=[
|
|
53
|
+
('Use default selections', 'default'),
|
|
54
|
+
('Use a custom test set', 'custom'),
|
|
55
|
+
('Use all test sets (including default selections)', 'all'),
|
|
56
|
+
],
|
|
57
|
+
default='default',
|
|
58
|
+
)
|
|
59
|
+
]) or {}
|
|
60
|
+
ts_mode = test_mode_answer['ts_mode']
|
|
61
|
+
if ts_mode == 'all':
|
|
62
|
+
do_all_test_sets = True
|
|
63
|
+
elif ts_mode == 'custom':
|
|
64
|
+
# Build available test set list
|
|
65
|
+
ts_names = list(project._manifest_cfg.selection_test_sets.keys())
|
|
66
|
+
ts_answer = inquirer.prompt([
|
|
67
|
+
inquirer.List(
|
|
68
|
+
'test_set',
|
|
69
|
+
message='Pick a selection test set',
|
|
70
|
+
choices=ts_names if ts_names else [c.DEFAULT_TEST_SET_NAME],
|
|
71
|
+
default=c.DEFAULT_TEST_SET_NAME,
|
|
72
|
+
)
|
|
73
|
+
]) or {}
|
|
74
|
+
test_set = ts_answer['test_set']
|
|
75
|
+
|
|
76
|
+
# 3) Model selection prompt (only if -s not provided)
|
|
77
|
+
if not selected_model:
|
|
78
|
+
# Ask whether to compile all or a specific model
|
|
79
|
+
model_mode_answer = inquirer.prompt([
|
|
80
|
+
inquirer.List(
|
|
81
|
+
'model_mode',
|
|
82
|
+
message='Compile all models in scope or just a specific model?',
|
|
83
|
+
choices=[
|
|
84
|
+
('All models', 'all'),
|
|
85
|
+
('Select a specific model', 'one'),
|
|
86
|
+
],
|
|
87
|
+
default='all',
|
|
88
|
+
)
|
|
89
|
+
]) or {}
|
|
90
|
+
model_mode = model_mode_answer['model_mode']
|
|
91
|
+
|
|
92
|
+
if model_mode == 'one':
|
|
93
|
+
# Build list of runtime query models (dbviews + federates) and build models if included
|
|
94
|
+
models_dict = project._get_models_dict(always_python_df=False)
|
|
95
|
+
|
|
96
|
+
valid_model_types: list[m.ModelType] = []
|
|
97
|
+
if runtime_included:
|
|
98
|
+
valid_model_types.extend([m.ModelType.DBVIEW, m.ModelType.FEDERATE])
|
|
99
|
+
if buildtime_included:
|
|
100
|
+
valid_model_types.append(m.ModelType.BUILD)
|
|
101
|
+
|
|
102
|
+
runtime_names = sorted([
|
|
103
|
+
(f"({model.model_type.value}) {name}", name) for name, model in models_dict.items()
|
|
104
|
+
if isinstance(model, m.QueryModel) and model.model_type in valid_model_types
|
|
105
|
+
])
|
|
106
|
+
if runtime_names:
|
|
107
|
+
model_answer = inquirer.prompt([
|
|
108
|
+
inquirer.List(
|
|
109
|
+
'selected_model',
|
|
110
|
+
message='Pick a runtime model to compile',
|
|
111
|
+
choices=runtime_names,
|
|
112
|
+
)
|
|
113
|
+
]) or {}
|
|
114
|
+
selected_model = model_answer['selected_model']
|
|
115
|
+
|
|
116
|
+
# Tips and equivalent command without prompts
|
|
117
|
+
def _maybe_quote(val: str) -> str:
|
|
118
|
+
return f'"{val}"' if any(ch.isspace() for ch in val) else val
|
|
119
|
+
|
|
120
|
+
parts = ["sqrl", "compile", "-y"]
|
|
121
|
+
if buildtime_only:
|
|
122
|
+
parts.append("--buildtime-only")
|
|
123
|
+
elif runtime_only:
|
|
124
|
+
parts.append("--runtime-only")
|
|
125
|
+
if do_all_test_sets:
|
|
126
|
+
parts.append("-T")
|
|
127
|
+
elif test_set:
|
|
128
|
+
parts.extend(["-t", _maybe_quote(test_set)])
|
|
129
|
+
if selected_model:
|
|
130
|
+
parts.extend(["-s", _maybe_quote(selected_model)])
|
|
131
|
+
|
|
132
|
+
# Pretty tips block
|
|
133
|
+
tips_header = " Compile tips "
|
|
134
|
+
border = "=" * 80
|
|
135
|
+
print(border)
|
|
136
|
+
print(tips_header)
|
|
137
|
+
print("-" * len(border))
|
|
138
|
+
print("Equivalent command (no prompts):")
|
|
139
|
+
print(f" $ {' '.join(parts)}")
|
|
140
|
+
print()
|
|
141
|
+
print("You can also:")
|
|
142
|
+
print(" - Add -c/--clear to clear the 'target/compile/' folder before compiling")
|
|
143
|
+
print(" - Add -r/--runquery to generate CSVs for runtime models")
|
|
144
|
+
print(border)
|
|
145
|
+
print()
|
|
146
|
+
|
|
147
|
+
return buildtime_only, runtime_only, test_set, do_all_test_sets, selected_model
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
from typing import Any
|
|
2
|
+
from dataclasses import dataclass, field
|
|
3
|
+
from sqlalchemy import Engine
|
|
4
|
+
import time, polars as pl, duckdb
|
|
5
|
+
|
|
6
|
+
from . import _utils as u, _constants as c, _py_module as pm
|
|
7
|
+
from ._arguments.init_time_args import ConnectionsArgs
|
|
8
|
+
from ._manifest import ManifestConfig, ConnectionProperties, ConnectionTypeEnum
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
@dataclass
|
|
12
|
+
class ConnectionSet:
|
|
13
|
+
"""
|
|
14
|
+
A wrapper class around a collection of sqlalchemy engines
|
|
15
|
+
|
|
16
|
+
Attributes:
|
|
17
|
+
_engines: A dictionary of connection name to the corresponding sqlalchemy engine
|
|
18
|
+
"""
|
|
19
|
+
_connections: dict[str, ConnectionProperties | Any] = field(default_factory=dict)
|
|
20
|
+
|
|
21
|
+
def get_connections_as_dict(self):
|
|
22
|
+
return self._connections.copy()
|
|
23
|
+
|
|
24
|
+
def get_connection(self, conn_name: str) -> ConnectionProperties | Any:
|
|
25
|
+
try:
|
|
26
|
+
connection = self._connections[conn_name]
|
|
27
|
+
except KeyError as e:
|
|
28
|
+
raise u.ConfigurationError(f'Connection name "{conn_name}" was not configured') from e
|
|
29
|
+
return connection
|
|
30
|
+
|
|
31
|
+
def run_sql_query_from_conn_name(self, query: str, conn_name: str, placeholders: dict = {}) -> pl.DataFrame:
|
|
32
|
+
conn = self.get_connection(conn_name)
|
|
33
|
+
try:
|
|
34
|
+
if isinstance(conn, ConnectionProperties) and (conn.type == ConnectionTypeEnum.CONNECTORX or conn.type == ConnectionTypeEnum.ADBC):
|
|
35
|
+
if len(placeholders) > 0:
|
|
36
|
+
raise u.ConfigurationError(f"Connection '{conn_name}' is a ConnectorX or ADBC connection, which does not support placeholders")
|
|
37
|
+
df = pl.read_database_uri(query, conn.uri, engine=conn.type.value)
|
|
38
|
+
elif isinstance(conn, ConnectionProperties) and conn.type == ConnectionTypeEnum.SQLALCHEMY:
|
|
39
|
+
with conn.engine.connect() as connection:
|
|
40
|
+
df = pl.read_database(query, connection, execute_options={"parameters": placeholders})
|
|
41
|
+
elif isinstance(conn, ConnectionProperties) and conn.type == ConnectionTypeEnum.DUCKDB:
|
|
42
|
+
path = conn.uri # .replace("duckdb://", "")
|
|
43
|
+
dd_conn = duckdb.connect(path)
|
|
44
|
+
try:
|
|
45
|
+
df = dd_conn.sql(query, params=placeholders).pl()
|
|
46
|
+
finally:
|
|
47
|
+
dd_conn.close()
|
|
48
|
+
else:
|
|
49
|
+
df = pl.read_database(query, conn, execute_options={"parameters": placeholders}) # type: ignore
|
|
50
|
+
return df
|
|
51
|
+
except Exception as e:
|
|
52
|
+
raise RuntimeError(e) from e
|
|
53
|
+
|
|
54
|
+
def dispose(self) -> None:
|
|
55
|
+
"""
|
|
56
|
+
Disposes / closes all the connections in this ConnectionSet
|
|
57
|
+
"""
|
|
58
|
+
for conn in self._connections.values():
|
|
59
|
+
if isinstance(conn, Engine):
|
|
60
|
+
conn.dispose()
|
|
61
|
+
elif isinstance(conn, ConnectionProperties):
|
|
62
|
+
if conn.type == ConnectionTypeEnum.SQLALCHEMY:
|
|
63
|
+
conn.engine.dispose()
|
|
64
|
+
elif hasattr(conn, 'close'):
|
|
65
|
+
conn.close()
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
class ConnectionSetIO:
|
|
69
|
+
|
|
70
|
+
@classmethod
|
|
71
|
+
def load_from_file(
|
|
72
|
+
cls, logger: u.Logger, project_path: str, manifest_cfg: ManifestConfig, conn_args: ConnectionsArgs
|
|
73
|
+
) -> ConnectionSet:
|
|
74
|
+
"""
|
|
75
|
+
Takes the DB connection engines from both the squirrels.yml and connections.py files and merges them
|
|
76
|
+
into a single ConnectionSet
|
|
77
|
+
|
|
78
|
+
Returns:
|
|
79
|
+
A ConnectionSet with the DB connections from both squirrels.yml and connections.py
|
|
80
|
+
"""
|
|
81
|
+
start = time.time()
|
|
82
|
+
connections: dict[str, ConnectionProperties | Any] = {}
|
|
83
|
+
|
|
84
|
+
for config in manifest_cfg.connections.values():
|
|
85
|
+
connections[config.name] = ConnectionProperties(
|
|
86
|
+
label=config.label, type=config.type, uri=config.uri, sa_create_engine_args=config.sa_create_engine_args
|
|
87
|
+
)
|
|
88
|
+
|
|
89
|
+
pm.run_pyconfig_main(project_path, c.CONNECTIONS_FILE, {"connections": connections, "sqrl": conn_args})
|
|
90
|
+
|
|
91
|
+
conn_set = ConnectionSet(connections)
|
|
92
|
+
|
|
93
|
+
logger.log_activity_time("creating sqlalchemy engines", start)
|
|
94
|
+
return conn_set
|