6 Commits

Author SHA1 Message Date
Richard Kubíček
4c0d03fa79 Revert "test_superfaktura_api: add type ignore for pytest"
This reverts commit d0147a0451.
2025-03-21 19:22:00 +01:00
Richard Kubíček
ff079440ac requirements_dev: specify package versions 2025-03-21 15:46:12 +01:00
Richard Kubíček
284edd3a45 ga: add mypy to requirements_dev 2025-03-21 15:41:24 +01:00
Richard Kubíček
e84426e49c ga: add mypy workflow 2025-03-13 13:42:10 +01:00
Richard Kubíček
d0147a0451 test_superfaktura_api: add type ignore for pytest 2025-03-13 13:40:12 +01:00
Richard Kubíček
11e14a8924 docs_conf: ignore by type 2025-03-13 13:40:12 +01:00
5 changed files with 37 additions and 95 deletions

24
.github/workflows/mypy.yml vendored Normal file
View File

@@ -0,0 +1,24 @@
name: MyPy Type Checking
on: [push]
jobs:
type-check:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements_dev.txt
- name: Run MyPy
run: mypy .

View File

@@ -1,3 +1,4 @@
# type: ignore
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:

View File

@@ -1,4 +1,7 @@
requests~=2.32.3
python-dotenv~=1.0.1
pytest~=8.3.5
pytest-cov
pytest-cov~=6.0.0
mypy~=1.9.0
types-requests~=2.31
types-setuptools~=68.2

View File

@@ -1,69 +0,0 @@
import os
import pytest # type: ignore
from unittest.mock import patch
from superfaktura.client_contacts import (
ClientContactModel,
ClientContact,
ClientException,
)
"""
Tests for the ClientContact class from the superfaktura package.
These tests validate the functionality of methods for managing client contacts
through the SuperFaktura API.
"""
@pytest.fixture
def client_contact():
with patch.dict(
os.environ,
{
"SUPERFAKTURA_API_KEY": "test_key",
"SUPERFAKTURA_API_URL": "https://api.superfaktura.cz",
"SUPERFAKTURA_API_EMAIL": "test_email",
"SUPERFAKTURA_API_COMPANY_ID": "test_company_id",
},
):
return ClientContact()
def test_add_contact_success(client_contact):
client = ClientContactModel(
name="John Doe",
)
with patch("superfaktura.superfaktura_api.SuperFakturaAPI.post") as mock_post:
mock_post.return_value = {"error_message": "Client created"}
assert client_contact.add_contact(contact=client)
def test_add_contact_failed(client_contact):
client = ClientContactModel(
name="John Doe",
)
with patch("superfaktura.superfaktura_api.SuperFakturaAPI.post") as mock_post:
mock_post.return_value = {"error_message": "Client creation failed"}
assert not client_contact.add_contact(contact=client)
def test_list(client_contact):
with patch("superfaktura.superfaktura_api.SuperFakturaAPI.get") as mock_get:
mock_get.return_value = {"data": "test"}
assert client_contact.list() == {"data": "test"}
def test_get_client_exists(client_contact):
with patch("superfaktura.superfaktura_api.SuperFakturaAPI.get") as mock_get:
mock_get.return_value = {"Client": {"name": "John Doe", "id": 1}}
assert client_contact.get_client(client_id=1).name == "John Doe"
def test_get_client_not_exists(client_contact):
with patch("superfaktura.superfaktura_api.SuperFakturaAPI.get") as mock_get:
mock_get.return_value = {}
with pytest.raises(ClientException):
client_contact.get_client(client_id=1)

View File

@@ -10,27 +10,21 @@ from superfaktura.superfaktura_api import (
SuperFakturaAPIMissingCredentialsException,
)
@pytest.fixture
def api():
with patch.dict(
os.environ,
{
with patch.dict(os.environ, {
"SUPERFAKTURA_API_KEY": "test_key",
"SUPERFAKTURA_API_URL": "https://api.superfaktura.cz",
"SUPERFAKTURA_API_EMAIL": "test_email",
"SUPERFAKTURA_API_COMPANY_ID": "test_company_id",
},
):
"SUPERFAKTURA_API_COMPANY_ID": "test_company_id"
}):
return SuperFakturaAPI()
def test_missing_credentials():
with patch.dict(os.environ, {}, clear=True):
with pytest.raises(SuperFakturaAPIMissingCredentialsException):
SuperFakturaAPI()
def test_get(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 200
@@ -38,14 +32,12 @@ def test_get(api):
response = api.get("test_endpoint")
assert response == {"data": "test"}
def test_get_failure(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 404
with pytest.raises(SuperFakturaAPIException):
api.get("test_endpoint")
def test_download(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 200
@@ -55,7 +47,6 @@ def test_download(api):
api.download("test_endpoint", f)
mock_file().write.assert_called_once_with(b"test_content")
def test_download_failure(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 404
@@ -64,7 +55,6 @@ def test_download_failure(api):
with pytest.raises(SuperFakturaAPIException):
api.download("test_endpoint", f)
def test_post(api):
with patch("requests.post") as mock_post:
mock_post.return_value.status_code = 200
@@ -72,7 +62,6 @@ def test_post(api):
response = api.post("test_endpoint", '{"name": "Example"}')
assert response == {"data": "test"}
def test_post_failure(api):
with patch("requests.post") as mock_post:
mock_post.return_value.status_code = 404
@@ -80,21 +69,15 @@ def test_post_failure(api):
with pytest.raises(SuperFakturaAPIException):
api.post("test_endpoint", '{"name": "Example"}')
def test_get_invalid_json(api):
with patch("requests.get") as mock_get:
mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.side_effect = requests.exceptions.JSONDecodeError(
"msg", "doc", 0
)
mock_response.json.side_effect = requests.exceptions.JSONDecodeError("msg", "doc", 0)
mock_get.return_value = mock_response
with pytest.raises(
SuperFakturaAPIException, match="Unable to decode response as JSON"
):
with pytest.raises(SuperFakturaAPIException, match="Unable to decode response as JSON"):
api.get("test_endpoint")
def test_download_not_writable_descriptor(api):
with patch("requests.get") as mock_get:
mock_get.return_value.status_code = 200