peeringdb

PeeringDB module.

exception spicerack.peeringdb.CacheMiss

Bases: SpicerackError

Custom exception class for cache management.

exception spicerack.peeringdb.PeeringDBError

Bases: SpicerackError

Custom exception class for errors of the PeeringDB class.

class spicerack.peeringdb.PeeringDB(*, ttl: int = 86400, cachedir: pathlib.Path | None = None, proxies: collections.abc.MutableMapping[str, str] | None = None, token: str = '')

Bases: object

Basic dumb wrapper over the PeeringDB API.

Implements the beta/v0 PeeringDB API. Tries to be smart by:

1. keeping a persistent keep-alived session for multiple requests

2. operating a local filesystem cache, if so desired.

Initiliaze the module.

Parameters:

• ttl (int, default: 86400) -- TTL for cached objects.

• cachedir (typing.Optional[pathlib.Path], default: None) -- Root path for objects caching.

• proxies (typing.Optional[collections.abc.MutableMapping[str, str]], default: None) -- Proxies for Internet access.

• token (str, default: '') -- PeeringDB read-only token.

fetch(resource: str, resource_id: int | None = None, filters: dict | None = None) → dict

Get a PeeringDB resource.

Parameters:

• resource (str) -- The PeeringDB resource requested.

• resource_id (typing.Optional[int], default: None) -- Optional resource number.

• filters (typing.Optional[dict], default: None) -- A dictionary of addtional filter parameters.

Return type:

dict

fetch_asn(asn: int) → dict

Fetch a specific asn data.

Parameters:

asn (int) -- The Autonomous system number.

Return type:

dict

baseurl: str = 'https://www.peeringdb.com/api/'

The PeeringDB base API URL.