Skip to content

Mock

LLMTestServer

Mock server for OpenAI API. This class is used to simulate the OpenAI API for testing purposes.

Source code in python/opsml/mock/_mock.pyi 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class LLMTestServer:
    """
    Mock server for OpenAI API.
    This class is used to simulate the OpenAI API for testing purposes.
    """

    def __init__(self): ...
    def __enter__(self):
        """
        Start the mock server.
        """

    def __exit__(self, exc_type, exc_value, traceback):
        """
        Stop the mock server.
        """

__enter__()

Start the mock server.

Source code in python/opsml/mock/_mock.pyi 
82
83
84
85
def __enter__(self):
    """
    Start the mock server.
    """

__exit__(exc_type, exc_value, traceback)

Stop the mock server.

Source code in python/opsml/mock/_mock.pyi 
87
88
89
90
def __exit__(self, exc_type, exc_value, traceback):
    """
    Stop the mock server.
    """

MockConfig

Source code in python/opsml/mock/_mock.pyi 
67
68
69
70
71
72
73
class MockConfig:
    def __init__(self, **kwargs) -> None:
        """Mock configuration for the ScouterQueue

        Args:
            **kwargs: Arbitrary keyword arguments to set as attributes.
        """

__init__(**kwargs)

Mock configuration for the ScouterQueue

Parameters:

Name Type Description Default
**kwargs

Arbitrary keyword arguments to set as attributes.

 {}
Source code in python/opsml/mock/_mock.pyi 
68
69
70
71
72
73
def __init__(self, **kwargs) -> None:
    """Mock configuration for the ScouterQueue

    Args:
        **kwargs: Arbitrary keyword arguments to set as attributes.
    """

OpsmlServerContext

Source code in python/opsml/mock/_mock.pyi 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
class OpsmlServerContext:
    def __init__(self) -> None:
        """Instantiates the server context.
        This is helpful when you are running tests in server mode to
        aid in background cleanup of resources
        """

    def __enter__(self) -> "OpsmlServerContext":
        """Starts the server context."""

    def __exit__(self, exc_type, exc_value, traceback) -> None:
        """Stops the server context."""

    @property
    def server_uri(self) -> str:
        """Returns the server URI."""

server_uri property

Returns the server URI.

__enter__()

Starts the server context.

Source code in python/opsml/mock/_mock.pyi 
57
58
def __enter__(self) -> "OpsmlServerContext":
    """Starts the server context."""

__exit__(exc_type, exc_value, traceback)

Stops the server context.

Source code in python/opsml/mock/_mock.pyi 
60
61
def __exit__(self, exc_type, exc_value, traceback) -> None:
    """Stops the server context."""

__init__()

Instantiates the server context. This is helpful when you are running tests in server mode to aid in background cleanup of resources

Source code in python/opsml/mock/_mock.pyi 
51
52
53
54
55
def __init__(self) -> None:
    """Instantiates the server context.
    This is helpful when you are running tests in server mode to
    aid in background cleanup of resources
    """

OpsmlTestServer

Source code in python/opsml/mock/_mock.pyi 
11
12
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
class OpsmlTestServer:
    def __init__(self, cleanup: bool = True, base_path: Optional[Path] = None) -> None:
        """Instantiates the test server.

        When the test server is used as a context manager, it will start the server
        in a background thread and set the appropriate env vars so that the client
        can connect to the server. The server will be stopped when the context manager
        exits and the env vars will be reset.

        Args:
            cleanup (bool, optional):
                Whether to cleanup the server after the test. Defaults to True.
            base_path (Optional[Path], optional):
                The base path for the server. Defaults to None. This is primarily
                used for testing loading attributes from a pyproject.toml file.
        """

    def start_server(self) -> None:
        """Starts the test server."""

    def stop_server(self) -> None:
        """Stops the test server."""

    def __enter__(self) -> "OpsmlTestServer":
        """Starts the test server."""

    def __exit__(self, exc_type, exc_value, traceback) -> None:
        """Stops the test server."""

    def set_env_vars_for_client(self) -> None:
        """Sets the env vars for the client to connect to the server."""

    def remove_env_vars_for_client(self) -> None:
        """Removes the env vars for the client to connect to the server."""

    @staticmethod
    def cleanup() -> None:
        """Cleans up the test server."""

__enter__()

Starts the test server.

Source code in python/opsml/mock/_mock.pyi 
34
35
def __enter__(self) -> "OpsmlTestServer":
    """Starts the test server."""

__exit__(exc_type, exc_value, traceback)

Stops the test server.

Source code in python/opsml/mock/_mock.pyi 
37
38
def __exit__(self, exc_type, exc_value, traceback) -> None:
    """Stops the test server."""

__init__(cleanup=True, base_path=None)

Instantiates the test server.

When the test server is used as a context manager, it will start the server in a background thread and set the appropriate env vars so that the client can connect to the server. The server will be stopped when the context manager exits and the env vars will be reset.

Parameters:

Name Type Description Default
cleanup bool

Whether to cleanup the server after the test. Defaults to True.

 True
base_path Optional[Path]

The base path for the server. Defaults to None. This is primarily used for testing loading attributes from a pyproject.toml file.

 None
Source code in python/opsml/mock/_mock.pyi 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
def __init__(self, cleanup: bool = True, base_path: Optional[Path] = None) -> None:
    """Instantiates the test server.

    When the test server is used as a context manager, it will start the server
    in a background thread and set the appropriate env vars so that the client
    can connect to the server. The server will be stopped when the context manager
    exits and the env vars will be reset.

    Args:
        cleanup (bool, optional):
            Whether to cleanup the server after the test. Defaults to True.
        base_path (Optional[Path], optional):
            The base path for the server. Defaults to None. This is primarily
            used for testing loading attributes from a pyproject.toml file.
    """

cleanup() staticmethod

Cleans up the test server.

Source code in python/opsml/mock/_mock.pyi 
46
47
48
@staticmethod
def cleanup() -> None:
    """Cleans up the test server."""

remove_env_vars_for_client()

Removes the env vars for the client to connect to the server.

Source code in python/opsml/mock/_mock.pyi 
43
44
def remove_env_vars_for_client(self) -> None:
    """Removes the env vars for the client to connect to the server."""

set_env_vars_for_client()

Sets the env vars for the client to connect to the server.

Source code in python/opsml/mock/_mock.pyi 
40
41
def set_env_vars_for_client(self) -> None:
    """Sets the env vars for the client to connect to the server."""

start_server()

Starts the test server.

Source code in python/opsml/mock/_mock.pyi 
28
29
def start_server(self) -> None:
    """Starts the test server."""

stop_server()

Stops the test server.

Source code in python/opsml/mock/_mock.pyi 
31
32
def stop_server(self) -> None:
    """Stops the test server."""

RegistryTestHelper

Helper class for testing the registry

Source code in python/opsml/mock/_mock.pyi 
4
5
6
7
8
9
class RegistryTestHelper:
    """Helper class for testing the registry"""

    def __init__(self) -> None: ...
    def setup(self) -> None: ...
    def cleanup(self) -> None: ...