sondra.ref module

exception sondra.ref.EndpointError

Bases: builtins.Exception

Raised when an API request is parsed correctly, but the endpoint isn’t found

exception sondra.ref.ParseError

Bases: builtins.Exception

Called when an API request is not parsed as valid

class sondra.ref.Reference(env, url=None, **kw)

Bases: builtins.object

Contains the application, collection, document, methods, and fragment the URL refers to

FORMATS = {'json', 'geojson', 'schema', 'help'}

construct()

Construct a URL from its base parts

classmethod dereference(sondra, value)

classmethod dereference_all(sondra, value)

get_application()

Return an Application instance for the given URL.

Parameters:url (str) – The URL to a collection or a document. Returns:An Application object

get_application_method()

Return everything you need to call an application method.

Returns:

• application object
• method name
• method object

Return type:A three-tuple of Raises:EndpointError if the method or application is not found or the method is not exposable.

get_collection()

Return a DocumentCollection instance for the given URL.

Parameters:url (str) – The URL to a collection or a document. Returns:A DocumentCollection object

get_collection_method()

Return everything you need to call an collection method.

Returns:

• collection object
• method name
• method object

Return type:A three-tuple of Raises:EndpointError if the method or collection is not found or the method is not exposable.

get_document()

Return the Document for a given URL.

get_document_method()

Return everything you need to call an document method.

Returns:

• document object
• method name
• method object

Return type:A three-tuple of Raises:EndpointError if the method or document is not found or the method is not exposable.

get_subdocument()

Return the fragment within the Document referred to by this URL.

is_application()

is_application_method_call()

is_collection()

is_collection_method_call()

is_document()

is_document_method_call()

is_subdocument()

kind

classmethod maybe_reference(sondra, value)

schema

value