pygments.filters.GobbleFilter Class Reference

Inheritance diagram for pygments.filters.GobbleFilter:

Collaboration diagram for pygments.filters.GobbleFilter:

Public Member Functions
	__init__ (self, **options)
	gobble (self, value, left)
	filter (self, lexer, stream)

Public Attributes
	n
Public Attributes inherited from pygments.filter.Filter
	options

Detailed Description

Gobbles source code lines (eats initial characters).

This filter drops the first ``n`` characters off every line of code.  This
may be useful when the source code fed to the lexer is indented by a fixed
amount of space that isn't desired in the output.

Options accepted:

`n` : int
   The number of characters to gobble.

.. versionadded:: 1.2

Constructor & Destructor Documentation

__init__()

pygments.filters.GobbleFilter.__init__	(		self,
		**	options
	)

Reimplemented from pygments.filter.Filter.

Member Function Documentation

filter()

pygments.filters.GobbleFilter.filter	(		self,
			lexer,
			stream
	)

Reimplemented from pygments.filter.Filter.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pygments/filters/__init__.py