apeye¶

Handy tools for working with URLs and APIs.

Docs
Tests
PyPI
Anaconda
Activity
QA
Other

Overview¶

apeye provides:

apeye.url: pathlib.Path-like objects to represent URLs
Cache: A JSON-backed cache decorator for functions
RateLimitAdapter: A CacheControl adapter to limit the rate of requests

Installation¶

python3 -m pip install apeye --user

First add the required channels

conda config --add channels https://conda.anaconda.org/conda-forge
conda config --add channels https://conda.anaconda.org/domdfcoding

Then install

conda install apeye

python3 -m pip install git+https://github.com/domdfcoding/apeye@master --user

Attention

In v0.9.0 and above the rate_limiter module requires the limiter extra to be installed:

python -m pip install apeye[limiter]

API Reference¶

`apeye.url`¶

Source code: apeye_core/__init__.py

pathlib-like approach to URLs.

Changed in version 0.2.0: SlumberURL and RequestsURL moved to apeye.slumber_url and apeye.requests_url respectively.

Note

The classes in this module can instead be imported from the apeye_core module instead.

Classes:

`Domain`(subdomain, domain, suffix)	`typing.NamedTuple` of a URL’s subdomain, domain, and suffix.
`URL`([url])	`pathlib`-like class for URLs.
`URLPath`(*args)	Represents the path part of a URL.

Data:

`URLPathType`	Invariant `TypeVar` bound to `apeye.url.URLPath`.
`URLType`	Invariant `TypeVar` bound to `apeye.url.URL`.

URLType = TypeVar(URLType, bound=URL)¶

Type: TypeVar

Invariant TypeVar bound to apeye.url.URL.

URLPathType = TypeVar(URLPathType, bound=URLPath)¶

Type: TypeVar

Invariant TypeVar bound to apeye.url.URLPath.

class URL(url='')[source]¶

Bases: PathLike

pathlib-like class for URLs.

Parameters: url (Union[str, URL]) – The URL to construct the URL object from. Default ''.

Changed in version 0.3.0: The url parameter can now be a string or a URL.

Changed in version 1.1.0: Added support for sorting and rich comparisons (<, <=, > and >=).

Methods:

`__eq__`(other)	Return `self == other`.
`__fspath__`()	Returns the file system path representation of the `URL`.
`__repr__`()	Returns the string representation of the `URL`.
`__str__`()	Returns the `URL` as a string.
`__truediv__`(key)	Construct a new `URL` object for the given child of this `URL`.
`from_parts`(scheme, netloc, path[, query, …])	Construct a `URL` from a scheme, netloc and path.
`joinurl`(*args)	Construct a new `URL` object by combining the given arguments with this instance’s path part.
`relative_to`(other)	Returns a version of this URL’s path relative to `other`.
`strict_compare`(other)	Return `self ≡ other`, comparing the scheme, netloc, path, fragment and query parameters.
`with_name`(name[, inherit])	Return a new `URL` with the file name changed.
`with_suffix`(suffix[, inherit])	Returns a new `URL` with the file suffix changed.

Attributes:

`base_url`	Returns a `apeye.url.URL` object representing the URL without query strings or URL fragments.
`domain`	Returns a `apeye.url.Domain` object representing the domain part of the URL.
`fqdn`	Returns the Fully Qualified Domain Name of the `URL` .
`fragment`	The URL fragment, used to identify a part of the document.
`name`	The final path component, if any.
`netloc`	Network location part of the URL
`parent`	The logical parent of the `URL`.
`parents`	An immutable sequence providing access to the logical ancestors of the `URL`.
`parts`	An object providing sequence-like access to the components in the URL.
`path`	The hierarchical path of the URL
`port`	The port of number of the URL as an integer, if present.
`query`	The query parameters of the URL, if present.
`scheme`	URL scheme specifier
`stem`	The final path component, minus its last suffix.
`suffix`	The final component’s last suffix, if any.
`suffixes`	A list of the final component’s suffixes, if any.

__class_getitem__ = <bound method GenericAlias of <class 'apeye.url.URL'>>¶: Type: MethodType

__eq__(other)[source]¶

Return self == other.

Attention

URL fragments and query parameters are not compared.

`apeye.requests_url`¶

Extension of URL with support for interacting with the website using the Requests library.

New in version 0.2.0.

Classes:

`RequestsURL`([url])	Extension of `URL` with support for interacting with the website using the Requests library.
`TrailingRequestsURL`([url])	Extension of `RequestsURL` which adds a trailing slash to the end of the URL.

Data:

`_R`	Invariant `TypeVar` bound to `apeye.requests_url.RequestsURL`.

class RequestsURL(url='')[source]¶

Bases: URL

Extension of URL with support for interacting with the website using the Requests library.

The requests.Session used for this object – and all objects created using the / or .parent operations – can be accessed using the session attribute. If desired, this can be replaced with a different session object, such as one using caching.

Parameters: url (Union[str, URL]) – The url to construct the URL object from. Default ''.

Changed in version 0.3.0: The url parameter can now be a string or a URL.

Changed in version 1.1.0: When a RequestsURL object is deleted or garbage collected, the underlying requests.Session object it only closed if no objects hold references to the session. This prevents the session object of a global object from being inadvertently closed when one of its children is garbage collected.

Methods:

`__del__`()	Attempt to close session when garbage collected to avoid leaving connections open.
`delete`(**kwargs)	Send a DELETE request using Requests.
`get`([params])	Perform a GET request using Requests.
`head`(**kwargs)	Send a HEAD request using Requests.
`options`(**kwargs)	Send an OPTIONS request using Requests.
`patch`([data, json])	Send a PATCH request using Requests.
`post`([data, json])	Send a POST request using Requests.
`put`([data, json])	Send a PUT request using Requests.
`resolve`([timeout])	Resolves the URL into its canonical form.

Attributes:

session

The underlying requests session.

__del__()[source]¶: Attempt to close session when garbage collected to avoid leaving connections open.

delete(**kwargs)[source]¶

Send a DELETE request using Requests.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE

Parameters: **kwargs – Optional arguments that requests.request() takes.
Return type: Response

get(params=None, **kwargs)[source]¶

Perform a GET request using Requests.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET

Parameters

params (Union[Mapping[Union[str, bytes, int, float], Union[str, bytes, int, float, Iterable[Union[str, bytes, int, float]]]], str, bytes, Tuple[Union[str, bytes, int, float], Union[str, bytes, int, float, Iterable[Union[str, bytes, int, float]]]], None]) – Dictionary, list of tuples or bytes to send in the query string for the requests.Request. Default None.
**kwargs – Optional arguments that requests.request() takes.

Changed in version 0.7.0: If params is None but the URL has a query string, the query string will be parsed and used for params.

Return type: Response

head(**kwargs)[source]¶

Send a HEAD request using Requests.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD

Parameters: **kwargs – Optional arguments that requests.request() takes. If allow_redirects is not provided, it will be set to False (as opposed to the default requests.request() behavior).
Return type: Response

options(**kwargs)[source]¶

Send an OPTIONS request using Requests.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS

Parameters: **kwargs – Optional arguments that requests.request() takes.
Return type: Response

patch(data=None, json=None, **kwargs)[source]¶

Send a PATCH request using Requests.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH

Parameters

data (Union[None, str, bytes, MutableMapping[str, Any], List[Tuple[str, Optional[str]]], Tuple[Tuple[str, Optional[str]]], IO]) – Dictionary, list of tuples, bytes, or file-like object to send in the body of the requests.Request. Default None.
json – json data to send in the body of the requests.Request. Default None.
**kwargs – Optional arguments that requests.request() takes.

Return type

Response

post(data=None, json=None, **kwargs)[source]¶

Send a POST request using Requests.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST

Parameters

data (Union[None, str, bytes, MutableMapping[str, Any], List[Tuple[str, Optional[str]]], Tuple[Tuple[str, Optional[str]]], IO]) – Dictionary, list of tuples, bytes, or file-like object to send in the body of the requests.Request. Default None.
json – json data to send in the body of the requests.Request. Default None.
**kwargs – Optional arguments that requests.request() takes.

Return type

Response

put(data=None, json=None, **kwargs)[source]¶

Send a PUT request using Requests.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT

Parameters

data (Union[None, str, bytes, MutableMapping[str, Any], List[Tuple[str, Optional[str]]], Tuple[Tuple[str, Optional[str]]], IO]) – Dictionary, list of tuples, bytes, or file-like object to send in the body of the requests.Request. Default None.
json – json data to send in the body of the requests.Request. Default None.
**kwargs – Optional arguments that requests.request() takes.

Return type

Response

resolve(timeout=None)[source]¶

Resolves the URL into its canonical form.

This is done by making a HEAD request and following HTTP 302 redirects.

New in version 0.8.0.

Changed in version 1.1.0: Added the timeout argument.

Return type: ~_R

session¶

Type: Session

The underlying requests session.

class TrailingRequestsURL(url='')[source]¶

Bases: RequestsURL

Extension of RequestsURL which adds a trailing slash to the end of the URL.

New in version 0.5.0.

Parameters: url (Union[str, URL]) – The url to construct the URL object from. Default ''.

__str__()[source]¶

Returns the TrailingRequestsURL as a string.

Return type: str

_R = TypeVar(_R, bound=RequestsURL)¶

Type: TypeVar

Invariant TypeVar bound to apeye.requests_url.RequestsURL.

`apeye.slumber_url`¶

Subclass of URL with support for interacting with REST APIs with Slumber and Requests.

New in version 0.2.0.

Classes:

SlumberURL([url, auth, format, …])

Subclass of URL with support for interacting with REST APIs with Slumber and Requests.

class SlumberURL(url='', auth=None, format='json', append_slash=True, session=None, serializer=None, *, timeout=None, allow_redirects=True, proxies=None, verify=None, cert=None)[source]¶

Bases: URL

Subclass of URL with support for interacting with REST APIs with Slumber and Requests.

Parameters

url (Union[str, URL]) – The url to construct the SlumberURL object from. Default ''.
auth (Union[None, Tuple[str, str], AuthBase, Callable[[PreparedRequest], PreparedRequest]]) – Default None.
format (str) – Default 'json'.
append_slash (bool) – Default True.
session – Default None.
serializer (Optional[SerializerRegistry]) – Default None.
timeout (Union[None, float, Tuple[float, float], Tuple[float, None]]) – How long to wait for the server to send data before giving up. Default None.
allow_redirects (Optional[bool]) – Whether to allow redirects. Default True.
proxies (Optional[MutableMapping[str, str]]) – Dictionary mapping protocol or protocol and hostname to the URL of the proxy. Default None.
verify (Union[None, bool, str]) – Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Default None.
cert (Union[str, Tuple[str, str], None]) – Either the path to the SSL client cert file (.pem), or a tuple of ('cert', 'key'). Default None.

timeout, allow_redirects, proxies, verify and cert are passed to Requests when making any HTTP requests, and are inherited by all children created from this URL.

Changed in version 0.3.0: The url parameter can now be a string or a URL.

Changed in version 1.1.0: When a RequestsURL object is deleted or garbage collected, the underlying requests.Session object it only closed if no objects hold references to the session. This prevents the session object of a global object from being inadvertently closed when one of its children is garbage collected.

Methods:

`__del__`()	Attempt to close session when garbage collected to avoid leaving connections open.
`delete`(**params)	Perform a DELETE request using Slumber.
`get`(**params)	Perform a GET request using Slumber.
`head`(**kwargs)	Send a HEAD request using Requests.
`options`(**kwargs)	Send an OPTIONS request using Requests.
`patch`([data, files])	Perform a PATCH request using Slumber.
`post`([data, files])	Perform a POST request using Slumber.
`put`([data, files])	Perform a PUT request using Slumber.
`url`()	Returns the URL as a string.

Attributes:

`allow_redirects`	Whether to allow redirects.
`cert`	The path to ssl client cert file or a tuple of `('cert', 'key')`.
`proxies`	Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
`serializer`	The serializer used to (de)serialize the data when interacting with the API.
`session`	The underlying requests session.
`timeout`	How long to wait for the server to send data before giving up.
`verify`	Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use.

__del__()[source]¶: Attempt to close session when garbage collected to avoid leaving connections open.

allow_redirects¶

Type: Optional[bool]

Whether to allow redirects.

cert¶

Type: Union[str, Tuple[str, str], None]

The path to ssl client cert file or a tuple of ('cert', 'key').

delete(**params)[source]¶

Perform a DELETE request using Slumber.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE

Parameters: params – Parameters to send in the query string of the requests.Request.
Return type: bool
Returns: True if the DELETE request succeeded. False otherwise.

get(**params)[source]¶

Perform a GET request using Slumber.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET

Parameters: params – Parameters to send in the query string of the requests.Request.
Return type: Dict

head(**kwargs)[source]¶

Send a HEAD request using Requests.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD

Parameters: kwargs – Optional arguments that requests.request() takes. If allow_redirects is not provided, it will be set to False (as opposed to the default requests.request() behavior).
Return type: CaseInsensitiveDict

options(**kwargs)[source]¶

Send an OPTIONS request using Requests.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS

Parameters: kwargs – Optional arguments that requests.request() takes.
Return type: str

patch(data=None, files=None, **params)[source]¶

Perform a PATCH request using Slumber.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH

Parameters

data – Dictionary, list of tuples, bytes, or file-like object to send in the body of the requests.Request. Default None.
files – Dictionary of 'name': file-like-objects (or {'name': file-tuple}) for multipart encoding upload. file-tuple can be a 2-tuple ('filename', fileobj), 3-tuple ('filename', fileobj, 'content_type') or a 4-tuple ('filename', fileobj, 'content_type', custom_headers), where 'content-type' is a string defining the content type of the given file and custom_headers a dict-like object containing additional headers to add for the file. Default None.
params – Parameters to send in the query string of the requests.Request.

Return type

Dict

post(data=None, files=None, **params)[source]¶

Perform a POST request using Slumber.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST

Parameters

data (Union[None, str, bytes, MutableMapping[str, Any], List[Tuple[str, Optional[str]]], Tuple[Tuple[str, Optional[str]]], IO]) – Dictionary, list of tuples, bytes, or file-like object to send in the body of the requests.Request. Default None.
files – Dictionary of 'name': file-like-objects (or {'name': file-tuple}) for multipart encoding upload. file-tuple can be a 2-tuple ('filename', fileobj), 3-tuple ('filename', fileobj, 'content_type') or a 4-tuple ('filename', fileobj, 'content_type', custom_headers), where 'content-type' is a string defining the content type of the given file and custom_headers a dict-like object containing additional headers to add for the file. Default None.
params – Parameters to send in the query string of the requests.Request.

Return type

Dict

proxies¶

Type: Optional[MutableMapping[str, str]]

Dictionary mapping protocol or protocol and hostname to the URL of the proxy.

put(data=None, files=None, **params)[source]¶

Perform a PUT request using Slumber.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT

Parameters

data – Dictionary, list of tuples, bytes, or file-like object to send in the body of the requests.Request. Default None.
files – Dictionary of 'name': file-like-objects (or {'name': file-tuple}) for multipart encoding upload. file-tuple can be a 2-tuple ('filename', fileobj), 3-tuple ('filename', fileobj, 'content_type') or a 4-tuple ('filename', fileobj, 'content_type', custom_headers), where 'content-type' is a string defining the content type of the given file and custom_headers a dict-like object containing additional headers to add for the file. Default None.
params – Parameters to send in the query string of the requests.Request.

Return type

Dict

serializer¶

Type: SerializerRegistry

The serializer used to (de)serialize the data when interacting with the API.

New in version 0.6.0.

session¶

Type: Session

The underlying requests session.

New in version 0.6.0.

timeout¶

Type: Union[None, float, Tuple[float, float], Tuple[float, None]]

How long to wait for the server to send data before giving up.

url()[source]¶

Returns the URL as a string.

Return type: str

verify¶

Type: Union[None, bool, str]

Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use.

`slumber_url.serializers`¶

JSON and YAML serializers for SlumberURL.

New in version 0.6.0.

Classes:

`JsonSerializer`()	Serializer for JSON data.
`Serializer`()	Base class for serializers.
`SerializerRegistry`([default, serializers])	Serializes and deserializes data for transfer to and from a REST API.
`YamlSerializer`()	Serializer for YAML data.

Exceptions:

SerializerNotAvailable(content_type)

The chosen Serializer is not available.

class JsonSerializer[source]¶

Bases: Serializer

Serializer for JSON data.

Changed in version 0.6.0: Moved to apeye.slumber_url.serializers

Methods:

`dumps`(data)	Serialize data using this `Serializer`.
`loads`(data)	Deserialize data using this `Serializer`.

dumps(data)[source]¶

Serialize data using this Serializer.

Parameters: data (Mapping[str, Any])
Return type: str

loads(data)[source]¶

Deserialize data using this Serializer.

Parameters: data (str)
Return type: MutableMapping[str, Any]

class Serializer¶

Bases: ABC

Base class for serializers.

Changed in version 0.6.0: Moved to apeye.slumber_url.serializers

Attributes:

`content_types`	List of supported content types.
`key`	An identifier for the supported data type.

Methods:

`dumps`(data)	Serialize data using this `Serializer`.
`get_content_type`()	Returns the first value from `content_types`.
`loads`(data)	Deserialize data using this `Serializer`.

abstract property content_types: List[str]¶

List of supported content types.

Return type: List[str]

abstract dumps(data)[source]¶

Serialize data using this Serializer.

Parameters: data (Mapping[str, Any])
Return type: str

get_content_type()[source]¶

Returns the first value from content_types.

Return type: str

abstract property key: str¶

An identifier for the supported data type.

For example, a YAML serializer would set this to 'yaml'.

Return type: str

abstract loads(data)[source]¶

Deserialize data using this Serializer.

Parameters: data (str)
Return type: MutableMapping[str, Any]

exception SerializerNotAvailable(content_type)[source]¶

Bases: apeye.slumber_url.exceptions.SlumberBaseException

The chosen Serializer is not available.

Changed in version 0.6.0: Moved to apeye.slumber_url.serializers

class SerializerRegistry(default='json', serializers=None)[source]¶

Bases: object

Serializes and deserializes data for transfer to and from a REST API.

Parameters

default (str) – The default serializer to use if none is specified. Corresponds to the key of a Serializer. Default 'json'.
serializers (Optional[List[Serializer]]) – List of Serializer objects to use. Default None.

Changed in version 0.6.0: Moved to apeye.slumber_url.serializers

Attributes:

`default`	The default serializer to use if none is specified.
`serializers`	Mapping of formats to `Serializer` objects.

Methods:

`dumps`(data[, format])	Serialize data of the given format.
`get_content_type`([format])	Returns the content type for the serializer that supports the given format.
`get_serializer`([name, content_type])	Returns the first `Serializer` that supports either the given format or the given content type.
`loads`(data[, format])	Deserialize data of the given format.

default¶

Type: str

The default serializer to use if none is specified.

dumps(data, format=None)[source]¶

Serialize data of the given format.

Parameters

data (Mapping[str, Any])
format (Optional[str]) – The serialization format to use. Default None.

Return type

str

get_content_type(format=None)[source]¶

Returns the content type for the serializer that supports the given format.

Parameters: format (Optional[str]) – The desired serialization format. Default None.

get_serializer(name=None, content_type=None)[source]¶

Returns the first Serializer that supports either the given format or the given content type.

Parameters

name (Optional[str]) – Default None.
content_type (Optional[str]) – Default None.

loads(data, format=None)[source]¶

Deserialize data of the given format.

Parameters

data (str)
format (Optional[str]) – The serialization format to use. Default None.

Return type

MutableMapping[str, Any]

serializers¶

Type: Dict[str, Serializer]

Mapping of formats to Serializer objects.

class YamlSerializer[source]¶

Bases: Serializer

Serializer for YAML data.

Changed in version 0.6.0: Moved to apeye.slumber_url.serializers

Attention

Either PyYaml or ruamel.yaml must be installed to use this serializer.

Methods:

`dumps`(data)	Serialize data using this `Serializer`.
`loads`(data)	Deserialize data using this `Serializer`.

dumps(data)[source]¶

Serialize data using this Serializer.

Parameters: data (Mapping[str, Any])
Return type: str

loads(data)[source]¶

Deserialize data using this Serializer.

Parameters: data (str)
Return type: MutableMapping[str, Any]

`slumber_url.exceptions`¶

Exceptions for SlumberURL.

New in version 0.6.0.

Exceptions:

`HttpClientError`(args, *kwargs)	Raised when the server tells us there was a client error (4xx).
`HttpNotFoundError`(args, *kwargs)	Raised when the server sends a 404 error.
`HttpServerError`(args, *kwargs)	Raised when the server tells us there was a server error (5xx).
`SlumberBaseException`	All Slumber exceptions inherit from this exception.
`SlumberHttpBaseException`(args, *kwargs)	All Slumber HTTP Exceptions inherit from this exception.

exception HttpClientError(*args, **kwargs)[source]¶

Bases: apeye.slumber_url.exceptions.SlumberHttpBaseException

Raised when the server tells us there was a client error (4xx).

Changed in version 0.6.0: Moved to apeye.slumber_url.exceptions

exception HttpNotFoundError(*args, **kwargs)[source]¶

Bases: apeye.slumber_url.exceptions.HttpClientError

Raised when the server sends a 404 error.

Changed in version 0.6.0: Moved to apeye.slumber_url.exceptions

exception HttpServerError(*args, **kwargs)[source]¶

Bases: apeye.slumber_url.exceptions.SlumberHttpBaseException

Raised when the server tells us there was a server error (5xx).

Changed in version 0.6.0: Moved to apeye.slumber_url.exceptions

exception SlumberBaseException[source]¶

Bases: Exception

All Slumber exceptions inherit from this exception.

Changed in version 0.6.0: Moved to apeye.slumber_url.exceptions

exception SlumberHttpBaseException(*args, **kwargs)[source]¶

Bases: apeye.slumber_url.exceptions.SlumberBaseException

All Slumber HTTP Exceptions inherit from this exception.

Changed in version 0.6.0: Moved to apeye.slumber_url.exceptions

`apeye.cache`¶

Caching functions for functions.

`apeye.email_validator`¶

Source code: apeye_core/email_validator.py

Email address validation functions.

New in version 1.0.0.

This module is a subset of https://pypi.org/project/email-validator

Note

The classes in this module can instead be imported from the apeye_core.email_validator module instead.

Exceptions:

EmailSyntaxError

Exception raised when an email address fails validation because of its form.

Classes:

ValidatedEmail(original_email, email, …[, …])

Represents the return type of the validate_email() function.

Functions:

`validate_email`(email[, allow_smtputf8, …])	Validates an email address.
`validate_email_domain_part`(domain)	Validate the domain part of an email address (the part after the @-sign).
`validate_email_local_part`(local[, …])	Validates the local part of an email address (the part before the @-sign).

exception EmailSyntaxError[source]¶

Bases: ValueError

Exception raised when an email address fails validation because of its form.

class ValidatedEmail(original_email, email, local_part, domain, *, ascii_email=None, ascii_local_part=None, ascii_domain=None, smtputf8=None)¶

Bases: object

Represents the return type of the validate_email() function.

This class holds the normalized form of the email address alongside other information.

Parameters

original_email (str) – The original, unnormalized email address.
email (str) – The normalized email address, which should always be used in preference to the original address.
local_part (str) – The local part of the email address after Unicode normalization.
domain (str) – The domain part of the email address after Unicode normalization or conversion to Unicode from IDNA ascii.
ascii_email (Optional[str]) – If not None, a form of the email address that uses 7-bit ASCII characters only. Default None.
ascii_local_part (Optional[str]) – If not None, the local part of the email address using 7-bit ASCII characters only. Default None.
ascii_domain (Optional[str]) – If not None, a form of the domain name that uses 7-bit ASCII characters only. Default None.
smtputf8 (Optional[bool]) – Indicates whether SMTPUTF8 will be required to transmit messages to this address. Default None.

Methods:

`__eq__`(other)	Return `self == other`.
`__repr__`()	Return a string representation of the `ValidatedEmail` object.
`__str__`()	Return a string representation of the `ValidatedEmail` object.
`as_dict`()	Convenience method for accessing the `ValidatedEmail` as a dict.

__eq__(other)[source]¶

Return self == other.

Return type: bool

__repr__()[source]¶

Return a string representation of the ValidatedEmail object.

Return type: str

__str__()[source]¶

Return a string representation of the ValidatedEmail object.

Return type: str

as_dict()[source]¶

Convenience method for accessing the ValidatedEmail as a dict.

Return type: Dict[str, Any]

validate_email(email, allow_smtputf8=True, allow_empty_local=False)[source]¶

Validates an email address.

Parameters

email (Union[str, bytes]) – Either a string, or ASCII-encoded bytes.
allow_smtputf8 (bool) – Default True.
allow_empty_local (bool) – Whether to allow the local part (the bit before the @-sign) to be empty. Default False.

Raises

EmailSyntaxError – if the address is not valid

Return type

ValidatedEmail

validate_email_domain_part(domain)[source]¶

Validate the domain part of an email address (the part after the @-sign).

Parameters: domain (str)
Return type: Dict[str, str]

validate_email_local_part(local, allow_smtputf8=True, allow_empty_local=False)[source]¶

Validates the local part of an email address (the part before the @-sign).

Parameters

local (str)
allow_smtputf8 (bool) – Default True.
allow_empty_local (bool) – Whether to allow the local part to be empty/. Default False.

Return type

Dict[str, Any]

`apeye.rate_limiter`¶

Rate limiters for making calls to external APIs in a polite manner.

Attention

This module has the following additional requirements:

cachecontrol[filecache]>=0.12.6
filelock>=3.8.0; python_version >= "3.7"
lockfile>=0.12.2; python_version < "3.7"

These can be installed as follows:

python -m pip install apeye[limiter]

Classes:

`HTTPCache`(app_name[, expires_after])	Cache HTTP requests for up to 28 days and limit the rate of requests to no more than 5/second.
`RateLimitAdapter`([cache, cache_etags, …])	Custom `cachecontrol.adapter.CacheControlAdapter` to limit the rate of requests to 5 per second.

Functions:

rate_limit([min_time, logger])

Decorator to force a function to run no less than min_time seconds after it last ran.

class HTTPCache(app_name, expires_after=datetime.timedelta(days=28))[source]¶

Cache HTTP requests for up to 28 days and limit the rate of requests to no more than 5/second.

Parameters

app_name (str) – The name of the app. This dictates the name of the cache directory.
expires_after (timedelta) – The maximum time to cache responses for. Default datetime.timedelta(days=28).

Attributes:

`app_name`	The name of the app.
`cache_dir`	The location of the cache directory on disk.
`caches`	Mapping of function names to their caches.

Methods:

clear()

Clear the cache.

app_name¶

Type: str

The name of the app. This dictates the name of the cache directory.

cache_dir¶

Type: PathPlus

The location of the cache directory on disk.

caches¶

Type: Dict[str, Dict[str, Any]]

Mapping of function names to their caches.

clear()[source]¶

Clear the cache.

Return type: bool
Returns: True to indicate success. False otherwise.

rate_limit(min_time=0.2, logger=None)[source]¶

Decorator to force a function to run no less than min_time seconds after it last ran. Used for rate limiting.

Parameters

min_time (float) – The minimum interval between subsequent runs of the decorated function. Default 0.2, which gives a maximum rate of 5 calls per second.
logger (Optional[Logger]) – Optional logger to log information about requests to. Defaults to the root logger.

Return type

Callable[[Callable], Any]

class RateLimitAdapter(cache=None, cache_etags=True, controller_class=None, serializer=None, heuristic=None, cacheable_methods=None, *args, **kw)[source]¶

Bases: CacheControlAdapter

Custom cachecontrol.adapter.CacheControlAdapter to limit the rate of requests to 5 per second.

Parameters

cache (BaseCache | None) – Default None.
cache_etags (bool) – Default True.
controller_class (type[CacheController] | None) – Default None.
serializer (Serializer | None) – Default None.
heuristic (BaseHeuristic | None) – Default None.
cacheable_methods (Collection[str] | None) – Default None.

Methods:

`rate_limited_send`(args, *kwargs)	Wrapper around `CacheControlAdapter.send` to limit the rate of requests.
`send`(request[, cacheable_methods])	Send a request.

rate_limited_send(*args, **kwargs)[source]¶

Wrapper around CacheControlAdapter.send to limit the rate of requests.

Return type: Response

send(request, cacheable_methods=None, **kwargs)[source]¶

Send a request.

Use the request information to see if it exists in the cache and cache the response if we need to and can.

Parameters

request (PreparedRequest) – The requests.PreparedRequest being sent.
cacheable_methods (Optional[Collection[str]]) – Default None.
**kwargs – Additional arguments taken by requests.adapters.HTTPAdapter.send() (e.g. timeout).

Return type

Response

Contributing¶

apeye uses tox to automate testing and packaging, and pre-commit to maintain code quality.

Install pre-commit with pip and install the git hook:

python -m pip install pre-commit
pre-commit install

Coding style¶

formate is used for code formatting.

It can be run manually via pre-commit:

pre-commit run formate -a

Or, to run the complete autoformatting suite:

pre-commit run -a

Automated tests¶

Tests are run with tox and pytest. To run tests for a specific Python version, such as Python 3.6:

tox -e py36

To run tests for all Python versions, simply run:

tox

Type Annotations¶

Type annotations are checked using mypy. Run mypy using tox:

tox -e mypy

Build documentation locally¶

The documentation is powered by Sphinx. A local copy of the documentation can be built with tox:

tox -e docs

Downloading source code¶

The apeye source code is available on GitHub, and can be accessed from the following URL: https://github.com/domdfcoding/apeye

If you have git installed, you can clone the repository with the following command:

git clone https://github.com/domdfcoding/apeye

Cloning into 'apeye'...
remote: Enumerating objects: 47, done.
remote: Counting objects: 100% (47/47), done.
remote: Compressing objects: 100% (41/41), done.
remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
Resolving deltas: 100% (66/66), done.

Alternatively, the code can be downloaded in a ‘zip’ file by clicking:

Clone or download –> Download Zip

Downloading a ‘zip’ file of the source code¶

Building from source¶

The recommended way to build apeye is to use tox:

tox -e build

The source and wheel distributions will be in the directory dist.

If you wish, you may also use pep517.build or another PEP 517-compatible build tool.

License¶

apeye is licensed under the GNU Lesser General Public License v3.0 or later.

Permissions of this copyleft license are conditioned on making available complete source code of licensed works and modifications under the same license or the GNU GPLv3. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. However, a larger work using the licensed work through interfaces provided by the licensed work may be distributed under different terms and without source code for the larger work.

Permissions	Conditions	Limitations
Commercial use Modification Distribution Patent use Private use	License and copyright notice Disclose source State changes Same license (library)	Liability Warranty

See more information on choosealicense.com ➩

GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>

Everyone is permitted to copy and distribute verbatim copies of this license
document, but changing it is not allowed.

This version of the GNU Lesser General Public License incorporates the terms
and conditions of version 3 of the GNU General Public License, supplemented
by the additional permissions listed below.

0. Additional Definitions.

As used herein, “this License” refers to version 3 of the GNU Lesser General
Public License, and the “GNU GPL” refers to version 3 of the
GNU General Public License.

“The Library” refers to a covered work governed by this License, other than
an Application or a Combined Work as defined below.

An “Application” is any work that makes use of an interface provided by the
Library, but which is not otherwise based on the Library. Defining a subclass
of a class defined by the Library is deemed a mode of using an interface
provided by the Library.

A “Combined Work” is a work produced by combining or linking an Application
with the Library. The particular version of the Library with which the
Combined Work was made is also called the “Linked Version”.

The “Minimal Corresponding Source” for a Combined Work means the Corresponding
Source for the Combined Work, excluding any source code for portions of the
Combined Work that, considered in isolation, are based on the Application,
and not on the Linked Version.

The “Corresponding Application Code” for a Combined Work means the object code
and/or source code for the Application, including any data and utility programs
needed for reproducing the Combined Work from the Application, but excluding
the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License without
being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a facility
refers to a function or data to be supplied by an Application that uses the
facility (other than as an argument passed when the facility is invoked),
then you may convey a copy of the modified version:

    a) under this License, provided that you make a good faith effort to
    ensure that, in the event an Application does not supply the function or
    data, the facility still operates, and performs whatever part of its
    purpose remains meaningful, or

    b) under the GNU GPL, with none of the additional permissions of this
    License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from a header
file that is part of the Library. You may convey such object code under terms
of your choice, provided that, if the incorporated material is not limited to
numerical parameters, data structure layouts and accessors, or small macros,
inline functions and templates (ten or fewer lines in length),
you do both of the following:

    a) Give prominent notice with each copy of the object code that the Library
    is used in it and that the Library and its use are covered by this License.

    b) Accompany the object code with a copy of the GNU GPL
    and this license document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that, taken together,
effectively do not restrict modification of the portions of the Library
contained in the Combined Work and reverse engineering for debugging such
modifications, if you also do each of the following:

    a) Give prominent notice with each copy of the Combined Work that the
    Library is used in it and that the Library and its use are covered
    by this License.

    b) Accompany the Combined Work with a copy of the GNU GPL and
    this license document.

    c) For a Combined Work that displays copyright notices during execution,
    include the copyright notice for the Library among these notices, as well
    as a reference directing the user to the copies of the GNU GPL
    and this license document.

    d) Do one of the following:

        0) Convey the Minimal Corresponding Source under the terms of this
        License, and the Corresponding Application Code in a form suitable
        for, and under terms that permit, the user to recombine or relink
        the Application with a modified version of the Linked Version to
        produce a modified Combined Work, in the manner specified by section 6
        of the GNU GPL for conveying Corresponding Source.

        1) Use a suitable shared library mechanism for linking with the
        Library. A suitable mechanism is one that (a) uses at run time a
        copy of the Library already present on the user's computer system,
        and (b) will operate properly with a modified version of the Library
        that is interface-compatible with the Linked Version.

    e) Provide Installation Information, but only if you would otherwise be
    required to provide such information under section 6 of the GNU GPL, and
    only to the extent that such information is necessary to install and
    execute a modified version of the Combined Work produced by recombining
    or relinking the Application with a modified version of the Linked Version.
    (If you use option 4d0, the Installation Information must accompany the
    Minimal Corresponding Source and Corresponding Application Code. If you
    use option 4d1, you must provide the Installation Information in the
    manner specified by section 6 of the GNU GPL for
    conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the Library side by
side in a single library together with other library facilities that are not
Applications and are not covered by this License, and convey such a combined
library under terms of your choice, if you do both of the following:

    a) Accompany the combined library with a copy of the same work based on
    the Library, uncombined with any other library facilities, conveyed under
    the terms of this License.

    b) Give prominent notice with the combined library that part of it is a
    work based on the Library, and explaining where to find the accompanying
    uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions of the
GNU Lesser General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

Each version is given a distinguishing version number. If the Library as you
received it specifies that a certain numbered version of the GNU Lesser
General Public License “or any later version” applies to it, you have the
option of following the terms and conditions either of that published version
or of any later version published by the Free Software Foundation. If the
Library as you received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser General
Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide whether
future versions of the GNU Lesser General Public License shall apply, that
proxy's public statement of acceptance of any version is permanent
authorization for you to choose that version for the Library.

View the Function Index or browse the Source Code.

Browse the GitHub Repository

`__bytes__`()	Return the bytes representation of the path.
`__eq__`(other)	Return `self == other`.
`__repr__`()	Return a string representation of the `URLPath`.
`__rtruediv__`(key)	Return `value / self`.
`__str__`()	Return the string representation of the path, suitable for passing to system calls.
`__truediv__`(key)	Return `self / value`.
`is_absolute`()	Returns whether the path is absolute (i.e.
`is_relative_to`(*other)	Return True if the path is relative to another path or False.
`is_reserved`()	Return True if the path contains one of the special names reserved by the system, if any.
`joinpath`(*args)	Combine this `URLPath` with one or several arguments.
`relative_to`(*other)	Returns the relative path to another path identified by the passed arguments.
`with_name`(name)	Return a new path with the file name changed.
`with_stem`(stem)	Return a new path with the stem changed.
`with_suffix`(suffix)	Return a new path with the file suffix changed.

`__call__`(func)	Decorator to cache the return values of a function based on its inputs.
`clear`([func])	Clear the cache.
`load_cache`(func)	Loads the cache for the given function.