search_query.generic package

Submodules

search_query.generic.linter module

Linter for generic queries.

class search_query.generic.linter.GenericLinter(query_str: str = '')

Bases: QueryStringLinter

Linter for Generic Query Strings

PLATFORM: <PLATFORM.GENERIC: 'generic'> = 'generic'

VALID_FIELDS_REGEX: re.Pattern = re.compile('\\b(?:abstract|accession-nr|address|affiliation|all-fields|author|author-identifiers|city|conference|country-region|descriptors|doi|editor|funding-agency|funding-text|grant-nr|group-author|isbn|issn|)

field_codes = {'abstract', 'accession-nr', 'address', 'affiliation', 'all-fields', 'author', 'author-identifiers', 'city', 'conference', 'country-region', 'descriptors', 'doi', 'editor', 'funding-agency', 'funding-text', 'grant-nr', 'group-author', 'isbn', 'issn', 'issn-isbn', 'journal', 'keywords', 'keywords-author', 'keywords-plus', 'language', 'mesh-term', 'organization', 'organization-enhanced', 'pmid', 'province-state', 'publication-name', 'publication-type', 'publisher', 'research-area', 'sb', 'source', 'street-address', 'subject-terms', 'suborganization', 'text-word', 'title', 'topic', 'wos-category', 'year-publication', 'zip'}

messages: List[dict]

query: Optional[Query]

syntax_str_to_generic_search_field_set(field_value: str) → set

Translate a search field

tokens: List[Token]

validate_query_tree(query: Query) → None

Validate the query tree. This method is called after the query tree has been built.

validate_tokens(*, tokens: List[Token], query_str: str, search_field_general: str = '') → List[Token]

Performs a pre-linting

Module contents

Top-level package for generic queries.