mirror of
https://github.com/cool-RR/PySnooper.git
synced 2026-01-23 10:15:11 +00:00
Add docs
This commit is contained in:
parent
28ede280fc
commit
a0ff31dd8a
2 changed files with 32 additions and 0 deletions
26
README.md
26
README.md
|
|
@ -81,6 +81,14 @@ See values of some variables that aren't local variables:
|
|||
@pysnooper.snoop(variables=('foo.bar', 'self.whatever'))
|
||||
```
|
||||
|
||||
Expand values to see all their attributes or items of lists/dictionaries:
|
||||
|
||||
```python
|
||||
@pysnooper.snoop(exploding_variables=('foo', 'self'))
|
||||
```
|
||||
|
||||
(see [Advanced Usage](#advanced-usage) for more control)
|
||||
|
||||
Show snoop lines for functions that your function calls:
|
||||
|
||||
```python
|
||||
|
|
@ -99,6 +107,24 @@ Start all snoop lines with a prefix, to grep for them easily:
|
|||
$ pip install pysnooper
|
||||
```
|
||||
|
||||
# Advanced Usage #
|
||||
|
||||
`exploding_variables` will automatically guess how to expand the expression passed to it based on its class. You can be more specific by using one of the following classes:
|
||||
|
||||
```python
|
||||
import pysnooper
|
||||
|
||||
@pysnooper.snoop(variables=(
|
||||
pysnooper.Attrs('x'), # attributes
|
||||
pysnooper.Keys('y'), # mapping (e.g. dict) items
|
||||
pysnooper.Indices('z'), # sequence (e.g. list/tuple) items
|
||||
))
|
||||
```
|
||||
|
||||
Exclude specific keys/attributes/indices with the `exclude` parameter, e.g. `Attrs('x', exclude=('_foo', '_bar'))`.
|
||||
|
||||
Add a slice after `Indices` to only see the values within that slice, e.g. `Indices('z')[-3:]`.
|
||||
|
||||
# Contribute #
|
||||
|
||||
[Pull requests](https://github.com/cool-RR/PySnooper/pulls) are always welcome!
|
||||
|
|
|
|||
|
|
@ -58,6 +58,12 @@ def snoop(output=None, variables=(), exploded_variables=(), depth=1, prefix='',
|
|||
|
||||
@pysnooper.snoop(variables=('foo.bar', 'self.whatever'))
|
||||
|
||||
Expand values to see all their attributes or items of lists/dictionaries:
|
||||
|
||||
@pysnooper.snoop(exploding_variables=('foo', 'self'))
|
||||
|
||||
(see Advanced Usage in the README for more control)
|
||||
|
||||
Show snoop lines for functions that your function calls::
|
||||
|
||||
@pysnooper.snoop(depth=2)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue