swh.graph.server.app module

A proxy HTTP server for swh-graph, talking to the Java code via py4j, and using FIFO as a transport to stream integers between the two languages.

class swh.graph.server.app.GraphServerApp(*args, **kwargs)

Bases: MutableMapping[str, Any]

async swh.graph.server.app.index(request)

class swh.graph.server.app.GraphView(*args, **kwargs)

Bases: aiohttp.web_urldispatcher.View

Base class for views working on the graph, with utility functions

node_of_swhid(swhid)

Lookup a SWHID in a swhid2node map, failing in an HTTP-nice way if needed.

swhid_of_node(node)

Lookup a node in a node2swhid map, failing in an HTTP-nice way if needed.

get_direction()

Validate HTTP query parameter direction

get_edges()

Validate HTTP query parameter edges, i.e., edge restrictions

get_return_types()

Validate HTTP query parameter ‘return types’, i.e, a set of types which we will filter the query results with

get_traversal()

Validate HTTP query parameter traversal, i.e., visit order

get_limit()

Validate HTTP query parameter limit, i.e., number of results

get_max_edges()

Validate HTTP query parameter ‘max_edges’, i.e., the limit of the number of edges that can be visited

class swh.graph.server.app.StreamingGraphView(*args, **kwargs)

Bases: swh.graph.server.app.GraphView

Base class for views streaming their response line by line.

content_type = 'text/plain'

response_streamer(*args, **kwargs)

Context manager to prepare then close a StreamResponse

async get()

async prepare_response()

This can be overridden with some setup to be run before the response actually starts streaming.

async stream_response()

Override this to perform the response streaming. Implementations of this should await self.stream_line(line) to write each line.

async stream_line(line)

Write a line in the response stream.

class swh.graph.server.app.StatsView(*args, **kwargs)

Bases: swh.graph.server.app.GraphView

View showing some statistics on the graph

async get()

class swh.graph.server.app.SimpleTraversalView(*args, **kwargs)

Bases: swh.graph.server.app.StreamingGraphView

Base class for views of simple traversals

simple_traversal_type: Optional[str] = None

async prepare_response()

This can be overridden with some setup to be run before the response actually starts streaming.

async stream_response()

Override this to perform the response streaming. Implementations of this should await self.stream_line(line) to write each line.

class swh.graph.server.app.LeavesView(*args, **kwargs)

Bases: swh.graph.server.app.SimpleTraversalView

simple_traversal_type: Optional[str] = 'leaves'

class swh.graph.server.app.NeighborsView(*args, **kwargs)

Bases: swh.graph.server.app.SimpleTraversalView

simple_traversal_type: Optional[str] = 'neighbors'

class swh.graph.server.app.VisitNodesView(*args, **kwargs)

Bases: swh.graph.server.app.SimpleTraversalView

simple_traversal_type: Optional[str] = 'visit_nodes'

class swh.graph.server.app.WalkView(*args, **kwargs)

Bases: swh.graph.server.app.StreamingGraphView

async prepare_response()

This can be overridden with some setup to be run before the response actually starts streaming.

async get_walk_iterator()

async stream_response()

Override this to perform the response streaming. Implementations of this should await self.stream_line(line) to write each line.

class swh.graph.server.app.RandomWalkView(*args, **kwargs)

Bases: swh.graph.server.app.WalkView

get_walk_iterator()

class swh.graph.server.app.VisitEdgesView(*args, **kwargs)

Bases: swh.graph.server.app.SimpleTraversalView

async stream_response()

Override this to perform the response streaming. Implementations of this should await self.stream_line(line) to write each line.

class swh.graph.server.app.VisitPathsView(*args, **kwargs)

Bases: swh.graph.server.app.SimpleTraversalView

content_type = 'application/x-ndjson'

async stream_response()

Override this to perform the response streaming. Implementations of this should await self.stream_line(line) to write each line.

class swh.graph.server.app.CountView(*args, **kwargs)

Bases: swh.graph.server.app.GraphView

Base class for counting views.

count_type: Optional[str] = None

async get()

class swh.graph.server.app.CountNeighborsView(*args, **kwargs)

Bases: swh.graph.server.app.CountView

count_type: Optional[str] = 'neighbors'

class swh.graph.server.app.CountLeavesView(*args, **kwargs)

Bases: swh.graph.server.app.CountView

count_type: Optional[str] = 'leaves'

class swh.graph.server.app.CountVisitNodesView(*args, **kwargs)

Bases: swh.graph.server.app.CountView

count_type: Optional[str] = 'visit_nodes'

swh.graph.server.app.make_app(config=None, backend=None, **kwargs)

swh.graph.server.app.make_app_from_configfile()

Load configuration and then build application to run