This is an automated email from the ASF dual-hosted git repository.
kou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new cb1e29c0c1 GH-40438: [GLib] Add GArrowTimestampParser (#40457)
cb1e29c0c1 is described below
commit cb1e29c0c1fdc691a8a4f3bc7621c6fdcf181dfc
Author: Sutou Kouhei <[email protected]>
AuthorDate: Tue Mar 12 04:39:02 2024 +0900
GH-40438: [GLib] Add GArrowTimestampParser (#40457)
### Rationale for this change
It's a binding of `arrow::TimestampParser`.
### What changes are included in this PR?
Add `GArrowStrptimeTimestampParser` and `GArrowISO8601TimestampParser`.
### Are these changes tested?
Yes.
### Are there any user-facing changes?
No.
* GitHub Issue: #40438
Authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
---
c_glib/arrow-glib/meson.build | 9 +-
c_glib/arrow-glib/reader.cpp | 4 +-
c_glib/arrow-glib/timestamp-parser.cpp | 207 +++++++++++++++++++++++++++++++++
c_glib/arrow-glib/timestamp-parser.h | 74 ++++++++++++
c_glib/arrow-glib/timestamp-parser.hpp | 27 +++++
c_glib/test/test-timestamp-parser.rb | 42 +++++++
6 files changed, 358 insertions(+), 5 deletions(-)
diff --git a/c_glib/arrow-glib/meson.build b/c_glib/arrow-glib/meson.build
index 7efba11bf9..a914002864 100644
--- a/c_glib/arrow-glib/meson.build
+++ b/c_glib/arrow-glib/meson.build
@@ -36,9 +36,10 @@ sources = files(
'record-batch.cpp',
'scalar.cpp',
'schema.cpp',
- 'table.cpp',
'table-builder.cpp',
+ 'table.cpp',
'tensor.cpp',
+ 'timestamp-parser.cpp',
'type.cpp',
)
@@ -99,9 +100,10 @@ c_headers = files(
'record-batch.h',
'scalar.h',
'schema.h',
- 'table.h',
'table-builder.h',
+ 'table.h',
'tensor.h',
+ 'timestamp-parser.h',
'type.h',
)
@@ -160,9 +162,10 @@ cpp_headers = files(
'record-batch.hpp',
'scalar.hpp',
'schema.hpp',
- 'table.hpp',
'table-builder.hpp',
+ 'table.hpp',
'tensor.hpp',
+ 'timestamp-parser.hpp',
'type.hpp',
)
diff --git a/c_glib/arrow-glib/reader.cpp b/c_glib/arrow-glib/reader.cpp
index 4bde9ee32d..0b388a4ba3 100644
--- a/c_glib/arrow-glib/reader.cpp
+++ b/c_glib/arrow-glib/reader.cpp
@@ -136,7 +136,7 @@
garrow_record_batch_reader_class_init(GArrowRecordBatchReaderClass *klass)
{
auto gobject_class = G_OBJECT_CLASS(klass);
gobject_class->finalize = garrow_record_batch_reader_finalize;
- gobject_class->finalize = garrow_record_batch_reader_dispose;
+ gobject_class->dispose = garrow_record_batch_reader_dispose;
gobject_class->set_property = garrow_record_batch_reader_set_property;
GParamSpec *spec;
@@ -187,7 +187,7 @@ garrow_record_batch_reader_import(gpointer
c_abi_array_stream, GError **error)
* @schema: (nullable): A #GArrowSchema to confirm to.
* @error: (nullable): Return location for a #GError or %NULL.
*
- * Returns: The schema in the stream on success, %NULL on error.
+ * Returns: A newly created #GArrowRecordBatchReader.
*
* Since: 6.0.0
*/
diff --git a/c_glib/arrow-glib/timestamp-parser.cpp
b/c_glib/arrow-glib/timestamp-parser.cpp
new file mode 100644
index 0000000000..1e41daf082
--- /dev/null
+++ b/c_glib/arrow-glib/timestamp-parser.cpp
@@ -0,0 +1,207 @@
+/*
+ * 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.
+ */
+
+#include <arrow-glib/timestamp-parser.hpp>
+
+G_BEGIN_DECLS
+
+/**
+ * SECTION: timestamp-parser
+ * @section_id: timestamp-parser-classes
+ * @title: TimestamParser classes
+ * @include: arrow-glib/arrow-glib.h
+ *
+ * #GArrowTimestampParser is a base class for parsing timestamp text.
+ *
+ * #GArrowStrptimeTimestampParser is a class for parsing timestamp
+ * text used by the given stprtime(3) format.
+ *
+ * #GArrowISO8601TimestampParser is a class for parsing ISO 8601
+ * format timestamp text.
+ */
+
+struct GArrowTimestampParserPrivate
+{
+ std::shared_ptr<arrow::TimestampParser> parser;
+};
+
+enum {
+ PROP_PARSER = 1,
+};
+
+G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE(GArrowTimestampParser,
+ garrow_timestamp_parser,
+ G_TYPE_OBJECT);
+
+#define GARROW_TIMESTAMP_PARSER_GET_PRIVATE(obj)
\
+ static_cast<GArrowTimestampParserPrivate *>(
\
+ garrow_timestamp_parser_get_instance_private(GARROW_TIMESTAMP_PARSER(obj)))
+
+static void
+garrow_timestamp_parser_finalize(GObject *object)
+{
+ auto priv = GARROW_TIMESTAMP_PARSER_GET_PRIVATE(object);
+
+ priv->parser.~shared_ptr();
+
+ G_OBJECT_CLASS(garrow_timestamp_parser_parent_class)->finalize(object);
+}
+
+static void
+garrow_timestamp_parser_set_property(GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ auto priv = GARROW_TIMESTAMP_PARSER_GET_PRIVATE(object);
+
+ switch (prop_id) {
+ case PROP_PARSER:
+ priv->parser =
+ *static_cast<std::shared_ptr<arrow::TimestampParser>
*>(g_value_get_pointer(value));
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+garrow_timestamp_parser_init(GArrowTimestampParser *object)
+{
+ auto priv = GARROW_TIMESTAMP_PARSER_GET_PRIVATE(object);
+ new (&priv->parser) std::shared_ptr<arrow::TimestampParser>;
+}
+
+static void
+garrow_timestamp_parser_class_init(GArrowTimestampParserClass *klass)
+{
+ auto gobject_class = G_OBJECT_CLASS(klass);
+ gobject_class->finalize = garrow_timestamp_parser_finalize;
+ gobject_class->set_property = garrow_timestamp_parser_set_property;
+
+ GParamSpec *spec;
+ spec = g_param_spec_pointer(
+ "parser",
+ "Parser",
+ "The raw std::shared<arrow::TimestampParser> *",
+ static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ g_object_class_install_property(gobject_class, PROP_PARSER, spec);
+}
+
+/**
+ * garrow_timestamp_parser_get_kind:
+ * @parser: A #GArrowTimestampParser.
+ *
+ * Returns: The kind of this timestamp parser.
+ *
+ * Since: 16.0.0
+ */
+const gchar *
+garrow_timestamp_parser_get_kind(GArrowTimestampParser *parser)
+{
+ auto arrow_parser = garrow_timestamp_parser_get_raw(parser);
+ return arrow_parser->kind();
+}
+
+G_DEFINE_TYPE(GArrowStrptimeTimestampParser,
+ garrow_strptime_timestamp_parser,
+ GARROW_TYPE_TIMESTAMP_PARSER);
+
+static void
+garrow_strptime_timestamp_parser_init(GArrowStrptimeTimestampParser *object)
+{
+}
+
+static void
+garrow_strptime_timestamp_parser_class_init(GArrowStrptimeTimestampParserClass
*klass)
+{
+}
+
+/**
+ * garrow_strptime_timestamp_parser_new:
+ * @format: A format used by strptime(3).
+ *
+ * Returns: (transfer full): A newly allocated #GArrowStrptimeTimestampParser.
+ *
+ * Since: 16.0.0
+ */
+GArrowStrptimeTimestampParser *
+garrow_strptime_timestamp_parser_new(const gchar *format)
+{
+ auto arrow_parser = arrow::TimestampParser::MakeStrptime(format);
+ return GARROW_STRPTIME_TIMESTAMP_PARSER(
+ g_object_new(GARROW_TYPE_STRPTIME_TIMESTAMP_PARSER,
+ "parser",
+ &arrow_parser,
+ nullptr));
+}
+
+/**
+ * garrow_strptime_timestamp_parser_get_format:
+ * @parser: A #GArrowStrptimeTimestampParser.
+ *
+ * Returns: The format used by this parser.
+ *
+ * Since: 16.0.0
+ */
+const gchar *
+garrow_strptime_timestamp_parser_get_format(GArrowStrptimeTimestampParser
*parser)
+{
+ auto arrow_parser =
garrow_timestamp_parser_get_raw(GARROW_TIMESTAMP_PARSER(parser));
+ return arrow_parser->format();
+}
+
+G_DEFINE_TYPE(GArrowISO8601TimestampParser,
+ garrow_iso8601_timestamp_parser,
+ GARROW_TYPE_TIMESTAMP_PARSER);
+
+static void
+garrow_iso8601_timestamp_parser_init(GArrowISO8601TimestampParser *object)
+{
+}
+
+static void
+garrow_iso8601_timestamp_parser_class_init(GArrowISO8601TimestampParserClass
*klass)
+{
+}
+
+/**
+ * garrow_iso8601_timestamp_parser_new:
+ *
+ * Returns: (transfer full): A newly allocated #GArrowISO8601TimestampParser.
+ *
+ * Since: 16.0.0
+ */
+GArrowISO8601TimestampParser *
+garrow_iso8601_timestamp_parser_new(void)
+{
+ auto arrow_parser = arrow::TimestampParser::MakeISO8601();
+ return GARROW_ISO8601_TIMESTAMP_PARSER(
+ g_object_new(GARROW_TYPE_ISO8601_TIMESTAMP_PARSER, "parser",
&arrow_parser, nullptr));
+}
+
+G_END_DECLS
+
+std::shared_ptr<arrow::TimestampParser>
+garrow_timestamp_parser_get_raw(GArrowTimestampParser *parser)
+{
+ auto priv = GARROW_TIMESTAMP_PARSER_GET_PRIVATE(parser);
+ return priv->parser;
+}
diff --git a/c_glib/arrow-glib/timestamp-parser.h
b/c_glib/arrow-glib/timestamp-parser.h
new file mode 100644
index 0000000000..d5b62bb568
--- /dev/null
+++ b/c_glib/arrow-glib/timestamp-parser.h
@@ -0,0 +1,74 @@
+/*
+ * 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.
+ */
+
+#pragma once
+
+#include <arrow-glib/gobject-type.h>
+#include <arrow-glib/version.h>
+
+G_BEGIN_DECLS
+
+#define GARROW_TYPE_TIMESTAMP_PARSER (garrow_timestamp_parser_get_type())
+G_DECLARE_DERIVABLE_TYPE(
+ GArrowTimestampParser, garrow_timestamp_parser, GARROW, TIMESTAMP_PARSER,
GObject)
+struct _GArrowTimestampParserClass
+{
+ GObjectClass parent_class;
+};
+
+GARROW_AVAILABLE_IN_16_0
+const gchar *
+garrow_timestamp_parser_get_kind(GArrowTimestampParser *parser);
+
+#define GARROW_TYPE_STRPTIME_TIMESTAMP_PARSER
\
+ (garrow_strptime_timestamp_parser_get_type())
+G_DECLARE_DERIVABLE_TYPE(GArrowStrptimeTimestampParser,
+ garrow_strptime_timestamp_parser,
+ GARROW,
+ STRPTIME_TIMESTAMP_PARSER,
+ GArrowTimestampParser)
+struct _GArrowStrptimeTimestampParserClass
+{
+ GArrowTimestampParserClass parent_class;
+};
+
+GARROW_AVAILABLE_IN_16_0
+GArrowStrptimeTimestampParser *
+garrow_strptime_timestamp_parser_new(const gchar *format);
+
+GARROW_AVAILABLE_IN_16_0
+const gchar *
+garrow_strptime_timestamp_parser_get_format(GArrowStrptimeTimestampParser
*parser);
+
+#define GARROW_TYPE_ISO8601_TIMESTAMP_PARSER
(garrow_iso8601_timestamp_parser_get_type())
+G_DECLARE_DERIVABLE_TYPE(GArrowISO8601TimestampParser,
+ garrow_iso8601_timestamp_parser,
+ GARROW,
+ ISO8601_TIMESTAMP_PARSER,
+ GArrowTimestampParser)
+struct _GArrowISO8601TimestampParserClass
+{
+ GArrowTimestampParserClass parent_class;
+};
+
+GARROW_AVAILABLE_IN_16_0
+GArrowISO8601TimestampParser *
+garrow_iso8601_timestamp_parser_new();
+
+G_END_DECLS
diff --git a/c_glib/arrow-glib/timestamp-parser.hpp
b/c_glib/arrow-glib/timestamp-parser.hpp
new file mode 100644
index 0000000000..00c37aed9c
--- /dev/null
+++ b/c_glib/arrow-glib/timestamp-parser.hpp
@@ -0,0 +1,27 @@
+/*
+ * 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.
+ */
+
+#pragma once
+
+#include <arrow/util/value_parsing.h>
+
+#include <arrow-glib/timestamp-parser.h>
+
+std::shared_ptr<arrow::TimestampParser>
+garrow_timestamp_parser_get_raw(GArrowTimestampParser *parser);
diff --git a/c_glib/test/test-timestamp-parser.rb
b/c_glib/test/test-timestamp-parser.rb
new file mode 100644
index 0000000000..7095b2d26c
--- /dev/null
+++ b/c_glib/test/test-timestamp-parser.rb
@@ -0,0 +1,42 @@
+# 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.
+
+class TestTimestampParser < Test::Unit::TestCase
+ sub_test_case("strptime") do
+ def setup
+ @parser = Arrow::StrptimeTimestampParser.new("%Y-%m-%d")
+ end
+
+ def test_kind
+ assert_equal("strptime", @parser.kind)
+ end
+
+ def test_format
+ assert_equal("%Y-%m-%d", @parser.format)
+ end
+ end
+
+ sub_test_case("ISO8601") do
+ def setup
+ @parser = Arrow::ISO8601TimestampParser.new
+ end
+
+ def test_kind
+ assert_equal("iso8601", @parser.kind)
+ end
+ end
+end
