The Python implementation of the client for communication with the sc-server
Project description
Py-sc-client
The python implementation of the client for communication with sc-server. This module is compatible with 0.6.0 - 0.6.1 versions of sc-machine.
Installing Requests and Supported Versions
Py-sc-client is available on PyPI:
$ python -m pip install Py-sc-client
Py-sc-client officially supports Python 3.8+.
API Reference
connect
Connect to the server by the URL. Run the client in another thread.
Parameters: A URL of the sc-server as a string.
from sc_client import client
client.connect("ws://localhost:8090/ws_json")
disconnect
Close the connection with the sc-server.
from sc_client import client
client.disconnect()
is_connected
Check the state of the connection with the sc-server.
Returns: The boolean value (true if a connection is established).
from sc_client import client
client.is_connected() # True
check_elements
Check the type of given elements.
Parameters: ScAddr class objects. Returns: A list of ScType class objects.
elem_types = client.check_elements(node_addr, edge_addr, link_addr)
elem_types[0].is_node() #True
elem_types[1].is_edge() #True
elem_types[2].is_link() #True
create_elements
Create a given construction in the KB memory.
Parameters: An ScConstruction class object. Returns: A list of ScAddr class objects.
const = ScConstruction()
const.create_node(sc_types.NODE_CONST, 'node')
link_content = ScLinkContent("Hello!", ScLinkContentType.STRING.value)
const.create_link(sc_types.LINK, link_content, 'link')
const.create_edge(sc_types.EDGE_ACCESS_CONST_POS_PERM, 'node', 'link')
addr_list = client.create_elements(const)
addr_list # [node_addr, link_addr, edge_addr]
delete_elements
Delete elements from the KB memory.
Parameters: ScAddr class objects. Returns: The boolean value (true if elements were deleted).
status = client.delete_elements(node_addr, edge_addr, link_addr)
status #True
set_link_contents
Set the new content to corresponding links.
Parameters: ScLinkContent class objects. Returns: The boolean value (true if the link content is set).
link_content = ScLinkContent("Hello world!", ScLinkContentType.STRING.value)
link_content.addr = link_addr
status = client.set_link_contents(link_content)
status # True
get_link_content
Get the content of the given link.
Parameters: An ScAddr class object. Returns: An ScLinkContent class object.
link_content = client.get_link_content(link_addr)
link_content.data # link content
link_content.addr # link addr
get_links_by_content
Get links from the KB with content.
Parameters: ScLinkContent class objects, strings. Returns: A list of lists of ScAddr class objects.
content = client.get_links_by_content("testing search by the link content as a string", "no content")
content[0] # get a list of ScAddrs links with the given content
content[1] # get an empty list if there is no link with the given content in the memory
resolve_keynodes
Get a keynode from the KB memory by identifier and type. If it doesn't exist, then create a new one. If ScType is None, try to find an element by the system identifier.
Parameters: An ScIdtfResolveParams class object. Returns: An ScAddr class object.
params = ScIdtfResolveParams(idtf='my_new_keynode_that_not_exist', type=sc_types.NODE_CONST)
addr = client.resolve_keynodes([params])
addr # new keynode addr
params = ScIdtfResolveParams(idtf='technology_OSTIS', type=sc_types.NODE_CONST)
addr = client.resolve_keynodes([params])
addr # keynode addr
params = ScIdtfResolveParams(idtf='my_another_keynode_that_not_exist', type=None)
addr = client.resolve_keynodes([params])
addr # None
params = ScIdtfResolveParams(idtf='nrel_format', type=None)
addr = client.resolve_keynodes([params])
addr # keynode addr
template_search
Search in the KB memory by template.
Parameters: An ScTemplate class object or an scs-template as a string. Returns: A list of ScTemplateResult class objects.
templ = ScTemplate()
templ.triple([class_node_addr, '_class_node'], sc_types.EDGE_ACCESS_VAR_POS_PERM, node_addr) # faf
templ.triple('_class_node', sc_types.EDGE_ACCESS_VAR_POS_TEMP, link_addr) # faf
templ.triple('_class_node', edge_addr, sc_types.NODE_VAR) # ffa
templ.triple(node_addr, edge_addr, sc_types.NODE_VAR, is_required=False) # ffa, can be empty
search_results = client.template_search(templ)
search_result = search_results[0]
search_result.size() # count of elements in the resulting construction
search_result.get(0).value # get an element from the result by index
search_result.get('_class_node').value # get an element from the result by alias
def for_each_tripple_func(src: ScAddr, edge: ScAddr, trg: ScAddr):
...
search_result.for_each_triple(for_each_tripple_func) # call a function for each triple in the result
template_generate
Generate a construction in the KB memory by template.
Parameters: An ScTemplate class object or an scs-template as a string, an ScTemplateGenParams class object. Returns: An ScTemplateResult class object.
templ = ScTemplate()
templ.triple_with_relation( # faaaf
[main_node, '_main_node'],
sc_types.EDGE_D_COMMON_VAR,
[sc_types.LINK, '_link'],
sc_types.EDGE_ACCESS_VAR_POS_PERM,
relation_node,
)
templ.triple( # faa
'_main_node',
sc_types.EDGE_ACCESS_VAR_POS_TEMP,
[sc_types.NODE_VAR, '_var_node']
)
gen_params = {'_link': link_node, '_var_node': var_node}
gen_result = client.template_generate(templ, gen_params)
events_create
Create an event in the KB memory.
Parameters: ScEventParams class objects. Returns: A list of ScEvent class objects.
def event_callback(src: ScAddr, edge: ScAddr, trg: ScAddr):
...
event_type = common.ScEventType.ADD_OUTGOING_EDGE
event_params = ScEventParams(bounded_elem_addr, event_type, event_callback)
sc_event = client.events_create(event_params)
is_event_valid
Check whether an event is active or not.
Parameters: An ScEvent class object. Returns: The boolean value (true if an event is valid).
status = client.is_event_valid(sc_event)
status # True
events_destroy
Destroy an event in the KB memory.
Parameters: ScEvent class objects. Returns: The boolean value (true if an event was destroyed).
status = client.events_destroy(sc_event)
status # true
Classes
The library contains the python implementation of useful classes and functions to work with the sc-memory.
There is a list of classes:
- ScKeynodes
- ScAgent
- ScModule
ScKeynodes
A singleton dictionary object which provides the ability to cache the identifier and ScAddr of keynodes stored in the KB. Create an instance of the ScKeynodes class to get access to the cache:
keynodes = ScKeynodes()
Get the provided identifier:
keynodes["identifier_of_keynode"] # returns an ScAddr of the given identifier
keynodes["not_stored_in_kb"] # returns an invalid ScAddr if an identifier does not exist in the memory
Use resolve_identifiers() to upload identifiers from Enum classes:
class CommonIdentifiers(Enum):
RREL_ONE = "rrel_1"
RREL_TWO = "rrel_2"
class QuestionStatus(Enum):
QUESTION_INITIATED = "question_initiated"
QUESTION_FINISHED = "question_finished"
QUESTION_FINISHED_SUCCESSFULLY = "question_finished_successfully"
QUESTION_FINISHED_UNSUCCESSFULLY = "question_finished_unsuccessfully"
keynodes.resolve_identifiers([QuestionStatus, CommonIdentifiers])
ScAgent
A class for handling a single ScEvent. Define your agents like this:
class MyAgent(ScAgent):
action = "Identifier_of_action_class"
def register(self) -> ScEvent:
# override method, must return an ScEvent instance
params = [
MyAgent.keynodes["action_initiated"],
common.ScEventType.ADD_OUTGOING_EDGE,
MyAgent.run_impl
]
event_params = ScEventParams(*params)
sc_event = client.events_create(event_params)
return sc_event[0]
@staticmethod
def run_impl(action_class: ScAddr, edge: ScAddr, action_node: ScAddr) -> None:
# override method, must have 3 args and be static
...
ScModule
A class for handling a multiple ScAgent. Define your modules like this:
class MyModule(ScModule):
def __init__(self) -> None:
agents_to_register = [MyAgent1, MyAgent2] # list of agent classes
super().__init__(agents_to_register)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for Py_sc_client-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 792d9585fc90c18c5c93b120187cfe9ed4121ea085fd7132ee5208d1d672a7a0 |
|
MD5 | 1bce60e41c504ef5d6d1ea7b37152247 |
|
BLAKE2b-256 | 44f478d2ea6eccc2173ad6ecbea76e3caf33768173481cd0991a694a418de3da |