Skip to content

ARROW-9279: [C++] Implement PrettyPrint for Scalars #8151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tianchen92 wants to merge 2 commits into from
Closed

ARROW-9279: [C++] Implement PrettyPrint for Scalars #8151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb0a1a5
ARROW-9279: [C++] Implement PrettyPrint for Scalars
tianchen92 Sep 9, 2020
86b1ab6
fix build fail
tianchen92 Sep 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
215 changes: 177 additions & 38 deletions cpp/src/arrow/pretty_print.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
namespace arrow {

using internal::checked_cast;
using internal::checked_pointer_cast;

class PrettyPrinter {
public:
Expand Down Expand Up @@ -111,6 +112,160 @@ void PrettyPrinter::Indent() {
}
}

static arrow_vendored::date::sys_days epoch_ =
arrow_vendored::date::sys_days{arrow_vendored::date::jan / 1 / 1970};

template <typename Unit>
static void FormatDateTime(std::ostream* sink, const char* fmt, int64_t value,
bool add_epoch) {
if (add_epoch) {
(*sink) << arrow_vendored::date::format(fmt, epoch_ + Unit{value});
} else {
(*sink) << arrow_vendored::date::format(fmt, Unit{value});
}
}

static void FormatDateTime(std::ostream* sink, TimeUnit::type unit, const char* fmt,
int64_t value, bool add_epoch) {
switch (unit) {
case TimeUnit::NANO:
FormatDateTime<std::chrono::nanoseconds>(sink, fmt, value, add_epoch);
break;
case TimeUnit::MICRO:
FormatDateTime<std::chrono::microseconds>(sink, fmt, value, add_epoch);
break;
case TimeUnit::MILLI:
FormatDateTime<std::chrono::milliseconds>(sink, fmt, value, add_epoch);
break;
case TimeUnit::SECOND:
FormatDateTime<std::chrono::seconds>(sink, fmt, value, add_epoch);
break;
}
}

class ScalarPrinter : public PrettyPrinter {
public:
ScalarPrinter(const PrettyPrintOptions& options, std::ostream* sink)
: PrettyPrinter(options, sink) {}

Status Print(const Scalar& scalar) {
if (scalar.is_valid == false) {
(*sink_) << "null";
} else {
RETURN_NOT_OK(VisitScalarInline(scalar, this));
Flush();
}
return Status::OK();
}

template <typename T>
enable_if_integer<typename T::TypeClass, Status> Visit(const T& scalar) {
(*sink_) << internal::UpcastInt(scalar.value);
return Status::OK();
}

template <typename T>
typename std::enable_if<std::is_base_of<HalfFloatScalar, T>::value ||
std::is_base_of<FloatScalar, T>::value ||
std::is_base_of<DoubleScalar, T>::value ||
std::is_base_of<DurationScalar, T>::value ||
std::is_base_of<MonthIntervalScalar, T>::value,
Status>::type
Visit(const T& scalar) {
(*sink_) << scalar.value;
return Status::OK();
}

template <typename T>
enable_if_string_like<typename T::TypeClass, Status> Visit(const T& scalar) {
(*sink_) << "\"" << scalar.value->ToString() << "\"";
return Status::OK();
}

template <typename T>
enable_if_binary_like<typename T::TypeClass, Status> Visit(const T& scalar) {
(*sink_) << HexEncode(scalar.value->ToString());
return Status::OK();
}

template <typename T>
enable_if_date<typename T::TypeClass, Status> Visit(const T& scalar) {
using unit = typename std::conditional<std::is_same<T, Date32Scalar>::value,
arrow_vendored::date::days,
std::chrono::milliseconds>::type;
FormatDateTime<unit>(sink_, "%F", scalar.value, true);
return Status::OK();
}

template <typename T>
enable_if_time<typename T::TypeClass, Status> Visit(const T& scalar) {
const auto type = static_cast<const TimeType*>(scalar.type.get());
FormatDateTime(sink_, type->unit(), "%T", scalar.value, false);
return Status::OK();
}

Status Visit(const TimestampScalar& scalar) {
const auto type = static_cast<const TimestampType*>(scalar.type.get());
FormatDateTime(sink_, type->unit(), "%F %T", scalar.value, true);
return Status::OK();
}

Status Visit(const DayTimeIntervalScalar& scalar) {
auto day_millis = scalar.value;
(*sink_) << day_millis.days << "d" << day_millis.milliseconds << "ms";
return Status::OK();
}

Status Visit(const BooleanScalar& scalar) {
(*sink_) << (scalar.value == true ? "true" : "false");
return Status::OK();
}

Status Visit(const Decimal128Scalar& scalar) {
auto type = checked_pointer_cast<Decimal128Type>(scalar.type);
(*sink_) << scalar.value.ToString(type->scale());
return Status::OK();
}

Status Visit(const BaseListScalar& scalar) {
(*sink_) << scalar.value->ToString();
return Status::OK();
}

Status Visit(const MapScalar& scalar) {
auto inner_array = checked_pointer_cast<StructArray>(scalar.value);
(*sink_) << "keys:\n";
(*sink_) << inner_array->field(0)->ToString();
(*sink_) << "values:\n";
(*sink_) << inner_array->field(1)->ToString();
return Status::OK();
}

Status Visit(const StructScalar& scalar) {
std::vector<std::shared_ptr<Scalar>> scalars = scalar.value;
(*sink_) << "{";
for (size_t i = 0; i < scalars.size(); i++) {
ScalarPrinter printer(options_, sink_);
RETURN_NOT_OK(printer.Print(*scalars[i]));
if (i != scalars.size() - 1) {
(*sink_) << ", ";
}
}
(*sink_) << "}";
return Status::OK();
}

Status Visit(const UnionScalar& scalar) {
ScalarPrinter printer(options_, sink_);
RETURN_NOT_OK(printer.Print(*(scalar.value)));
return Status::OK();
}

Status Visit(const Scalar& scalar) {
return Status::NotImplemented("Not implemented type:" + scalar.type->ToString());
}
};

class ArrayPrinter : public PrettyPrinter {
public:
ArrayPrinter(const PrettyPrintOptions& options, std::ostream* sink)
Expand Down Expand Up @@ -166,24 +321,27 @@ class ArrayPrinter : public PrettyPrinter {
using unit = typename std::conditional<std::is_same<T, Date32Array>::value,
arrow_vendored::date::days,
std::chrono::milliseconds>::type;
WriteValues(array, [&](int64_t i) { FormatDateTime<unit>("%F", data[i], true); });
WriteValues(array,
[&](int64_t i) { FormatDateTime<unit>(sink_, "%F", data[i], true); });
return Status::OK();
}

template <typename T>
enable_if_time<typename T::TypeClass, Status> WriteDataValues(const T& array) {
const auto data = array.raw_values();
const auto type = static_cast<const TimeType*>(array.type().get());
WriteValues(array,
[&](int64_t i) { FormatDateTime(type->unit(), "%T", data[i], false); });
WriteValues(array, [&](int64_t i) {
FormatDateTime(sink_, type->unit(), "%T", data[i], false);
});
return Status::OK();
}

Status WriteDataValues(const TimestampArray& array) {
const int64_t* data = array.raw_values();
const auto type = static_cast<const TimestampType*>(array.type().get());
WriteValues(array,
[&](int64_t i) { FormatDateTime(type->unit(), "%F %T", data[i], true); });
WriteValues(array, [&](int64_t i) {
FormatDateTime(sink_, type->unit(), "%F %T", data[i], true);
});
return Status::OK();
}

Expand Down Expand Up @@ -385,41 +543,8 @@ class ArrayPrinter : public PrettyPrinter {
Flush();
return Status::OK();
}

private:
template <typename Unit>
void FormatDateTime(const char* fmt, int64_t value, bool add_epoch) {
if (add_epoch) {
(*sink_) << arrow_vendored::date::format(fmt, epoch_ + Unit{value});
} else {
(*sink_) << arrow_vendored::date::format(fmt, Unit{value});
}
}

void FormatDateTime(TimeUnit::type unit, const char* fmt, int64_t value,
bool add_epoch) {
switch (unit) {
case TimeUnit::NANO:
FormatDateTime<std::chrono::nanoseconds>(fmt, value, add_epoch);
break;
case TimeUnit::MICRO:
FormatDateTime<std::chrono::microseconds>(fmt, value, add_epoch);
break;
case TimeUnit::MILLI:
FormatDateTime<std::chrono::milliseconds>(fmt, value, add_epoch);
break;
case TimeUnit::SECOND:
FormatDateTime<std::chrono::seconds>(fmt, value, add_epoch);
break;
}
}

static arrow_vendored::date::sys_days epoch_;
};

arrow_vendored::date::sys_days ArrayPrinter::epoch_ =
arrow_vendored::date::sys_days{arrow_vendored::date::jan / 1 / 1970};

Status ArrayPrinter::WriteValidityBitmap(const Array& array) {
Indent();
Write("-- is_valid:");
Expand Down Expand Up @@ -456,6 +581,20 @@ Status PrettyPrint(const Array& arr, const PrettyPrintOptions& options,
return Status::OK();
}

Status PrettyPrint(const Scalar& scalar, const PrettyPrintOptions& options,
std::ostream* sink) {
ScalarPrinter printer(options, sink);
return printer.Print(scalar);
}

Status PrettyPrint(const Scalar& scalar, const PrettyPrintOptions& options,
std::string* result) {
std::ostringstream sink;
RETURN_NOT_OK(PrettyPrint(scalar, options, &sink));
*result = sink.str();
return Status::OK();
}

Status PrettyPrint(const ChunkedArray& chunked_arr, const PrettyPrintOptions& options,
std::ostream* sink) {
int num_chunks = chunked_arr.num_chunks();
Expand Down
9 changes: 9 additions & 0 deletions cpp/src/arrow/pretty_print.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,15 @@ ARROW_EXPORT
Status PrettyPrint(const Schema& schema, const PrettyPrintOptions& options,
std::string* result);

/// \brief Print human-readable representation of Scalar
ARROW_EXPORT
Status PrettyPrint(const Scalar& scalar, const PrettyPrintOptions& options,
std::ostream* sink);

ARROW_EXPORT
Status PrettyPrint(const Scalar& scalar, const PrettyPrintOptions& options,
std::string* result);

ARROW_EXPORT
Status DebugPrint(const Array& arr, int indent);

Expand Down
Loading