* @name Batch element errors * * @{ */ * Structure representing per-element batch operation errors. * * Many OpenAssetIO API functions take multi

Loads Python Packages, using entry point discovery or from a custom search path. If they contain a top-level 'plugin' attribute, that hol

A Factory to manage @ref openassetio.pluginSystem.PythonPluginSystemManagerPlugin derived plugins. Not usually used directly by a @ref host,

`ManagerImplementationFactoryInterface` that forwards calls to an internal mock.

A Factory to manage @ref openassetio.ui.pluginSystem.PythonPluginSystemUIDelegatePlugin derived plugins. Not usually used directly by a @

`UIDelegateImplementationFactoryInterface` that forwards calls to an internal mock.

Base test case class that all test classes must inherit from. Expects test harness fixtures and an OpenAssetIO @ref manager to be provid

Python base class augmenting the C++ abstract base class. @see @fqref{ui.managerApi.UIDelegateInterface} "UIDelegateInterface".

Throwaway pager interface def, so we can create a temporary interface intended to fall out of scope. See `test_pager_kept_alive_by_retai

Python base class augmenting the C++ abstract base class. @see @fqref{hostApi.HostInterface} "HostInterface".

`EntityReferencePagerInterface` implementation that delegates all calls to a public `Mock` instance.

* Duplicate of SimpleCppContainer to be bound to Python with * PyRetainingSharedPtr decorators. */

A helper class that aids testing runtime generated strings that may contain unpredictable content along with known text (e.g stack traces

Throwaway pager interface def, so we can create a temporary interface intended to fall out of scope. See `test_when_EntityReferencePager

`HostInterface` implementation that delegates all calls to a public `Mock` instance.

`LoggerInterface` implementation that delegates all calls to a public `Mock` instance.

`ManagerImplementationFactoryInterface` implementation that delegates all calls to a public `Mock` instance.

`ManagerImplementationFactoryInterface` that forwards calls to an internal mock. @see mock_manager_implementation_factory

`UIDelegateImplementationFactoryInterface` implementation that delegates all calls to a public `Mock` instance.

`UIDelegateImplementationFactoryInterface` that forwards calls to an internal mock. @see mock_ui_delegate_implementation_factory

`UIDelegateInterface` implementation that delegates all calls to a public `Mock` instance.

A UIDelegateRequestInterface implementation that delegates all calls to a public Mock instance.

A UIDelegateStateInterface implementation that delegates all calls to a public Mock instance.

Subclass of pybind11-bound abstract C++ class, which is expected to throw the same exception from each of its methods. Each method corre

A minimal host interface implementation. This identifiers the calling tool or application to the API and downstream Manager.

A stub manager implementation that provides functionality required for the src/openassetio-python/tests/package/test/manager test suite t

`ManagerInterface` implementation that asserts parameter types then calls an internal mock. All method calls first have their parameter

The manager test harness. It acts as an anti-corruption layer around a unittest-compatible test runner, injecting a custom testcase load

Minimal required OpenAssetIO \fqref{hostApi.HostInterface} "HostInterface" implementation. @private

Custom test case loader that injects test harness fixtures into test cases for use in querying and assertions. @private

* Common constant values for strong enumerations of access pattern. * * We must ensure correspondence between the values of the various * workflows

* @name Batch element error handling * * @{ */ * Tag dispatching structure intended for use selecting appropriate * overloads for various

Assertion helpers for testing batch-first methods and their "convenience" method signatures. Many Manager methods have multiple overload

* Common constant values for strong enumerations of capability sets. * * We must ensure correspondence between the values of the middleware * and m

* Capabilities that the manager implements. * * Many OpenAssetIO methods are optional. This enum is used with the * introspection mechanism @

* Capabilities that the manager implements. * * Many OpenAssetIO methods are optional. This enum is used with the * introspection mechanism @

* Convenience struct deriving compile-time properties from the above * list of OpenAssetIO-specific exception class types and names. * * In particu

* Access pattern when querying a sensible default starting entity for * further queries. * * @see @fqref{hostApi.Manager.defaultEntityReference} *

Doxygen Awesome https://github.com/jothepro/doxygen-awesome-css MIT License Copyright (c) 2022 - 2023 jothepro Permission is hereby granted, free o

* Utility for handling Windows drive letters e.g. `C:\`. */

* Utility for handling Windows drive paths e.g. `C:\path`. */

* EntityReference forms a strongly typed wrapper around arbitrary * strings to ensure they have been validated by the target @ref manager * before b

* Access pattern for entity trait set queries. */ NOLINTNEXTLINE(performance-enum-size): requires binary breaking change

* Common constant values for error codes. * * The enum values must be kept in sync with the C API. */ NOLINTNEXTLINE(performance-enum-size): requir

* Abstract C++ class to be implemented as a subclass in Python, which * is expected to implement each method such that they throw an * exception. *

* POSIX path<->URL handler. * * This is the POSIX-specific entry point for converting a POSIX path * to/from a URL. */

* Windows path<->URL handler. * * This is the Windows-specific entry point for converting any type of * Window path to/from a URL. */

* Utility class for converting between file URLs and paths for both * Windows and POSIX systems. * * Reusable components (each usually consisting o

Used to test calling bound members in another thread.

* Utility for dealing with `/`-separated strings. * * I.e. posix paths and URLs. */

* Utility for non-platform specific paths. */

* Utility for dealing with non-platform specific URLs. */

* A ManagerInterface implementation that composes multiple child * ManagerInterfaces and forwards API calls to one of the children. * * For most AP

* Base fixture for tests, providing a pre-populated InfoDictionary and * its C handle. */

* Fixture providing a Manager instance injected with mock dependencies. */ NOLINTBEGIN(*-avoid-const-or-ref-data-members)

The Mapper class provides string substitution methods and lookups to determine the correct terminology for the supplied @ref manager. @u

* Mock manager API implementation that the function pointer suite (see * `mockManagerInterfaceSuite`) will delegate to. */

* Mock implementation of a HostInterface. * * Used as constructor parameter to Host classes required as part of these tests */