Skip to main content

Pydantic models for the Reasoner API data formats

Project description

Reasoner-Pydantic

Test status via GitHub Actions ℹ️

Pydantic models for the Reasoner API data formats.

These models are very handy when setting up a Reasoner API with FastAPI.

Example usage

from reasoner_pydantic import (
    Query,
    Message,
    QNode,
    KnowledgeGraph,
    Node,
    Result,
    NodeBinding,
)


def add_result_to_query(query_dict):
    query = Query.parse_obj(query_dict)
    message: Message = query.message

    # get query graph node
    qnode_id = next(iter(message.query_graph.nodes))

    # add knowledge graph node
    knode = Node.parse_obj({"categories": ["biolink:FooBar"]})
    knode_id = "foo:bar"
    message.knowledge_graph.nodes[knode_id] = knode

    # add result
    result: Result = Result.parse_obj(
        {
            "node_bindings": {qnode_id: [{"id": knode_id}]}
        }
    )

    message.results.add(result)

    return message.json()


add_result_to_query({
    "message": {
        "query_graph": {"nodes": {"n0": {}}, "edges": {}},
        "knowledge_graph": {"nodes": {}, "edges": {}},
        "results" : []
    }
})

Validation Usage

Because of performance concerns, as well as how types are implemented in Python, there is no assignment validation enforced on these models. For example:

from reasoner_pydantic import KnowledgeGraph

# This will not throw an error
kg = KnowledgeGraph(nodes = "hi")

This is especially important to keep in mind when constructing objects that use containers. This library uses custom container types: HashableMapping, HashableSequence, HashableSet:

from reasoner_pydantic import KnowledgeGraph, Node, CURIE

# This is not correct and will not throw an error, but will cause problems later
kg = KnowledgeGraph(nodes = {})

# Instead, if you would like to build models this way, use a typed container constructor
kg = KnowledgeGraph(nodes = HashableMapping[CURIE, Node](__root__ = {}))

For this reason, we recommend one of the following options:

  1. Use parse_obj exclusively for constructing models. This will perform validation for you. This option is best if performance is not important.
  2. Use a static type checker to ensure that models are being constructed correctly. Constructing objects this way is more performant, and the static type checker will ensure that it is done correctly. We recommend using pyright in your editor.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reasoner-pydantic-5.0.6.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

reasoner_pydantic-5.0.6-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file reasoner-pydantic-5.0.6.tar.gz.

File metadata

  • Download URL: reasoner-pydantic-5.0.6.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for reasoner-pydantic-5.0.6.tar.gz
Algorithm Hash digest
SHA256 956275e2f8f3b3dea4ccc65055506ca937213eccdb6acd695fcc789afbdfa880
MD5 3cda76f38ec8d703180d61fbce890822
BLAKE2b-256 ac378256607dbf2e9f921bba62296e2307e34665dd7009b7ee63821cad76414e

See more details on using hashes here.

File details

Details for the file reasoner_pydantic-5.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for reasoner_pydantic-5.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5464a2ba6473bb0bbb9bb5e229192a77d7fe1fc504dbeec10f173b1e14534bf7
MD5 3720dd42c4e920754d96f3685fc76c42
BLAKE2b-256 a559947a683cd565e2eff3100c0875e65ece3fee6d36d2b5cd538210a3d74820

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page