Skip to content

proxystore.endpoint.client

Utilities for client interactions with endpoints.

Note

Endpoints serve an HTTP REST API for clients on the local network. It is not intended that clients from outside the local network interact with an endpoint this way. (Rather, they should connect to their own local endpoint, which peers with remote endpoints.)

Note

These client functions ignore all HTTP proxies.

evict 

evict(
    address: str,
    key: str,
    endpoint: UUID | str | None = None,
    session: Session | None = None,
) -> None

Evict the object associated with the key.

Parameters:

  • address (str) –

    Address of endpoint.

  • key (str) –

    Key associated with object to evict.

  • endpoint (UUID | str | None, default: None ) –

    Optional UUID of remote endpoint to forward operation to.

  • session (Session | None, default: None ) –

    Session instance to use for making the request. Reusing the same session across multiple requests to the same host can improve performance.

Raises:

  • RequestException –

    If the endpoint request results in an unexpected error code.

Source code in proxystore/endpoint/client.py 
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
49
50
51
52
53
54
55
56
57
58
def evict(
    address: str,
    key: str,
    endpoint: uuid.UUID | str | None = None,
    session: requests.Session | None = None,
) -> None:
    """Evict the object associated with the key.

    Args:
        address: Address of endpoint.
        key: Key associated with object to evict.
        endpoint: Optional UUID of remote endpoint to forward operation to.
        session: Session instance to use for making the request. Reusing the
            same session across multiple requests to the same host can improve
            performance.

    Raises:
        RequestException: If the endpoint request results in an unexpected
            error code.
    """
    endpoint_str = (
        str(endpoint) if isinstance(endpoint, uuid.UUID) else endpoint
    )
    post = requests.post if session is None else session.post
    response = post(
        f'{address}/evict',
        params={'key': key, 'endpoint': endpoint_str},
        proxies={'http': ''},
    )
    if not response.ok:
        raise requests.exceptions.RequestException(
            f'Endpoint returned HTTP error code {response.status_code}. '
            f'{response.text}',
            response=response,
        )

exists 

exists(
    address: str,
    key: str,
    endpoint: UUID | str | None = None,
    session: Session | None = None,
) -> bool

Check if an object associated with the key exists.

Parameters:

  • address (str) –

    Address of endpoint.

  • key (str) –

    Key potentially associated with stored object.

  • endpoint (UUID | str | None, default: None ) –

    Optional UUID of remote endpoint to forward operation to.

  • session (Session | None, default: None ) –

    Session instance to use for making the request. Reusing the same session across multiple requests to the same host can improve performance.

Returns:

  • bool –

    If an object associated with the key exists.

Raises:

  • RequestException –

    If the endpoint request results in an unexpected error code.

Source code in proxystore/endpoint/client.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def exists(
    address: str,
    key: str,
    endpoint: uuid.UUID | str | None = None,
    session: requests.Session | None = None,
) -> bool:
    """Check if an object associated with the key exists.

    Args:
        address: Address of endpoint.
        key: Key potentially associated with stored object.
        endpoint: Optional UUID of remote endpoint to forward operation to.
        session: Session instance to use for making the request. Reusing the
            same session across multiple requests to the same host can improve
            performance.

    Returns:
        If an object associated with the key exists.

    Raises:
        RequestException: If the endpoint request results in an unexpected
            error code.
    """
    endpoint_str = (
        str(endpoint) if isinstance(endpoint, uuid.UUID) else endpoint
    )
    get_ = requests.get if session is None else session.get
    response = get_(
        f'{address}/exists',
        params={'key': key, 'endpoint': endpoint_str},
        proxies={'http': ''},
    )
    if not response.ok:
        raise requests.exceptions.RequestException(
            f'Endpoint returned HTTP error code {response.status_code}. '
            f'{response.text}',
            response=response,
        )
    return response.json()['exists']

get 

get(
    address: str,
    key: str,
    endpoint: UUID | str | None = None,
    session: Session | None = None,
) -> bytes | None

Get the serialized object associated with the key.

Parameters:

  • address (str) –

    Address of endpoint.

  • key (str) –

    Key associated with object to retrieve.

  • endpoint (UUID | str | None, default: None ) –

    Optional UUID of remote endpoint to forward operation to.

  • session (Session | None, default: None ) –

    Session instance to use for making the request. Reusing the same session across multiple requests to the same host can improve performance.

Returns:

  • bytes | None –

    Serialized object or None if the object does not exist.

Raises:

  • RequestException –

    If the endpoint request results in an unexpected error code.

Source code in proxystore/endpoint/client.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
def get(
    address: str,
    key: str,
    endpoint: uuid.UUID | str | None = None,
    session: requests.Session | None = None,
) -> bytes | None:
    """Get the serialized object associated with the key.

    Args:
        address: Address of endpoint.
        key: Key associated with object to retrieve.
        endpoint: Optional UUID of remote endpoint to forward operation to.
        session: Session instance to use for making the request. Reusing the
            same session across multiple requests to the same host can improve
            performance.

    Returns:
        Serialized object or `None` if the object does not exist.

    Raises:
        RequestException: If the endpoint request results in an unexpected
            error code.
    """
    endpoint_str = (
        str(endpoint) if isinstance(endpoint, uuid.UUID) else endpoint
    )
    get_ = requests.get if session is None else session.get
    response = get_(
        f'{address}/get',
        params={'key': key, 'endpoint': endpoint_str},
        proxies={'http': ''},
        stream=True,
    )

    # Status code 404 is only returned if there's no data associated with the
    # provided key.
    if response.status_code == 404:
        return None

    if not response.ok:
        raise requests.exceptions.RequestException(
            f'Endpoint returned HTTP error code {response.status_code}. '
            f'{response.text}',
            response=response,
        )

    data = bytearray()
    for chunk in response.iter_content(chunk_size=None):
        data += chunk
    return bytes(data)

put 

put(
    address: str,
    key: str,
    data: bytes,
    endpoint: UUID | str | None = None,
    session: Session | None = None,
) -> None

Put a serialized object in the store.

Parameters:

  • address (str) –

    Address of endpoint.

  • key (str) –

    Key associated with object to retrieve.

  • data (bytes) –

    Serialized data to put in the store.

  • endpoint (UUID | str | None, default: None ) –

    Optional UUID of remote endpoint to forward operation to.

  • session (Session | None, default: None ) –

    Session instance to use for making the request. Reusing the same session across multiple requests to the same host can improve performance.

Raises:

  • RequestException –

    If the endpoint request results in an unexpected error code.

Source code in proxystore/endpoint/client.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def put(
    address: str,
    key: str,
    data: bytes,
    endpoint: uuid.UUID | str | None = None,
    session: requests.Session | None = None,
) -> None:
    """Put a serialized object in the store.

    Args:
        address: Address of endpoint.
        key: Key associated with object to retrieve.
        data: Serialized data to put in the store.
        endpoint: Optional UUID of remote endpoint to forward operation to.
        session: Session instance to use for making the request. Reusing the
            same session across multiple requests to the same host can improve
            performance.

    Raises:
        RequestException: If the endpoint request results in an unexpected
            error code.
    """
    endpoint_str = (
        str(endpoint) if isinstance(endpoint, uuid.UUID) else endpoint
    )
    post = requests.post if session is None else session.post
    response = post(
        f'{address}/set',
        headers={'Content-Type': 'application/octet-stream'},
        params={'key': key, 'endpoint': endpoint_str},
        proxies={'http': ''},
        data=chunk_bytes(data, MAX_CHUNK_LENGTH),
        stream=True,
    )
    if not response.ok:
        raise requests.exceptions.RequestException(
            f'Endpoint returned HTTP error code {response.status_code}. '
            f'{response.text}',
            response=response,
        )