pygments.lexers.ruby.RubyLexer

class documentation

class RubyLexer(ExtendedRegexLexer):

For Ruby source code.

Method	`analyse_text`	No summary
Method	`gen_rubystrings_rules`	Undocumented
Method	`heredoc_callback`	Undocumented
Class Variable	`aliases`	Undocumented
Class Variable	`filenames`	Undocumented
Class Variable	`flags`	Undocumented
Class Variable	`mimetypes`	Undocumented
Class Variable	`name`	Undocumented
Class Variable	`tokens`	Undocumented

Inherited from ExtendedRegexLexer:

Method get_tokens_unprocessed Split text into (tokentype, text) pairs. If context is given, use this lexer context instead.

Inherited from Lexer (via ExtendedRegexLexer, RegexLexer):

Method	`get_tokens`	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.
Class Variable	`alias_filenames`	Undocumented
Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`add_filter`	Add a new stream filter to this lexer.
Class Variable	`priority`	Undocumented
Instance Variable	`encoding`	Undocumented
Instance Variable	`ensurenl`	Undocumented
Instance Variable	`filters`	Undocumented
Instance Variable	`options`	Undocumented
Instance Variable	`stripall`	Undocumented
Instance Variable	`stripnl`	Undocumented
Instance Variable	`tabsize`	Undocumented

def analyse_text(text):

overrides pygments.lexer.Lexer.analyse_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.

def gen_rubystrings_rules():

Undocumented

def heredoc_callback(self, match, ctx):

Undocumented

aliases: list[str] =

overrides pygments.lexer.Lexer.aliases

Undocumented

filenames: list[str] =

overrides pygments.lexer.Lexer.filenames

Undocumented

flags =

Undocumented

mimetypes: list[str] =

overrides pygments.lexer.Lexer.mimetypes

Undocumented

name: str =

overrides pygments.lexer.Lexer.name

Undocumented

tokens =

overrides pygments.lexer.RegexLexer.tokens

Undocumented