Pygments

https://pygments.org/docs/
Admin
Pygments is a syntax highlighter that converts source code into formatted output with colored...
Tokens:120,769
Snippets:1,290
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### MSDOSSessionLexer example session

Source: https://pygments.org/docs/lexers

Example session for MSDOSSessionLexer, showing a prompt, command, and continuation prompt.

```doscon
[any]> dir
> dir
More? dir
```

--------------------------------

### BashSessionLexer example session

Source: https://pygments.org/docs/lexers

Example session for BashSessionLexer, showing prompts, commands, and output. Demonstrates multi-line continuation with backslash and prompt changes for su and virtualenv.

```shell-session
user@host:~/path$ ls -a
.  ..  a  b  c
user@host:~/path$ diff -u a b
--- a   2008-07-26 17:10:07.000000000 -0700
+++ b   2008-07-26 17:10:10.000000000 -0700
@@ -1,3 +1,3 @@
 a
-b
+x
 c
user@host:~/path$ echo \
> a
a
user@host:~/path$ su
root@host:~#
sh-3.1$ # on hardy
sh$ # on etch
(virtualenv-name)user@host:~$ ls -a
```

--------------------------------

### Example HTML output from Pygments highlighting

Source: https://pygments.org/docs/java

Sample output produced by the Java example, showing the HTML markup generated for a simple Python print statement.

```html
<div class="highlight">
<pre><span class="k">print</span> <span class="s">&quot;Hello World&quot;</span></pre>
</div>
```

--------------------------------

### PsySH console output example

Source: https://pygments.org/docs/lexers

Example of PsySH console output that PsyshConsoleLexer highlights. Shows a closure definition and its invocation with the resulting output.

```php
>>> $greeting = function($name): string {
...     return "Hello, {$name}";
... };
=> Closure($name): string {#2371 …3}
>>> $greeting('World')
=> "Hello, World"
```

--------------------------------

### PowerShellSessionLexer example session

Source: https://pygments.org/docs/lexers

Example session for PowerShellSessionLexer, showing prompts and commands.

```pwsh-session
PS[any]> Get-ChildItem
PS> Get-ChildItem
>> Get-ChildItem
```

--------------------------------

### Lexer subclass __init__ example

Source: https://pygments.org/docs/api

Shows how a subclass of Lexer should process its own options and then call the base Lexer constructor. The example sets a custom option 'compress' with a default of an empty string before delegating to Lexer.__init__.

```python
def __init__(self, **options):
    self.compress = options.get('compress', '')
    Lexer.__init__(self, **options)

```

--------------------------------

### TcshSessionLexer example session

Source: https://pygments.org/docs/lexers

Example session for TcshSessionLexer, showing a prompt and command.

```tcshcon
(any)> ls -lh
? ls -lh
```

--------------------------------

### SqliteConsoleLexer example session

Source: https://pygments.org/docs/lexers

Example session for the SqliteConsoleLexer, showing sqlite3 prompts, schema creation, error handling, and a query with results. Use this to test lexing of sqlite3 console output.

```sqlite3
SQLite version 3.4.2
Enter ".help" for instructions
sqlite> .schema
CREATE TABLE paste (paste_id integer, code text, parsed_code text, pub_date
varchar(24), language varchar(64), parent_id integer, url varchar(128));
CREATE TABLE vars (key varchar(24), value varchar(128));
sqlite> a '
   ...> '
   ...> ;
SQL error: near "a": syntax error
sqlite> %;
SQL error: near "%": syntax error
sqlite> select count(language), language from paste group by language order
   ...> by count(language) desc;
144|python
76|text
22|pycon
9|ruby
7|c
7|js
6|html+django
4|html
4|tex
2|html+php
1|cpp
1|scheme
sqlite> 
```

--------------------------------

### Julia console session example

Source: https://pygments.org/docs/lexers

Example of a Julia console session using the JuliaConsoleLexer. Shows a REPL prompt with a function definition and a call, including a recursive call and a comment. The output '6' is displayed after the call.

```julia
julia> x = 2
2

julia> """
        The factorial function.

        ```julia
        @assert fac(3) == 1 * 2 * 3
        ```
        """
        function fac(n)
            if n < 2
                return 1
            else
                return n * fac(n - 1) # <-- recursive call
            end
        end


        # Lets try the function out...
        f(x + 1)
6

```

--------------------------------

### Matlab session example

Source: https://pygments.org/docs/lexers

Example of a Matlab session, showing prompts, assignments, matrix output, division by zero, undefined function error, and cell array output. Modeled after PythonConsoleLexer.

```matlab
>>
>>
>> a = 'okay'

a =

okay

>> x = rand(3)    % a matrix

x =

    0.8147    0.9134    0.2785
    0.9058    0.6324    0.5469
    0.1270    0.0975    0.9575

>> 1/0

ans =

   Inf

>> foo
??? Undefined function or variable 'foo'.

>>
>>
>> {cos(2*pi), 'testing'}

ans =

    [1]    'testing'

>>
>>
>>

```

--------------------------------

### Node.js REPL session example

Source: https://pygments.org/docs/lexers

Example of an interactive Node.js REPL session showing variable assignment and comparison. The output includes 'undefined' after each assignment and the result of the comparison 'false'.

```text
> let a = 3
undefined
> a
3
> let b = '4'
undefined
> b
'4'
> b == a
false

```

--------------------------------

### LatexFormatter Verbatim output example

Source: https://pygments.org/docs/formatters

Example output of the LatexFormatter without the full option, showing a Verbatim environment with commandchars and \PY macros for token highlighting.

```latex
\begin{Verbatim}[commandchars=\\\{\}]
\PY{k}{def }\PY{n+nf}{foo}(\PY{n}{bar}):
    \PY{k}{pass}
\end{Verbatim}

```

--------------------------------

### Elixir iex console session example

Source: https://pygments.org/docs/lexers

Example of Elixir interactive console (iex) output, showing pattern matching and list operations. The output includes the prompts and results for each command.

```text
iex> [head | tail] = [1,2,3]
[1,2,3]
iex> head
1
iex> tail
[2,3]
iex> [head | tail]
[1,2,3]
iex> length [head | tail]
3
```

--------------------------------

### PostgresConsoleLexer psql session example

Source: https://pygments.org/docs/lexers

Example psql session demonstrating the PostgresConsoleLexer's handling of prompts, commands, errors, and output. It covers variable setting with \set, psql meta-commands, multiline queries, and various output formats. The lexer correctly distinguishes prompts like 'regression=#' and 'piro=>' and does not treat '->' in query plans as a prompt.

```psql
regression=# select foo;
ERROR:  column "foo" does not exist
CONTEXT:  PL/pgSQL function "test1" while casting return value to function's return type
LINE 1: select foo;
               ^
regression=# \q

peter@localhost testdb=> \a \t \x
Output format is aligned.
Tuples only is off.
Expanded display is on.

regression=# select '\x';
WARNING:  nonstandard use of escape in a string literal
LINE 1: select '\x';
               ^
HINT:  Use the escape string syntax for escapes, e.g., E'\r\n'.
 ?column? 
----------
 x
(1 row)

regression=# select E'\x';

piro=> \set foo 30;
piro=> select * from test where foo <= :foo;
 foo | bar 
-----+-----
  10 | 
  20 | 
(2 rows)

testdb=> \set foo 'my_table'
testdb=> SELECT * FROM :"foo";

testdb=> \set content `cat my_file.txt`
testdb=> INSERT INTO my_table VALUES (:'content');

regression=# select (
regression(# 1);
 ?column? 
----------
        1
(1 row)

piro=> select (
piro(> '
piro'> ' || $$
piro$> $$)
piro-> from "
piro"> foo";
ERROR:  relation "
foo" does not exist
LINE 5: from "
             ^

testdb=> CREATE TABLE my_table (
first integer not null default 0,
second text) ; -- end of command
CREATE TABLE

-- Table output
=# SELECT '0x10'::mpz AS "hex", '10'::mpz AS "dec",
-#        '010'::mpz AS oct, '0b10'::mpz AS bin;
 hex | dec | oct | bin
-----+-----+-----+-----
 16  | 10  | 8   | 2
(1 row)

-- One field output
regression=# select schemaname from  pg_tables limit 3;
 schemaname 
------------
 pg_catalog
 pg_catalog
 pg_catalog
(3 rows)

-- TODO: prompt in multiline comments still not handled correctly
test=> select 1 /* multiline
test*> and 2 /* and 3 */
test*> end comment */, 2;
 ?column? | ?column? 
----------+----------
        1 |        2

=# select 10.0, 1e-6, 1E+6;
 ?column? | ?column? | ?column? 
----------+----------+----------
     10.0 | 0.000001 |  1000000
(1 row)

regression=# begin;
BEGIN
regression=# create table asdf (foo serial primary key);
NOTICE:  CREATE TABLE will create implicit sequence "asdf_foo_seq" for serial column "asdf.foo"
NOTICE:  CREATE TABLE / PRIMARY KEY will create implicit index "asdf_pkey" for table "asdf"
CREATE TABLE
regression=# insert into asdf values (10) returning foo;
 foo 
-----
  10
(1 row)

INSERT 0 1
regression=# ROLLBACK ;
ROLLBACK

=> EXPLAIN SELECT * FROM tenk1
-> WHERE unique1 < 100;   -- Don't take -> in the plan as a prompt

                                  QUERY PLAN
------------------------------------------------------------------------------
 Bitmap Heap Scan on tenk1  (cost=2.37..232.35 rows=106 width=244)
   Recheck Cond: (unique1 < 100)
   ->  Bitmap Index Scan on tenk1_unique1  (cost=0.00..2.37 rows=106 width=0)
         Index Cond: (unique1 < 100)


-- don't swallow the end of a malformed line
test=> select 1,
'this line must be emitted'
```

--------------------------------

### Install Pygments with plugins extra

Source: https://pygments.org/docs/changelog

Install Pygments with the 'plugins' extra to ensure optimal plugin support on Python versions older than 3.8, where importlib.metadata is not available in the standard library.

```bash
pip install pygments[plugins]

```

--------------------------------

### DylanConsoleLexer example: interactive console output

Source: https://pygments.org/docs/lexers

Example of Dylan interactive console output, showing prompts and results. Use this to test the DylanConsoleLexer.

```dylan-console
? let a = 1;
=> 1
? a
=> 1

```

--------------------------------

### irb console output example

Source: https://pygments.org/docs/lexers

Example of Ruby interactive console (irb) output. Shows assignment and puts commands with their results.

```irb
irb(main):001:0> a = 1
=> 1
irb(main):002:0> puts a
1
=> nil

```

--------------------------------

### List styles as JSON with pygmentize -L --json

Source: https://pygments.org/docs/cmdline

Prints all installed styles and their descriptions as JSON. The --json option can be used with -L to output its contents as JSON.

```bash
$ pygmentize -L styles --json

```

--------------------------------

### Python console output example for PythonConsoleLexer

Source: https://pygments.org/docs/lexers

Example of Python console output or doctest that the PythonConsoleLexer is designed to highlight. It shows a simple assignment, a print statement, and a traceback for a division by zero error.

```python
>>> a = 'foo'
>>> print(a)
foo
>>> 1 / 0
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ZeroDivisionError: integer division or modulo by zero

```

--------------------------------

### SqliteConsoleLexer

Source: https://pygments.org/docs/lexers

Lexer for example sessions using sqlite3.

```APIDOC
## Lexer: SqliteConsoleLexer

### Description
Lexer for example sessions using sqlite3.

### Class
`pygments.lexers.sql.SqliteConsoleLexer`

### Short Names
- `sqlite3`

### Filenames
- `*.sqlite3-console`

### MIME Types
- `text/x-sqlite3-console`

### Added in Version
0.11
```

--------------------------------

### R console transcript example for RConsoleLexer

Source: https://pygments.org/docs/lexers

Example transcript for the RConsoleLexer, showing R startup messages, a syntax error, function definition, and output. Use this to test lexing of R console transcripts or R CMD BATCH output files.

```r
R version 2.9.2 (2009-08-24)
Copyright (C) 2009 The R Foundation for Statistical Computing
ISBN 3-900051-07-0

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

  Natural language support but running in an English locale

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

[R.app GUI 1.29 (5464) i386-apple-darwin8.11.1]

> x <- function {}
Error: syntax error
> x <- function() {}
> x <- function() {
+ cat("hello")
+ cat("world")
+ }
> x
function() {
cat("hello")
cat("world")
}
> x()
helloworld
> 2 + 2
[1] 4
> 
```

--------------------------------

### Get help for HTML formatter with pygmentize -H

Source: https://pygments.org/docs/cmdline

Prints detailed help for the HTML formatter. The -H option gives the same information found in the documentation about a lexer, formatter, or filter.

```bash
$ pygmentize -H formatter html

```

--------------------------------

### DiffLexer using RegexLexer

Source: https://pygments.org/docs/lexerdevelopment

Complete DiffLexer example from the builtin lexers. It uses a single state 'root' and includes name, aliases, and filenames attributes for the builtin lexer lookup functions.

```python
from pygments.lexer import RegexLexer
from pygments.token import *

class DiffLexer(RegexLexer):
    name = 'Diff'
    aliases = ['diff']
    filenames = ['*.diff']

    tokens = {
        'root': [
            (r' .*\n', Text),
            (r'\+.*\n', Generic.Inserted),
            (r'-.*\n', Generic.Deleted),
            (r'@.*\n', Generic.Subheading),
            (r'Index.*\n', Generic.Heading),
            (r'=.*\n', Generic.Heading),
            (r'.*\n', Text),
        ]
    }

```

--------------------------------

### Get help for Python lexer with pygmentize -H

Source: https://pygments.org/docs/cmdline

Prints detailed help for the Python lexer. The -H option gives the same information found in the documentation about a lexer, formatter, or filter.

```bash
$ pygmentize -H lexer python

```

--------------------------------

### Generate full HTML document with pygmentize

Source: https://pygments.org/docs/quickstart

Produces a full HTML document with an included stylesheet, using the 'full' option.

```bash
$ pygmentize -f html -O full -o test.html test.py

```

--------------------------------

### Split token type hierarchy and get parent

Source: https://pygments.org/docs/tokens

Splits a token type into its hierarchy and gets its parent token type. The split returns a list of token types from the root to the specific token.

```python
>>> String.split()
[Token, Token.Literal, Token.Literal.String]
>>> String.parent
Token.Literal
```

--------------------------------

### Source configuration file to apply changes

Source: https://pygments.org/docs/terminaltips

Run source on the edited configuration file to apply the alias changes to the current shell environment.

```bash
$ source [~/.filenamerc]

```

--------------------------------

### get_choice_opt()

Source: https://pygments.org/docs/api

Get a choice option from a dictionary.

```APIDOC
## get_choice_opt()

### Description
Get a choice option from a dictionary.

### Method
N/A (Python function)

### Endpoint
N/A

### Parameters
- **options** (dict) - The options dictionary.
- **optname** (str) - The option name.
- **choices** (list) - The allowed choices.
- **default** (str) - Optional - Default value.

### Request Example
N/A

### Response
#### Success Response
- **value** (str) - The option value.

#### Response Example
N/A
```

--------------------------------

### get_list_opt()

Source: https://pygments.org/docs/api

Get a list option from a dictionary.

```APIDOC
## get_list_opt()

### Description
Get a list option from a dictionary.

### Method
N/A (Python function)

### Endpoint
N/A

### Parameters
- **options** (dict) - The options dictionary.
- **optname** (str) - The option name.
- **default** (list) - Optional - Default value.

### Request Example
N/A

### Response
#### Success Response
- **value** (list) - The option value.

#### Response Example
N/A
```

--------------------------------

### get_int_opt()

Source: https://pygments.org/docs/api

Get an integer option from a dictionary.

```APIDOC
## get_int_opt()

### Description
Get an integer option from a dictionary.

### Method
N/A (Python function)

### Endpoint
N/A

### Parameters
- **options** (dict) - The options dictionary.
- **optname** (str) - The option name.
- **default** (int) - Optional - Default value.

### Request Example
N/A

### Response
#### Success Response
- **value** (int) - The option value.

#### Response Example
N/A
```

--------------------------------

### Load custom lexer from command line

Source: https://pygments.org/docs/lexerdevelopment

Load and test a custom lexer from the command line using the -x flag. The lexer file must contain a class named CustomLexer.

```bash
$ python -m pygments -x -l your_lexer_file.py <inputfile>

```

--------------------------------

### get_bool_opt()

Source: https://pygments.org/docs/api

Get a boolean option from a dictionary.

```APIDOC
## get_bool_opt()

### Description
Get a boolean option from a dictionary.

### Method
N/A (Python function)

### Endpoint
N/A

### Parameters
- **options** (dict) - The options dictionary.
- **optname** (str) - The option name.
- **default** (bool) - Optional - Default value.

### Request Example
N/A

### Response
#### Success Response
- **value** (bool) - The option value.

#### Response Example
N/A
```

--------------------------------

### HexdumpLexer example output

Source: https://pygments.org/docs/lexers

Example of a typical hex dump output format supported by the HexdumpLexer. The format matches the output of `hexdump -C FILE`, which is also used by `hd FILE`. The lexer recognizes outputs from UNIX and GNU/Linux tools such as `hexdump`, `hd`, `hexcat`, `od`, and `xxd`, as well as the DOS tool `DEBUG`.

```text
00000000  7f 45 4c 46 02 01 01 00  00 00 00 00 00 00 00 00  |.ELF............|
00000010  02 00 3e 00 01 00 00 00  c5 48 40 00 00 00 00 00  |..>......H@.....|

```

--------------------------------

### get_all_styles()

Source: https://pygments.org/docs/api

Return a list of all available styles.

```APIDOC
## get_all_styles()

### Description
Return a list of all available styles.

### Method
N/A (Python function)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **styles** (list) - List of style names.

#### Response Example
N/A
```

--------------------------------

### Output HTML with pygmentize -f html

Source: https://pygments.org/docs/quickstart

Writes an HTML-highlighted version of test.py to test.html. Note that it produces only a snippet of HTML, not a full document.

```bash
$ pygmentize -f html -o test.html test.py

```

--------------------------------

### Override get_tokens_unprocessed() to start in a different state

Source: https://pygments.org/docs/lexerdevelopment

Override get_tokens_unprocessed() to start lexing in a different state by providing a custom initial stack. Some lexers like PhpLexer use this to make leading <?php preprocessor comments optional; note that putting values into the stack that don't exist in the token map can crash the lexer, and removing 'root' can cause strange errors.

```python
from pygments.lexer import RegexLexer

class ExampleLexer(RegexLexer):
    tokens = {...}

    def get_tokens_unprocessed(self, text, stack=('root', 'otherstate')):
        for item in RegexLexer.get_tokens_unprocessed(self, text, stack):
            yield item

```
Tokens:
Raw