Skip to main content
# ubermock
Mock out calls to the python-ubersmith library


# Usage

pytest-ubersmith makes it really easy to mock out API calls:

```python
import ubersmith.client

def test_add_client(ubermock):
client_id = 1234
ubermock.client.add = client_id

assert ubersmith.client.add(login='test') == 1234
```

To have python-ubersmith raise a ResponseError, return an
`ubermock.ResponseError`:

```python
import ubersmith.client
import ubersmith.exceptions

def test_unknown_client(ubermock):
ubermock.client.get = ubermock.ResponseError('Invalid client!', 1)

with pytest.raises(ubersmith.exceptions.ResponseError):
ubersmith.client.get(client_id=1234)
```

If you need complete control over the response, you can return the whole
Ubersmith JSON response:

```python
import pytest
import ubersmith.client
import ubersmith.exceptions

def test_unknown_client_raw(ubermock):
ubermock.client.get.raw_response = {
'status': False,
'data': '',
'error_message': 'Invalid client',
'error_code': 1,
}

with pytest.raises(ubersmith.exceptions.ResponseError):
ubersmith.client.get(client_id=1234)
```

You can even pass a callable for dynamic responses:

```python
import pytest
import ubersmith.client
import ubersmith.exceptions

def test_dynamic_client(ubermock):
def get_client(method, params, request, context):
# params is a MultiDict
if params['client_id'][0] == '1':
return {'client_id': 1}
else:
raise ubermock.ResponseError('Invalid client!', 1)

ubermock.client.get.response = get_client

assert ubersmith.client.get(client_id=1) == {'client_id': 1}
with pytest.raises(ubersmith.exceptions.ResponseError):
ubersmith.client.get(client_id=2)
```

Metadata

Release history Release notifications | RSS feed

1.2.0

1 release file

1.1.0

1 release file

1.0.2

1 release file

1.0.1

1 release file

This release

1.0.0 This release

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page