jprint2 0.1.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- jprint2/__init__.py +10 -0
- jprint2/defaults.py +45 -0
- jprint2/jformat.py +56 -0
- jprint2/jprint.py +53 -0
- jprint2-0.1.1.dist-info/METADATA +73 -0
- jprint2-0.1.1.dist-info/RECORD +8 -0
- jprint2-0.1.1.dist-info/WHEEL +4 -0
- jprint2-0.1.1.dist-info/licenses/LICENSE +21 -0
jprint2/__init__.py
ADDED
jprint2/defaults.py
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
from typing import Callable, Any
|
2
|
+
|
3
|
+
import jsons
|
4
|
+
|
5
|
+
|
6
|
+
def default_formatter(
|
7
|
+
value: Any,
|
8
|
+
indent: int = 4,
|
9
|
+
sort_keys: bool = False,
|
10
|
+
ensure_ascii: bool = False,
|
11
|
+
):
|
12
|
+
return jsons.dumps(
|
13
|
+
value,
|
14
|
+
jdkwargs=dict(
|
15
|
+
indent=indent,
|
16
|
+
sort_keys=sort_keys,
|
17
|
+
ensure_ascii=ensure_ascii,
|
18
|
+
),
|
19
|
+
)
|
20
|
+
|
21
|
+
|
22
|
+
defaults = {
|
23
|
+
"keep_strings": True,
|
24
|
+
"indent": 2,
|
25
|
+
"sort_keys": False,
|
26
|
+
"ensure_ascii": False,
|
27
|
+
"formatter": default_formatter,
|
28
|
+
}
|
29
|
+
|
30
|
+
USE_DEFAULT = object()
|
31
|
+
|
32
|
+
|
33
|
+
def set_defaults(
|
34
|
+
keep_strings: bool = False,
|
35
|
+
indent: int = 4,
|
36
|
+
sort_keys: bool = False,
|
37
|
+
ensure_ascii: bool = False,
|
38
|
+
formatter: Callable = jsons.dumps,
|
39
|
+
):
|
40
|
+
defaults["keep_strings"] = keep_strings
|
41
|
+
defaults["indent"] = indent
|
42
|
+
defaults["sort_keys"] = sort_keys
|
43
|
+
defaults["ensure_ascii"] = ensure_ascii
|
44
|
+
defaults["formatter"] = formatter
|
45
|
+
return defaults
|
jprint2/jformat.py
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
from typing import Any, Callable
|
2
|
+
import jsons
|
3
|
+
|
4
|
+
from jprint2.defaults import USE_DEFAULT, defaults
|
5
|
+
|
6
|
+
try:
|
7
|
+
import ujson as json
|
8
|
+
except ImportError:
|
9
|
+
import json
|
10
|
+
|
11
|
+
|
12
|
+
def jformat(
|
13
|
+
value: Any,
|
14
|
+
keep_strings: bool = USE_DEFAULT,
|
15
|
+
formatter: Callable = USE_DEFAULT,
|
16
|
+
indent: int = USE_DEFAULT,
|
17
|
+
sort_keys: bool = USE_DEFAULT,
|
18
|
+
ensure_ascii: bool = USE_DEFAULT,
|
19
|
+
):
|
20
|
+
# - Process arguments
|
21
|
+
|
22
|
+
keep_strings = (
|
23
|
+
defaults["keep_strings"] if keep_strings is USE_DEFAULT else keep_strings
|
24
|
+
)
|
25
|
+
indent = defaults["indent"] if indent is USE_DEFAULT else indent
|
26
|
+
sort_keys = defaults["sort_keys"] if sort_keys is USE_DEFAULT else sort_keys
|
27
|
+
ensure_ascii = (
|
28
|
+
defaults["ensure_ascii"] if ensure_ascii is USE_DEFAULT else ensure_ascii
|
29
|
+
)
|
30
|
+
formatter = defaults["formatter"] if formatter is USE_DEFAULT else formatter
|
31
|
+
|
32
|
+
# - Return if keep_strings is True and value is a string
|
33
|
+
|
34
|
+
if keep_strings and isinstance(value, str):
|
35
|
+
return value
|
36
|
+
|
37
|
+
# - Format and return
|
38
|
+
|
39
|
+
return formatter(
|
40
|
+
value,
|
41
|
+
indent=indent,
|
42
|
+
sort_keys=sort_keys,
|
43
|
+
ensure_ascii=ensure_ascii,
|
44
|
+
)
|
45
|
+
|
46
|
+
|
47
|
+
def test():
|
48
|
+
assert jformat(1) == "1"
|
49
|
+
assert jformat("1") == "1"
|
50
|
+
assert jformat({"a": 1}) == '{"a": 1}'
|
51
|
+
assert jformat({"a": 1}, keep_strings=True) == '{"a": 1}'
|
52
|
+
assert jformat({"a": 1}, keep_strings=False) == '{"a": 1}'
|
53
|
+
|
54
|
+
|
55
|
+
if __name__ == "__main__":
|
56
|
+
test()
|
jprint2/jprint.py
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
from pygments import highlight
|
2
|
+
from pygments.lexers import JsonLexer
|
3
|
+
from pygments.formatters import TerminalFormatter
|
4
|
+
|
5
|
+
from typing import Union, Any, Callable
|
6
|
+
from jprint2.defaults import defaults, USE_DEFAULT
|
7
|
+
from jprint2.jformat import jformat
|
8
|
+
|
9
|
+
|
10
|
+
def jprint(
|
11
|
+
value: Any,
|
12
|
+
keep_strings: bool = USE_DEFAULT,
|
13
|
+
formatter: Callable = USE_DEFAULT,
|
14
|
+
indent: int = USE_DEFAULT,
|
15
|
+
sort_keys: bool = USE_DEFAULT,
|
16
|
+
ensure_ascii: bool = USE_DEFAULT,
|
17
|
+
colorize: bool = True,
|
18
|
+
):
|
19
|
+
# - Get json string
|
20
|
+
|
21
|
+
json_string = jformat(
|
22
|
+
value,
|
23
|
+
keep_strings=keep_strings,
|
24
|
+
formatter=formatter,
|
25
|
+
indent=indent,
|
26
|
+
sort_keys=sort_keys,
|
27
|
+
ensure_ascii=ensure_ascii,
|
28
|
+
)
|
29
|
+
|
30
|
+
# - Colorize if needed
|
31
|
+
|
32
|
+
if colorize:
|
33
|
+
json_string = highlight(
|
34
|
+
code=json_string,
|
35
|
+
lexer=JsonLexer(),
|
36
|
+
formatter=TerminalFormatter(),
|
37
|
+
)
|
38
|
+
|
39
|
+
# - Print
|
40
|
+
|
41
|
+
print(json_string.strip())
|
42
|
+
|
43
|
+
|
44
|
+
def example():
|
45
|
+
print()
|
46
|
+
import json
|
47
|
+
|
48
|
+
jprint({"name": "Mark", "age": 30}, formatter=json.dumps)
|
49
|
+
jprint('{"name": "Mark"}', keep_strings=False)
|
50
|
+
|
51
|
+
|
52
|
+
if __name__ == "__main__":
|
53
|
+
example()
|
@@ -0,0 +1,73 @@
|
|
1
|
+
Metadata-Version: 2.4
|
2
|
+
Name: jprint2
|
3
|
+
Version: 0.1.1
|
4
|
+
Summary: Simple json printer for python
|
5
|
+
Author-email: Mark Lidenberg <marklidenberg@gmail.com>
|
6
|
+
License: MIT
|
7
|
+
License-File: LICENSE
|
8
|
+
Classifier: Intended Audience :: Developers
|
9
|
+
Classifier: License :: OSI Approved :: MIT License
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
11
|
+
Classifier: Programming Language :: Python :: 3.8
|
12
|
+
Classifier: Programming Language :: Python :: 3.9
|
13
|
+
Classifier: Programming Language :: Python :: 3.10
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
17
|
+
Requires-Python: >=3.8
|
18
|
+
Requires-Dist: jsons>=1.6.3
|
19
|
+
Requires-Dist: pygments>=2.19.1
|
20
|
+
Provides-Extra: dev
|
21
|
+
Requires-Dist: better-exceptions>=0.3.3; extra == 'dev'
|
22
|
+
Requires-Dist: build>=1.2.2.post1; extra == 'dev'
|
23
|
+
Requires-Dist: load-dotenv>=0.1.0; extra == 'dev'
|
24
|
+
Requires-Dist: questionary>=2.1.0; extra == 'dev'
|
25
|
+
Requires-Dist: twine>=6.1.0; extra == 'dev'
|
26
|
+
Description-Content-Type: text/markdown
|
27
|
+
|
28
|
+
# jprint2
|
29
|
+
|
30
|
+
Print any object in JSON. Built on top of [jsons](https://github.com/ramonhagenaars/jsons) for formatting and [pygments](https://pygments.org/) for colorizing.
|
31
|
+
|
32
|
+
## Basic usage
|
33
|
+
|
34
|
+
```python
|
35
|
+
|
36
|
+
from jprint2 import jprint, jformat, set_defaults
|
37
|
+
|
38
|
+
# - Print json
|
39
|
+
|
40
|
+
jprint({"name": "Mark", "age": 30}) # {"name": "Mark", "age": 30}
|
41
|
+
|
42
|
+
# - Keeps strings by default as is to preserve json objects
|
43
|
+
|
44
|
+
jprint("Mark") # Mark
|
45
|
+
jprint('{"name": "Mark"}') # {"name": "Mark"}
|
46
|
+
jprint('{"name": "Mark"}', keep_strings=False) # "{\"name\": \"Mark\"}"
|
47
|
+
|
48
|
+
# - Set defaults of your liking
|
49
|
+
|
50
|
+
set_defaults(
|
51
|
+
indent=2,
|
52
|
+
sort_keys=True
|
53
|
+
)
|
54
|
+
|
55
|
+
# - Format json
|
56
|
+
|
57
|
+
my_json_string = jformat({"name": "Mark", "age": 30})
|
58
|
+
|
59
|
+
# - Override defaults
|
60
|
+
|
61
|
+
jprint({"name": "🧙♂️", "age": 30}, ensure_ascii=True) # {"name": "\ud83e\uddd9\u200d\u2642\ufe0f", "age": 30}
|
62
|
+
|
63
|
+
```
|
64
|
+
|
65
|
+

|
66
|
+
|
67
|
+
## License
|
68
|
+
|
69
|
+
MIT License
|
70
|
+
|
71
|
+
## Author
|
72
|
+
|
73
|
+
Mark Lidenberg [marklidenberg@gmail.com](mailto:marklidenberg@gmail.com)
|
@@ -0,0 +1,8 @@
|
|
1
|
+
jprint2/__init__.py,sha256=YY2n0QV8t-aC_dYRTdzHxKAnFyNrgwO7X6pg3v4yGZc,227
|
2
|
+
jprint2/defaults.py,sha256=0t9NDTuyzqjyEJ0qcwBRuL_SqYX33Zge6V_q39MPRJg,914
|
3
|
+
jprint2/jformat.py,sha256=0pkBkaGYSLYJNFXhXviFjsKltuK0hRVqUKx5rIuvevg,1428
|
4
|
+
jprint2/jprint.py,sha256=AZMF2VDFVZ0pdNE1fooJBvWxiiYyilRzEaA65EkDQbc,1154
|
5
|
+
jprint2-0.1.1.dist-info/METADATA,sha256=y1dvfKQF9U5QeWcMCu9x7uNyTnX8xTTCdX8r_vAxo9E,2019
|
6
|
+
jprint2-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
7
|
+
jprint2-0.1.1.dist-info/licenses/LICENSE,sha256=xdHI81oRL12WI-XH0xKpafTL9Miwi4iGj_T2w4RJOgo,1070
|
8
|
+
jprint2-0.1.1.dist-info/RECORD,,
|
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2025 marklidenberg
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|