summaryrefslogtreecommitdiff
path: root/python-jsontable.spec
blob: 3be9e9bb81e5f584896255fa00ae9a0cde8bfac3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
%global _empty_manifest_terminate_build 0
Name:		python-jsontable
Version:	0.1.1
Release:	1
Summary:	Convert a JSON to a table
License:	MIT License
URL:		https://github.com/ernestomonroy/jsontable
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/a6/ab/c367ce6f85cf0623ace14b178e507853e0b27d506421af58c0707ea90621/jsontable-0.1.1.tar.gz
BuildArch:	noarch


%description
# JSON Table

A little package to convert a JSON into a table! This project was born out of a need to transform many JSONs mined from APIs to something that Pandas or a relational database could understand. The difference between this package and json path packages is that its designed to create __tables__, not just extract single values.


<a href="https://pypi.org/project/jsontable/">
<img src="https://img.shields.io/pypi/v/jsontable.svg" alt="latest release" />
</a>


## How to install

The package is available through pypi. So simply go to your command line and:

```bash
pip install jsontable
```
You're also welcome to download the code from github and modify to suit your needs. And if you have time let me know what cool functionality you added and we can improve the project!

## How it works

It works in a similar manner to JSON parsers
1. Create a converter object
2. Give the converter a list of paths you want to explore and how you want to name each column
3. Give the converter a __decoded__ JSON object you want to read, and it returns a table

## Usage

Here is a quick example to get you going

```python
import jsontable as jsontable

#Create a list of paths you want to extract
paths = [{"$.id":"id"},	{"$.name":"name"}, {"$.address.city":"city"}]
#The JSON object you want to explore
sample = {"id":"1","name":"Foo","address":{"city":"Bar"}}

#Create an instance of a converter
converter = jsontable.converter()
#Set the paths you want to extract
converter.set_paths(paths)
#Input a JSON to be interpreted
converter.convert_json(sample)
```

In this case, you will get a table with two columns and two rows (header and first row of data) like these:

```python
[['id', 'name', 'city'], ['1', 'Foo', 'Bar']]
```

For more examples, refer to the [tests folder](/tests)

## How it works

#### JSON Paths

Each path you specify is a column in your final table. Each path that is setup is expanded according to the [standard JSON Path functionality](https://goessner.net/articles/JsonPath/). This is, for each path, the converter starts at the root of the JSON object and navigates each step (a.k.a node) of the path in order. When it reaches the final step in the path (a.k.a leaf), it outputs the resulting element of the JSON into the cell.

The __final cell value__ is converted based on the [standard JSON values](https://www.json.org/) as follows:

|JSON Value|Conversion|Sample Output|
|--|--|--|
|object|stringified object |`'{"city":"Bar"}'`|
|array|stringified array |`'[1,2,3]'`|
|string|string|'Foo'|
|number|number|4.7|
|boolean|stringidied boolean|'False'|
|null|None|None|
|_missing value_ (i.e. the path did not find an element)|None|None|

The intention behind stringifying the object, array and boolean is to be able to pass the output to other data libraries (e.g [Pandas](https://pandas.pydata.org/))  or to a relational database. 

#### Array Expansion

__With the exception of the final node__, array elements are automatically expanded into rows. So for example a path `'$.a.b'` applied to a JSON `{"a":[{"b":1},{"b":2}]}` would result into two rows `[[1],[2]]`. The array expansion functionality can be applied to the final node by explicitly using the `*` operator as a final step (e.g. `$.a.*`)

Example:
```python
paths = [{"$.name":"Name"},{"$.telephones.type":"Telephone Type"},{"$.telephones.number":"Telephone Number"}]
sample = {
			"name":"Foo",
			"telephones":[
				{"type":"mobile", "number":"0000"},
				{"type":"home", "number":"1111"}
			]
		}
converter = jsontable.converter()
converter.set_paths(paths)
converter.convert_json(sample)
```
Result:
```
[['Name', 'Telephone Number', 'Telephone Type'], ['Foo', '0000', 'mobile'], ['Foo', '1111', 'home']]
```

The reverse of this functionality (not expand arrays if they are encountered before the end) is not implemented only due to the lack of need.

#### Joining Columns

Since a path may result in multiple rows, there is the need to be able to combine the result of each column into the same table. The joining mechanism is similar to an SQL join, where each cell (row-cell combination) is "matched" to a row in the result using a "matching value". The matching value in this case is the last common element of the paths. 

This is best illustrated with an example, the following table shows the transformations applied to the sample JSON.

```python
sample = {
	"contacts":[
		{
			"name":"Foo",
			"telephones":[
				{"type":"mobile", "number":"0000"},
				{"type":"home", "number":"1111"}
			],
			"emails":[
				{"type":"work", "email":"foo@w.com"},
				{"type":"personal", "email":"foo@p.com"}
			]
		},
		{
			"name":"Bar",
			"telephones":[
				{"type":"mobile", "number":"2222"},
				{"type":"home", "number":"3333"}
			],
			"emails":[
				{"type":"work", "email":"bar@w.com"},
				{"type":"personal", "email":"bar@p.com"}
			]
		}
	]
}
```

<table>
	<tr><th>Paths</th><th>Result</th></tr>
	<tr>
		<td>
			<pre lang="python">
[
	{"$.contacts.name":"Name"},
	{"$.contacts.telephones.type":"Type"},
	{"$.contacts.telephones.number":"Number"}
]
			</pre>
		</td>
		<td>
			<pre lang="python">
[
	['Name', 'Type', 'Number'], 
	['Foo', 'mobile', '0000'], 
	['Foo', 'home', '1111'], 
	['Bar', 'mobile', '2222'], 
	['Bar', 'home', '3333']
]
			</pre>
		</td>
	</tr>
		<tr>
		<td>
			<pre lang="python">
[
	{"$.contacts.name":"Name"},
	{"$.contacts.telephones.number":"Number"},
	{"$.contacts.emails.email":"Email"}
]
			</pre>
		</td>
		<td>
			<pre lang="python">
[
	['Name', 'Number', 'Email'], 
	['Foo', '0000', 'foo@w.com'], 
	['Foo', '1111', 'foo@w.com'],
	['Foo', '0000', 'foo@p.com'], 
	['Foo', '1111', 'foo@p.com'],  
	['Bar', '0000', 'bar@w.com'], 
	['Bar', '1111', 'bar@w.com'],
	['Bar', '0000', 'bar@p.com'], 
	['Bar', '1111', 'bar@p.com'],  
]
			</pre>
		</td>
	</tr>
</table>

In the first case, the `type` and `number` have a common path `telephone` and therefore the columns are combined for the same telephone element. If we then look at the `name` path it has a common path `contacts` with the rest of the columns, and therefore, the value is repeated across the rows.

In the second case the `email` and `number` only have a common path `contacts` and since each path results in two rows, the only possible way to match these is to combine all the values, resulting in 4 rows per contact (total 8 rows since there are 2 contacts). 

## Operators

Currently there are two operators supported: * and ~

|Syntax|Description|
|--|--|
|`*`| Returns __all values__ of the current element. If its an array, it will return one row per array value. If its an object (dictionary in Python) it will return one row per __value__. If its a value (string, number, boolean, null), it returns the same value|
|`~`| Return __all indices__ of the current element. If its an array, it returns an ascending numbered sequence starting with 0 (e.g. [1,2] would return [[0],[1]]) . If its an object, it will return the keys (e.g. {"a":1,"b":2} would return [['a'],['b']]). If its a value it returns 0|

More operators will be implemented in later releases.

## New in this version

 - A bug that was preventing list expansions at different depths (e.g. $.a as well as $.b.c) has been fixed.
 - Implementation of the * and ~ operators

Both these changes were made possible by changing the search method from depth first to breadth first, as well as recursing through a tree rather than iterating through one column at a time. 

## Coming up

In the wishlist we have:
 - Filtering
 - List indexing
 - More functions (basic arithmetics, string concatenation and expansion)
 - Square bracket notation ($[a][b] for $.a.b)
 - Stringify objects as an option
 - Option to output pandas style named array
 - Method to set paths and convert at the same time
 - CSV Output/Input

## References

I want to mention that whilst I inted to expand the functionality of this package, at the moment it can only take a simple sequence of keys to navigate a path. This is, the full functionality proposed by Stefan Gossner in his [jsonpath](https://goessner.net/articles/JsonPath/) is not yet implemented.... but we will get there.

If you are looking for a package that simply extracts a single value from a JSON by using more complex paths (and its functions), I recommend you look at [jsonpath-rw](https://github.com/kennknowles/python-jsonpath-rw) by Kenn Knowles [jsonpath-ng](https://pypi.org/project/jsonpath-ng/) by Tomas Aparicio or [jsonpath2](https://pypi.org/project/jsonpath2/) by Mark Borkum. 

## Final disclaimer

I will continue to look for improvements in the package and hopefully add some useful functionality. Given the current popularity of the package, the maintenance is in a best effort manner. However if you have issues or bugs to report let me know [here](/issues) and I will try my best to help. 

You can use this package as you wish, but unfortunatelly, I cannot take responsibility of how this code is used, or the results it provides. It is up to you to test this does what you want it to!



%package -n python3-jsontable
Summary:	Convert a JSON to a table
Provides:	python-jsontable
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-jsontable
# JSON Table

A little package to convert a JSON into a table! This project was born out of a need to transform many JSONs mined from APIs to something that Pandas or a relational database could understand. The difference between this package and json path packages is that its designed to create __tables__, not just extract single values.


<a href="https://pypi.org/project/jsontable/">
<img src="https://img.shields.io/pypi/v/jsontable.svg" alt="latest release" />
</a>


## How to install

The package is available through pypi. So simply go to your command line and:

```bash
pip install jsontable
```
You're also welcome to download the code from github and modify to suit your needs. And if you have time let me know what cool functionality you added and we can improve the project!

## How it works

It works in a similar manner to JSON parsers
1. Create a converter object
2. Give the converter a list of paths you want to explore and how you want to name each column
3. Give the converter a __decoded__ JSON object you want to read, and it returns a table

## Usage

Here is a quick example to get you going

```python
import jsontable as jsontable

#Create a list of paths you want to extract
paths = [{"$.id":"id"},	{"$.name":"name"}, {"$.address.city":"city"}]
#The JSON object you want to explore
sample = {"id":"1","name":"Foo","address":{"city":"Bar"}}

#Create an instance of a converter
converter = jsontable.converter()
#Set the paths you want to extract
converter.set_paths(paths)
#Input a JSON to be interpreted
converter.convert_json(sample)
```

In this case, you will get a table with two columns and two rows (header and first row of data) like these:

```python
[['id', 'name', 'city'], ['1', 'Foo', 'Bar']]
```

For more examples, refer to the [tests folder](/tests)

## How it works

#### JSON Paths

Each path you specify is a column in your final table. Each path that is setup is expanded according to the [standard JSON Path functionality](https://goessner.net/articles/JsonPath/). This is, for each path, the converter starts at the root of the JSON object and navigates each step (a.k.a node) of the path in order. When it reaches the final step in the path (a.k.a leaf), it outputs the resulting element of the JSON into the cell.

The __final cell value__ is converted based on the [standard JSON values](https://www.json.org/) as follows:

|JSON Value|Conversion|Sample Output|
|--|--|--|
|object|stringified object |`'{"city":"Bar"}'`|
|array|stringified array |`'[1,2,3]'`|
|string|string|'Foo'|
|number|number|4.7|
|boolean|stringidied boolean|'False'|
|null|None|None|
|_missing value_ (i.e. the path did not find an element)|None|None|

The intention behind stringifying the object, array and boolean is to be able to pass the output to other data libraries (e.g [Pandas](https://pandas.pydata.org/))  or to a relational database. 

#### Array Expansion

__With the exception of the final node__, array elements are automatically expanded into rows. So for example a path `'$.a.b'` applied to a JSON `{"a":[{"b":1},{"b":2}]}` would result into two rows `[[1],[2]]`. The array expansion functionality can be applied to the final node by explicitly using the `*` operator as a final step (e.g. `$.a.*`)

Example:
```python
paths = [{"$.name":"Name"},{"$.telephones.type":"Telephone Type"},{"$.telephones.number":"Telephone Number"}]
sample = {
			"name":"Foo",
			"telephones":[
				{"type":"mobile", "number":"0000"},
				{"type":"home", "number":"1111"}
			]
		}
converter = jsontable.converter()
converter.set_paths(paths)
converter.convert_json(sample)
```
Result:
```
[['Name', 'Telephone Number', 'Telephone Type'], ['Foo', '0000', 'mobile'], ['Foo', '1111', 'home']]
```

The reverse of this functionality (not expand arrays if they are encountered before the end) is not implemented only due to the lack of need.

#### Joining Columns

Since a path may result in multiple rows, there is the need to be able to combine the result of each column into the same table. The joining mechanism is similar to an SQL join, where each cell (row-cell combination) is "matched" to a row in the result using a "matching value". The matching value in this case is the last common element of the paths. 

This is best illustrated with an example, the following table shows the transformations applied to the sample JSON.

```python
sample = {
	"contacts":[
		{
			"name":"Foo",
			"telephones":[
				{"type":"mobile", "number":"0000"},
				{"type":"home", "number":"1111"}
			],
			"emails":[
				{"type":"work", "email":"foo@w.com"},
				{"type":"personal", "email":"foo@p.com"}
			]
		},
		{
			"name":"Bar",
			"telephones":[
				{"type":"mobile", "number":"2222"},
				{"type":"home", "number":"3333"}
			],
			"emails":[
				{"type":"work", "email":"bar@w.com"},
				{"type":"personal", "email":"bar@p.com"}
			]
		}
	]
}
```

<table>
	<tr><th>Paths</th><th>Result</th></tr>
	<tr>
		<td>
			<pre lang="python">
[
	{"$.contacts.name":"Name"},
	{"$.contacts.telephones.type":"Type"},
	{"$.contacts.telephones.number":"Number"}
]
			</pre>
		</td>
		<td>
			<pre lang="python">
[
	['Name', 'Type', 'Number'], 
	['Foo', 'mobile', '0000'], 
	['Foo', 'home', '1111'], 
	['Bar', 'mobile', '2222'], 
	['Bar', 'home', '3333']
]
			</pre>
		</td>
	</tr>
		<tr>
		<td>
			<pre lang="python">
[
	{"$.contacts.name":"Name"},
	{"$.contacts.telephones.number":"Number"},
	{"$.contacts.emails.email":"Email"}
]
			</pre>
		</td>
		<td>
			<pre lang="python">
[
	['Name', 'Number', 'Email'], 
	['Foo', '0000', 'foo@w.com'], 
	['Foo', '1111', 'foo@w.com'],
	['Foo', '0000', 'foo@p.com'], 
	['Foo', '1111', 'foo@p.com'],  
	['Bar', '0000', 'bar@w.com'], 
	['Bar', '1111', 'bar@w.com'],
	['Bar', '0000', 'bar@p.com'], 
	['Bar', '1111', 'bar@p.com'],  
]
			</pre>
		</td>
	</tr>
</table>

In the first case, the `type` and `number` have a common path `telephone` and therefore the columns are combined for the same telephone element. If we then look at the `name` path it has a common path `contacts` with the rest of the columns, and therefore, the value is repeated across the rows.

In the second case the `email` and `number` only have a common path `contacts` and since each path results in two rows, the only possible way to match these is to combine all the values, resulting in 4 rows per contact (total 8 rows since there are 2 contacts). 

## Operators

Currently there are two operators supported: * and ~

|Syntax|Description|
|--|--|
|`*`| Returns __all values__ of the current element. If its an array, it will return one row per array value. If its an object (dictionary in Python) it will return one row per __value__. If its a value (string, number, boolean, null), it returns the same value|
|`~`| Return __all indices__ of the current element. If its an array, it returns an ascending numbered sequence starting with 0 (e.g. [1,2] would return [[0],[1]]) . If its an object, it will return the keys (e.g. {"a":1,"b":2} would return [['a'],['b']]). If its a value it returns 0|

More operators will be implemented in later releases.

## New in this version

 - A bug that was preventing list expansions at different depths (e.g. $.a as well as $.b.c) has been fixed.
 - Implementation of the * and ~ operators

Both these changes were made possible by changing the search method from depth first to breadth first, as well as recursing through a tree rather than iterating through one column at a time. 

## Coming up

In the wishlist we have:
 - Filtering
 - List indexing
 - More functions (basic arithmetics, string concatenation and expansion)
 - Square bracket notation ($[a][b] for $.a.b)
 - Stringify objects as an option
 - Option to output pandas style named array
 - Method to set paths and convert at the same time
 - CSV Output/Input

## References

I want to mention that whilst I inted to expand the functionality of this package, at the moment it can only take a simple sequence of keys to navigate a path. This is, the full functionality proposed by Stefan Gossner in his [jsonpath](https://goessner.net/articles/JsonPath/) is not yet implemented.... but we will get there.

If you are looking for a package that simply extracts a single value from a JSON by using more complex paths (and its functions), I recommend you look at [jsonpath-rw](https://github.com/kennknowles/python-jsonpath-rw) by Kenn Knowles [jsonpath-ng](https://pypi.org/project/jsonpath-ng/) by Tomas Aparicio or [jsonpath2](https://pypi.org/project/jsonpath2/) by Mark Borkum. 

## Final disclaimer

I will continue to look for improvements in the package and hopefully add some useful functionality. Given the current popularity of the package, the maintenance is in a best effort manner. However if you have issues or bugs to report let me know [here](/issues) and I will try my best to help. 

You can use this package as you wish, but unfortunatelly, I cannot take responsibility of how this code is used, or the results it provides. It is up to you to test this does what you want it to!



%package help
Summary:	Development documents and examples for jsontable
Provides:	python3-jsontable-doc
%description help
# JSON Table

A little package to convert a JSON into a table! This project was born out of a need to transform many JSONs mined from APIs to something that Pandas or a relational database could understand. The difference between this package and json path packages is that its designed to create __tables__, not just extract single values.


<a href="https://pypi.org/project/jsontable/">
<img src="https://img.shields.io/pypi/v/jsontable.svg" alt="latest release" />
</a>


## How to install

The package is available through pypi. So simply go to your command line and:

```bash
pip install jsontable
```
You're also welcome to download the code from github and modify to suit your needs. And if you have time let me know what cool functionality you added and we can improve the project!

## How it works

It works in a similar manner to JSON parsers
1. Create a converter object
2. Give the converter a list of paths you want to explore and how you want to name each column
3. Give the converter a __decoded__ JSON object you want to read, and it returns a table

## Usage

Here is a quick example to get you going

```python
import jsontable as jsontable

#Create a list of paths you want to extract
paths = [{"$.id":"id"},	{"$.name":"name"}, {"$.address.city":"city"}]
#The JSON object you want to explore
sample = {"id":"1","name":"Foo","address":{"city":"Bar"}}

#Create an instance of a converter
converter = jsontable.converter()
#Set the paths you want to extract
converter.set_paths(paths)
#Input a JSON to be interpreted
converter.convert_json(sample)
```

In this case, you will get a table with two columns and two rows (header and first row of data) like these:

```python
[['id', 'name', 'city'], ['1', 'Foo', 'Bar']]
```

For more examples, refer to the [tests folder](/tests)

## How it works

#### JSON Paths

Each path you specify is a column in your final table. Each path that is setup is expanded according to the [standard JSON Path functionality](https://goessner.net/articles/JsonPath/). This is, for each path, the converter starts at the root of the JSON object and navigates each step (a.k.a node) of the path in order. When it reaches the final step in the path (a.k.a leaf), it outputs the resulting element of the JSON into the cell.

The __final cell value__ is converted based on the [standard JSON values](https://www.json.org/) as follows:

|JSON Value|Conversion|Sample Output|
|--|--|--|
|object|stringified object |`'{"city":"Bar"}'`|
|array|stringified array |`'[1,2,3]'`|
|string|string|'Foo'|
|number|number|4.7|
|boolean|stringidied boolean|'False'|
|null|None|None|
|_missing value_ (i.e. the path did not find an element)|None|None|

The intention behind stringifying the object, array and boolean is to be able to pass the output to other data libraries (e.g [Pandas](https://pandas.pydata.org/))  or to a relational database. 

#### Array Expansion

__With the exception of the final node__, array elements are automatically expanded into rows. So for example a path `'$.a.b'` applied to a JSON `{"a":[{"b":1},{"b":2}]}` would result into two rows `[[1],[2]]`. The array expansion functionality can be applied to the final node by explicitly using the `*` operator as a final step (e.g. `$.a.*`)

Example:
```python
paths = [{"$.name":"Name"},{"$.telephones.type":"Telephone Type"},{"$.telephones.number":"Telephone Number"}]
sample = {
			"name":"Foo",
			"telephones":[
				{"type":"mobile", "number":"0000"},
				{"type":"home", "number":"1111"}
			]
		}
converter = jsontable.converter()
converter.set_paths(paths)
converter.convert_json(sample)
```
Result:
```
[['Name', 'Telephone Number', 'Telephone Type'], ['Foo', '0000', 'mobile'], ['Foo', '1111', 'home']]
```

The reverse of this functionality (not expand arrays if they are encountered before the end) is not implemented only due to the lack of need.

#### Joining Columns

Since a path may result in multiple rows, there is the need to be able to combine the result of each column into the same table. The joining mechanism is similar to an SQL join, where each cell (row-cell combination) is "matched" to a row in the result using a "matching value". The matching value in this case is the last common element of the paths. 

This is best illustrated with an example, the following table shows the transformations applied to the sample JSON.

```python
sample = {
	"contacts":[
		{
			"name":"Foo",
			"telephones":[
				{"type":"mobile", "number":"0000"},
				{"type":"home", "number":"1111"}
			],
			"emails":[
				{"type":"work", "email":"foo@w.com"},
				{"type":"personal", "email":"foo@p.com"}
			]
		},
		{
			"name":"Bar",
			"telephones":[
				{"type":"mobile", "number":"2222"},
				{"type":"home", "number":"3333"}
			],
			"emails":[
				{"type":"work", "email":"bar@w.com"},
				{"type":"personal", "email":"bar@p.com"}
			]
		}
	]
}
```

<table>
	<tr><th>Paths</th><th>Result</th></tr>
	<tr>
		<td>
			<pre lang="python">
[
	{"$.contacts.name":"Name"},
	{"$.contacts.telephones.type":"Type"},
	{"$.contacts.telephones.number":"Number"}
]
			</pre>
		</td>
		<td>
			<pre lang="python">
[
	['Name', 'Type', 'Number'], 
	['Foo', 'mobile', '0000'], 
	['Foo', 'home', '1111'], 
	['Bar', 'mobile', '2222'], 
	['Bar', 'home', '3333']
]
			</pre>
		</td>
	</tr>
		<tr>
		<td>
			<pre lang="python">
[
	{"$.contacts.name":"Name"},
	{"$.contacts.telephones.number":"Number"},
	{"$.contacts.emails.email":"Email"}
]
			</pre>
		</td>
		<td>
			<pre lang="python">
[
	['Name', 'Number', 'Email'], 
	['Foo', '0000', 'foo@w.com'], 
	['Foo', '1111', 'foo@w.com'],
	['Foo', '0000', 'foo@p.com'], 
	['Foo', '1111', 'foo@p.com'],  
	['Bar', '0000', 'bar@w.com'], 
	['Bar', '1111', 'bar@w.com'],
	['Bar', '0000', 'bar@p.com'], 
	['Bar', '1111', 'bar@p.com'],  
]
			</pre>
		</td>
	</tr>
</table>

In the first case, the `type` and `number` have a common path `telephone` and therefore the columns are combined for the same telephone element. If we then look at the `name` path it has a common path `contacts` with the rest of the columns, and therefore, the value is repeated across the rows.

In the second case the `email` and `number` only have a common path `contacts` and since each path results in two rows, the only possible way to match these is to combine all the values, resulting in 4 rows per contact (total 8 rows since there are 2 contacts). 

## Operators

Currently there are two operators supported: * and ~

|Syntax|Description|
|--|--|
|`*`| Returns __all values__ of the current element. If its an array, it will return one row per array value. If its an object (dictionary in Python) it will return one row per __value__. If its a value (string, number, boolean, null), it returns the same value|
|`~`| Return __all indices__ of the current element. If its an array, it returns an ascending numbered sequence starting with 0 (e.g. [1,2] would return [[0],[1]]) . If its an object, it will return the keys (e.g. {"a":1,"b":2} would return [['a'],['b']]). If its a value it returns 0|

More operators will be implemented in later releases.

## New in this version

 - A bug that was preventing list expansions at different depths (e.g. $.a as well as $.b.c) has been fixed.
 - Implementation of the * and ~ operators

Both these changes were made possible by changing the search method from depth first to breadth first, as well as recursing through a tree rather than iterating through one column at a time. 

## Coming up

In the wishlist we have:
 - Filtering
 - List indexing
 - More functions (basic arithmetics, string concatenation and expansion)
 - Square bracket notation ($[a][b] for $.a.b)
 - Stringify objects as an option
 - Option to output pandas style named array
 - Method to set paths and convert at the same time
 - CSV Output/Input

## References

I want to mention that whilst I inted to expand the functionality of this package, at the moment it can only take a simple sequence of keys to navigate a path. This is, the full functionality proposed by Stefan Gossner in his [jsonpath](https://goessner.net/articles/JsonPath/) is not yet implemented.... but we will get there.

If you are looking for a package that simply extracts a single value from a JSON by using more complex paths (and its functions), I recommend you look at [jsonpath-rw](https://github.com/kennknowles/python-jsonpath-rw) by Kenn Knowles [jsonpath-ng](https://pypi.org/project/jsonpath-ng/) by Tomas Aparicio or [jsonpath2](https://pypi.org/project/jsonpath2/) by Mark Borkum. 

## Final disclaimer

I will continue to look for improvements in the package and hopefully add some useful functionality. Given the current popularity of the package, the maintenance is in a best effort manner. However if you have issues or bugs to report let me know [here](/issues) and I will try my best to help. 

You can use this package as you wish, but unfortunatelly, I cannot take responsibility of how this code is used, or the results it provides. It is up to you to test this does what you want it to!



%prep
%autosetup -n jsontable-0.1.1

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-jsontable -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.1-1
- Package Spec generated