Repository navigation
Expand file tree
/
Copy pathscalar.pxi
More file actions
1748 lines (1403 loc) · 53 KB
/
Copy pathscalar.pxi
File metadata and controls
1748 lines (1403 loc) · 53 KB
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
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import collections
import warnings
from uuid import UUID
from collections.abc import Sequence, Mapping
cdef class Scalar(_Weakrefable):
"""
The base class for scalars.
Notes
-----
This class supports Python's standard operators
for element-wise operations, i.e. arithmetic (`+`, `-`, `/`, `%`, `**`),
bitwise (`&`, `|`, `^`, `>>`, `<<`) and others.
They can be used directly instead of calling underlying
`pyarrow.compute` functions explicitly.
Examples
--------
>>> import pyarrow as pa
>>> pa.scalar(42) + pa.scalar(17)
<pyarrow.Int64Scalar: 59>
>>> pa.scalar(6) ** 3
<pyarrow.Int64Scalar: 216>
>>> arr = pa.array([1, 2, 3], type=pa.int8())
>>> val = pa.scalar(42)
>>> val - arr
<pyarrow.lib.Int64Array object at ...>
[
41,
40,
39
]
"""
def __init__(self):
raise TypeError(f"Do not call {self.__class__.__name__}'s constructor directly, "
"use pa.scalar() instead.")
cdef void init(self, const shared_ptr[CScalar]& wrapped):
self.wrapped = wrapped
@staticmethod
cdef wrap(const shared_ptr[CScalar]& wrapped):
cdef:
Scalar self
Type type_id = wrapped.get().type.get().id()
shared_ptr[CDataType] sp_data_type = wrapped.get().type
if type_id == _Type_NA:
return _NULL
if type_id not in _scalar_classes:
raise NotImplementedError(
"Wrapping scalar of type " + frombytes(sp_data_type.get().ToString()))
typ = get_scalar_class_from_type(sp_data_type)
self = typ.__new__(typ)
self.init(wrapped)
return self
cdef inline shared_ptr[CScalar] unwrap(self) nogil:
return self.wrapped
@property
def type(self):
"""
Data type of the Scalar object.
"""
return pyarrow_wrap_data_type(self.wrapped.get().type)
@property
def is_valid(self):
"""
Holds a valid (non-null) value.
"""
return self.wrapped.get().is_valid
def cast(self, object target_type=None, safe=None, options=None, memory_pool=None):
"""
Cast scalar value to another data type.
See :func:`pyarrow.compute.cast` for usage.
Parameters
----------
target_type : DataType, default None
Type to cast scalar to.
safe : boolean, default True
Whether to check for conversion errors such as overflow.
options : CastOptions, default None
Additional checks pass by CastOptions
memory_pool : MemoryPool, optional
memory pool to use for allocations during function execution.
Returns
-------
scalar : A Scalar of the given target data type.
"""
return _pc().cast(self, target_type, safe=safe,
options=options, memory_pool=memory_pool)
def validate(self, *, full=False):
"""
Perform validation checks. An exception is raised if validation fails.
By default only cheap validation checks are run. Pass `full=True`
for thorough validation checks (potentially O(n)).
Parameters
----------
full : bool, default False
If True, run expensive checks, otherwise cheap checks only.
Raises
------
ArrowInvalid
"""
if full:
with nogil:
check_status(self.wrapped.get().ValidateFull())
else:
with nogil:
check_status(self.wrapped.get().Validate())
def __repr__(self):
return f'<pyarrow.{self.__class__.__name__}: {self.as_py()!r}>'
def __str__(self):
return str(self.as_py())
def equals(self, Scalar other not None):
"""
Parameters
----------
other : pyarrow.Scalar
Returns
-------
bool
"""
return self.wrapped.get().Equals(other.unwrap().get()[0])
def __eq__(self, other):
try:
return self.equals(other)
except TypeError:
return NotImplemented
def __hash__(self):
cdef CScalarHash hasher
return hasher(self.wrapped)
def __reduce__(self):
return scalar, (self.as_py(), self.type)
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python representation.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
The default behavior (`None`), is to convert Arrow Map arrays to
Python association lists (list-of-tuples) in the same order as the
Arrow Map, as in [(key1, value1), (key2, value2), ...].
If 'lossy' or 'strict', convert Arrow Map arrays to native Python dicts.
If 'lossy', whenever duplicate keys are detected, a warning will be printed.
The last seen value of a duplicate key will be in the Python dictionary.
If 'strict', this instead results in an exception being raised when detected.
"""
raise NotImplementedError()
def __abs__(self):
return _pc().call_function('abs_checked', [self])
def __add__(self, object other):
return _pc().call_function('add_checked', [self, other])
def __truediv__(self, object other):
return _pc().call_function('divide_checked', [self, other])
def __mul__(self, object other):
return _pc().call_function('multiply_checked', [self, other])
def __neg__(self):
return _pc().call_function('negate_checked', [self])
def __pow__(self, object other):
return _pc().call_function('power_checked', [self, other])
def __sub__(self, object other):
return _pc().call_function('subtract_checked', [self, other])
def __and__(self, object other):
return _pc().call_function('bit_wise_and', [self, other])
def __or__(self, object other):
return _pc().call_function('bit_wise_or', [self, other])
def __xor__(self, object other):
return _pc().call_function('bit_wise_xor', [self, other])
def __lshift__(self, object other):
return _pc().call_function('shift_left_checked', [self, other])
def __rshift__(self, object other):
return _pc().call_function('shift_right_checked', [self, other])
_NULL = NA = None
cdef class NullScalar(Scalar):
"""
Concrete class for null scalars.
"""
def __cinit__(self):
global NA
if NA is not None:
raise RuntimeError('Cannot create multiple NullScalar instances')
self.init(shared_ptr[CScalar](new CNullScalar()))
def __init__(self):
pass
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python None.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
return None
_NULL = NA = NullScalar()
cdef class BooleanScalar(Scalar):
"""
Concrete class for boolean scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python bool.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CBooleanScalar* sp = <CBooleanScalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __bool__(self):
return self.as_py() or False
cdef class UInt8Scalar(Scalar):
"""
Concrete class for uint8 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python int.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CUInt8Scalar* sp = <CUInt8Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __index__(self):
return self.as_py()
cdef class Int8Scalar(Scalar):
"""
Concrete class for int8 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python int.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CInt8Scalar* sp = <CInt8Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __index__(self):
return self.as_py()
cdef class UInt16Scalar(Scalar):
"""
Concrete class for uint16 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python int.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CUInt16Scalar* sp = <CUInt16Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __index__(self):
return self.as_py()
cdef class Int16Scalar(Scalar):
"""
Concrete class for int16 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python int.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CInt16Scalar* sp = <CInt16Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __index__(self):
return self.as_py()
cdef class UInt32Scalar(Scalar):
"""
Concrete class for uint32 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python int.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CUInt32Scalar* sp = <CUInt32Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __index__(self):
return self.as_py()
cdef class Int32Scalar(Scalar):
"""
Concrete class for int32 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python int.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CInt32Scalar* sp = <CInt32Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __index__(self):
return self.as_py()
cdef class UInt64Scalar(Scalar):
"""
Concrete class for uint64 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python int.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CUInt64Scalar* sp = <CUInt64Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __index__(self):
return self.as_py()
cdef class Int64Scalar(Scalar):
"""
Concrete class for int64 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python int.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CInt64Scalar* sp = <CInt64Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __index__(self):
return self.as_py()
cdef class HalfFloatScalar(Scalar):
"""
Concrete class for float scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python float.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CHalfFloatScalar* sp = <CHalfFloatScalar*> self.wrapped.get()
return PyFloat_FromHalf(sp.value) if sp.is_valid else None
def __float__(self):
return self.as_py()
def __int__(self):
return int(self.as_py())
cdef class FloatScalar(Scalar):
"""
Concrete class for float scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python float.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CFloatScalar* sp = <CFloatScalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __float__(self):
return self.as_py()
def __int__(self):
return int(float(self))
cdef class DoubleScalar(Scalar):
"""
Concrete class for double scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python float.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CDoubleScalar* sp = <CDoubleScalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def __float__(self):
return self.as_py()
def __int__(self):
return int(float(self))
cdef class Decimal32Scalar(Scalar):
"""
Concrete class for decimal32 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python Decimal.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef:
CDecimal32Scalar* sp = <CDecimal32Scalar*> self.wrapped.get()
CDecimal32Type* dtype = <CDecimal32Type*> sp.type.get()
if sp.is_valid:
return _pydecimal.Decimal(
frombytes(sp.value.ToString(dtype.scale()))
)
else:
return None
cdef class Decimal64Scalar(Scalar):
"""
Concrete class for decimal64 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python Decimal.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef:
CDecimal64Scalar* sp = <CDecimal64Scalar*> self.wrapped.get()
CDecimal64Type* dtype = <CDecimal64Type*> sp.type.get()
if sp.is_valid:
return _pydecimal.Decimal(
frombytes(sp.value.ToString(dtype.scale()))
)
else:
return None
cdef class Decimal128Scalar(Scalar):
"""
Concrete class for decimal128 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python Decimal.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef:
CDecimal128Scalar* sp = <CDecimal128Scalar*> self.wrapped.get()
CDecimal128Type* dtype = <CDecimal128Type*> sp.type.get()
if sp.is_valid:
return _pydecimal.Decimal(
frombytes(sp.value.ToString(dtype.scale()))
)
else:
return None
cdef class Decimal256Scalar(Scalar):
"""
Concrete class for decimal256 scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python Decimal.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef:
CDecimal256Scalar* sp = <CDecimal256Scalar*> self.wrapped.get()
CDecimal256Type* dtype = <CDecimal256Type*> sp.type.get()
if sp.is_valid:
return _pydecimal.Decimal(
frombytes(sp.value.ToString(dtype.scale()))
)
else:
return None
cdef class Date32Scalar(Scalar):
"""
Concrete class for date32 scalars.
"""
@property
def value(self):
cdef CDate32Scalar* sp = <CDate32Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python datetime.datetime instance.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CDate32Scalar* sp = <CDate32Scalar*> self.wrapped.get()
if sp.is_valid:
# shift to seconds since epoch
return (
datetime.date(1970, 1, 1) + datetime.timedelta(days=sp.value)
)
else:
return None
cdef class Date64Scalar(Scalar):
"""
Concrete class for date64 scalars.
"""
@property
def value(self):
cdef CDate64Scalar* sp = <CDate64Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python datetime.datetime instance.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef CDate64Scalar* sp = <CDate64Scalar*> self.wrapped.get()
if sp.is_valid:
return (
datetime.date(1970, 1, 1) +
datetime.timedelta(days=sp.value / 86400000)
)
else:
return None
def _datetime_from_int(int64_t value, TimeUnit unit, tzinfo=None):
if unit == TimeUnit_SECOND:
delta = datetime.timedelta(seconds=value)
elif unit == TimeUnit_MILLI:
delta = datetime.timedelta(milliseconds=value)
elif unit == TimeUnit_MICRO:
delta = datetime.timedelta(microseconds=value)
else:
# TimeUnit_NANO: prefer pandas timestamps if available
if _pandas_api.have_pandas:
return _pandas_api.pd.Timestamp(value, tz=tzinfo, unit='ns')
# otherwise safely truncate to microsecond resolution datetime
if value % 1000 != 0:
raise ValueError(
f"Nanosecond resolution temporal type {value} is not safely "
"convertible to microseconds to convert to datetime.datetime. "
"Install pandas to return as Timestamp with nanosecond "
"support or access the .value attribute."
)
delta = datetime.timedelta(microseconds=value // 1000)
dt = datetime.datetime(1970, 1, 1) + delta
# adjust timezone if set to the datatype
if tzinfo is not None:
dt = dt.replace(tzinfo=datetime.timezone.utc).astimezone(tzinfo)
return dt
cdef class Time32Scalar(Scalar):
"""
Concrete class for time32 scalars.
"""
@property
def value(self):
cdef CTime32Scalar* sp = <CTime32Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python datetime.timedelta instance.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef:
CTime32Scalar* sp = <CTime32Scalar*> self.wrapped.get()
CTime32Type* dtype = <CTime32Type*> sp.type.get()
if sp.is_valid:
return _datetime_from_int(sp.value, unit=dtype.unit()).time()
else:
return None
cdef class Time64Scalar(Scalar):
"""
Concrete class for time64 scalars.
"""
@property
def value(self):
cdef CTime64Scalar* sp = <CTime64Scalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python datetime.timedelta instance.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef:
CTime64Scalar* sp = <CTime64Scalar*> self.wrapped.get()
CTime64Type* dtype = <CTime64Type*> sp.type.get()
if sp.is_valid:
return _datetime_from_int(sp.value, unit=dtype.unit()).time()
else:
return None
cdef class TimestampScalar(Scalar):
"""
Concrete class for timestamp scalars.
"""
@property
def value(self):
cdef CTimestampScalar* sp = <CTimestampScalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Pandas Timestamp instance (if units are
nanoseconds and pandas is available), otherwise as a Python
datetime.datetime instance.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef:
CTimestampScalar* sp = <CTimestampScalar*> self.wrapped.get()
CTimestampType* dtype = <CTimestampType*> sp.type.get()
if not sp.is_valid:
return None
if not dtype.timezone().empty():
tzinfo = string_to_tzinfo(frombytes(dtype.timezone()))
else:
tzinfo = None
return _datetime_from_int(sp.value, unit=dtype.unit(), tzinfo=tzinfo)
def __repr__(self):
"""
Return the representation of TimestampScalar using `strftime` to avoid
original repr datetime values being out of range.
"""
cdef:
CTimestampScalar* sp = <CTimestampScalar*> self.wrapped.get()
CTimestampType* dtype = <CTimestampType*> sp.type.get()
if not dtype.timezone().empty():
type_format = str(_pc().strftime(self, format="%Y-%m-%dT%H:%M:%S%z"))
else:
type_format = str(_pc().strftime(self))
return f'<pyarrow.{self.__class__.__name__}: {type_format!r}>'
cdef class DurationScalar(Scalar):
"""
Concrete class for duration scalars.
"""
@property
def value(self):
cdef CDurationScalar* sp = <CDurationScalar*> self.wrapped.get()
return sp.value if sp.is_valid else None
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Pandas Timedelta instance (if units are
nanoseconds and pandas is available), otherwise as a Python
datetime.timedelta instance.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef:
CDurationScalar* sp = <CDurationScalar*> self.wrapped.get()
CDurationType* dtype = <CDurationType*> sp.type.get()
TimeUnit unit = dtype.unit()
if not sp.is_valid:
return None
if unit == TimeUnit_SECOND:
return datetime.timedelta(seconds=sp.value)
elif unit == TimeUnit_MILLI:
return datetime.timedelta(milliseconds=sp.value)
elif unit == TimeUnit_MICRO:
return datetime.timedelta(microseconds=sp.value)
else:
# TimeUnit_NANO: prefer pandas timestamps if available
if _pandas_api.have_pandas:
return _pandas_api.pd.Timedelta(sp.value, unit='ns')
# otherwise safely truncate to microsecond resolution timedelta
if sp.value % 1000 != 0:
raise ValueError(
f"Nanosecond duration {sp.value} is not safely convertible to "
"microseconds to convert to datetime.timedelta. Install "
"pandas to return as Timedelta with nanosecond support or "
"access the .value attribute."
)
return datetime.timedelta(microseconds=sp.value // 1000)
cdef class MonthDayNanoIntervalScalar(Scalar):
"""
Concrete class for month, day, nanosecond interval scalars.
"""
@property
def value(self):
"""
Same as self.as_py()
"""
return self.as_py()
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a pyarrow.MonthDayNano.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
cdef:
PyObject* val
CMonthDayNanoIntervalScalar* scalar
scalar = <CMonthDayNanoIntervalScalar*>self.wrapped.get()
val = GetResultValue(MonthDayNanoIntervalScalarToPyObject(
deref(scalar)))
return PyObject_to_object(val)
cdef class BinaryScalar(Scalar):
"""
Concrete class for binary-like scalars.
"""
def as_buffer(self):
"""
Return a view over this value as a Buffer object.
"""
cdef CBaseBinaryScalar* sp = <CBaseBinaryScalar*> self.wrapped.get()
return pyarrow_wrap_buffer(sp.value) if sp.is_valid else None
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python bytes.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
buffer = self.as_buffer()
return None if buffer is None else buffer.to_pybytes()
def __bytes__(self):
return self.as_py()
def __getbuffer__(self, cp.Py_buffer* buffer, int flags):
buf = self.as_buffer()
if buf is None:
raise ValueError("Cannot export buffer from null Arrow Scalar")
cp.PyObject_GetBuffer(buf, buffer, flags)
cdef class LargeBinaryScalar(BinaryScalar):
pass
cdef class FixedSizeBinaryScalar(BinaryScalar):
pass
cdef class StringScalar(BinaryScalar):
"""
Concrete class for string-like (utf8) scalars.
"""
def as_py(self, *, maps_as_pydicts=None):
"""
Return this value as a Python string.
Parameters
----------
maps_as_pydicts : str, optional, default `None`
Valid values are `None`, 'lossy', or 'strict'.
This parameter is ignored for non-nested Scalars.
"""
buffer = self.as_buffer()
return None if buffer is None else str(buffer, 'utf8')
cdef class LargeStringScalar(StringScalar):
pass
cdef class BinaryViewScalar(BinaryScalar):
pass
cdef class StringViewScalar(StringScalar):
pass