polars-df 0.20.0-x64-mingw-ucrt → 0.21.1-x64-mingw-ucrt

data/lib/polars/date_time_name_space.rb

@@ -18,6 +18,68 @@ module Polars
       s[item]
     end
 
+    # Offset by `n` business days.
+    #
+    # @note
+    #   This functionality is considered **unstable**. It may be changed
+    #   at any point without it being considered a breaking change.
+    #
+    # @param n [Object]
+    #   Number of business days to offset by. Can be a single number of an
+    #   expression.
+    # @param week_mask [Array]
+    #   Which days of the week to count. The default is Monday to Friday.
+    #   If you wanted to count only Monday to Thursday, you would pass
+    #   `[true, true, true, true, false, false, false]`.
+    # roll
+    #   What to do when the start date lands on a non-business day. Options are:
+    #
+    #   - `'raise'`: raise an error
+    #   - `'forward'`: move to the next business day
+    #   - `'backward'`: move to the previous business day
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new("start", [Date.new(2020, 1, 1), Date.new(2020, 1, 2)])
+    #   s.dt.add_business_days(5)
+    #   # =>
+    #   # shape: (2,)
+    #   # Series: 'start' [date]
+    #   # [
+    #   #         2020-01-08
+    #   #         2020-01-09
+    #   # ]
+    #
+    # @example You can pass a custom weekend - for example, if you only take Sunday off:
+    #   week_mask = [true, true, true, true, true, true, false]
+    #   s.dt.add_business_days(5, week_mask: week_mask)
+    #   # =>
+    #   # shape: (2,)
+    #   # Series: 'start' [date]
+    #   # [
+    #   #         2020-01-07
+    #   #         2020-01-08
+    #   # ]
+    #
+    # @example Roll all dates forwards to the next business day:
+    #   s = Polars::Series.new("start", [Date.new(2020, 1, 5), Date.new(2020, 1, 6)])
+    #   s.dt.add_business_days(0, roll: "forward")
+    #   # =>
+    #   # shape: (2,)
+    #   # Series: 'start' [date]
+    #   # [
+    #   #         2020-01-06
+    #   #         2020-01-06
+    #   # ]
+    def add_business_days(
+      n,
+      week_mask: [true, true, true, true, true, false, false],
+      roll: "raise"
+    )
+      super
+    end
+
     # Return minimum as Ruby object.
     #
     # @return [Object]
@@ -139,6 +201,74 @@ module Polars
       super
     end
 
+    # Extract the millennium from underlying representation.
+    #
+    # Applies to Date and Datetime columns.
+    #
+    # Returns the millennium number in the calendar date.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new(
+    #     "dt",
+    #     [
+    #       Date.new(999, 12, 31),
+    #       Date.new(1897, 5, 7),
+    #       Date.new(2000, 1, 1),
+    #       Date.new(2001, 7, 5),
+    #       Date.new(3002, 10, 20)
+    #     ]
+    #   )
+    #   s.dt.millennium
+    #   # =>
+    #   # shape: (5,)
+    #   # Series: 'dt' [i32]
+    #   # [
+    #   #         1
+    #   #         2
+    #   #         2
+    #   #         3
+    #   #         4
+    #   # ]
+    def millennium
+      super
+    end
+
+    # Extract the century from underlying representation.
+    #
+    # Applies to Date and Datetime columns.
+    #
+    # Returns the century number in the calendar date.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new(
+    #     "dt",
+    #     [
+    #       Date.new(999, 12, 31),
+    #       Date.new(1897, 5, 7),
+    #       Date.new(2000, 1, 1),
+    #       Date.new(2001, 7, 5),
+    #       Date.new(3002, 10, 20)
+    #     ]
+    #   )
+    #   s.dt.century
+    #   # =>
+    #   # shape: (5,)
+    #   # Series: 'dt' [i32]
+    #   # [
+    #   #         10
+    #   #         19
+    #   #         20
+    #   #         21
+    #   #         31
+    #   # ]
+    def century
+      super
+    end
+
     # Extract the year from the underlying date representation.
     #
     # Applies to Date and Datetime columns.
@@ -161,6 +291,69 @@ module Polars
       super
     end
 
+    # Determine whether each day lands on a business day.
+    #
+    # @note
+    #   This functionality is considered **unstable**. It may be changed
+    #   at any point without it being considered a breaking change.
+    #
+    # @param week_mask [Array]
+    #   Which days of the week to count. The default is Monday to Friday.
+    #   If you wanted to count only Monday to Thursday, you would pass
+    #   `(True, True, True, True, False, False, False)`.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new([Date.new(2020, 1, 3), Date.new(2020, 1, 5)])
+    #   s.dt.is_business_day
+    #   # =>
+    #   # shape: (2,)
+    #   # Series: '' [bool]
+    #   # [
+    #   #         true
+    #   #         false
+    #   # ]
+    #
+    # @example You can pass a custom weekend - for example, if you only take Sunday off:
+    #   week_mask = [true, true, true, true, true, true, false]
+    #   s.dt.is_business_day(week_mask: week_mask)
+    #   # =>
+    #   # shape: (2,)
+    #   # Series: '' [bool]
+    #   # [
+    #   #         true
+    #   #         false
+    #   # ]
+    def is_business_day(
+      week_mask: [true, true, true, true, true, false, false]
+    )
+      super
+    end
+
+    # Determine whether the year of the underlying date representation is a leap year.
+    #
+    # Applies to Date and Datetime columns.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new(
+    #     "date", [Date.new(2000, 1, 1), Date.new(2001, 1, 1), Date.new(2002, 1, 1)]
+    #   )
+    #   s.dt.is_leap_year
+    #   # =>
+    #   # shape: (3,)
+    #   # Series: 'date' [bool]
+    #   # [
+    #   #         true
+    #   #         false
+    #   #         false
+    #   # ]
+    def is_leap_year
+      super
+    end
+
     # Extract ISO year from underlying Date representation.
     #
     # Applies to Date and Datetime columns.
@@ -346,6 +539,48 @@ module Polars
       super
     end
 
+    # Extract (local) time.
+    #
+    # Applies to Date/Datetime/Time columns.
+    #
+    # @return
+    #
+    # @example
+    #   ser = Polars::Series.new([DateTime.new(2021, 1, 2, 5)]).dt.replace_time_zone(
+    #     "Asia/Kathmandu"
+    #   )
+    #   ser.dt.time
+    #   # =>
+    #   # shape: (1,)
+    #   # Series: '' [time]
+    #   # [
+    #   #         05:00:00
+    #   # ]
+    def time
+      super
+    end
+
+    # Extract (local) date.
+    #
+    # Applies to Date/Datetime columns.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   ser = Polars::Series.new([DateTime.new(2021, 1, 2, 5)]).dt.replace_time_zone(
+    #     "Asia/Kathmandu"
+    #   )
+    #   ser.dt.date
+    #   # =>
+    #   # shape: (1,)
+    #   # Series: '' [date]
+    #   # [
+    #   #         2021-01-02
+    #   # ]
+    def date
+      super
+    end
+
     # Extract the hour from the underlying DateTime representation.
     #
     # Applies to Datetime columns.
@@ -1276,6 +1511,21 @@ module Polars
       super
     end
 
+    # Create a naive Datetime from an existing Date/Datetime expression and a Time.
+    #
+    # If the underlying expression is a Datetime then its time component is replaced,
+    # and if it is a Date then a new Datetime is created by combining the two values.
+    #
+    # @param time [Object]
+    #   A Ruby time literal or Series of the same length as this Series.
+    # @param time_unit ['ns', 'us', 'ms']
+    #   Unit of time.
+    #
+    # @return [Series]
+    def combine(time, time_unit: "us")
+      super
+    end
+
     # Roll backward to the first day of the month.
     #
     # @return [Series]
@@ -1370,5 +1620,54 @@ module Polars
     def dst_offset
       super
     end
+
+    # Replace time unit.
+    #
+    # @param year [Object]
+    #   Literal or Series.
+    # @param month [Object]
+    #   Literal or Series, ranging from 1-12.
+    # @param day [Object]
+    #   Literal or Series, ranging from 1-31.
+    # @param hour [Object]
+    #   Literal or Series, ranging from 0-23.
+    # @param minute [Object]
+    #   Literal or Series, ranging from 0-59.
+    # @param second [Object]
+    #   Literal or Series, ranging from 0-59.
+    # @param microsecond [Object]
+    #   Literal or Series, ranging from 0-999999.
+    # @param ambiguous [String]
+    #   Determine how to deal with ambiguous datetimes:
+    #
+    #   - `'raise'` (default): raise
+    #   - `'earliest'`: use the earliest datetime
+    #   - `'latest'`: use the latest datetime
+    #   - `'null'`: set to null
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new("date", [Date.new(2013, 1, 1), Date.new(2024, 1, 2)])
+    #   s.dt.replace(year: 1800)
+    #   # =>
+    #   # shape: (2,)
+    #   # Series: 'date' [date]
+    #   # [
+    #   #         1800-01-01
+    #   #         1800-01-02
+    #   # ]
+    def replace(
+      year: nil,
+      month: nil,
+      day: nil,
+      hour: nil,
+      minute: nil,
+      second: nil,
+      microsecond: nil,
+      ambiguous: "raise"
+    )
+      super
+    end
   end
 end

data/lib/polars/exceptions.rb

@@ -24,10 +24,15 @@ module Polars
   class TooManyRowsReturned < RowsException; end
 
   # @private
-  class AssertionError < Error; end
+  # Exception raised when Polars could not perform an underlying computation.
+  class ComputeError < Error; end
 
   # @private
-  class ComputeError < Error; end
+  # Exception raised when a column name is duplicated.
+  class DuplicateError < Error; end
+
+  # @private
+  class AssertionError < Error; end
 
   # @private
   class Todo < Error