qiskit.qasm.OpenQASMLexer

class OpenQASMLexer(*args, **kwds)

A pygments lexer for OpenQasm.

__init__(**options)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(**options)	Initialize self.
add_filter(filter_, **options)	Add a new stream filter to this lexer.
analyse_text(text)	Has to return a float between 0 and 1 that indicates if a lexer wants to highlight this text.
get_tokens(text[, unfiltered])	Return an iterable of (tokentype, value) pairs generated from text.
get_tokens_unprocessed(text[, stack])	Split text into (tokentype, text) pairs.

Attributes

alias_filenames
aliases
filenames
flags
gates
mimetypes
name
priority
tokens

add_filter(filter_, **options)

Add a new stream filter to this lexer.

static analyse_text(text)

Has to return a float between 0 and 1 that indicates if a lexer wants to highlight this text. Used by guess_lexer. If this method returns 0 it won’t highlight it in any case, if it returns 1 highlighting with this lexer is guaranteed.

The LexerMeta metaclass automatically wraps this function so that it works like a static method (no self or cls parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was 0.0.

get_tokens(text, unfiltered=False)

Return an iterable of (tokentype, value) pairs generated from text. If unfiltered is set to True, the filtering mechanism is bypassed even if filters are defined.

Also preprocess the text, i.e. expand tabs and strip it if wanted and applies registered filters.

get_tokens_unprocessed(text, stack=('root'))

Split text into (tokentype, text) pairs.

stack is the inital stack (default: ['root'])