Skip to content

Support decimal #203

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.

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
Totktonada opened this issue Dec 14, 2021 · 0 comments · Fixed by #226
Closed

Support decimal #203

Totktonada opened this issue Dec 14, 2021 · 0 comments · Fixed by #226
Assignees
Labels
feature A new functionality

Comments

@Totktonada
Copy link
Member

Protocol documentation: tarantool/doc#992.
Python documentation: https://docs.python.org/3/library/decimal.html.

What is interesting: I don't see a way to construct Python's decimal from a binary form without encoding into a string first. Maybe I missed something.

@Totktonada Totktonada added feature A new functionality teamE labels Dec 14, 2021
@DifferentialOrange DifferentialOrange self-assigned this Aug 30, 2022
DifferentialOrange added a commit that referenced this issue Aug 31, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Aug 31, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Aug 31, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Sep 1, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Sep 1, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Sep 1, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Sep 1, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Sep 1, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Sep 1, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Sep 1, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Sep 5, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Sep 5, 2022
Tarantool supports decimal type since version 2.2.1 [1]. This patch
introduced the support of Tarantool decimal type in msgpack decoders and
encoders. The Tarantool decimal type is mapped to the native Python
decimal.Decimal type.

Tarantool decimal numbers have 38 digits of precision, that is, the
total number of digits before and after the decimal point can be 38 [2].
If there are more digits arter the decimal point, the precision is lost.
If there are more digits before the decimal point, error is thrown. In
fact, there is also an exceptional case: if decimal starts with `0.`,
38 digits after the decimal point are supported without the loss of
precision. msgpack encoder checks if everything is alright. If number is
not a valid Tarantool decimal, the error is raised. If precision will be
lost on conversion, warning is issued.

Any Tarantool decimal could be converted to a Python decimal without the
loss of precision. Python decimals have its own user alterable precision
(defaulting to 28 places), but it's related only to arithmetic
operations: we can allocate 38-placed decimal disregarding of what
decimal module configuration is used [3].

1. tarantool/tarantool#692
2. https://www.tarantool.io/ru/doc/latest/reference/reference_lua/decimal/
3. https://docs.python.org/3/library/decimal.html

Closed #203
DifferentialOrange added a commit that referenced this issue Nov 9, 2022
Overview

  This release introduces the support of extention types (decimal, uuid,
  error, datetime, interval) in MessagePack, various IProto features
  support (feature discovery and push protocol) and major infrastructure
  updates (scm version computation, full documentation for external and
  internal API both as code docstrings and readthedocs HTML, deb and RPM
  packages, and everything is processed with CI/CD pipelines).

Breaking changes

  This release should not break any existing behavior.

New features

  - Backport ConnectionPool support for Python 3.6 (PR #245).
  - Support iproto feature discovery (#206).
  - Decimal type support (#203).
  - UUID type support (#202).
  - Support extra information for iproto errors (#232).
  - Error extension type support (#232).
  - Datetime type support and tarantool.Datetime type (#204, PR #252).

    Tarantool datetime objects are decoded to `tarantool.Datetime`
    type. `tarantool.Datetime` may be encoded to Tarantool datetime
    objects.

    You can create `tarantool.Datetime` objects either from
    MessagePack data or by using the same API as in Tarantool:

    ```python
    dt1 = tarantool.Datetime(year=2022, month=8, day=31,
                             hour=18, minute=7, sec=54,
                             nsec=308543321)

    dt2 = tarantool.Datetime(timestamp=1661969274)

    dt3 = tarantool.Datetime(timestamp=1661969274, nsec=308543321)
    ```

    `tarantool.Datetime` exposes `year`, `month`, `day`, `hour`,
    `minute`, `sec`, `nsec`, `timestamp` and `value` (integer epoch time
    with nanoseconds precision) properties if you need to convert
    `tarantool.Datetime` to any other kind of datetime object:

    ```python
    pdt = pandas.Timestamp(year=dt.year, month=dt.month, day=dt.day,
                           hour=dt.hour, minute=dt.minute, second=dt.sec,
                           microsecond=(dt.nsec // 1000),
                           nanosecond=(dt.nsec % 1000))
    ```

    Use `tzoffset` parameter to set up offset timezone:

    ```python
    dt = tarantool.Datetime(year=2022, month=8, day=31,
                            hour=18, minute=7, sec=54,
                            nsec=308543321, tzoffset=180)
    ```

    You may use `tzoffset` property to get timezone offset of a datetime
    object.

    Use `tz` parameter to set up timezone name:

    ```python
    dt = tarantool.Datetime(year=2022, month=8, day=31,
                            hour=18, minute=7, sec=54,
                            nsec=308543321, tz='Europe/Moscow')
    ```

    If both `tz` and `tzoffset` is specified, `tz` is used.

    You may use `tz` property to get timezone name of a datetime object.

    `timestamp_since_utc_epoch` is a parameter to set timestamp
    convertion behavior for timezone-aware datetimes.

    If ``False`` (default), behaves similar to Tarantool `datetime.new()`:

    ```python
    >>> dt = tarantool.Datetime(timestamp=1640995200, timestamp_since_utc_epoch=False)
    >>> dt
    datetime: Timestamp('2022-01-01 00:00:00'), tz: ""
    >>> dt.timestamp
    1640995200.0
    >>> dt = tarantool.Datetime(timestamp=1640995200, tz='Europe/Moscow',
    ...                         timestamp_since_utc_epoch=False)
    >>> dt
    datetime: Timestamp('2022-01-01 00:00:00+0300', tz='Europe/Moscow'), tz: "Europe/Moscow"
    >>> dt.timestamp
    1640984400.0
    ```

    Thus, if ``False``, datetime is computed from timestamp
    since epoch and then timezone is applied without any
    convertion. In that case, `dt.timestamp` won't be equal to
    initialization `timestamp` for all timezones with non-zero offset.

    If ``True``, behaves similar to `pandas.Timestamp`:

    ```python
    >>> dt = tarantool.Datetime(timestamp=1640995200, timestamp_since_utc_epoch=True)
    >>> dt
    datetime: Timestamp('2022-01-01 00:00:00'), tz: ""
    >>> dt.timestamp
    1640995200.0
    >>> dt = tarantool.Datetime(timestamp=1640995200, tz='Europe/Moscow',
    ...                         timestamp_since_utc_epoch=True)
    >>> dt
    datetime: Timestamp('2022-01-01 03:00:00+0300', tz='Europe/Moscow'), tz: "Europe/Moscow"
    >>> dt.timestamp
    1640995200.0
    ```

    Thus, if ``True``, datetime is computed in a way that `dt.timestamp`
    will always be equal to initialization `timestamp`.

  - Datetime interval type support and tarantool.Interval type (#229).

    Tarantool datetime interval objects are decoded to
    `tarantool.Interval` type. `tarantool.Interval` may be encoded to
    Tarantool interval objects.

    You can create `tarantool.Interval` objects either from
    MessagePack data or by using the same API as in Tarantool:

    ```python
    di = tarantool.Interval(year=-1, month=2, day=3,
                            hour=4, minute=-5, sec=6,
                            nsec=308543321,
                            adjust=tarantool.IntervalAdjust.NONE)
    ```

    Its attributes (same as in init API) are exposed, so you can
    use them if needed.

  - Datetime interval arithmetic support (#229).

    Valid operations:
    - `tarantool.Datetime` + `tarantool.Interval` = `tarantool.Datetime`
    - `tarantool.Datetime` - `tarantool.Interval` = `tarantool.Datetime`
    - `tarantool.Datetime` - `tarantool.Datetime` = `tarantool.Interval`
    - `tarantool.Interval` + `tarantool.Interval` = `tarantool.Interval`
    - `tarantool.Interval` - `tarantool.Interval` = `tarantool.Interval`

    Since `tarantool.Interval` could contain `month` and `year` fields
    and such operations could be ambiguous, you can use `adjust` field
    to tune the logic. The behavior is the same as in Tarantool, see
    [Interval arithmetic RFC](https://github.com/tarantool/tarantool/wiki/Datetime-Internals#interval-arithmetic).

    - `tarantool.IntervalAdjust.NONE` -- only truncation toward the end
      of month performed (default mode).

      ```python
      >>> dt = tarantool.Datetime(year=2022, month=3, day=31)
      datetime: Timestamp('2022-03-31 00:00:00'), tz: ""
      >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.NONE)
      >>> dt + di
      datetime: Timestamp('2022-04-30 00:00:00'), tz: ""
      ```

    - `tarantool.IntervalAdjust.EXCESS` -- overflow mode, without any
      snap or truncation to the end of month, straight addition of days
      in month, stopping over month boundaries if there is less number
      of days.

      ```python
      >>> dt = tarantool.Datetime(year=2022, month=1, day=31)
      datetime: Timestamp('2022-01-31 00:00:00'), tz: ""
      >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.EXCESS)
      >>> dt + di
      datetime: Timestamp('2022-03-02 00:00:00'), tz: ""
      ```

    - `tarantool.IntervalAdjust.LAST` -- mode when day snaps to the end
      of month, if happens.

      ```python
      >>> dt = tarantool.Datetime(year=2022, month=2, day=28)
      datetime: Timestamp('2022-02-28 00:00:00'), tz: ""
      >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.LAST)
      >>> dt + di
      datetime: Timestamp('2022-03-31 00:00:00'), tz: ""
      ```

  - Full documentation of internal and external API (#67).

Bugfixes

  - Allow any MessagePack supported type as a request key (#240).
  - Make connection close idempotent (#250).

Infrastructure

  - Use git version to set package version (#238).
  - Test pip install from branch (PR #241).
  - Pack and publish pip, RPM and deb packages with GitHub Actions
    (#164, #198).
  - Publish on readthedocs with CI/CD (including PRs) (#67).
DifferentialOrange added a commit that referenced this issue Nov 9, 2022
Overview

  This release introduces the support of extention types (decimal, uuid,
  error, datetime, interval) in MessagePack, various IProto features
  support (feature discovery and push protocol) and major infrastructure
  updates (scm version computation, full documentation for external and
  internal API both as code docstrings and readthedocs HTML, deb and RPM
  packages, and everything is processed with CI/CD pipelines).

Breaking changes

  This release should not break any existing behavior.

New features

  - Backport ConnectionPool support for Python 3.6 (PR #245).
  - Support iproto feature discovery (#206).
  - Decimal type support (#203).
  - UUID type support (#202).
  - Support extra information for iproto errors (#232).
  - Error extension type support (#232).
  - Datetime type support and tarantool.Datetime type (#204, PR #252).

    Tarantool datetime objects are decoded to `tarantool.Datetime`
    type. `tarantool.Datetime` may be encoded to Tarantool datetime
    objects.

    You can create `tarantool.Datetime` objects either from
    MessagePack data or by using the same API as in Tarantool:

    ```python
    dt1 = tarantool.Datetime(year=2022, month=8, day=31,
                             hour=18, minute=7, sec=54,
                             nsec=308543321)

    dt2 = tarantool.Datetime(timestamp=1661969274)

    dt3 = tarantool.Datetime(timestamp=1661969274, nsec=308543321)
    ```

    `tarantool.Datetime` exposes `year`, `month`, `day`, `hour`,
    `minute`, `sec`, `nsec`, `timestamp` and `value` (integer epoch time
    with nanoseconds precision) properties if you need to convert
    `tarantool.Datetime` to any other kind of datetime object:

    ```python
    pdt = pandas.Timestamp(year=dt.year, month=dt.month, day=dt.day,
                           hour=dt.hour, minute=dt.minute, second=dt.sec,
                           microsecond=(dt.nsec // 1000),
                           nanosecond=(dt.nsec % 1000))
    ```

    Use `tzoffset` parameter to set up offset timezone:

    ```python
    dt = tarantool.Datetime(year=2022, month=8, day=31,
                            hour=18, minute=7, sec=54,
                            nsec=308543321, tzoffset=180)
    ```

    You may use `tzoffset` property to get timezone offset of a datetime
    object.

    Use `tz` parameter to set up timezone name:

    ```python
    dt = tarantool.Datetime(year=2022, month=8, day=31,
                            hour=18, minute=7, sec=54,
                            nsec=308543321, tz='Europe/Moscow')
    ```

    If both `tz` and `tzoffset` is specified, `tz` is used.

    You may use `tz` property to get timezone name of a datetime object.

    `timestamp_since_utc_epoch` is a parameter to set timestamp
    convertion behavior for timezone-aware datetimes.

    If ``False`` (default), behaves similar to Tarantool `datetime.new()`:

    ```python
    >>> dt = tarantool.Datetime(timestamp=1640995200, timestamp_since_utc_epoch=False)
    >>> dt
    datetime: Timestamp('2022-01-01 00:00:00'), tz: ""
    >>> dt.timestamp
    1640995200.0
    >>> dt = tarantool.Datetime(timestamp=1640995200, tz='Europe/Moscow',
    ...                         timestamp_since_utc_epoch=False)
    >>> dt
    datetime: Timestamp('2022-01-01 00:00:00+0300', tz='Europe/Moscow'), tz: "Europe/Moscow"
    >>> dt.timestamp
    1640984400.0
    ```

    Thus, if ``False``, datetime is computed from timestamp
    since epoch and then timezone is applied without any
    convertion. In that case, `dt.timestamp` won't be equal to
    initialization `timestamp` for all timezones with non-zero offset.

    If ``True``, behaves similar to `pandas.Timestamp`:

    ```python
    >>> dt = tarantool.Datetime(timestamp=1640995200, timestamp_since_utc_epoch=True)
    >>> dt
    datetime: Timestamp('2022-01-01 00:00:00'), tz: ""
    >>> dt.timestamp
    1640995200.0
    >>> dt = tarantool.Datetime(timestamp=1640995200, tz='Europe/Moscow',
    ...                         timestamp_since_utc_epoch=True)
    >>> dt
    datetime: Timestamp('2022-01-01 03:00:00+0300', tz='Europe/Moscow'), tz: "Europe/Moscow"
    >>> dt.timestamp
    1640995200.0
    ```

    Thus, if ``True``, datetime is computed in a way that `dt.timestamp`
    will always be equal to initialization `timestamp`.

  - Datetime interval type support and tarantool.Interval type (#229).

    Tarantool datetime interval objects are decoded to
    `tarantool.Interval` type. `tarantool.Interval` may be encoded to
    Tarantool interval objects.

    You can create `tarantool.Interval` objects either from
    MessagePack data or by using the same API as in Tarantool:

    ```python
    di = tarantool.Interval(year=-1, month=2, day=3,
                            hour=4, minute=-5, sec=6,
                            nsec=308543321,
                            adjust=tarantool.IntervalAdjust.NONE)
    ```

    Its attributes (same as in init API) are exposed, so you can
    use them if needed.

  - Datetime interval arithmetic support (#229).

    Valid operations:
    - `tarantool.Datetime` + `tarantool.Interval` = `tarantool.Datetime`
    - `tarantool.Datetime` - `tarantool.Interval` = `tarantool.Datetime`
    - `tarantool.Datetime` - `tarantool.Datetime` = `tarantool.Interval`
    - `tarantool.Interval` + `tarantool.Interval` = `tarantool.Interval`
    - `tarantool.Interval` - `tarantool.Interval` = `tarantool.Interval`

    Since `tarantool.Interval` could contain `month` and `year` fields
    and such operations could be ambiguous, you can use `adjust` field
    to tune the logic. The behavior is the same as in Tarantool, see
    [Interval arithmetic RFC](https://github.com/tarantool/tarantool/wiki/Datetime-Internals#interval-arithmetic).

    - `tarantool.IntervalAdjust.NONE` -- only truncation toward the end
      of month performed (default mode).

      ```python
      >>> dt = tarantool.Datetime(year=2022, month=3, day=31)
      datetime: Timestamp('2022-03-31 00:00:00'), tz: ""
      >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.NONE)
      >>> dt + di
      datetime: Timestamp('2022-04-30 00:00:00'), tz: ""
      ```

    - `tarantool.IntervalAdjust.EXCESS` -- overflow mode, without any
      snap or truncation to the end of month, straight addition of days
      in month, stopping over month boundaries if there is less number
      of days.

      ```python
      >>> dt = tarantool.Datetime(year=2022, month=1, day=31)
      datetime: Timestamp('2022-01-31 00:00:00'), tz: ""
      >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.EXCESS)
      >>> dt + di
      datetime: Timestamp('2022-03-02 00:00:00'), tz: ""
      ```

    - `tarantool.IntervalAdjust.LAST` -- mode when day snaps to the end
      of month, if happens.

      ```python
      >>> dt = tarantool.Datetime(year=2022, month=2, day=28)
      datetime: Timestamp('2022-02-28 00:00:00'), tz: ""
      >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.LAST)
      >>> dt + di
      datetime: Timestamp('2022-03-31 00:00:00'), tz: ""
      ```

  - Full documentation of internal and external API (#67).

Bugfixes

  - Allow any MessagePack supported type as a request key (#240).
  - Make connection close idempotent (#250).

Infrastructure

  - Use git version to set package version (#238).
  - Test pip install from branch (PR #241).
  - Pack and publish pip, RPM and deb packages with GitHub Actions
    (#164, #198).
  - Publish on readthedocs with CI/CD (including PRs) (#67).
DifferentialOrange added a commit that referenced this issue Nov 9, 2022
Overview

  This release introduces the support of extention types (decimal, uuid,
  error, datetime, interval) in MessagePack, various IProto features
  support (feature discovery and push protocol) and major infrastructure
  updates (scm version computation, full documentation for external and
  internal API both as code docstrings and readthedocs HTML, deb and RPM
  packages, and everything is processed with CI/CD pipelines).

Breaking changes

  This release should not break any existing behavior.

New features

  - Backport ConnectionPool support for Python 3.6 (PR #245).
  - Support iproto feature discovery (#206).
  - Decimal type support (#203).
  - UUID type support (#202).
  - Support extra information for iproto errors (#232).
  - Error extension type support (#232).
  - Datetime type support and tarantool.Datetime type (#204, PR #252).

    Tarantool datetime objects are decoded to `tarantool.Datetime`
    type. `tarantool.Datetime` may be encoded to Tarantool datetime
    objects.

    You can create `tarantool.Datetime` objects either from
    MessagePack data or by using the same API as in Tarantool:

    ```python
    dt1 = tarantool.Datetime(year=2022, month=8, day=31,
                             hour=18, minute=7, sec=54,
                             nsec=308543321)

    dt2 = tarantool.Datetime(timestamp=1661969274)

    dt3 = tarantool.Datetime(timestamp=1661969274, nsec=308543321)
    ```

    `tarantool.Datetime` exposes `year`, `month`, `day`, `hour`,
    `minute`, `sec`, `nsec`, `timestamp` and `value` (integer epoch time
    with nanoseconds precision) properties if you need to convert
    `tarantool.Datetime` to any other kind of datetime object:

    ```python
    pdt = pandas.Timestamp(year=dt.year, month=dt.month, day=dt.day,
                           hour=dt.hour, minute=dt.minute, second=dt.sec,
                           microsecond=(dt.nsec // 1000),
                           nanosecond=(dt.nsec % 1000))
    ```

    Use `tzoffset` parameter to set up offset timezone:

    ```python
    dt = tarantool.Datetime(year=2022, month=8, day=31,
                            hour=18, minute=7, sec=54,
                            nsec=308543321, tzoffset=180)
    ```

    You may use `tzoffset` property to get timezone offset of a datetime
    object.

    Use `tz` parameter to set up timezone name:

    ```python
    dt = tarantool.Datetime(year=2022, month=8, day=31,
                            hour=18, minute=7, sec=54,
                            nsec=308543321, tz='Europe/Moscow')
    ```

    If both `tz` and `tzoffset` is specified, `tz` is used.

    You may use `tz` property to get timezone name of a datetime object.

    `timestamp_since_utc_epoch` is a parameter to set timestamp
    convertion behavior for timezone-aware datetimes.

    If ``False`` (default), behaves similar to Tarantool `datetime.new()`:

    ```python
    >>> dt = tarantool.Datetime(timestamp=1640995200, timestamp_since_utc_epoch=False)
    >>> dt
    datetime: Timestamp('2022-01-01 00:00:00'), tz: ""
    >>> dt.timestamp
    1640995200.0
    >>> dt = tarantool.Datetime(timestamp=1640995200, tz='Europe/Moscow',
    ...                         timestamp_since_utc_epoch=False)
    >>> dt
    datetime: Timestamp('2022-01-01 00:00:00+0300', tz='Europe/Moscow'), tz: "Europe/Moscow"
    >>> dt.timestamp
    1640984400.0
    ```

    Thus, if ``False``, datetime is computed from timestamp
    since epoch and then timezone is applied without any
    convertion. In that case, `dt.timestamp` won't be equal to
    initialization `timestamp` for all timezones with non-zero offset.

    If ``True``, behaves similar to `pandas.Timestamp`:

    ```python
    >>> dt = tarantool.Datetime(timestamp=1640995200, timestamp_since_utc_epoch=True)
    >>> dt
    datetime: Timestamp('2022-01-01 00:00:00'), tz: ""
    >>> dt.timestamp
    1640995200.0
    >>> dt = tarantool.Datetime(timestamp=1640995200, tz='Europe/Moscow',
    ...                         timestamp_since_utc_epoch=True)
    >>> dt
    datetime: Timestamp('2022-01-01 03:00:00+0300', tz='Europe/Moscow'), tz: "Europe/Moscow"
    >>> dt.timestamp
    1640995200.0
    ```

    Thus, if ``True``, datetime is computed in a way that `dt.timestamp`
    will always be equal to initialization `timestamp`.

  - Datetime interval type support and tarantool.Interval type (#229).

    Tarantool datetime interval objects are decoded to
    `tarantool.Interval` type. `tarantool.Interval` may be encoded to
    Tarantool interval objects.

    You can create `tarantool.Interval` objects either from
    MessagePack data or by using the same API as in Tarantool:

    ```python
    di = tarantool.Interval(year=-1, month=2, day=3,
                            hour=4, minute=-5, sec=6,
                            nsec=308543321,
                            adjust=tarantool.IntervalAdjust.NONE)
    ```

    Its attributes (same as in init API) are exposed, so you can
    use them if needed.

  - Datetime interval arithmetic support (#229).

    Valid operations:
    - `tarantool.Datetime` + `tarantool.Interval` = `tarantool.Datetime`
    - `tarantool.Datetime` - `tarantool.Interval` = `tarantool.Datetime`
    - `tarantool.Datetime` - `tarantool.Datetime` = `tarantool.Interval`
    - `tarantool.Interval` + `tarantool.Interval` = `tarantool.Interval`
    - `tarantool.Interval` - `tarantool.Interval` = `tarantool.Interval`

    Since `tarantool.Interval` could contain `month` and `year` fields
    and such operations could be ambiguous, you can use `adjust` field
    to tune the logic. The behavior is the same as in Tarantool, see
    [Interval arithmetic RFC](https://github.com/tarantool/tarantool/wiki/Datetime-Internals#interval-arithmetic).

    - `tarantool.IntervalAdjust.NONE` -- only truncation toward the end
      of month performed (default mode).

      ```python
      >>> dt = tarantool.Datetime(year=2022, month=3, day=31)
      datetime: Timestamp('2022-03-31 00:00:00'), tz: ""
      >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.NONE)
      >>> dt + di
      datetime: Timestamp('2022-04-30 00:00:00'), tz: ""
      ```

    - `tarantool.IntervalAdjust.EXCESS` -- overflow mode, without any
      snap or truncation to the end of month, straight addition of days
      in month, stopping over month boundaries if there is less number
      of days.

      ```python
      >>> dt = tarantool.Datetime(year=2022, month=1, day=31)
      datetime: Timestamp('2022-01-31 00:00:00'), tz: ""
      >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.EXCESS)
      >>> dt + di
      datetime: Timestamp('2022-03-02 00:00:00'), tz: ""
      ```

    - `tarantool.IntervalAdjust.LAST` -- mode when day snaps to the end
      of month, if happens.

      ```python
      >>> dt = tarantool.Datetime(year=2022, month=2, day=28)
      datetime: Timestamp('2022-02-28 00:00:00'), tz: ""
      >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.LAST)
      >>> dt + di
      datetime: Timestamp('2022-03-31 00:00:00'), tz: ""
      ```

  - Full documentation of internal and external API (#67).

Bugfixes

  - Allow any MessagePack supported type as a request key (#240).
  - Make connection close idempotent (#250).

Infrastructure

  - Use git version to set package version (#238).
  - Test pip install from branch (PR #241).
  - Pack and publish pip, RPM and deb packages with GitHub Actions
    (#164, #198).
  - Publish on readthedocs with CI/CD (including PRs) (#67).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants