swh.graph.http_rpc_server module

A proxy HTTP server for swh-graph, talking to the Rust code via the gRPC API.

class swh.graph.http_rpc_server.GraphServerApp(*args, middlewares=(), **kwargs)

Bases: Application

async swh.graph.http_rpc_server.index(request)

class swh.graph.http_rpc_server.GraphView(*args, **kwargs)

Bases: View

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

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_max_matching_nodes()

Validate HTTP query parameter max_matching_nodes, 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

async check_swhid(swhid)

Validate that the given SWHID exists in the graph

class swh.graph.http_rpc_server.StreamingGraphView(*args, **kwargs)

Bases: 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.http_rpc_server.StatsView(*args, **kwargs)

Bases: GraphView

View showing some statistics on the graph

async get()

class swh.graph.http_rpc_server.SimpleTraversalView(*args, **kwargs)

Bases: StreamingGraphView

Base class for views of simple traversals

async prepare_response()

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

configure_request()

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.http_rpc_server.LeavesView(*args, **kwargs)

Bases: SimpleTraversalView

configure_request()

class swh.graph.http_rpc_server.NeighborsView(*args, **kwargs)

Bases: SimpleTraversalView

configure_request()

class swh.graph.http_rpc_server.VisitNodesView(*args, **kwargs)

Bases: SimpleTraversalView

class swh.graph.http_rpc_server.VisitEdgesView(*args, **kwargs)

Bases: SimpleTraversalView

configure_request()

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.http_rpc_server.CountView(*args, **kwargs)

Bases: GraphView

Base class for counting views.

count_type: str | None = None

async get()

configure_request()

class swh.graph.http_rpc_server.CountNeighborsView(*args, **kwargs)

Bases: CountView

configure_request()

class swh.graph.http_rpc_server.CountLeavesView(*args, **kwargs)

Bases: CountView

configure_request()

class swh.graph.http_rpc_server.CountVisitNodesView(*args, **kwargs)

Bases: CountView

swh.graph.http_rpc_server.make_app(config=None)

Create an aiohttp server for the HTTP RPC frontend to the swh-graph API.

It may either connect to an existing grpc server (cls=”remote”) or spawn a local grpc server (cls=”local”).

config is expected to be a dict like:

graph:
  cls: "local"
  grpc_server:
    port: 50091
  http_rpc_server:
    debug: true

or:

graph:
  cls: "remote"
  url: "localhost:50091"
  http_rpc_server:
    debug: true

See:

• swh.graph.grpc_server for more details of the content of the grpc_server section,

• GraphServerApp class for more details of the content of the http_rpc_server section.

swh.graph.http_rpc_server.make_app_from_configfile()

Load configuration and then build application to run