Skip to content

information_formulas

shortfx.fxExcel.information_formulas

Excel Information Functions Module.

This module provides Excel-compatible validation and error handling functions for shortfx. Functions include: - IS Functions: ISBLANK, ISERR, ISERROR, ISEVEN, ISLOGICAL, ISNA, ISNONTEXT, ISNUMBER, ISODD, ISOMITTED, ISTEXT - Error handling: ERROR_TYPE

All functions follow Excel naming conventions and behavior.

Note: Functions like CELL, INFO, ISREF, and ISFORMULA are excluded because they depend on Excel's application context (cells, worksheets, references) which don't exist in standalone Python execution.

Functions

ERROR_TYPE(error_val: Any) -> Optional[int]

Return a number corresponding to an error type.

Parameters:

Name Type Description Default
error_val Any

Error value to analyze.

 required

Returns:

Type Description
Optional[int]

Optional[int]: Error number, or None if not an error. - 1: #NULL! - 2: #DIV/0! - 3: #VALUE! - 4: #REF! - 5: #NAME? - 6: #NUM! - 7: #N/A
Example

ERROR_TYPE(ZeroDivisionError()) 2 ERROR_TYPE(42) None

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
def ERROR_TYPE(error_val: Any) -> Optional[int]:
    """
    Return a number corresponding to an error type.

    Args:
        error_val: Error value to analyze.

    Returns:
        Optional[int]: Error number, or None if not an error.
            - 1: #NULL!
            - 2: #DIV/0!
            - 3: #VALUE!
            - 4: #REF!
            - 5: #NAME?
            - 6: #NUM!
            - 7: #N/A

    Example:
        >>> ERROR_TYPE(ZeroDivisionError())
        2
        >>> ERROR_TYPE(42)
        None

    Cost: O(1)
    """
    if not ISERROR(error_val):
        return None

    error_types = {
        ZeroDivisionError: 2,
        ValueError: 3,
        NameError: 5,
        TypeError: 6,
        "#N/A": 7
    }

    return error_types.get(type(error_val), 3)

ISBLANK(value: Any) -> bool

Return TRUE if the value is blank.

Parameters:

Name Type Description Default
value Any

Value to test.

 required

Returns:

Name Type Description
bool bool

True if value is blank, False otherwise.
Example

ISBLANK(None) True ISBLANK("") True ISBLANK("text") False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def ISBLANK(value: Any) -> bool:
    """
    Return TRUE if the value is blank.

    Args:
        value: Value to test.

    Returns:
        bool: True if value is blank, False otherwise.

    Example:
        >>> ISBLANK(None)
        True
        >>> ISBLANK("")
        True
        >>> ISBLANK("text")
        False

    Cost: O(1)
    """
    return value is None or (isinstance(value, str) and value.strip() == "")

ISERR(value: Any) -> bool

Return TRUE if the value is any error value except #N/A.

Parameters:

Name Type Description Default
value Any

Value to test.

 required

Returns:

Name Type Description
bool bool

True if value is error (except #N/A), False otherwise.
Example

ISERR(ValueError()) True ISERR("#N/A") False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def ISERR(value: Any) -> bool:
    """
    Return TRUE if the value is any error value except #N/A.

    Args:
        value: Value to test.

    Returns:
        bool: True if value is error (except #N/A), False otherwise.

    Example:
        >>> ISERR(ValueError())
        True
        >>> ISERR("#N/A")
        False

    Cost: O(1)
    """
    return isinstance(value, Exception) and not ISNA(value)

ISERROR(value: Any) -> bool

Return TRUE if the value is any error value.

Parameters:

Name Type Description Default
value Any

Value to test.

 required

Returns:

Name Type Description
bool bool

True if value is any error, False otherwise.
Example

ISERROR(ValueError()) True ISERROR(42) False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def ISERROR(value: Any) -> bool:
    """
    Return TRUE if the value is any error value.

    Args:
        value: Value to test.

    Returns:
        bool: True if value is any error, False otherwise.

    Example:
        >>> ISERROR(ValueError())
        True
        >>> ISERROR(42)
        False

    Cost: O(1)
    """
    return isinstance(value, Exception)

ISEVEN(number: Union[int, float]) -> bool

Return TRUE if the number is even.

Parameters:

Name Type Description Default
number Union[int, float]

Number to test.

 required

Returns:

Name Type Description
bool bool

True if number is even, False otherwise.
Example

ISEVEN(4) True ISEVEN(3) False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
def ISEVEN(number: Union[int, float]) -> bool:
    """
    Return TRUE if the number is even.

    Args:
        number: Number to test.

    Returns:
        bool: True if number is even, False otherwise.

    Example:
        >>> ISEVEN(4)
        True
        >>> ISEVEN(3)
        False

    Cost: O(1)
    """
    try:
        return _core_is_even(int(number))
    except (ValueError, TypeError):
        return False

ISLOGICAL(value: Any) -> bool

Return TRUE if the value is a logical value.

Parameters:

Name Type Description Default
value Any

Value to test.

 required

Returns:

Name Type Description
bool bool

True if value is boolean, False otherwise.
Example

ISLOGICAL(True) True ISLOGICAL(1) False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
def ISLOGICAL(value: Any) -> bool:
    """
    Return TRUE if the value is a logical value.

    Args:
        value: Value to test.

    Returns:
        bool: True if value is boolean, False otherwise.

    Example:
        >>> ISLOGICAL(True)
        True
        >>> ISLOGICAL(1)
        False

    Cost: O(1)
    """
    return _core_is_logical(value)

ISNA(value: Any) -> bool

Return TRUE if the value is the #N/A error value.

Parameters:

Name Type Description Default
value Any

Value to test.

 required

Returns:

Name Type Description
bool bool

True if value is #N/A, False otherwise.
Example

ISNA("#N/A") True ISNA(ValueError()) False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
def ISNA(value: Any) -> bool:
    """
    Return TRUE if the value is the #N/A error value.

    Args:
        value: Value to test.

    Returns:
        bool: True if value is #N/A, False otherwise.

    Example:
        >>> ISNA("#N/A")
        True
        >>> ISNA(ValueError())
        False

    Cost: O(1)
    """
    return value == "#N/A" or (isinstance(value, float) and math.isnan(value))

ISNONTEXT(value: Any) -> bool

Return TRUE if the value is not text.

Parameters:

Name Type Description Default
value Any

Value to test.

 required

Returns:

Name Type Description
bool bool

True if value is not text, False otherwise.
Example

ISNONTEXT(42) True ISNONTEXT("text") False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
def ISNONTEXT(value: Any) -> bool:
    """
    Return TRUE if the value is not text.

    Args:
        value: Value to test.

    Returns:
        bool: True if value is not text, False otherwise.

    Example:
        >>> ISNONTEXT(42)
        True
        >>> ISNONTEXT("text")
        False

    Cost: O(1)
    """
    return not ISTEXT(value)

ISNUMBER(value: Any) -> bool

Return TRUE if the value is a number.

Parameters:

Name Type Description Default
value Any

Value to test.

 required

Returns:

Name Type Description
bool bool

True if value is numeric, False otherwise.
Example

ISNUMBER(42) True ISNUMBER(3.14) True ISNUMBER("42") False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
def ISNUMBER(value: Any) -> bool:
    """
    Return TRUE if the value is a number.

    Args:
        value: Value to test.

    Returns:
        bool: True if value is numeric, False otherwise.

    Example:
        >>> ISNUMBER(42)
        True
        >>> ISNUMBER(3.14)
        True
        >>> ISNUMBER("42")
        False

    Cost: O(1)
    """
    return _core_is_number(value)

ISODD(number: Union[int, float]) -> bool

Return TRUE if the number is odd.

Parameters:

Name Type Description Default
number Union[int, float]

Number to test.

 required

Returns:

Name Type Description
bool bool

True if number is odd, False otherwise.
Example

ISODD(3) True ISODD(4) False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
def ISODD(number: Union[int, float]) -> bool:
    """
    Return TRUE if the number is odd.

    Args:
        number: Number to test.

    Returns:
        bool: True if number is odd, False otherwise.

    Example:
        >>> ISODD(3)
        True
        >>> ISODD(4)
        False

    Cost: O(1)
    """
    try:
        return _core_is_odd(int(number))
    except (ValueError, TypeError):
        return False

ISOMITTED(value: Any) -> bool

Check if a value is missing in a LAMBDA expression.

Parameters:

Name Type Description Default
value Any

Value to test.

 required

Returns:

Name Type Description
bool bool

True if value was omitted, False otherwise.
Example

ISOMITTED(inspect.Parameter.empty) True ISOMITTED(42) False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
def ISOMITTED(value: Any) -> bool:
    """
    Check if a value is missing in a LAMBDA expression.

    Args:
        value: Value to test.

    Returns:
        bool: True if value was omitted, False otherwise.

    Example:
        >>> ISOMITTED(inspect.Parameter.empty)
        True
        >>> ISOMITTED(42)
        False

    Cost: O(1)
    """
    return value is inspect.Parameter.empty

ISTEXT(value: Any) -> bool

Return TRUE if the value is text.

Parameters:

Name Type Description Default
value Any

Value to test.

 required

Returns:

Name Type Description
bool bool

True if value is text, False otherwise.
Example

ISTEXT("hello") True ISTEXT(42) False

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
def ISTEXT(value: Any) -> bool:
    """
    Return TRUE if the value is text.

    Args:
        value: Value to test.

    Returns:
        bool: True if value is text, False otherwise.

    Example:
        >>> ISTEXT("hello")
        True
        >>> ISTEXT(42)
        False

    Cost: O(1)
    """
    return _core_is_text(value)

N(value: Any) -> Union[int, float]

Return a value converted to a number.

Parameters:

Name Type Description Default
value Any

Value to convert.

 required

Returns:

Type Description
Union[int, float]

Union[int, float]: Numeric value. - Numbers return themselves - True returns 1, False returns 0 - Dates return serial number - Everything else returns 0
Example

N(42) 42 N(True) 1 N("text") 0

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
def N(value: Any) -> Union[int, float]:
    """
    Return a value converted to a number.

    Args:
        value: Value to convert.

    Returns:
        Union[int, float]: Numeric value.
            - Numbers return themselves
            - True returns 1, False returns 0
            - Dates return serial number
            - Everything else returns 0

    Example:
        >>> N(42)
        42
        >>> N(True)
        1
        >>> N("text")
        0

    Cost: O(1)
    """
    if ISNUMBER(value):
        return value
    if isinstance(value, bool):
        return 1 if value else 0
    return 0

NA() -> str

Return the error value #N/A.

Returns:

Name Type Description
str str

"#N/A" error value.
Example

NA() '#N/A'

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
312
313
314
315
316
317
318
319
320
321
322
323
324
325
def NA() -> str:
    """
    Return the error value #N/A.

    Returns:
        str: "#N/A" error value.

    Example:
        >>> NA()
        '#N/A'

    Cost: O(1)
    """
    return "#N/A"

TYPE(value: Any) -> int

Returns the type of a value as a numeric code.

Follows Excel's TYPE function convention: 1 = Number (int or float) 2 = Text (str) 4 = Logical (bool) 16 = Error (Exception) 64 = Array (list, tuple, or numpy array)

Excel function: TYPE

Parameters:

Name Type Description Default
value Any

The value whose type to determine.

 required

Returns:

Name Type Description
int int

Type code (1, 2, 4, 16, or 64).
Usage Example

TYPE(42) 1 TYPE(3.14) 1 TYPE("hello") 2 TYPE(True) 4 TYPE([1, 2, 3]) 64 TYPE(ValueError()) 16

Cost: O(1)

Source code in shortfx/fxExcel/information_formulas.py 
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
def TYPE(value: Any) -> int:
    """Returns the type of a value as a numeric code.

    Follows Excel's TYPE function convention:
        1 = Number (int or float)
        2 = Text (str)
        4 = Logical (bool)
        16 = Error (Exception)
        64 = Array (list, tuple, or numpy array)

    Excel function: TYPE

    Args:
        value: The value whose type to determine.

    Returns:
        int: Type code (1, 2, 4, 16, or 64).

    Usage Example:
        >>> TYPE(42)
        1
        >>> TYPE(3.14)
        1
        >>> TYPE("hello")
        2
        >>> TYPE(True)
        4
        >>> TYPE([1, 2, 3])
        64
        >>> TYPE(ValueError())
        16

    Cost: O(1)
    """
    if isinstance(value, bool):
        return 4

    if isinstance(value, (int, float)):
        return 1

    if isinstance(value, str):
        if value in ("#N/A", "#DIV/0!", "#VALUE!", "#REF!", "#NAME?", "#NUM!", "#NULL!"):
            return 16

        return 2

    if isinstance(value, Exception):
        return 16

    if isinstance(value, (list, tuple)):
        return 64

    return 1