typed_print

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #golang #go #android #deep-learning #linux #macos #nodejs #kubernetes #vue #security #open-source

(★ 27)

Easily beautify your logs with a drop-in replacement for the print function.

typed_print Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Example
If you print something in your terminal or notebook, e.g.
```python
print('Epoch [4/300]', 3, 3231.32, 'loss=-22.4e-9 time=121mc')
```
you will see a very bleak output:
<p align="center">
  <img height=22 src="https://raw.githubusercontent.com/DmitryUlyanov/dmitryulyanov.github.io/master/assets/typed_print/args_no_color.png">
</p>

**Typed_print** gets your logs a little bit more cheerful and easy to read.

The output is colorized based on the argument's type. Additionally, some keywords can be highlighted (like `Epoch` here). If you print a string, the numbers in the string will get highlighted.

- For a light background you will get:
<p align="center">
  <img height=29  src="https://raw.githubusercontent.com/DmitryUlyanov/dmitryulyanov.github.io/master/assets/typed_print/args_light.png">
</p>

- For a dark background:
<p align="center">
<img height=30  src="https://raw.githubusercontent.com/DmitryUlyanov/dmitryulyanov.github.io/master/assets/typed_print/args_dark.png"/>
</p>

-------
Of course, everything is customizable. For example, you can override list printing like that:
```python
print([131, 'I love cats', 'String with number 9'])
```
<table style="border-width:0px; width:100%">
  <th>Light palette</th>
  <th>Dark palette</th>
  <tr>
    <td width=50%><img src="https://raw.githubusercontent.com/DmitryUlyanov/dmitryulyanov.github.io/master/assets/typed_print/list_light.png"/></td>
    <td width=50%><img src="https://raw.githubusercontent.com/DmitryUlyanov/dmitryulyanov.github.io/master/assets/typed_print/list_dark.png"/></td>
  </tr>
</table>

# Features

- Type-based coloring and printing layout.
- Automatic highlighting guided by regexp or list of keywords.
- Extensible and customizable framework: easily change representation for objects of any type including the built-in types like `int`, `list`, `dict`, etc.

# Install

```
pip install typed_print
```

Tested with Ubuntu 14.04 and Python 3.6.

# Usage

For the examples above the printing function is initialized as follows:
```python
import typed_print as tp

print = tp.init(palette='light', # or 'dark' 
                str_mode=tp.HIGHLIGHT_NUMBERS, 
                highlight_word_list=['Epoch'])
```

## Arguments

- `palette`: highlighting palette. Use `dark` if the background of your terminal is dark and `light` otherwise
- `str_mode`: what to highlight in strings and sting representations of objects of unknown types. Possible values are:
  - `tp.HIGHLIGHT_NOTHING`
  - `tp.HIGHLIGHT_DIGITS`
  - `tp.HIGHLIGHT_NUMBERS`
  - `tp.HIGHLIGHT_CUSTOM`: in this case you should pass a compiled regex extractor as `re_custom` argument to `tp.init`, e.g.
    - `re_custom=re.compile("\d+")`
- `custom_type_map`: a dictionary with correspondence `type:processor_fn`. `processor_fn` should return string representation for the object, similarly to `__str__` or `__repr__`.
  - `highlight_word_list`: a list of words to highlight. In the example above `highlight_word_list=['Epoch']`

## Why overriding print function?
 I did not find a way to override `__str__` or `__repr__` methods for the built-in types. Thus the only way to change the way the objects of built-in type are printed is to override `print` function.

UPDATE: @alex-bender mentioned [here](https://github.com/DmitryUlyanov/typed_print/issues/1) that there is actually a way to override built-in types.

typed_print

typed_print Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

typed_print

typed_print Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README