Skip to content

Commit 100b682

Browse files
alixdammanalixdamman
committed
>> skip doctests from all IO methods of the Session class
1 parent e42fb3b commit 100b682

File tree

1 file changed

+64
-64
lines changed

1 file changed

+64
-64
lines changed

‎larray/core/session.py

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -373,36 +373,36 @@ def load(self, fname, names=None, engine='auto', display=False, **kwargs):
373373
In one module:
374374
375375
>>> # scalars
376-
>>> i, s = 5, 'string'
376+
>>> i, s = 5, 'string' # doctest: +SKIP
377377
>>> # axes
378-
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2")
378+
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2") # doctest: +SKIP
379379
>>> # groups
380-
>>> a01 = a['a0,a1'] >> 'a01'
380+
>>> a01 = a['a0,a1'] >> 'a01' # doctest: +SKIP
381381
>>> # arrays
382-
>>> arr1, arr2 = ndtest((a, b)), ndtest(a)
382+
>>> arr1, arr2 = ndtest((a, b)), ndtest(a) # doctest: +SKIP
383383
>>> ses = Session([('i', i), ('s', s), ('a', a), ('b', b), ('a01', a01),
384-
... ('arr1', arr1), ('arr2', arr2)])
384+
... ('arr1', arr1), ('arr2', arr2)]) # doctest: +SKIP
385385
>>> # metadata
386-
>>> ses.meta.title = 'my title'
387-
>>> ses.meta.author = 'John Smith'
386+
>>> ses.meta.title = 'my title' # doctest: +SKIP
387+
>>> ses.meta.author = 'John Smith' # doctest: +SKIP
388388
>>> # save the session in an HDF5 file
389-
>>> ses.save('input.h5')
389+
>>> ses.save('input.h5') # doctest: +SKIP
390390
391391
In another module: load the whole session
392392
393393
>>> # the load method is automatically called when passing
394394
>>> # the path of file to the Session constructor
395-
>>> ses = Session('input.h5')
396-
>>> ses
395+
>>> ses = Session('input.h5') # doctest: +SKIP
396+
>>> ses # doctest: +SKIP
397397
Session(a, a01, arr1, arr2, b, i, s)
398-
>>> ses.meta
398+
>>> ses.meta # doctest: +SKIP
399399
title: my title
400400
author: John Smith
401401
402402
Load only some objects
403403
404404
>>> ses = Session()
405-
>>> ses.load('input.h5', names=['s', 'a', 'b', 'arr1', 'arr2'], display=True)
405+
>>> ses.load('input.h5', names=['s', 'a', 'b', 'arr1', 'arr2'], display=True) # doctest: +SKIP
406406
opening input.h5
407407
loading Axis object a ... done
408408
loading Array object arr1 ... done
@@ -412,15 +412,15 @@ def load(self, fname, names=None, engine='auto', display=False, **kwargs):
412412
413413
Using .csv files (assuming the same session as above)
414414
415-
>>> ses.save('data')
416-
>>> ses = Session()
415+
>>> ses.save('data') # doctest: +SKIP
416+
>>> ses = Session() # doctest: +SKIP
417417
>>> # load all .csv files from the 'data' directory
418-
>>> ses.load('data', display=True)
418+
>>> ses.load('data', display=True) # doctest: +SKIP
419419
opening data
420420
loading Array object arr1 ... done
421421
loading Array object arr2 ... done
422422
>>> # or only arrays containing the character '1' in their names
423-
>>> ses.load('data/*1.csv', display=True)
423+
>>> ses.load('data/*1.csv', display=True) # doctest: +SKIP
424424
opening data/*1.csv
425425
loading Array object arr1 ... done
426426
"""
@@ -470,22 +470,22 @@ def save(self, fname, names=None, engine='auto', overwrite=True, display=False,
470470
Examples
471471
--------
472472
>>> # scalars
473-
>>> i, s = 5, 'string'
473+
>>> i, s = 5, 'string' # doctest: +SKIP
474474
>>> # axes
475-
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2")
475+
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2") # doctest: +SKIP
476476
>>> # groups
477-
>>> a01 = a['a0,a1'] >> 'a01'
477+
>>> a01 = a['a0,a1'] >> 'a01' # doctest: +SKIP
478478
>>> # arrays
479-
>>> arr1, arr2 = ndtest((a, b)), ndtest(a)
479+
>>> arr1, arr2 = ndtest((a, b)), ndtest(a) # doctest: +SKIP
480480
>>> ses = Session([('i', i), ('s', s), ('a', a), ('b', b), ('a01', a01),
481-
... ('arr1', arr1), ('arr2', arr2)])
481+
... ('arr1', arr1), ('arr2', arr2)]) # doctest: +SKIP
482482
>>> # metadata
483-
>>> ses.meta.title = 'my title'
484-
>>> ses.meta.author = 'John Smith'
483+
>>> ses.meta.title = 'my title' # doctest: +SKIP
484+
>>> ses.meta.author = 'John Smith' # doctest: +SKIP
485485
486486
Save all objects
487487
488-
>>> ses.save('output.h5', display=True)
488+
>>> ses.save('output.h5', display=True) # doctest: +SKIP
489489
dumping i ... done
490490
dumping s ... done
491491
dumping a ... done
@@ -496,7 +496,7 @@ def save(self, fname, names=None, engine='auto', overwrite=True, display=False,
496496
497497
Save only some objects
498498
499-
>>> ses.save('output.h5', names=['s', 'a', 'b', 'arr1', 'arr2'], display=True)
499+
>>> ses.save('output.h5', names=['s', 'a', 'b', 'arr1', 'arr2'], display=True) # doctest: +SKIP
500500
dumping s ... done
501501
dumping a ... done
502502
dumping b ... done
@@ -505,10 +505,10 @@ def save(self, fname, names=None, engine='auto', overwrite=True, display=False,
505505
506506
Update file
507507
508-
>>> arr1, arr4 = ndtest((3, 3)), ndtest((2, 3))
509-
>>> ses2 = Session([('arr1', arr1), ('arr4', arr4)])
508+
>>> arr1, arr4 = ndtest((3, 3)), ndtest((2, 3)) # doctest: +SKIP
509+
>>> ses2 = Session([('arr1', arr1), ('arr4', arr4)]) # doctest: +SKIP
510510
>>> # replace arr1 and add arr4 in file output.h5
511-
>>> ses2.save('output.h5', overwrite=False, display=True)
511+
>>> ses2.save('output.h5', overwrite=False, display=True) # doctest: +SKIP
512512
dumping arr1 ... done
513513
dumping arr4 ... done
514514
"""
@@ -616,22 +616,22 @@ def to_pickle(self, fname, names=None, overwrite=True, display=False, **kwargs):
616616
Examples
617617
--------
618618
>>> # scalars
619-
>>> i, s = 5, 'string'
619+
>>> i, s = 5, 'string' # doctest: +SKIP
620620
>>> # axes
621-
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2")
621+
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2") # doctest: +SKIP
622622
>>> # groups
623-
>>> a01 = a['a0,a1'] >> 'a01'
623+
>>> a01 = a['a0,a1'] >> 'a01' # doctest: +SKIP
624624
>>> # arrays
625-
>>> arr1, arr2 = ndtest((a, b)), ndtest(a)
625+
>>> arr1, arr2 = ndtest((a, b)), ndtest(a) # doctest: +SKIP
626626
>>> ses = Session([('i', i), ('s', s), ('a', a), ('b', b), ('a01', a01),
627-
... ('arr1', arr1), ('arr2', arr2)])
627+
... ('arr1', arr1), ('arr2', arr2)]) # doctest: +SKIP
628628
>>> # metadata
629-
>>> ses.meta.title = 'my title'
630-
>>> ses.meta.author = 'John Smith'
629+
>>> ses.meta.title = 'my title' # doctest: +SKIP
630+
>>> ses.meta.author = 'John Smith' # doctest: +SKIP
631631
632632
Save all objects
633633
634-
>>> ses.to_pickle('output.pkl', display=True)
634+
>>> ses.to_pickle('output.pkl', display=True) # doctest: +SKIP
635635
dumping i ... done
636636
dumping s ... done
637637
dumping a ... done
@@ -642,7 +642,7 @@ def to_pickle(self, fname, names=None, overwrite=True, display=False, **kwargs):
642642
643643
Save only some objects
644644
645-
>>> ses.to_pickle('output.pkl', names=['s', 'a', 'b', 'arr1', 'arr2'], display=True)
645+
>>> ses.to_pickle('output.pkl', names=['s', 'a', 'b', 'arr1', 'arr2'], display=True) # doctest: +SKIP
646646
dumping s ... done
647647
dumping a ... done
648648
dumping b ... done
@@ -673,22 +673,22 @@ def to_hdf(self, fname, names=None, overwrite=True, display=False, **kwargs):
673673
Examples
674674
--------
675675
>>> # scalars
676-
>>> i, s = 5, 'string'
676+
>>> i, s = 5, 'string' # doctest: +SKIP
677677
>>> # axes
678-
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2")
678+
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2") # doctest: +SKIP
679679
>>> # groups
680-
>>> a01 = a['a0,a1'] >> 'a01'
680+
>>> a01 = a['a0,a1'] >> 'a01' # doctest: +SKIP
681681
>>> # arrays
682-
>>> arr1, arr2 = ndtest((a, b)), ndtest(a)
682+
>>> arr1, arr2 = ndtest((a, b)), ndtest(a) # doctest: +SKIP
683683
>>> ses = Session([('i', i), ('s', s), ('a', a), ('b', b), ('a01', a01),
684-
... ('arr1', arr1), ('arr2', arr2)])
684+
... ('arr1', arr1), ('arr2', arr2)]) # doctest: +SKIP
685685
>>> # metadata
686-
>>> ses.meta.title = 'my title'
687-
>>> ses.meta.author = 'John Smith'
686+
>>> ses.meta.title = 'my title' # doctest: +SKIP
687+
>>> ses.meta.author = 'John Smith' # doctest: +SKIP
688688
689689
Save all objects
690690
691-
>>> ses.to_hdf('output.h5', display=True)
691+
>>> ses.to_hdf('output.h5', display=True) # doctest: +SKIP
692692
dumping i ... done
693693
dumping s ... done
694694
dumping a ... done
@@ -699,7 +699,7 @@ def to_hdf(self, fname, names=None, overwrite=True, display=False, **kwargs):
699699
700700
Save only some objects
701701
702-
>>> ses.to_hdf('output.h5', names=['s', 'a', 'b', 'arr1', 'arr2'], display=True)
702+
>>> ses.to_hdf('output.h5', names=['s', 'a', 'b', 'arr1', 'arr2'], display=True) # doctest: +SKIP
703703
dumping s ... done
704704
dumping a ... done
705705
dumping b ... done
@@ -734,22 +734,22 @@ def to_excel(self, fname, names=None, overwrite=True, display=False, **kwargs):
734734
Examples
735735
--------
736736
>>> # scalars
737-
>>> i, s = 5, 'string'
737+
>>> i, s = 5, 'string' # doctest: +SKIP
738738
>>> # axes
739-
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2")
739+
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2") # doctest: +SKIP
740740
>>> # groups
741-
>>> a01 = a['a0,a1'] >> 'a01'
741+
>>> a01 = a['a0,a1'] >> 'a01' # doctest: +SKIP
742742
>>> # arrays
743-
>>> arr1, arr2 = ndtest((a, b)), ndtest(a)
743+
>>> arr1, arr2 = ndtest((a, b)), ndtest(a) # doctest: +SKIP
744744
>>> ses = Session([('i', i), ('s', s), ('a', a), ('b', b), ('a01', a01),
745-
... ('arr1', arr1), ('arr2', arr2)])
745+
... ('arr1', arr1), ('arr2', arr2)]) # doctest: +SKIP
746746
>>> # metadata
747-
>>> ses.meta.title = 'my title'
748-
>>> ses.meta.author = 'John Smith'
747+
>>> ses.meta.title = 'my title' # doctest: +SKIP
748+
>>> ses.meta.author = 'John Smith' # doctest: +SKIP
749749
750750
Save all arrays (and arrays only)
751751
752-
>>> ses.to_excel('output.xlsx', display=True)
752+
>>> ses.to_excel('output.xlsx', display=True) # doctest: +SKIP
753753
dumping i ... Cannot dump i. int is not a supported type
754754
dumping s ... Cannot dump s. str is not a supported type
755755
dumping a ... Cannot dump a. Axis is not a supported type
@@ -760,7 +760,7 @@ def to_excel(self, fname, names=None, overwrite=True, display=False, **kwargs):
760760
761761
Save only some arrays
762762
763-
>>> ses.to_excel('output.xlsx', names=['arr1'], display=True)
763+
>>> ses.to_excel('output.xlsx', names=['arr1'], display=True) # doctest: +SKIP
764764
dumping arr1 ... done
765765
"""
766766
self.save(fname, names, ext_default_engine['xlsx'], overwrite, display, **kwargs)
@@ -789,22 +789,22 @@ def to_csv(self, fname, names=None, display=False, **kwargs):
789789
Examples
790790
--------
791791
>>> # scalars
792-
>>> i, s = 5, 'string'
792+
>>> i, s = 5, 'string' # doctest: +SKIP
793793
>>> # axes
794-
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2")
794+
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2") # doctest: +SKIP
795795
>>> # groups
796-
>>> a01 = a['a0,a1'] >> 'a01'
796+
>>> a01 = a['a0,a1'] >> 'a01' # doctest: +SKIP
797797
>>> # arrays
798-
>>> arr1, arr2 = ndtest((a, b)), ndtest(a)
798+
>>> arr1, arr2 = ndtest((a, b)), ndtest(a) # doctest: +SKIP
799799
>>> ses = Session([('i', i), ('s', s), ('a', a), ('b', b), ('a01', a01),
800-
... ('arr1', arr1), ('arr2', arr2)])
800+
... ('arr1', arr1), ('arr2', arr2)]) # doctest: +SKIP
801801
>>> # metadata
802-
>>> ses.meta.title = 'my title'
803-
>>> ses.meta.author = 'John Smith'
802+
>>> ses.meta.title = 'my title' # doctest: +SKIP
803+
>>> ses.meta.author = 'John Smith' # doctest: +SKIP
804804
805805
Save all arrays (and arrays only)
806806
807-
>>> ses.to_csv('output', display=True)
807+
>>> ses.to_csv('output', display=True) # doctest: +SKIP
808808
dumping i ... Cannot dump i. int is not a supported type
809809
dumping s ... Cannot dump s. str is not a supported type
810810
dumping a ... Cannot dump a. Axis is not a supported type
@@ -815,7 +815,7 @@ def to_csv(self, fname, names=None, display=False, **kwargs):
815815
816816
Save only some arrays
817817
818-
>>> ses.to_csv('output', names=['arr1'], display=True)
818+
>>> ses.to_csv('output', names=['arr1'], display=True) # doctest: +SKIP
819819
dumping arr1 ... done
820820
"""
821821
self.save(fname, names, ext_default_engine['csv'], display=display, **kwargs)

0 commit comments

Comments
 (0)