HEX
Server: Apache/2.4.46 (Win64) OpenSSL/1.1.1j PHP/8.4.25
System: Windows NT DESKTOP-4TAV2RJ 10.0 build 19045 (Windows 10) AMD64
User: fred (0)
PHP: 8.4.25
Disabled: NONE
Upload Files
File: C:/Users/fred/anaconda3/Lib/site-packages/xlwings/pro/_xlofficejs.py
"""
Required Notice: Copyright (C) Zoomer Analytics GmbH.

xlwings PRO is dual-licensed under one of the following licenses:

* PolyForm Noncommercial License 1.0.0 (for noncommercial use):
  https://polyformproject.org/licenses/noncommercial/1.0.0
* xlwings PRO License (for commercial use):
  https://github.com/xlwings/xlwings/blob/main/LICENSE_PRO.txt

Commercial licenses can be purchased at https://www.xlwings.org
"""

"""
This engine is only used in connection with Office.js UDFs, not with runPython.
"""

import datetime as dt

try:
    import numpy as np
except ImportError:
    np = None
try:
    import pandas as pd
except ImportError:
    pd = None

from .. import utils


def datetime_to_formatted_number(datetime_object, date_format, runtime):
    # https://learn.microsoft.com/en-us/javascript/api/requirement-sets/excel/custom-functions-requirement-sets
    serial = utils.datetime_to_xlserial(datetime_object)
    if float(runtime) < 1.4 or date_format is None:
        return serial
    else:
        return {
            "type": "FormattedNumber",
            "basicValue": serial,
            "numberFormat": date_format,
        }


def errorstr_to_errortype(error, runtime):
    if float(runtime) < 1.4:
        return error
    error_to_type = {
        "#DIV/0!": "Div0",
        "#N/A": "NotAvailable",
        "#NAME?": "Name",
        "#NULL!": "Null",
        "#NUM!": "Num",
        "#REF!": "Ref",
        "#VALUE!": "Value",
    }
    error_type = error_to_type.get(error)
    if not error_type:
        return error
    else:
        return {
            "type": "Error",
            "errorType": error_type,
        }


def _clean_value_data_element(
    value,
    datetime_builder,
    empty_as,
    number_builder,
    err_to_str,
):
    # datetime_builder is not supported as normal date-formatted cells aren't recognized
    if value == "":
        return empty_as
    elif isinstance(value, dict):
        # https://learn.microsoft.com/en-us/office/dev/add-ins/excel/custom-functions-data-types-concepts
        if value["type"] == "Error":
            if err_to_str:
                return value["basicValue"]
            else:
                return None
        else:
            value = value["basicValue"]  # e.g., datetime (only via data types)
    elif number_builder is not None and isinstance(value, float):
        value = number_builder(value)
    return value


class Engine:
    @staticmethod
    def clean_value_data(data, datetime_builder, empty_as, number_builder, err_to_str):
        return [
            [
                _clean_value_data_element(
                    c, datetime_builder, empty_as, number_builder, err_to_str
                )
                for c in row
            ]
            for row in data
        ]

    @staticmethod
    def prepare_xl_data_element(x, options):
        if x is None:
            return ""
        elif pd and pd.isna(x):
            return errorstr_to_errortype("#NUM!", options["runtime"])
        elif np and isinstance(x, (np.floating, float)) and np.isnan(x):
            return errorstr_to_errortype("#NUM!", options["runtime"])
        elif np and isinstance(x, np.number):
            return float(x)
        elif np and isinstance(x, np.datetime64):
            return datetime_to_formatted_number(
                utils.np_datetime_to_datetime(x),
                options["date_format"],
                options["runtime"],
            )
        elif pd and isinstance(x, pd.Timestamp):
            return datetime_to_formatted_number(
                x.to_pydatetime(),
                options["date_format"],
                options["runtime"],
            )
        elif pd and isinstance(x, type(pd.NaT)):
            # This seems to be caught by pd.isna() nowadays?
            return ""
        elif isinstance(x, (dt.date, dt.datetime)):
            return datetime_to_formatted_number(
                x, options["date_format"], options["runtime"]
            )
        elif isinstance(x, str) and x.startswith("#"):
            return errorstr_to_errortype(x, options["runtime"])
        return x

    @property
    def name(self):
        return "officejs"

    @property
    def type(self):
        return "remote"


engine = Engine()