clarin.sru.queryparser

class clarin.sru.queryparser.SRUQuery(raw_query: str, parsed_query: _T)

Bases: ABC, Generic[_T]

Holder class for a parsed query to be returned from a SRUQueryParser.

abstract property query_type: str

Get the short name for supported query, e.g. “cql”.

property raw_query: str

Get the original query as a string.

property parsed_query: _T

Get the parsed query as an abstract syntax tree.

class clarin.sru.queryparser.SRUQueryParser(*args, **kwds)

Bases: ABC, Generic[_T]

Interface for implementing pluggable query parsers.

Parameterized by ‘abstract syntax tree (object) for parsed queries.’

abstract property query_type: str

Get the short name for supported query, e.g. “cql”.

abstract supports_version(version: SRUVersion | None) → bool

Check if query is supported by a specific version of SRU/CQL.

property query_type_definition: str | None

The URI for the for the query type’s definition.

abstract property query_parameter_names: List[str]

Get the list of query parameters.

abstract parse_query(version: SRUVersion, parameters: Dict[str, str], diagnostics: SRUDiagnosticList) → SRUQuery[_T] | None

Parse a query into an abstract syntax tree.

Parameters:

• version – the SRU version the request was made

• parameters – the request parameters containing the query

• diagnostics – a SRUDiagnosticList for storing fatal and non-fatal diagnostics

Returns:

the parsed query or None if the query could not be parsed

class clarin.sru.queryparser.SRUQueryParserRegistry(parsers: List[SRUQueryParser[Any]])

Bases: object

A registry to keep track of registered SRUQueryParser to be used by the SRUServer.

See also

SRUQueryParser

property query_parsers: List[SRUQueryParser[Any]]

Get a list of all registered query parsers.

Returns:

List[SRUQueryParser[Any]] –

a list of registered query

parsers

find_query_parser(query_type: str) → SRUQueryParser[Any] | None

Find a query parser by query type.

Parameters:

query_type – the query type to search for

Returns:

SRUQueryParser[Any] –

the matching SRUQueryParser

instance or None if no matching parser was found.

class Builder(register_defaults: bool = True)

Bases: object

Builder for creating SRUQueryParserRegistry instances.

[Constructor]

Parameters:

register_defaults – if True, register SRU/CQL standard query parsers (queryType cql and searchTerms), otherwise do nothing. Defaults to True.

register_defaults() → Builder

Registers registers SRU/CQL standard query parsers (queryType cql and searchTerms).

register(parser: SRUQueryParser[Any]) → Builder

Register a new query parser

Parameters:

parser (SRUQueryParser[Any]) – the query parser instance to be registered

Raises:

SRUConfigException – if a query parser for the same query type was already registered

build() → SRUQueryParserRegistry

Create a configured SRUQueryParserRegistry instance from this builder.

Returns:

SRUQueryParserRegistry –

a SRUQueryParserRegistry

instance

class clarin.sru.queryparser.SearchTermsQuery(raw_query: str, parsed_query: _T)

Bases: SRUQuery[List[str]]

property query_type: str

Get the short name for supported query, e.g. “cql”.

class clarin.sru.queryparser.SearchTermsQueryParser(*args, **kwds)

Bases: SRUQueryParser[List[str]]

property query_type: str

Get the short name for supported query, e.g. “cql”.

property query_parameter_names: List[str]

Get the list of query parameters.

supports_version(version: SRUVersion | None) → bool

Check if query is supported by a specific version of SRU/CQL.

parse_query(version: SRUVersion, parameters: Dict[str, str], diagnostics: SRUDiagnosticList) → SRUQuery[List[str]] | None

Parse a query into an abstract syntax tree.

Parameters:

• version – the SRU version the request was made

• parameters – the request parameters containing the query

• diagnostics – a SRUDiagnosticList for storing fatal and non-fatal diagnostics

Returns:

the parsed query or None if the query could not be parsed

class clarin.sru.queryparser.CQLQuery(raw_query: str, parsed_query: _T)

Bases: SRUQuery[CQLQuery]

property query_type: str

Get the short name for supported query, e.g. “cql”.

class clarin.sru.queryparser.CQLQueryParser(*args, **kwds)

Bases: SRUQueryParser[CQLQuery]

Default query parser to parse CQL.

property query_type: str

Get the short name for supported query, e.g. “cql”.

property query_parameter_names: List[str]

Get the list of query parameters.

supports_version(version: SRUVersion | None) → bool

Check if query is supported by a specific version of SRU/CQL.

parse_query(version: SRUVersion, parameters: Dict[str, str], diagnostics: SRUDiagnosticList) → SRUQuery[CQLQuery] | None

Parse a query into an abstract syntax tree.

Parameters:

• version – the SRU version the request was made

• parameters – the request parameters containing the query

• diagnostics – a SRUDiagnosticList for storing fatal and non-fatal diagnostics

Returns:

the parsed query or None if the query could not be parsed