lordwelch/comictagger
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix tests

Browse Source
This commit is contained in:
Timmy Welch 2022-12-22 10:16:32 -08:00
parent 1d9840913a
commit 521d5634f3
No known key found for this signature in database
4 changed files with 36 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
comictalker/resulttypes.py
View File

@ -16,7 +16,7 @@ class ComicSeries(TypedDict, total=False):
image_url: str
name: Required[str]
publisher: str
start_year: int
start_year: int | None
class ComicIssue(TypedDict, total=False):

50
comictalker/talkers/comicvine.py
View File

@ -67,13 +67,6 @@ class CVPublisher(TypedDict, total=False):
name: Required[str]
class CVVolume(TypedDict):
api_detail_url: str
id: int
name: str
site_detail_url: str
class CVCredits(TypedDict):
api_detail_url: str
id: int
@ -89,7 +82,9 @@ class CVPersonCredits(TypedDict):
role: str
class CVVolumeResults(TypedDict):
class CVVolume(TypedDict):
api_detail_url: str
site_detail_url: str
aliases: str
count_of_issues: int
description: str
@ -108,7 +103,7 @@ class CVResult(TypedDict):
number_of_page_results: int
number_of_total_results: int
status_code: int
results: (CVIssueDetailResults | CVVolumeResults | list[CVVolumeResults] | list[CVIssueDetailResults])
results: (CVIssueDetailResults | CVVolume | list[CVVolume] | list[CVIssueDetailResults])
version: str
@ -284,7 +279,7 @@ class ComicVineTalker(ComicTalker):
raise TalkerNetworkError(self.source_name_friendly, 5)
def format_search_results(self, search_results: list[CVVolumeResults]) -> list[ComicSeries]:
def format_search_results(self, search_results: list[CVVolume]) -> list[ComicSeries]:
formatted_results = []
for record in search_results:
# Flatten publisher to name only
@ -298,14 +293,13 @@ class ComicVineTalker(ComicTalker):
else:
image_url = record["image"].get("super_url", "")
if record.get("start_year") is None:
start_year = 0
else:
start_year = utils.xlate(record["start_year"], True)
start_year = utils.xlate(record.get("start_year", ""), True)
aliases = record.get("aliases") or ""
formatted_results.append(
ComicSeries(
aliases=record["aliases"].split("\n") if record["aliases"] else [], # CV returns a null because...?
aliases=aliases.splitlines(),
count_of_issues=record.get("count_of_issues", 0),
description=record.get("description", ""),
id=record["id"],
@ -371,7 +365,7 @@ class ComicVineTalker(ComicTalker):
issue_number=record["issue_number"],
name=record["name"],
site_detail_url=record.get("site_detail_url", ""),
series=cast(ComicSeries, record["volume"]),
series=self.format_search_results([record["volume"]])[0],
alt_image_urls=alt_images_list,
characters=character_list,
locations=location_list,
@ -416,7 +410,7 @@ class ComicVineTalker(ComicTalker):
cv_response = self.get_cv_content(urljoin(self.api_url, "search"), params)
search_results: list[CVVolumeResults] = []
search_results: list[CVVolume] = []
# see http://api.comicvine.com/documentation/#handling_responses
@ -436,7 +430,7 @@ class ComicVineTalker(ComicTalker):
logger.debug(
f"Found {cv_response['number_of_page_results']} of {cv_response['number_of_total_results']} results"
)
search_results.extend(cast(list[CVVolumeResults], cv_response["results"]))
search_results.extend(cast(list[CVVolume], cv_response["results"]))
page = 1
if callback is not None:
@ -449,7 +443,7 @@ class ComicVineTalker(ComicTalker):
# Stop searching once any entry falls below the threshold
stop_searching = any(
not utils.titles_match(search_series_name, series["name"], self.series_match_thresh)
for series in cast(list[CVVolumeResults], cv_response["results"])
for series in cast(list[CVVolume], cv_response["results"])
)
if stop_searching:
@ -462,7 +456,7 @@ class ComicVineTalker(ComicTalker):
params["page"] = page
cv_response = self.get_cv_content(urljoin(self.api_url, "search"), params)
search_results.extend(cast(list[CVVolumeResults], cv_response["results"]))
search_results.extend(cast(list[CVVolume], cv_response["results"]))
current_result_count += cv_response["number_of_page_results"]
if callback is not None:
@ -487,7 +481,7 @@ class ComicVineTalker(ComicTalker):
return comic_data
def fetch_partial_series_data(self, series_id: int) -> ComicSeries:
def fetch_series_data(self, series_id: int) -> ComicSeries:
# before we search online, look in our cache, since we might already have this info
cvc = ComicCacher(self.cache_folder, self.version)
cached_series_result = cvc.get_series_info(series_id, self.source_name)
@ -500,11 +494,10 @@ class ComicVineTalker(ComicTalker):
params = {
"api_key": self.api_key,
"format": "json",
"field_list": "name,id,start_year,publisher,count_of_issues,aliases",
}
cv_response = self.get_cv_content(series_url, params)
series_results = cast(CVVolumeResults, cv_response["results"])
series_results = cast(CVVolume, cv_response["results"])
formatted_series_results = self.format_search_results([series_results])
if series_results:
@ -517,7 +510,7 @@ class ComicVineTalker(ComicTalker):
cvc = ComicCacher(self.cache_folder, self.version)
cached_series_issues_result = cvc.get_series_issues_info(series_id, self.source_name)
series_data = self.fetch_partial_series_data(series_id)
series_data = self.fetch_series_data(series_id)
if len(cached_series_issues_result) == series_data["count_of_issues"]:
return cached_series_issues_result
@ -644,13 +637,16 @@ class ComicVineTalker(ComicTalker):
issue_results = cast(CVIssueDetailResults, cv_response["results"])
# Format to expected output
formatted_issues_result = self.format_issue_results([issue_results], True)
cv_issues = self.format_issue_results([issue_results], True)
cvc.add_series_issues_info(self.source_name, formatted_issues_result)
# Due to issue/ not returning volume publisher, get it.
cv_issues[0]["series"] = self.fetch_series_data(cv_issues[0]["series"]["id"])
cvc.add_series_issues_info(self.source_name, cv_issues)
# Now, map the ComicIssue data to generic metadata
return talker_utils.map_comic_issue_to_metadata(
formatted_issues_result[0],
cv_issues[0],
self.source_name_friendly,
self.remove_html_tables,
self.use_series_start_as_volume,

14
testing/comicvine.py
View File

@ -23,7 +23,7 @@ cv_issue_result: dict[str, Any] = {
"number_of_total_results": 1,
"status_code": 1,
"results": {
"aliases": [],
"aliases": None,
"api_detail_url": "https://comicvine.gamespot.com/api/issue/4000-140529/",
"associated_images": [],
"character_credits": [],
@ -118,7 +118,7 @@ cv_volume_result: dict[str, Any] = {
"number_of_total_results": 1,
"status_code": 1,
"results": {
"aliases": [],
"aliases": None,
"api_detail_url": "https://comicvine.gamespot.com/api/volume/4050-23437/",
"count_of_issues": 6,
"date_added": "2008-10-16 05:25:47",
@ -159,7 +159,7 @@ cv_not_found = {
"results": [],
}
comic_issue_result = ComicIssue(
aliases=cv_issue_result["results"]["aliases"],
aliases=cv_issue_result["results"]["aliases"] or [],
cover_date=cv_issue_result["results"]["cover_date"],
description=cv_issue_result["results"]["description"],
id=cv_issue_result["results"]["id"],
@ -169,10 +169,14 @@ comic_issue_result = ComicIssue(
name=cv_issue_result["results"]["name"],
site_detail_url=cv_issue_result["results"]["site_detail_url"],
series=ComicSeries(
# api_detail_url=cv_issue_result["results"]["volume"]["api_detail_url"],
id=cv_issue_result["results"]["volume"]["id"],
name=cv_issue_result["results"]["volume"]["name"],
# site_detail_url=cv_issue_result["results"]["volume"]["site_detail_url"],
aliases=[],
count_of_issues=0,
description="",
image_url="",
publisher="",
start_year=None,
),
characters=[],
alt_image_urls=[],

18
tests/comicvinetalker_test.py
View File

@ -15,7 +15,7 @@ def test_search_for_series(comicvine_api, comic_cache):
def test_fetch_series_data(comicvine_api, comic_cache):
result = comicvine_api.fetch_partial_series_data(23437)
result = comicvine_api.fetch_series_data(23437)
del result["description"]
del result["image_url"]
cache_result = comic_cache.get_series_info(23437, comicvine_api.source_name)
@ -52,21 +52,9 @@ def test_fetch_issue_data_by_issue_id(comicvine_api):
def test_fetch_issues_by_series_issue_num_and_year(comicvine_api):
results = comicvine_api.fetch_issues_by_series_issue_num_and_year([23437], "1", None)
cv_expected = testing.comicvine.comic_issue_result.copy()
testing.comicvine.filter_field_list(
cv_expected,
{"params": {"field_list": "id,volume,issue_number,name,image,cover_date,site_detail_url,description,aliases"}},
)
for r, e in zip(results, [cv_expected]):
del r["image_thumb_url"]
del r["image_url"]
del r["alt_image_urls"]
del r["characters"]
del r["credits"]
del r["locations"]
del r["story_arcs"]
del r["teams"]
del r["complete"]
del r["volume"]["publisher"]
assert r["series"] == e["series"]
assert r == e