Reshape¶

Reshaping will create a copy of a Resource while keeping a set of specified properties.

In [1]:

from kgforge.core import KnowledgeGraphForge

A configuration file is needed in order to create a KnowledgeGraphForge session. A configuration can be generated using the notebook 00-Initialization.ipynb.

In [3]:

forge = KnowledgeGraphForge("../../configurations/forge.yml")

Imports¶

In [4]:

from kgforge.core import Resource

Reshaping¶

basics¶

In [5]:

jane = Resource(type="Person", name="Jane Doe")

In [6]:

john = Resource(type="Person", name="John Smith")

In [7]:

persons = [jane, john]

In [8]:

resources = forge.reshape(persons, keep=["name"])

In [9]:

type(resources)

Out[9]:

list

In [10]:

type(resources[0])

Out[10]:

kgforge.core.resource.Resource

In [11]:

print(jane)

{
    type: Person
    name: Jane Doe
}

In [12]:

print(resources[0])

{
    name: Jane Doe
}

advanced¶

In [13]:

jane = Resource(type="Person", name="Jane Doe")

In [14]:

association = Resource(type="Association", agent=jane)

In [15]:

resource = forge.reshape(association, keep=["type", "agent.name"])

In [16]:

print(association)

{
    type: Association
    agent:
    {
        type: Person
        name: Jane Doe
    }
}

In [17]:

print(resource)

{
    type: Association
    agent:
    {
        name: Jane Doe
    }
}

reshape versioned¶

This is useful to switch resource references to versioned identifiers.

In [18]:

jane = Resource(type="Person", name="Jane Doe")

In [19]:

forge.register(jane)

<action> _register_one
<succeeded> True

In [20]:

resource = forge.reshape(jane, keep=["id", "type"], versioned=True)

In [21]:

forge.as_json(jane)

Out[21]:

{'id': 'https://bbp.epfl.ch/nexus/v1/resources/dke/kgforge/_/9c0d1bac-2f14-4a8b-ad6f-dc7495cc10e7',
 'type': 'Person',
 'name': 'Jane Doe'}

In [22]:

print(resource)

{
    id: https://bbp.epfl.ch/nexus/v1/resources/dke/kgforge/_/9c0d1bac-2f14-4a8b-ad6f-dc7495cc10e7?rev=1
    type: Person
}

error handling¶

In [23]:

john = Resource(type="Person", name="John Smith")

In [24]:

resource = forge.reshape(john, keep=["id"], versioned=True)

In [25]:

resource is None

Out[25]:

True