https://docs.justcat.it/reference/python-module/ Recent content in CAT Python module on Hugo -- gohugo.io Wed, 19 Aug 2026 10:00:00 +0200 https://docs.justcat.it/reference/python-module/introduction/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/introduction/ The CAT Python module — package justcatit on PyPI, module justcatit.cat — drives CAT from Python: it opens a project file (.cat.yaml), runs its tests, hands the results back as objects, and manages the installation. It works with the same project file and runs tests with the same engine as CAT Studio, CAT CLI and the PowerShell module — which tool you use is a matter of environment and taste, not of capability. https://docs.justcat.it/reference/python-module/installation/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/installation/ Prerequisites # A 64-bit Python, 3.8 or later. The package depends on pythonnet, a compiled extension that is released for a range of Python versions — pip picks the pythonnet release that fits your Python; a Python newer than the latest pythonnet release cannot install the module until pythonnet catches up. An installed .NET runtime, version 8 or later. The package does not bring its own runtime; pythonnet finds the one installed on the machine (through DOTNET_ROOT or dotnet on PATH) and uses the highest version it finds. https://docs.justcat.it/reference/python-module/close-project/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/close-project/ Signature # cat.close_project() -> None Parameters # None. What it does # Detaches the open project from the session so that the project functions (get_tests, invoke_tests, …) refuse until another open_project. It does not end the session, does not sign out, and keeps the last run’s summary — get_test_results_summary() still works afterwards. It is never required: open_project replaces the open project by itself, and ending the process releases everything. Returns # None. https://docs.justcat.it/reference/python-module/get-data-source-lists/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/get-data-source-lists/ Signature # cat.get_data_source_lists() Parameters # None. What it does # Returns the project’s data-source lists: the project file’s own implicit list and every Data source list the project declares (a YAML file, a database table, an Excel sheet, …), each with its provider and connection. Use it to see where data sources come from; get_data_sources returns the data sources themselves, with DataSourceListID pointing back here. Returns # A .NET collection of DataSourceList objects: DataSourceListID, Name, Order, ProviderNameAndVersion, ConnectionString, Query, IsImplicit (the project file’s own list), FullName (for example # 1: Project file (Yaml@1)), Settings. https://docs.justcat.it/reference/python-module/get-data-sources/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/get-data-sources/ Signature # cat.get_data_sources() Parameters # None. What it does # Returns the data sources CAT loaded when the project was opened — from the project file and from every data-source list the project points to. Nothing is connected; this is what the project defines. Returns # A .NET collection of DataSourceDefinition objects: Name, ProviderTypeAndVersion (for example SqlServer@2), ConnectionString (with environment variables already expanded), Settings, DataSourceListID, DataSourceID, and the *Raw twins with the values as written in the file. https://docs.justcat.it/reference/python-module/get-instance/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/get-instance/ Signature # cat.get_instance() Parameters # None. What it does # Loads the engine if needed, reads %APPDATA%\CAT\.catconfig (~/.config/CAT/.catconfig on Linux) and the runtime, and returns one object describing the installation. It does not sign in and needs neither a token nor a key — it is the one function that always works, which makes it the first thing to run when something else does not (and the way to verify an installation). https://docs.justcat.it/reference/python-module/get-project-templates/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/get-project-templates/ Signature # cat.get_project_templates(online: bool = False, logging_level: LoggingLevel = None) Parameters # Parameter Type Default Meaning online bool False True: list the templates on the CAT server instead of the local ones. Nothing is downloaded by listing. logging_level LoggingLevel None cat.LoggingLevel member; used only when this is the first call of the process. See Logging. What it does # Without online, returns the templates available locally — the two shipped with CAT (default, getStartedWindows) and any downloaded earlier. https://docs.justcat.it/reference/python-module/get-test-lists/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/get-test-lists/ Signature # cat.get_test_lists() Parameters # None. What it does # Returns the project’s test lists: the project file’s own implicit list and every Test list the project declares (a YAML file, a database table, an Excel sheet, …), each with its provider and connection. Use it to see where tests come from; get_tests returns the tests themselves, with TestListID pointing back here. Returns # A .NET collection of TestList objects: TestListID, Name, Order, ProviderNameAndVersion, ConnectionString, Query, IsImplicit (the project file’s own list), FullName, Settings. https://docs.justcat.it/reference/python-module/get-test-results/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/get-test-results/ Signature # cat.get_test_results() Parameters # None. What it does # Returns the per-test results CAT kept from the last invoke_project / invoke_tests in this process — the same collection as get_test_results_summary().Results. A new run replaces them; close_project keeps them. Returns # A .NET collection of TestOutput objects: TestResult (an enum — str(r.TestResult) gives Passed, Failed, Error, Inconclusive), TestFullName, TestSuite, TestCase, TestName, Description, Message (the verdict’s explanation, including the sample of offending rows), RawMessage, ExceptionMessage, FirstDataSource, FirstQuery, SecondDataSource, SecondQuery, Expectation, NumberOfErrors, StartTime, EndTime, Duration, ThreadNumber, TestDefinition, TestDefinitionGuid. https://docs.justcat.it/reference/python-module/get-test-results-summary/ Mon, 15 Jan 2024 10:00:00 +0100 https://docs.justcat.it/reference/python-module/get-test-results-summary/ Signature # cat.get_test_results_summary() Parameters # None. What it does # Returns the summary CAT kept from the last invoke_project / invoke_tests in this process — the same object those functions returned; None before any run. This is how a script decides whether a run was good: neither invoke_* function raises for failed tests. Returns # A TestExecutionSummary object, or None: TotalCount, PassedCount, FailedCount, ErrorCount, InconclusiveCount, SkippedCount (ints); PassRate, FailedRate, ErrorRate, InconclusiveRate (percent, System.