# Copyright (C) 2019-2020 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information
"""Python client for the Software Heritage Web API
Light wrapper around requests for the archive API, taking care of data
conversions and pagination.
.. code-block:: python
from swh.web.client.client import WebAPIClient
cli = WebAPIClient()
# retrieve any archived object via its SWHID
cli.get('swh:1:rev:aafb16d69fd30ff58afdd69036a26047f3aebdc6')
# same, but for specific object types
cli.revision('swh:1:rev:aafb16d69fd30ff58afdd69036a26047f3aebdc6')
# get() always retrieve entire objects, following pagination
# WARNING: this might *not* be what you want for large objects
cli.get('swh:1:snp:6a3a2cf0b2b90ce7ae1cf0a221ed68035b686f5a')
# type-specific methods support explicit iteration through pages
next(cli.snapshot('swh:1:snp:cabcc7d7bf639bbe1cc3b41989e1806618dd5764'))
"""
from datetime import datetime
from typing import Any, Callable, Dict, Iterator, List, Optional, Union
from urllib.parse import urlparse
import dateutil.parser
import requests
from swh.model.hashutil import hash_to_bytes, hash_to_hex
from swh.model.identifiers import CoreSWHID, ObjectType
from swh.web.client.cli import DEFAULT_CONFIG
SWHIDish = Union[CoreSWHID, str]
CONTENT = "content"
DIRECTORY = "directory"
REVISION = "revision"
RELEASE = "release"
SNAPSHOT = "snapshot"
ORIGIN_VISIT = "origin_visit"
ORIGIN = "origin"
def _get_object_id_hex(swhidish: SWHIDish) -> str:
"""Parse string or SWHID and return the hex value of the object_id"""
if isinstance(swhidish, str):
swhid = CoreSWHID.from_string(swhidish)
else:
swhid = swhidish
return hash_to_hex(swhid.object_id)
[docs]def typify_json(data: Any, obj_type: str) -> Any:
"""Type API responses using pythonic types where appropriate
The following conversions are performed:
- identifiers are converted from strings to SWHID instances
- timestamps are converted from strings to datetime.datetime objects
"""
def to_swhid(object_type: Union[str, ObjectType], s: Any) -> CoreSWHID:
if isinstance(object_type, str):
parsed_object_type = ObjectType[object_type.upper()]
else:
parsed_object_type = object_type
return CoreSWHID(object_type=parsed_object_type, object_id=hash_to_bytes(s))
def to_date(date: str) -> datetime:
return dateutil.parser.parse(date)
def to_optional_date(date: Optional[str]) -> Optional[datetime]:
return None if date is None else to_date(date)
# The date attribute is optional for Revision and Release object
def obj_type_of_entry_type(s):
if s == "file":
return ObjectType.CONTENT
elif s == "dir":
return ObjectType.DIRECTORY
elif s == "rev":
return ObjectType.REVISION
else:
raise ValueError(f"invalid directory entry type: {s}")
if obj_type == SNAPSHOT:
for name, target in data.items():
if target["target_type"] != "alias":
# alias targets do not point to objects via SWHIDs; others do
target["target"] = to_swhid(target["target_type"], target["target"])
elif obj_type == REVISION:
data["id"] = to_swhid(obj_type, data["id"])
data["directory"] = to_swhid(DIRECTORY, data["directory"])
for key in ("date", "committer_date"):
data[key] = to_optional_date(data[key])
for parent in data["parents"]:
parent["id"] = to_swhid(REVISION, parent["id"])
elif obj_type == RELEASE:
data["id"] = to_swhid(obj_type, data["id"])
data["date"] = to_optional_date(data["date"])
data["target"] = to_swhid(data["target_type"], data["target"])
elif obj_type == DIRECTORY:
dir_swhid = None
for entry in data:
dir_swhid = dir_swhid or to_swhid(obj_type, entry["dir_id"])
entry["dir_id"] = dir_swhid
entry["target"] = to_swhid(
obj_type_of_entry_type(entry["type"]), entry["target"]
)
elif obj_type == CONTENT:
pass # nothing to do for contents
elif obj_type == ORIGIN_VISIT:
data["date"] = to_date(data["date"])
if data["snapshot"] is not None:
data["snapshot"] = to_swhid("snapshot", data["snapshot"])
else:
raise ValueError(f"invalid object type: {obj_type}")
return data
[docs]class WebAPIClient:
"""Client for the Software Heritage archive Web API, see
https://archive.softwareheritage.org/api/
"""
def __init__(
self,
api_url: str = DEFAULT_CONFIG["api_url"],
bearer_token: Optional[str] = DEFAULT_CONFIG["bearer_token"],
):
"""Create a client for the Software Heritage Web API
See: https://archive.softwareheritage.org/api/
Args:
api_url: base URL for API calls
bearer_token: optional bearer token to do authenticated API calls
"""
api_url = api_url.rstrip("/")
u = urlparse(api_url)
self.api_url = api_url
self.api_path = u.path
self.bearer_token = bearer_token
self._getters: Dict[ObjectType, Callable[[SWHIDish, bool], Any]] = {
ObjectType.CONTENT: self.content,
ObjectType.DIRECTORY: self.directory,
ObjectType.RELEASE: self.release,
ObjectType.REVISION: self.revision,
ObjectType.SNAPSHOT: self._get_snapshot,
}
def _call(
self, query: str, http_method: str = "get", **req_args
) -> requests.models.Response:
"""Dispatcher for archive API invocation
Args:
query: API method to be invoked, rooted at api_url
http_method: HTTP method to be invoked, one of: 'get', 'head'
req_args: extra keyword arguments for requests.get()/.head()
Raises:
requests.HTTPError: if HTTP request fails and http_method is 'get'
"""
url = None
if urlparse(query).scheme: # absolute URL
url = query
else: # relative URL; prepend base API URL
url = "/".join([self.api_url, query])
r = None
headers = {}
if self.bearer_token is not None:
headers = {"Authorization": f"Bearer {self.bearer_token}"}
if http_method == "get":
r = requests.get(url, **req_args, headers=headers)
r.raise_for_status()
elif http_method == "post":
r = requests.post(url, **req_args, headers=headers)
r.raise_for_status()
elif http_method == "head":
r = requests.head(url, **req_args, headers=headers)
else:
raise ValueError(f"unsupported HTTP method: {http_method}")
return r
def _get_snapshot(self, swhid: SWHIDish, typify: bool = True) -> Dict[str, Any]:
"""Analogous to self.snapshot(), but zipping through partial snapshots,
merging them together before returning
"""
snapshot = {}
for snp in self.snapshot(swhid, typify):
snapshot.update(snp)
return snapshot
[docs] def get(self, swhid: SWHIDish, typify: bool = True, **req_args) -> Any:
"""Retrieve information about an object of any kind
Dispatcher method over the more specific methods content(),
directory(), etc.
Note that this method will buffer the entire output in case of long,
iterable output (e.g., for snapshot()), see the iter() method for
streaming.
"""
if isinstance(swhid, str):
obj_type = CoreSWHID.from_string(swhid).object_type
else:
obj_type = swhid.object_type
return self._getters[obj_type](swhid, typify)
[docs] def iter(
self, swhid: SWHIDish, typify: bool = True, **req_args
) -> Iterator[Dict[str, Any]]:
"""Stream over the information about an object of any kind
Streaming variant of get()
"""
if isinstance(swhid, str):
obj_type = CoreSWHID.from_string(swhid).object_type
else:
obj_type = swhid.object_type
if obj_type == SNAPSHOT:
yield from self.snapshot(swhid, typify)
elif obj_type == REVISION:
yield from [self.revision(swhid, typify)]
elif obj_type == RELEASE:
yield from [self.release(swhid, typify)]
elif obj_type == DIRECTORY:
yield from self.directory(swhid, typify)
elif obj_type == CONTENT:
yield from [self.content(swhid, typify)]
else:
raise ValueError(f"invalid object type: {obj_type}")
[docs] def content(
self, swhid: SWHIDish, typify: bool = True, **req_args
) -> Dict[str, Any]:
"""Retrieve information about a content object
Args:
swhid: object persistent identifier
typify: if True, convert return value to pythonic types wherever
possible, otherwise return raw JSON types (default: True)
req_args: extra keyword arguments for requests.get()
Raises:
requests.HTTPError: if HTTP request fails
"""
json = self._call(
f"content/sha1_git:{_get_object_id_hex(swhid)}/", **req_args
).json()
return typify_json(json, CONTENT) if typify else json
[docs] def directory(
self, swhid: SWHIDish, typify: bool = True, **req_args
) -> List[Dict[str, Any]]:
"""Retrieve information about a directory object
Args:
swhid: object persistent identifier
typify: if True, convert return value to pythonic types wherever
possible, otherwise return raw JSON types (default: True)
req_args: extra keyword arguments for requests.get()
Raises:
requests.HTTPError: if HTTP request fails
"""
json = self._call(f"directory/{_get_object_id_hex(swhid)}/", **req_args).json()
return typify_json(json, DIRECTORY) if typify else json
[docs] def revision(
self, swhid: SWHIDish, typify: bool = True, **req_args
) -> Dict[str, Any]:
"""Retrieve information about a revision object
Args:
swhid: object persistent identifier
typify: if True, convert return value to pythonic types wherever
possible, otherwise return raw JSON types (default: True)
req_args: extra keyword arguments for requests.get()
Raises:
requests.HTTPError: if HTTP request fails
"""
json = self._call(f"revision/{_get_object_id_hex(swhid)}/", **req_args).json()
return typify_json(json, REVISION) if typify else json
[docs] def release(
self, swhid: SWHIDish, typify: bool = True, **req_args
) -> Dict[str, Any]:
"""Retrieve information about a release object
Args:
swhid: object persistent identifier
typify: if True, convert return value to pythonic types wherever
possible, otherwise return raw JSON types (default: True)
req_args: extra keyword arguments for requests.get()
Raises:
requests.HTTPError: if HTTP request fails
"""
json = self._call(f"release/{_get_object_id_hex(swhid)}/", **req_args).json()
return typify_json(json, RELEASE) if typify else json
[docs] def snapshot(
self, swhid: SWHIDish, typify: bool = True, **req_args
) -> Iterator[Dict[str, Any]]:
"""Retrieve information about a snapshot object
Args:
swhid: object persistent identifier
typify: if True, convert return value to pythonic types wherever
possible, otherwise return raw JSON types (default: True)
req_args: extra keyword arguments for requests.get()
Returns:
an iterator over partial snapshots (dictionaries mapping branch
names to information about where they point to), each containing a
subset of available branches
Raises:
requests.HTTPError: if HTTP request fails
"""
done = False
r = None
query = f"snapshot/{_get_object_id_hex(swhid)}/"
while not done:
r = self._call(query, http_method="get", **req_args)
json = r.json()["branches"]
yield typify_json(json, SNAPSHOT) if typify else json
if "next" in r.links and "url" in r.links["next"]:
query = r.links["next"]["url"]
else:
done = True
[docs] def visits(
self,
origin: str,
per_page: Optional[int] = None,
last_visit: Optional[int] = None,
typify: bool = True,
**req_args,
) -> Iterator[Dict[str, Any]]:
"""List visits of an origin
Args:
origin: the URL of a software origin
per_page: the number of visits to list
last_visit: visit to start listing from
typify: if True, convert return value to pythonic types wherever
possible, otherwise return raw JSON types (default: True)
req_args: extra keyword arguments for requests.get()
Returns:
an iterator over visits of the origin
Raises:
requests.HTTPError: if HTTP request fails
"""
done = False
r = None
params = []
if last_visit is not None:
params.append(("last_visit", last_visit))
if per_page is not None:
params.append(("per_page", per_page))
query = f"origin/{origin}/visits/"
while not done:
r = self._call(query, http_method="get", params=params, **req_args)
yield from [typify_json(v, ORIGIN_VISIT) if typify else v for v in r.json()]
if "next" in r.links and "url" in r.links["next"]:
params = []
query = r.links["next"]["url"]
else:
done = True
[docs] def last_visit(self, origin: str, typify: bool = True) -> Dict[str, Any]:
"""Return the last visit of an origin.
Args:
origin: the URL of a software origin
typify: if True, convert return value to pythonic types wherever
possible, otherwise return raw JSON types (default: True)
Returns:
The last visit for that origin
Raises:
requests.HTTPError: if HTTP request fails
"""
query = f"origin/{origin}/visit/latest/"
r = self._call(query, http_method="get")
visit = r.json()
return typify_json(visit, ORIGIN_VISIT) if typify else visit
[docs] def known(
self, swhids: Iterator[SWHIDish], **req_args
) -> Dict[CoreSWHID, Dict[Any, Any]]:
"""Verify the presence in the archive of several objects at once
Args:
swhids: SWHIDs of the objects to verify
Returns:
a dictionary mapping object SWHIDs to archive information about them; the
dictionary includes a "known" key associated to a boolean value that is true
if and only if the object is known to the archive
Raises:
requests.HTTPError: if HTTP request fails
"""
r = self._call(
"known/", http_method="post", json=list(map(str, swhids)), **req_args
)
return {CoreSWHID.from_string(k): v for k, v in r.json().items()}
[docs] def content_exists(self, swhid: SWHIDish, **req_args) -> bool:
"""Check if a content object exists in the archive
Args:
swhid: object persistent identifier
req_args: extra keyword arguments for requests.head()
Raises:
requests.HTTPError: if HTTP request fails
"""
return bool(
self._call(
f"content/sha1_git:{_get_object_id_hex(swhid)}/",
http_method="head",
**req_args,
)
)
[docs] def directory_exists(self, swhid: SWHIDish, **req_args) -> bool:
"""Check if a directory object exists in the archive
Args:
swhid: object persistent identifier
req_args: extra keyword arguments for requests.head()
Raises:
requests.HTTPError: if HTTP request fails
"""
return bool(
self._call(
f"directory/{_get_object_id_hex(swhid)}/",
http_method="head",
**req_args,
)
)
[docs] def revision_exists(self, swhid: SWHIDish, **req_args) -> bool:
"""Check if a revision object exists in the archive
Args:
swhid: object persistent identifier
req_args: extra keyword arguments for requests.head()
Raises:
requests.HTTPError: if HTTP request fails
"""
return bool(
self._call(
f"revision/{_get_object_id_hex(swhid)}/",
http_method="head",
**req_args,
)
)
[docs] def release_exists(self, swhid: SWHIDish, **req_args) -> bool:
"""Check if a release object exists in the archive
Args:
swhid: object persistent identifier
req_args: extra keyword arguments for requests.head()
Raises:
requests.HTTPError: if HTTP request fails
"""
return bool(
self._call(
f"release/{_get_object_id_hex(swhid)}/", http_method="head", **req_args,
)
)
[docs] def snapshot_exists(self, swhid: SWHIDish, **req_args) -> bool:
"""Check if a snapshot object exists in the archive
Args:
swhid: object persistent identifier
req_args: extra keyword arguments for requests.head()
Raises:
requests.HTTPError: if HTTP request fails
"""
return bool(
self._call(
f"snapshot/{_get_object_id_hex(swhid)}/",
http_method="head",
**req_args,
)
)
[docs] def origin_exists(self, origin: str, **req_args) -> bool:
"""Check if an origin object exists in the archive
Args:
origin: the URL of a software origin
req_args: extra keyword arguments for requests.head()
Raises:
requests.HTTPError: if HTTP request fails
"""
return bool(
self._call(f"origin/{origin}/get/", http_method="head", **req_args,)
)
[docs] def content_raw(self, swhid: SWHIDish, **req_args) -> Iterator[bytes]:
"""Iterate over the raw content of a content object
Args:
swhid: object persistent identifier
req_args: extra keyword arguments for requests.get()
Raises:
requests.HTTPError: if HTTP request fails
"""
r = self._call(
f"content/sha1_git:{_get_object_id_hex(swhid)}/raw/",
stream=True,
**req_args,
)
r.raise_for_status()
yield from r.iter_content(chunk_size=None, decode_unicode=False)
[docs] def origin_search(
self,
query: str,
limit: Optional[int] = None,
with_visit: bool = False,
**req_args,
) -> Iterator[Dict[str, Any]]:
"""List origin search results
Args:
query: search keywords
limit: the maximum number of found origins to return
with_visit: if true, only return origins with at least one visit
Returns:
an iterator over search results
Raises:
requests.HTTPError: if HTTP request fails
"""
params = []
if limit is not None:
params.append(("limit", limit))
if with_visit:
params.append(("with_visit", True))
done = False
nb_returned = 0
q = f"origin/search/{query}/"
while not done:
r = self._call(q, params=params, **req_args)
json = r.json()
if limit and nb_returned + len(json) > limit:
json = json[: limit - nb_returned]
nb_returned += len(json)
yield from json
if limit and nb_returned == limit:
done = True
if "next" in r.links and "url" in r.links["next"]:
params = []
q = r.links["next"]["url"]
else:
done = True
[docs] def origin_save(self, visit_type: str, origin: str) -> Dict:
"""Save code now query for the origin with visit_type.
Args:
visit_type: Type of the visit
origin: the origin to save
Returns:
The resulting dict of the visit saved
Raises:
requests.HTTPError: if HTTP request fails
"""
q = f"origin/save/{visit_type}/url/{origin}/"
r = self._call(q, http_method="post")
return r.json()