API Reference

Everything below is available from the package root:

import neoprint as np

Printing

All printing functions return None. A markup passed as the first or last positional argument is merged with the shorthand’s own markup, so np.warning(x, ':n') is the same as np.show(x, ':v6n').

np.vshow exists as the :n1 shorthand, but variable-name resolution keys on the called function name, and vshow is not recognizable to the analyzer. Use np.show(x, ':n1') instead.

markdown

markdown(*args: str) -> None

Accept one argument (the Markdown text) or two arguments (the text and a markup, in either order):

np.markdown('# Title\n\nSome **bold** text.')
np.markdown(':n', '**bold**')

Formatting

format(*args, markup=None) -> str

Returns the same layout that np.show would print, but with color codes stripped, so it can be logged to a file or embedded in another message.

format_list(*args, markup=None) -> list[TextObject]

The lower-level pipeline. Each returned object has a render(color_code_scheme=...) method, where the scheme is 'plain', 'ansi', or 'bbcode'. Use it when you want to post-process pieces rather than print them directly. The remaining parameters (_frame, _elevate_parent_level, _mark_position, _raise_builtin_print) are internal.

Text objects

Text(obj, color='default', style='')

A piece of text with an explicit color and style. True, False, and None are rendered green, red, and magenta by default. Colors can be names, Rich styles, or #rrggbb values.

Markdown(text)

A Rich-rendered Markdown block. Prefer np.markdown() for printing, which also takes care of the markup and line break.

Scopes and counters

scope(name='') -> contextmanager

Opens a named scope for the with block. Inside it, :i2 (and np.index) counts per scope and :t3 reports scope-level timing. Without a name, a random short id is generated.

Progress bars

Progress(total=None, indicator_style='counter', color='red')

A manual progress bar. indicator_style is one of 'counter', 'digital', 'decimal', or 'none'; color is one of 'blue', 'green', 'yellow', 'red'.

Methods:

total is required for a normal bar. A Progress without a total raises NotImplementedError on the first update().

progress(obj, total=None, **kwargs) -> Iterator

A generator that wraps an iterable and advances automatically. For concrete sized containers, total is inferred from len(obj); generators need an explicit total.

ProgressItem(data, label='')

Wraps one item of a progress() iteration to attach a label. The loop receives data, and the bar shows label (or str(data) when omitted).

Spinner and spinner() are exported as reserved names and are not implemented yet.

Configuration

config(**kwargs) -> None
config.reset() -> None

Change global options, or restore defaults. See Configuration for the full option table.

Package control

setup(package_name=None) -> None
unload() -> None

np.setup(__package__) replaces the builtin print with np.print for the given package, so existing print calls gain neoprint’s formatting without being edited. np.unload() restores the builtin print.

Advanced