polars-df 0.1.2 → 0.1.4

data/lib/polars/struct_expr.rb

@@ -1,11 +1,17 @@
 module Polars
+  # Namespace for struct related expressions.
   class StructExpr
+    # @private
     attr_accessor :_rbexpr
 
+    # @private
     def initialize(expr)
       self._rbexpr = expr._rbexpr
     end
 
+    # Retrieve one of the fields of this `Struct` as a new Series.
+    #
+    # @return [Expr]
     def [](item)
       if item.is_a?(String)
         field(item)
@@ -16,10 +22,77 @@ module Polars
       end
     end
 
+    # Retrieve one of the fields of this `Struct` as a new Series.
+    #
+    # @param name [String]
+    #   Name of the field
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = (
+    #     Polars::DataFrame.new(
+    #       {
+    #         "int" => [1, 2],
+    #         "str" => ["a", "b"],
+    #         "bool" => [true, nil],
+    #         "list" => [[1, 2], [3]]
+    #       }
+    #     )
+    #     .to_struct("my_struct")
+    #     .to_frame
+    #   )
+    #   df.select(Polars.col("my_struct").struct.field("str"))
+    #   # =>
+    #   # shape: (2, 1)
+    #   # ┌─────┐
+    #   # │ str │
+    #   # │ --- │
+    #   # │ str │
+    #   # ╞═════╡
+    #   # │ a   │
+    #   # ├╌╌╌╌╌┤
+    #   # │ b   │
+    #   # └─────┘
     def field(name)
       Utils.wrap_expr(_rbexpr.struct_field_by_name(name))
     end
 
+    # Rename the fields of the struct.
+    #
+    # @param names [Array]
+    #   New names in the order of the struct's fields
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = (
+    #     Polars::DataFrame.new(
+    #       {
+    #         "int" => [1, 2],
+    #         "str" => ["a", "b"],
+    #         "bool" => [true, nil],
+    #         "list" => [[1, 2], [3]]
+    #       }
+    #     )
+    #     .to_struct("my_struct")
+    #     .to_frame
+    #   )
+    #   df = df.with_column(
+    #     Polars.col("my_struct").struct.rename_fields(["INT", "STR", "BOOL", "LIST"])
+    #   )
+    #   df.select(Polars.col("my_struct").struct.field("INT"))
+    #   # =>
+    #   # shape: (2, 1)
+    #   # ┌─────┐
+    #   # │ INT │
+    #   # │ --- │
+    #   # │ i64 │
+    #   # ╞═════╡
+    #   # │ 1   │
+    #   # ├╌╌╌╌╌┤
+    #   # │ 2   │
+    #   # └─────┘
     def rename_fields(names)
       Utils.wrap_expr(_rbexpr.struct_rename_fields(names))
     end

data/lib/polars/struct_name_space.rb

@@ -0,0 +1,64 @@
+module Polars
+  # Series.struct namespace.
+  class StructNameSpace
+    include ExprDispatch
+
+    self._accessor = "struct"
+
+    # @private
+    def initialize(series)
+      self._s = series._s
+    end
+
+    # Retrieve one of the fields of this `Struct` as a new Series.
+    #
+    # @return [Series]
+    def [](item)
+      if item.is_a?(Integer)
+        field(fields[item])
+      elsif item.is_a?(String)
+        field(item)
+      else
+        raise ArgumentError, "expected type Integer or String, got #{item.class.name}"
+      end
+    end
+
+    # Convert this Struct Series to a DataFrame.
+    #
+    # @return [DataFrame]
+    def to_frame
+      Utils.wrap_df(_s.struct_to_frame)
+    end
+
+    # Get the names of the fields.
+    #
+    # @return [Array]
+    def fields
+      if _s.nil?
+        []
+      else
+        _s.struct_fields
+      end
+    end
+
+    # Retrieve one of the fields of this `Struct` as a new Series.
+    #
+    # @param name [String]
+    #   Name of the field
+    #
+    # @return [Series]
+    def field(name)
+      super
+    end
+
+    # Rename the fields of the struct.
+    #
+    # @param names [Array]
+    #   New names in the order of the struct's fields
+    #
+    # @return [Series]
+    def rename_fields(names)
+      super
+    end
+  end
+end

data/lib/polars/utils.rb

@@ -19,6 +19,52 @@ module Polars
       Polars.col(name)
     end
 
+    def self._timedelta_to_pl_duration(td)
+      td
+    end
+
+    def self._datetime_to_pl_timestamp(dt, tu)
+      if tu == "ns"
+        (dt.to_datetime.utc.to_f * 1e9).to_i
+      elsif tu == "us"
+        (dt.to_datetime.utc.to_f * 1e6).to_i
+      elsif tu == "ms"
+        (dt.to_datetime.utc.to_f * 1e3).to_i
+      elsif tu.nil?
+        (dt.to_datetime.utc.to_f * 1e6).to_i
+      else
+        raise ArgumentError, "tu must be one of {{'ns', 'us', 'ms'}}, got #{tu}"
+      end
+    end
+
+    def self._to_ruby_datetime(value, dtype, tu: "ns", tz: nil)
+      if dtype == :date
+        # days to seconds
+        # important to create from utc. Not doing this leads
+        # to inconsistencies dependent on the timezone you are in.
+        Time.at(value * 86400).utc.to_date
+      # TODO fix dtype
+      elsif dtype.to_s.start_with?("datetime[")
+        if tz.nil? || tz == ""
+          if tu == "ns"
+            raise Todo
+          elsif tu == "us"
+            dt = Time.at(value / 1000000, value % 1000000, :usec).utc
+          elsif tu == "ms"
+            raise Todo
+          else
+            raise ArgumentError, "tu must be one of {{'ns', 'us', 'ms'}}, got #{tu}"
+          end
+        else
+          raise Todo
+        end
+
+        dt
+      else
+        raise NotImplementedError
+      end
+    end
+
     def self.selection_to_rbexpr_list(exprs)
       if exprs.is_a?(String) || exprs.is_a?(Expr) || exprs.is_a?(Series)
         exprs = [exprs]
@@ -49,12 +95,30 @@ module Polars
 
     # TODO fix
     def self.is_polars_dtype(data_type)
-      true
+      data_type.is_a?(Symbol) || data_type.is_a?(String)
     end
 
+    RB_TYPE_TO_DTYPE = {
+      Float => :f64,
+      Integer => :i64,
+      String => :str,
+      TrueClass => :bool,
+      FalseClass => :bool,
+      Date => :date,
+      DateTime => :datetime
+    }
+
     # TODO fix
-    def self.rb_type_to_dtype(dtype)
-      dtype.to_s
+    def self.rb_type_to_dtype(data_type)
+      if is_polars_dtype(data_type)
+        return data_type.to_s
+      end
+
+      begin
+        RB_TYPE_TO_DTYPE.fetch(data_type).to_s
+      rescue KeyError
+        raise ArgumentError, "Conversion of Ruby data type #{data_type} to Polars data type not implemented."
+      end
     end
 
     def self._process_null_values(null_values)
@@ -103,5 +167,9 @@ module Polars
         sz
       end
     end
+
+    def self.bool?(value)
+      value == true || value == false
+    end
   end
 end

data/lib/polars/version.rb

@@ -1,3 +1,4 @@
 module Polars
-  VERSION = "0.1.2"
+  # @private
+  VERSION = "0.1.4"
 end

data/lib/polars/when.rb

@@ -1,4 +1,5 @@
 module Polars
+  # @private
   class When
     attr_accessor :_rbwhen
 

data/lib/polars/when_then.rb

@@ -1,4 +1,5 @@
 module Polars
+  # @private
   class WhenThen
     attr_accessor :_rbwhenthen
 

data/lib/polars.rb

@@ -1,38 +1,40 @@
 # ext
 require "polars/polars"
 
+# stdlib
+require "date"
+
 # modules
+require "polars/expr_dispatch"
 require "polars/batched_csv_reader"
 require "polars/cat_expr"
+require "polars/cat_name_space"
 require "polars/data_frame"
 require "polars/date_time_expr"
+require "polars/date_time_name_space"
+require "polars/exceptions"
 require "polars/expr"
 require "polars/functions"
+require "polars/group_by"
 require "polars/io"
 require "polars/lazy_frame"
 require "polars/lazy_functions"
 require "polars/lazy_group_by"
 require "polars/list_expr"
+require "polars/list_name_space"
 require "polars/meta_expr"
 require "polars/series"
+require "polars/slice"
 require "polars/string_expr"
+require "polars/string_name_space"
 require "polars/struct_expr"
+require "polars/struct_name_space"
 require "polars/utils"
 require "polars/version"
 require "polars/when"
 require "polars/when_then"
 
 module Polars
-  # @private
-  class Error < StandardError; end
-
-  # @private
-  class Todo < Error
-    def message
-      "not implemented yet"
-    end
-  end
-
   extend Functions
   extend IO
   extend LazyFunctions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polars-df
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-26 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -31,6 +31,7 @@ extensions:
 - ext/polars/extconf.rb
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - Cargo.lock
 - Cargo.toml
@@ -50,24 +51,36 @@ files:
 - ext/polars/src/lazy/mod.rs
 - ext/polars/src/lazy/utils.rs
 - ext/polars/src/lib.rs
+- ext/polars/src/list_construction.rs
 - ext/polars/src/series.rs
+- ext/polars/src/set.rs
+- ext/polars/src/utils.rs
 - lib/polars-df.rb
 - lib/polars.rb
 - lib/polars/batched_csv_reader.rb
 - lib/polars/cat_expr.rb
+- lib/polars/cat_name_space.rb
 - lib/polars/data_frame.rb
 - lib/polars/date_time_expr.rb
+- lib/polars/date_time_name_space.rb
+- lib/polars/exceptions.rb
 - lib/polars/expr.rb
+- lib/polars/expr_dispatch.rb
 - lib/polars/functions.rb
+- lib/polars/group_by.rb
 - lib/polars/io.rb
 - lib/polars/lazy_frame.rb
 - lib/polars/lazy_functions.rb
 - lib/polars/lazy_group_by.rb
 - lib/polars/list_expr.rb
+- lib/polars/list_name_space.rb
 - lib/polars/meta_expr.rb
 - lib/polars/series.rb
+- lib/polars/slice.rb
 - lib/polars/string_expr.rb
+- lib/polars/string_name_space.rb
 - lib/polars/struct_expr.rb
+- lib/polars/struct_name_space.rb
 - lib/polars/utils.rb
 - lib/polars/version.rb
 - lib/polars/when.rb