Benjamin_Loison/waybackpy
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

lint waybackpy/cdx_api.py and added some doc strings

Browse Source
This commit is contained in:
Akash Mahanty 2022-01-22 00:11:35 +05:30
parent d13dd4db1a
commit db551abbf6
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
waybackpy/cdx_api.py
View File

@ -12,6 +12,10 @@ from .utils import DEFAULT_USER_AGENT
class WaybackMachineCDXServerAPI: class WaybackMachineCDXServerAPI:
"""
Class that interfaces the CDX server API of the Wayback Machine.
"""
def __init__( def __init__(
self, self,
url, url,
@ -45,7 +49,7 @@ class WaybackMachineCDXServerAPI:
total_pages = get_total_pages(self.url, self.user_agent) total_pages = get_total_pages(self.url, self.user_agent)
# If we only have two or less pages of archives then we care for accuracy # If we only have two or less pages of archives then we care for accuracy
# pagination API can be lagged sometimes # pagination API can be lagged sometimes
if use_page == True and total_pages >= 2: if use_page is True and total_pages >= 2:
blank_pages = 0 blank_pages = 0
for i in range(total_pages): for i in range(total_pages):
payload["page"] = str(i) payload["page"] = str(i)
@ -105,7 +109,7 @@ class WaybackMachineCDXServerAPI:
if self.end_timestamp: if self.end_timestamp:
payload["to"] = self.end_timestamp payload["to"] = self.end_timestamp
if self.gzip != True: if self.gzip is not True:
payload["gzip"] = "false" payload["gzip"] = "false"
if self.match_type: if self.match_type:
@ -165,10 +169,14 @@ class WaybackMachineCDXServerAPI:
if prop_values_len != properties_len: if prop_values_len != properties_len:
raise WaybackError( raise WaybackError(
"Snapshot returned by Cdx API has {prop_values_len} properties instead of expected {properties_len} properties.\nInvolved Snapshot : {snapshot}".format( "Snapshot returned by Cdx API has {prop_values_len} properties".format(
prop_values_len=prop_values_len, prop_values_len=prop_values_len
properties_len=properties_len, )
snapshot=snapshot, + " instead of expected {properties_len} ".format(
properties_len=properties_len
)
+ "properties.\nProblematic Snapshot : {snapshot}".format(
snapshot=snapshot
) )
) )