close_project

Forgets the open project. The session and the results of the last run stay.

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.

Raises #

The sign-in and plan check (first call of the process) raises the CatPortalError family listed on the Introduction page. With no open project: in the current version a bare TypeError: exceptions must derive from BaseException (not a readable message) — call open_project first.

Examples #

cat.open_project("D:/Testing/DwhTests.cat.yaml")
summary = cat.invoke_tests()
cat.close_project()

Related #

• Introduction — session model, logging, .NET objects, exceptions, sign-in.
• open_project — the counterpart.