package gpyrpc

Get desktop application:
View/edit binary Protocol Buffers messages

Service for built-in functionality.

• rpc Ping (Ping_Args, Ping_Result)

  gpyrpc.proto:56

  Sends a ping request.

• rpc ListMethod (ListMethod_Args, ListMethod_Result)

  gpyrpc.proto:58

  Lists available methods.

  message ListMethod_Args

  gpyrpc.proto:835

  Message for list method request arguments. Empty message.

  empty

  (message has no fields)

  message ListMethod_Result

  gpyrpc.proto:840

  Message for list method response.

  • repeated string method_name_list = 1

    List of available method names.

Service for KCL VM interactions.

• rpc Ping (Ping_Args, Ping_Result)

  gpyrpc.proto:87

  / Ping KclvmService, return the same value as the parameter / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "Ping", / "params": { / "value": "hello" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "value": "hello" / }, / "id": 1 / } / ```

• rpc GetVersion (GetVersion_Args, GetVersion_Result)

  gpyrpc.proto:114

  / GetVersion KclvmService, return the kclvm service version information / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "GetVersion", / "params": {}, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "version": "0.9.1", / "checksum": "c020ab3eb4b9179219d6837a57f5d323", / "git_sha": "1a9a72942fffc9f62cb8f1ae4e1d5ca32aa1f399", / "version_info": "Version: 0.9.1-c020ab3eb4b9179219d6837a57f5d323\nPlatform: aarch64-apple-darwin\nGitCommit: 1a9a72942fffc9f62cb8f1ae4e1d5ca32aa1f399" / }, / "id": 1 / } / ```

  message GetVersion_Args

  gpyrpc.proto:818

  Message for version request arguments. Empty message.

  empty

  (message has no fields)

  message GetVersion_Result

  gpyrpc.proto:823

  Message for version response.

  • string version = 1

    KCL version.

  • string checksum = 2

    Checksum of the KCL version.

  • string git_sha = 3

    Git Git SHA of the KCL code repo.

  • string version_info = 4

    Detailed version information as a string.

• rpc ParseProgram (ParseProgram_Args, ParseProgram_Result)

  gpyrpc.proto:142

  / Parse KCL program with entry files. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "ParseProgram", / "params": { / "paths": ["./src/testdata/test.k"] / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "ast_json": "{...}", / "paths": ["./src/testdata/test.k"], / "errors": [] / }, / "id": 1 / } / ```

  message ParseProgram_Result

  gpyrpc.proto:876

  Message for parse program response.

  • string ast_json = 1

    Abstract Syntax Tree (AST) in JSON format.

  • repeated string paths = 2

    Returns the files in the order they should be compiled.

  • repeated Error errors = 3

    List of parse errors.

• rpc ParseFile (ParseFile_Args, ParseFile_Result)

  gpyrpc.proto:171

  / Parse KCL single file to Module AST JSON string with import dependencies / and parse errors. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "ParseFile", / "params": { / "path": "./src/testdata/parse/main.k" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "ast_json": "{...}", / "deps": ["./dep1", "./dep2"], / "errors": [] / }, / "id": 1 / } / ```

  message ParseFile_Args

  gpyrpc.proto:846

  Message for parse file request arguments.

  • string path = 1

    Path of the file to be parsed.

  • string source = 2

    Source code to be parsed.

  • repeated ExternalPkg external_pkgs = 3

    External packages path.

  message ParseFile_Result

  gpyrpc.proto:856

  Message for parse file response.

  • string ast_json = 1

    Abstract Syntax Tree (AST) in JSON format.

  • repeated string deps = 2

    File dependency paths.

  • repeated Error errors = 3

    List of parse errors.

• rpc LoadPackage (LoadPackage_Args, LoadPackage_Result)

  gpyrpc.proto:210

  / load_package provides users with the ability to parse kcl program and semantic model / information including symbols, types, definitions, etc. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "LoadPackage", / "params": { / "parse_args": { / "paths": ["./src/testdata/parse/main.k"] / }, / "resolve_ast": true / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "program": "{...}", / "paths": ["./src/testdata/parse/main.k"], / "parse_errors": [], / "type_errors": [], / "symbols": { ... }, / "scopes": { ... }, / "node_symbol_map": { ... }, / "symbol_node_map": { ... }, / "fully_qualified_name_map": { ... }, / "pkg_scope_map": { ... } / }, / "id": 1 / } / ```

  message LoadPackage_Args

  gpyrpc.proto:886

  Message for load package request arguments.

  • optional ParseProgram_Args parse_args = 1

    Arguments for parsing the program.

  • bool resolve_ast = 2

    Flag indicating whether to resolve AST.

  • bool load_builtin = 3

    Flag indicating whether to load built-in modules.

  • bool with_ast_index = 4

    Flag indicating whether to include AST index.

  message LoadPackage_Result

  gpyrpc.proto:898

  Message for load package response.

  • string program = 1

    Program Abstract Syntax Tree (AST) in JSON format.

  • repeated string paths = 2

    Returns the files in the order they should be compiled.

  • repeated Error parse_errors = 3

    List of parse errors.

  • repeated Error type_errors = 4

    List of type errors.

  • map<string, Scope> scopes = 5

    Map of scopes with scope index as key.

  • map<string, Symbol> symbols = 6

    Map of symbols with symbol index as key.

  • map<string, SymbolIndex> node_symbol_map = 7

    Map of node-symbol associations with AST index UUID as key.

  • map<string, string> symbol_node_map = 8

    Map of symbol-node associations with symbol index as key.

  • map<string, SymbolIndex> fully_qualified_name_map = 9

    Map of fully qualified names with symbol index as key.

  • map<string, ScopeIndex> pkg_scope_map = 10

    Map of package scope with package path as key.

• rpc ListOptions (ParseProgram_Args, ListOptions_Result)

  gpyrpc.proto:240

  / list_options provides users with the ability to parse kcl program and get all option information. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "ListOptions", / "params": { / "paths": ["./src/testdata/option/main.k"] / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "options": [ / { "name": "option1", "type": "str", "required": true, "default_value": "", "help": "option 1 help" }, / { "name": "option2", "type": "int", "required": false, "default_value": "0", "help": "option 2 help" }, / { "name": "option3", "type": "bool", "required": false, "default_value": "false", "help": "option 3 help" } / ] / }, / "id": 1 / } / ```

  message ListOptions_Result

  gpyrpc.proto:922

  Message for list options response.

  • repeated OptionHelp options = 2

    List of available options.

• rpc ListVariables (ListVariables_Args, ListVariables_Result)

  gpyrpc.proto:275

  / list_variables provides users with the ability to parse kcl program and get all variables by specs. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "ListVariables", / "params": { / "files": ["./src/testdata/variables/main.k"], / "specs": ["a"] / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "variables": { / "a": { / "variables": [ / { "value": "1", "type_name": "int", "op_sym": "", "list_items": [], "dict_entries": [] } / ] / } / }, / "unsupported_codes": [], / "parse_errors": [] / }, / "id": 1 / } / ```

  message ListVariables_Args

  gpyrpc.proto:1132

  Message for list variables request arguments.

  • repeated string files = 1

    Files to be processed.

  • repeated string specs = 2

    Specifications for variables.

  • optional ListVariables_Options options = 3

    Options for listing variables.

  message ListVariables_Result

  gpyrpc.proto:1142

  Message for list variables response.

  • map<string, VariableList> variables = 1

    Map of variable lists by file.

  • repeated string unsupported_codes = 2

    List of unsupported codes.

  • repeated Error parse_errors = 3

    List of parse errors encountered.

• rpc ExecProgram (ExecProgram_Args, ExecProgram_Result)

  gpyrpc.proto:368

  / Execute KCL file with args. **Note that it is not thread safe.** / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "ExecProgram", / "params": { / "work_dir": "./src/testdata", / "k_filename_list": ["test.k"] / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "json_result": "{\"alice\": {\"age\": 18}}", / "yaml_result": "alice:\n age: 18", / "log_message": "", / "err_message": "" / }, / "id": 1 / } / / // Request with code / { / "jsonrpc": "2.0", / "method": "ExecProgram", / "params": { / "k_filename_list": ["file.k"], / "k_code_list": ["alice = {age = 18}"] / }, / "id": 2 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "json_result": "{\"alice\": {\"age\": 18}}", / "yaml_result": "alice:\n age: 18", / "log_message": "", / "err_message": "" / }, / "id": 2 / } / / // Error case - cannot find file / { / "jsonrpc": "2.0", / "method": "ExecProgram", / "params": { / "k_filename_list": ["invalid_file.k"] / }, / "id": 3 / } / / // Error Response / { / "jsonrpc": "2.0", / "error": { / "code": -32602, / "message": "Cannot find the kcl file" / }, / "id": 3 / } / / // Error case - no input files / { / "jsonrpc": "2.0", / "method": "ExecProgram", / "params": { / "k_filename_list": [] / }, / "id": 4 / } / / // Error Response / { / "jsonrpc": "2.0", / "error": { / "code": -32602, / "message": "No input KCL files or paths" / }, / "id": 4 / } / ```

• rpc BuildProgram (BuildProgram_Args, BuildProgram_Result)

  gpyrpc.proto:398

  / Build the KCL program to an artifact. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "BuildProgram", / "params": { / "exec_args": { / "work_dir": "./src/testdata", / "k_filename_list": ["test.k"] / }, / "output": "./build" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "path": "./build/test.k" / }, / "id": 1 / } / ```

  message BuildProgram_Args

  gpyrpc.proto:1044

  Message for build program request arguments.

  • optional ExecProgram_Args exec_args = 1

    Arguments for executing the program.

  • string output = 2

    Output path.

  message BuildProgram_Result

  gpyrpc.proto:1052

  Message for build program response.

  • string path = 1

    Path of the built program.

• rpc ExecArtifact (ExecArtifact_Args, ExecProgram_Result)

  gpyrpc.proto:431

  / Execute the KCL artifact with args. **Note that it is not thread safe.** / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "ExecArtifact", / "params": { / "path": "./artifact_path", / "exec_args": { / "work_dir": "./src/testdata", / "k_filename_list": ["test.k"] / } / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "json_result": "{\"alice\": {\"age\": 18}}", / "yaml_result": "alice:\n age: 18", / "log_message": "", / "err_message": "" / }, / "id": 1 / } / ```

  message ExecArtifact_Args

  gpyrpc.proto:1058

  Message for execute artifact request arguments.

  • string path = 1

    Path of the artifact.

  • optional ExecProgram_Args exec_args = 2

    Arguments for executing the program.

• rpc OverrideFile (OverrideFile_Args, OverrideFile_Result)

  gpyrpc.proto:459

  / Override KCL file with args. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "OverrideFile", / "params": { / "file": "./src/testdata/test.k", / "specs": ["alice.age=18"] / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "result": true, / "parse_errors": [] / }, / "id": 1 / } / ```

  message OverrideFile_Args

  gpyrpc.proto:1102

  Message for override file request arguments.

  • string file = 1

    Path of the file to override.

  • repeated string specs = 2

    List of override specifications.

  • repeated string import_paths = 3

    List of import paths.

  message OverrideFile_Result

  gpyrpc.proto:1112

  Message for override file response.

  • bool result = 1

    Result of the override operation.

  • repeated Error parse_errors = 2

    List of parse errors encountered.

• rpc GetSchemaTypeMapping (GetSchemaTypeMapping_Args, GetSchemaTypeMapping_Result)

  gpyrpc.proto:506

  / Get schema type mapping. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "GetSchemaTypeMapping", / "params": { / "exec_args": { / "work_dir": "./src/testdata", / "k_filename_list": ["main.k"], / "external_pkgs": [ / { / "pkg_name":"pkg", / "pkg_path": "./src/testdata/pkg" / } / ] / }, / "schema_name": "Person" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "schema_type_mapping": { / "Person": { / "type": "schema", / "schema_name": "Person", / "properties": { / "name": { "type": "str" }, / "age": { "type": "int" } / }, / "required": ["name", "age"], / "decorators": [] / } / } / }, / "id": 1 / } / ```

  message GetSchemaTypeMapping_Args

  gpyrpc.proto:1174

  Message for get schema type mapping request arguments.

  • optional ExecProgram_Args exec_args = 1

    Arguments for executing the program.

  • string schema_name = 2

    Name of the schema.

  message GetSchemaTypeMapping_Result

  gpyrpc.proto:1182

  Message for get schema type mapping response.

  • map<string, KclType> schema_type_mapping = 1

    Map of schema type mappings.

• rpc FormatCode (FormatCode_Args, FormatCode_Result)

  gpyrpc.proto:532

  / Format code source. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "FormatCode", / "params": { / "source": "schema Person {\n name: str\n age: int\n}\nperson = Person {\n name = \"Alice\"\n age = 18\n}\n" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "formatted": "schema Person {\n name: str\n age: int\n}\nperson = Person {\n name = \"Alice\"\n age = 18\n}\n" / }, / "id": 1 / } / ```

  message FormatCode_Args

  gpyrpc.proto:1066

  Message for format code request arguments.

  • string source = 1

    Source code to be formatted.

  message FormatCode_Result

  gpyrpc.proto:1072

  Message for format code response.

  • bytes formatted = 1

    Formatted code as bytes.

• rpc FormatPath (FormatPath_Args, FormatPath_Result)

  gpyrpc.proto:558

  / Format KCL file or directory path contains KCL files and returns the changed file paths. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "FormatPath", / "params": { / "path": "./src/testdata/test.k" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "changed_paths": [] / }, / "id": 1 / } / ```

  message FormatPath_Args

  gpyrpc.proto:1078

  Message for format file path request arguments.

  • string path = 1

    Path of the file to format.

  message FormatPath_Result

  gpyrpc.proto:1084

  Message for format file path response.

  • repeated string changed_paths = 1

    List of changed file paths.

• rpc LintPath (LintPath_Args, LintPath_Result)

  gpyrpc.proto:584

  / Lint files and return error messages including errors and warnings. / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "LintPath", / "params": { / "paths": ["./src/testdata/test-lint.k"] / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "results": ["Module 'math' imported but unused"] / }, / "id": 1 / } / ```

  message LintPath_Args

  gpyrpc.proto:1090

  Message for lint file path request arguments.

  • repeated string paths = 1

    Paths of the files to lint.

  message LintPath_Result

  gpyrpc.proto:1096

  Message for lint file path response.

  • repeated string results = 1

    List of lint results.

• rpc ValidateCode (ValidateCode_Args, ValidateCode_Result)

  gpyrpc.proto:614

  / Validate code using schema and data strings. / / **Note that it is not thread safe.** / / # Examples / / ```jsonrpc / // Request / { / "jsonrpc": "2.0", / "method": "ValidateCode", / "params": { / "code": "schema Person {\n name: str\n age: int\n check: 0 < age < 120\n}", / "data": "{\"name\": \"Alice\", \"age\": 10}" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "success": true, / "err_message": "" / }, / "id": 1 / } / ```

  message ValidateCode_Args

  gpyrpc.proto:1199

  Message for validate code request arguments.

  • string datafile = 1

    Path to the data file.

  • string data = 2

    Data content.

  • string file = 3

    Path to the code file.

  • string code = 4

    Source code content.

  • string schema = 5

    Name of the schema.

  • string attribute_name = 6

    Name of the attribute.

  • string format = 7

    Format of the validation (e.g., "json", "yaml").

  • repeated ExternalPkg external_pkgs = 8

    List of external packages updated.

  message ValidateCode_Result

  gpyrpc.proto:1219

  Message for validate code response.

  • bool success = 1

    Flag indicating if validation was successful.

  • string err_message = 2

    Error message from validation.

• rpc ListDepFiles (ListDepFiles_Args, ListDepFiles_Result)

  gpyrpc.proto:616

  message ListDepFiles_Args

  gpyrpc.proto:1237

  Message for list dependency files request arguments.

  • string work_dir = 1

    Working directory.

  • bool use_abs_path = 2

    Flag to use absolute paths.

  • bool include_all = 3

    Flag to include all files.

  • bool use_fast_parser = 4

    Flag to use fast parser.

  message ListDepFiles_Result

  gpyrpc.proto:1249

  Message for list dependency files response.

  • string pkgroot = 1

    Root package path.

  • string pkgpath = 2

    Package path.

  • repeated string files = 3

    List of file paths in the package.

• rpc LoadSettingsFiles (LoadSettingsFiles_Args, LoadSettingsFiles_Result)

  gpyrpc.proto:656

  / Build setting file config from args. / / # Examples / / / // Request / { / "jsonrpc": "2.0", / "method": "LoadSettingsFiles", / "params": { / "work_dir": "./src/testdata/settings", / "files": ["./src/testdata/settings/kcl.yaml"] / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "kcl_cli_configs": { / "files": ["./src/testdata/settings/kcl.yaml"], / "output": "", / "overrides": [], / "path_selector": [], / "strict_range_check": false, / "disable_none": false, / "verbose": 0, / "debug": false, / "sort_keys": false, / "show_hidden": false, / "include_schema_type_path": false, / "fast_eval": false / }, / "kcl_options": [] / }, / "id": 1 / } / ```

  message LoadSettingsFiles_Args

  gpyrpc.proto:1264

  Message for load settings files request arguments.

  • string work_dir = 1

    Working directory.

  • repeated string files = 2

    Setting files to load.

  message LoadSettingsFiles_Result

  gpyrpc.proto:1272

  Message for load settings files response.

  • optional CliConfig kcl_cli_configs = 1

    KCL CLI configuration.

  • repeated KeyValuePair kcl_options = 2

    List of KCL options as key-value pairs.

• rpc Rename (Rename_Args, Rename_Result)

  gpyrpc.proto:686

  / Rename all the occurrences of the target symbol in the files. This API will rewrite files if they contain symbols to be renamed. / Return the file paths that got changed. / / # Examples / / / // Request / { / "jsonrpc": "2.0", / "method": "Rename", / "params": { / "package_root": "./src/testdata/rename_doc", / "symbol_path": "a", / "file_paths": ["./src/testdata/rename_doc/main.k"], / "new_name": "a2" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "changed_files": ["./src/testdata/rename_doc/main.k"] / }, / "id": 1 / } / ```

  message Rename_Args

  gpyrpc.proto:1322

  Message for rename request arguments.

  • string package_root = 1

    File path to the package root.

  • string symbol_path = 2

    Path to the target symbol to be renamed.

  • repeated string file_paths = 3

    Paths to the source code files.

  • string new_name = 4

    New name of the symbol.

  message Rename_Result

  gpyrpc.proto:1334

  Message for rename response.

  • repeated string changed_files = 1

    List of file paths that got changed.

• rpc RenameCode (RenameCode_Args, RenameCode_Result)

  gpyrpc.proto:719

  / Rename all the occurrences of the target symbol and return the modified code if any code has been changed. This API won't rewrite files but return the changed code. / / # Examples / / / // Request / { / "jsonrpc": "2.0", / "method": "RenameCode", / "params": { / "package_root": "/mock/path", / "symbol_path": "a", / "source_codes": { / "/mock/path/main.k": "a = 1\nb = a" / }, / "new_name": "a2" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "changed_codes": { / "/mock/path/main.k": "a2 = 1\nb = a2" / } / }, / "id": 1 / } / ```

  message RenameCode_Args

  gpyrpc.proto:1346

  Message for rename code request arguments.

  • string package_root = 1

    File path to the package root.

  • string symbol_path = 2

    Path to the target symbol to be renamed.

  • map<string, string> source_codes = 3

    Map of source code with filename as key and code as value.

  • string new_name = 4

    New name of the symbol.

  message RenameCode_Result

  gpyrpc.proto:1358

  Message for rename code response.

  • map<string, string> changed_codes = 1

    Map of changed code with filename as key and modified code as value.

• rpc Test (Test_Args, Test_Result)

  gpyrpc.proto:752

  / Test KCL packages with test arguments. / / # Examples / / / // Request / { / "jsonrpc": "2.0", / "method": "Test", / "params": { / "exec_args": { / "work_dir": "./src/testdata/testing/module", / "k_filename_list": ["main.k"] / }, / "pkg_list": ["./src/testdata/testing/module/..."] / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "info": [ / {"name": "test_case_1", "error": "", "duration": 1000, "log_message": ""}, / {"name": "test_case_2", "error": "some error", "duration": 2000, "log_message": ""} / ] / }, / "id": 1 / } / ```

  message Test_Args

  gpyrpc.proto:1369

  Message for test request arguments.

  • optional ExecProgram_Args exec_args = 1

    Execution program arguments.

  • repeated string pkg_list = 2

    List of KCL package paths to be tested.

  • string run_regexp = 3

    Regular expression for filtering tests to run.

  • bool fail_fast = 4

    Flag to stop the test run on the first failure.

  message Test_Result

  gpyrpc.proto:1381

  Message for test response.

  • repeated TestCaseInfo info = 2

    List of test case information.

• rpc UpdateDependencies (UpdateDependencies_Args, UpdateDependencies_Result)

  gpyrpc.proto:802

  / Download and update dependencies defined in the kcl.mod file. / / # Examples / / / // Request / { / "jsonrpc": "2.0", / "method": "UpdateDependencies", / "params": { / "manifest_path": "./src/testdata/update_dependencies" / }, / "id": 1 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "external_pkgs": [ / {"pkg_name": "pkg1", "pkg_path": "./src/testdata/update_dependencies/pkg1"} / ] / }, / "id": 1 / } / / // Request with vendor flag / { / "jsonrpc": "2.0", / "method": "UpdateDependencies", / "params": { / "manifest_path": "./src/testdata/update_dependencies", / "vendor": true / }, / "id": 2 / } / / // Response / { / "jsonrpc": "2.0", / "result": { / "external_pkgs": [ / {"pkg_name": "pkg1", "pkg_path": "./src/testdata/update_dependencies/pkg1"} / ] / }, / "id": 2 / } / ```

  message UpdateDependencies_Args

  gpyrpc.proto:1404

  Message for update dependencies request arguments.

  • string manifest_path = 1

    Path to the manifest file.

  • bool vendor = 2

    Flag to vendor dependencies locally.

  message UpdateDependencies_Result

  gpyrpc.proto:1412

  Message for update dependencies response.

  • repeated ExternalPkg external_pkgs = 3

    List of external packages updated.

Message representing a key-value argument for KCL. kcl main.k -D name=value

Used in: ExecProgram_Args

• string name = 1

  Name of the argument.

• string value = 2

  Value of the argument.

Message representing KCL CLI configuration.

Used in: LoadSettingsFiles_Result

• repeated string files = 1

  List of files.

• string output = 2

  Output path.

• repeated string overrides = 3

  List of overrides.

• repeated string path_selector = 4

  Path selectors.

• bool strict_range_check = 5

  Flag for strict range check.

• bool disable_none = 6

  Flag to disable none values.

• int64 verbose = 7

  Verbose level.

• bool debug = 8

  Debug flag.

• bool sort_keys = 9

  Flag to sort keys in YAML/JSON results.

• bool show_hidden = 10

  Flag to show hidden attributes.

• bool include_schema_type_path = 11

  Flag to include schema type path in results.

• bool fast_eval = 12

  Flag for fast evaluation.

Message representing a decorator in KCL.

Used in: KclType

• string name = 1

  Name of the decorator.

• repeated string arguments = 2

  Arguments for the decorator.

• map<string, string> keywords = 3

  Keyword arguments for the decorator as a map with keyword name as key.

Message representing an error.

Used in: ListVariables_Result, LoadPackage_Result, OverrideFile_Result, ParseFile_Result, ParseProgram_Result

• string level = 1

  Level of the error (e.g., "Error", "Warning").

• string code = 2

  Error code. (e.g., "E1001")

• repeated Message messages = 3

  List of error messages.

Message representing an example in KCL.

Used in: KclType

• string summary = 1

  Short description for the example.

• string description = 2

  Long description for the example.

• string value = 3

  Embedded literal example.

Message for execute program request arguments.

Used as request type in: KclvmService.ExecProgram

Used as field type in: BuildProgram_Args, ExecArtifact_Args, GetSchemaTypeMapping_Args, Test_Args

• string work_dir = 1

  Working directory.

• repeated string k_filename_list = 2

  List of KCL filenames.

• repeated string k_code_list = 3

  List of KCL codes.

• repeated Argument args = 4

  Arguments for the program.

• repeated string overrides = 5

  Override configurations.

• bool disable_yaml_result = 6

  Flag to disable YAML result.

• bool print_override_ast = 7

  Flag to print override AST.

• bool strict_range_check = 8

  Flag for strict range check.

• bool disable_none = 9

  Flag to disable none values.

• int32 verbose = 10

  Verbose level.

• int32 debug = 11

  Debug level.

• bool sort_keys = 12

  Flag to sort keys in YAML/JSON results.

• repeated ExternalPkg external_pkgs = 13

  External packages path.

• bool include_schema_type_path = 14

  Flag to include schema type path in results.

• bool compile_only = 15

  Flag to compile only without execution.

• bool show_hidden = 16

  Flag to show hidden attributes.

• repeated string path_selector = 17

  Path selectors for results.

• bool fast_eval = 18

  Flag for fast evaluation.

Message for execute program response.

Used as response type in: KclvmService.ExecArtifact, KclvmService.ExecProgram

• string json_result = 1

  Result in JSON format.

• string yaml_result = 2

  Result in YAML format.

• string log_message = 3

  Log message from execution.

• string err_message = 4

  Error message from execution.

Message representing an external package for KCL. kcl main.k -E pkg_name=pkg_path

Used in: ExecProgram_Args, ParseFile_Args, ParseProgram_Args, UpdateDependencies_Result, ValidateCode_Args

• string pkg_name = 1

  Name of the package.

• string pkg_path = 2

  Path of the package.

Message for get schema type mapping response.

• map<string, SchemaTypes> schema_type_mapping = 1

  Map of pkg and schema types mappings.

Message representing a KCL type.

Used in: GetSchemaTypeMapping_Result, SchemaTypes, Symbol

• string type = 1

  Type name (e.g., schema, dict, list, str, int, float, bool, any, union, number_multiplier).

• repeated KclType union_types = 2

  Union types if applicable.

• string default = 3

  Default value of the type.

• string schema_name = 4

  Name of the schema if applicable.

• string schema_doc = 5

  Documentation for the schema.

• map<string, KclType> properties = 6

  Properties of the schema as a map with property name as key.

• repeated string required = 7

  List of required schema properties.

• optional KclType key = 8

  Key type if the KclType is a dictionary.

• optional KclType item = 9

  Item type if the KclType is a list or dictionary.

• int32 line = 10

  Line number where the type is defined.

• repeated Decorator decorators = 11

  List of decorators for the schema.

• string filename = 12

  Absolute path of the file where the attribute is located.

• string pkg_path = 13

  Path of the package where the attribute is located.

• string description = 14

  Documentation for the attribute.

• map<string, Example> examples = 15

  Map of examples with example name as key.

• optional KclType base_schema = 16

  Base schema if applicable.

Message representing a key-value pair.

Used in: LoadSettingsFiles_Result

• string key = 1

  Key of the pair.

• string value = 2

  Value of the pair.

Message for list variables options.

Used in: ListVariables_Args

• bool merge_program = 1

  Flag to merge program configuration.

Message representing a map entry.

Used in: Variable

• string key = 1

  Key of the map entry.

• optional Variable value = 2

  Value of the map entry.

Message representing a detailed error message with a position.

Used in: Error

• string msg = 1

  The error message text.

• optional Position pos = 2

  The position in the source code where the error occurred.

Message representing a help option.

Used in: ListOptions_Result

• string name = 1

  Name of the option.

• string type = 2

  Type of the option.

• bool required = 3

  Flag indicating if the option is required.

• string default_value = 4

  Default value of the option.

• string help = 5

  Help text for the option.

Message for parse program request arguments.

Used as request type in: KclvmService.ListOptions, KclvmService.ParseProgram

Used as field type in: LoadPackage_Args

• repeated string paths = 1

  Paths of the program files to be parsed.

• repeated string sources = 2

  Source codes to be parsed.

• repeated ExternalPkg external_pkgs = 3

  External packages path.

Message for ping request arguments.

Used as request type in: BuiltinService.Ping, KclvmService.Ping

• string value = 1

  Value to be sent in the ping request.

Message for ping response.

Used as response type in: BuiltinService.Ping, KclvmService.Ping

• string value = 1

  Value received in the ping response.

Message representing a position in the source code.

Used in: Message

• int64 line = 1

  Line number.

• int64 column = 2

  Column number.

• string filename = 3

  Filename the position refers to.

Used in: GetSchemaTypeMappingUnderPath_Result

• repeated KclType schema_type = 1

  List of schema type mappings.

Message representing a scope in KCL.

Used in: LoadPackage_Result

• string kind = 1

  Type of the scope.

• optional ScopeIndex parent = 2

  Parent scope.

• optional SymbolIndex owner = 3

  Owner of the scope.

• repeated ScopeIndex children = 4

  Children of the scope.

• repeated SymbolIndex defs = 5

  Definitions in the scope.

Message representing a scope index.

Used in: LoadPackage_Result, Scope

• uint64 i = 1

  Index identifier.

• uint64 g = 2

  Global identifier.

• string kind = 3

  Type of the scope.

Message representing a symbol in KCL.

Used in: LoadPackage_Result

• optional KclType ty = 1

  Type of the symbol.

• string name = 2

  Name of the symbol.

• optional SymbolIndex owner = 3

  Owner of the symbol.

• optional SymbolIndex def = 4

  Definition of the symbol.

• repeated SymbolIndex attrs = 5

  Attributes of the symbol.

• bool is_global = 6

  Flag indicating if the symbol is global.

Message representing a symbol index.

Used in: LoadPackage_Result, Scope, Symbol

• uint64 i = 1

  Index identifier.

• uint64 g = 2

  Global identifier.

• string kind = 3

  Type of the symbol or scope.

Message representing information about a single test case.

Used in: Test_Result

• string name = 1

  Name of the test case.

• string error = 2

  Error message if any.

• uint64 duration = 3

  Duration of the test case in microseconds.

• string log_message = 4

  Log message from the test case.

Message representing a variable.

Used in: MapEntry, VariableList

• string value = 1

  Value of the variable.

• string type_name = 2

  Type name of the variable.

• string op_sym = 3

  Operation symbol associated with the variable.

• repeated Variable list_items = 4

  List items if the variable is a list.

• repeated MapEntry dict_entries = 5

  Dictionary entries if the variable is a dictionary.

Message representing a list of variables.

Used in: ListVariables_Result

• repeated Variable variables = 1

  List of variables.