pip._vendor.pygments.modeline Namespace Reference

Functions
	get_filetype_from_line (l)
	get_filetype_from_buffer (buf, max_lines=5)

Variables
	modeline_re = re.compile(, re.VERBOSE)

Detailed Description

    pygments.modeline
    ~~~~~~~~~~~~~~~~~

    A simple modeline parser (based on pymodeline).

    :copyright: Copyright 2006-2023 by the Pygments team, see AUTHORS.
    :license: BSD, see LICENSE for details.

Function Documentation

get_filetype_from_buffer()

get_filetype_from_buffer	(		buf,
			max_lines = 5
	)

Scan the buffer for modelines and return filetype if one is found.

Definition at line 28 of file modeline.py.

def get_filetype_from_buffer(buf, max_lines=5):
    """
    Scan the buffer for modelines and return filetype if one is found.
    """
    lines = buf.splitlines()
    for l in lines[-1:-max_lines-1:-1]:
        ret = get_filetype_from_line(l)
        if ret:
            return ret
    for i in range(max_lines, -1, -1):
        if i < len(lines):
            ret = get_filetype_from_line(lines[i])
            if ret:
                return ret
 
    return None

References pip._vendor.pygments.modeline.get_filetype_from_line(), and i.

Here is the call graph for this function:

get_filetype_from_line()

get_filetype_from_line

(

l

)

Definition at line 22 of file modeline.py.

def get_filetype_from_line(l):
    m = modeline_re.search(l)
    if m:
        return m.group(1)
 
 

References i.

Referenced by pip._vendor.pygments.modeline.get_filetype_from_buffer().

Here is the caller graph for this function:

Variable Documentation

modeline_re

modeline_re = re.compile(, re.VERBOSE)

Definition at line 16 of file modeline.py.