Skip to content

date_functions

shortfx.fxVBA.date_functions

Access Date and Time Functions Module.

Description Funciones de fecha y hora compatibles con VBA/Access.

Functions

DateAdd(interval: str, number: float, date_val: datetime) -> datetime

Description Agrega intervalo de tiempo a una fecha.

Args interval: Tipo de intervalo (yyyy, q, m, y, d, w, ww, h, n, s). number: Cantidad de intervalos a agregar. date_val: Fecha base.

Returns datetime: Nueva fecha.

Usage Example >>> dateadd("d", 5, datetime(2024, 1, 1)) datetime.datetime(2024, 1, 6, 0, 0)

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def DateAdd(interval: str, number: float, date_val: datetime) -> datetime:
    """
    Description
        Agrega intervalo de tiempo a una fecha.

    Args
        interval: Tipo de intervalo (yyyy, q, m, y, d, w, ww, h, n, s).
        number: Cantidad de intervalos a agregar.
        date_val: Fecha base.

    Returns
        datetime: Nueva fecha.

    Usage Example
        >>> dateadd("d", 5, datetime(2024, 1, 1))
        datetime.datetime(2024, 1, 6, 0, 0)

    Cost
        O(1)
    """
    if not isinstance(date_val, datetime):
        if isinstance(date_val, date):
            date_val = datetime.combine(date_val, time.min)

    if interval == "yyyy":
        return _core_add_years(date_val, int(number))
    elif interval == "q":
        return _core_add_months(date_val, int(number) * 3)
    elif interval == "m":
        return _core_add_months(date_val, int(number))
    elif interval in ("y", "d", "w"):
        return date_val + timedelta(days=int(number))
    elif interval == "ww":
        return date_val + timedelta(weeks=int(number))
    elif interval == "h":
        return date_val + timedelta(hours=number)
    elif interval == "n":
        return date_val + timedelta(minutes=number)
    elif interval == "s":
        return date_val + timedelta(seconds=number)
    else:
        raise ValueError(f"Intervalo inválido: {interval}")

DateDiff(interval: str, date1: datetime, date2: datetime, first_day_of_week: int = 0, first_week_of_year: int = 0) -> int

Description Calcula diferencia entre dos fechas según intervalo.

Args interval: Tipo de intervalo (yyyy, q, m, d, ww, h, n, s). date1: Fecha inicial. date2: Fecha final. first_day_of_week: Primer día de semana (0-7). first_week_of_year: Primera semana del año (0-3).

Returns int: Diferencia en el intervalo especificado.

Usage Example >>> datediff("d", datetime(2024, 1, 1), datetime(2024, 1, 10)) 9

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def DateDiff(
    interval: str,
    date1: datetime,
    date2: datetime,
    first_day_of_week: int = 0,
    first_week_of_year: int = 0
) -> int:
    """
    Description
        Calcula diferencia entre dos fechas según intervalo.

    Args
        interval: Tipo de intervalo (yyyy, q, m, d, ww, h, n, s).
        date1: Fecha inicial.
        date2: Fecha final.
        first_day_of_week: Primer día de semana (0-7).
        first_week_of_year: Primera semana del año (0-3).

    Returns
        int: Diferencia en el intervalo especificado.

    Usage Example
        >>> datediff("d", datetime(2024, 1, 1), datetime(2024, 1, 10))
        9

    Cost
        O(1)
    """
    if not isinstance(date1, datetime):
        date1 = datetime.combine(date1, time.min)

    if not isinstance(date2, datetime):
        date2 = datetime.combine(date2, time.min)

    if interval == "yyyy":
        return date2.year - date1.year
    elif interval == "q":
        return ((date2.year - date1.year) * 4) + ((date2.month - 1) // 3 - (date1.month - 1) // 3)
    elif interval == "m":
        return (date2.year - date1.year) * 12 + (date2.month - date1.month)
    elif interval in ("y", "d"):
        return _core_diff_time(date1, date2, "days")
    elif interval == "ww":
        return _core_diff_time(date1, date2, "weeks")
    elif interval == "h":
        return _core_diff_time(date1, date2, "hours")
    elif interval == "n":
        return _core_diff_time(date1, date2, "minutes")
    elif interval == "s":
        return _core_diff_time(date1, date2, "seconds")
    else:
        raise ValueError(f"Intervalo inválido: {interval}")

DatePart(interval: str, date_val: datetime, first_day_of_week: int = 0, first_week_of_year: int = 0) -> int

Description Extrae parte específica de una fecha.

Args interval: Tipo de intervalo (yyyy, q, m, y, d, w, ww, h, n, s). date_val: Fecha a analizar. first_day_of_week: Primer día de semana. first_week_of_year: Primera semana del año.

Returns int: Parte de fecha solicitada.

Usage Example >>> datepart("m", datetime(2024, 6, 15)) 6

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
def DatePart(
    interval: str,
    date_val: datetime,
    first_day_of_week: int = 0,
    first_week_of_year: int = 0
) -> int:
    """
    Description
        Extrae parte específica de una fecha.

    Args
        interval: Tipo de intervalo (yyyy, q, m, y, d, w, ww, h, n, s).
        date_val: Fecha a analizar.
        first_day_of_week: Primer día de semana.
        first_week_of_year: Primera semana del año.

    Returns
        int: Parte de fecha solicitada.

    Usage Example
        >>> datepart("m", datetime(2024, 6, 15))
        6

    Cost
        O(1)
    """
    return _core_date_part(interval, date_val, first_day_of_week, first_week_of_year)

DateSerial(year: int, month: int, day: int) -> date

Description Retorna fecha compuesta por año, mes y día indicados.

Args year: Año. month: Mes. day: Día (0 = último día mes anterior).

Returns date: Objeto fecha.

Usage Example >>> dateserial(2024, 6, 15) datetime.date(2024, 6, 15)

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
def DateSerial(year: int, month: int, day: int) -> date:
    """
    Description
        Retorna fecha compuesta por año, mes y día indicados.

    Args
        year: Año.
        month: Mes.
        day: Día (0 = último día mes anterior).

    Returns
        date: Objeto fecha.

    Usage Example
        >>> dateserial(2024, 6, 15)
        datetime.date(2024, 6, 15)

    Cost
        O(1)
    """
    return _core_parts_to_date(year, month, day)

Date_() -> date

Description Retorna fecha actual del sistema.

Returns date: Fecha actual.

Usage Example >>> date_() datetime.date(2024, 1, 15)

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def Date_() -> date:
    """
    Description
        Retorna fecha actual del sistema.

    Returns
        date: Fecha actual.

    Usage Example
        >>> date_()
        datetime.date(2024, 1, 15)

    Cost
        O(1)
    """
    return datetime.now().date()

Day(date_val: datetime) -> int

Description Extrae día de una fecha.

Args date_val: Fecha.

Returns int: Número de día.

Usage Example >>> day(datetime(2024, 6, 15)) 15

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
def Day(date_val: datetime) -> int:
    """
    Description
        Extrae día de una fecha.

    Args
        date_val: Fecha.

    Returns
        int: Número de día.

    Usage Example
        >>> day(datetime(2024, 6, 15))
        15

    Cost
        O(1)
    """
    if isinstance(date_val, datetime):
        return date_val.day
    return date_val.day

Hour(time_val: datetime) -> int

Description Retorna hora de una expresión DateTime.

Args time_val: Valor de fecha/hora.

Returns int: Hora (0-23).

Usage Example >>> hour(datetime(2024, 1, 1, 14, 30)) 14

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
def Hour(time_val: datetime) -> int:
    """
    Description
        Retorna hora de una expresión DateTime.

    Args
        time_val: Valor de fecha/hora.

    Returns
        int: Hora (0-23).

    Usage Example
        >>> hour(datetime(2024, 1, 1, 14, 30))
        14

    Cost
        O(1)
    """
    return time_val.hour

Minute(time_val: datetime) -> int

Description Retorna minutos de una expresión de tiempo.

Args time_val: Valor de fecha/hora.

Returns int: Minutos (0-59).

Usage Example >>> minute(datetime(2024, 1, 1, 14, 30)) 30

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
def Minute(time_val: datetime) -> int:
    """
    Description
        Retorna minutos de una expresión de tiempo.

    Args
        time_val: Valor de fecha/hora.

    Returns
        int: Minutos (0-59).

    Usage Example
        >>> minute(datetime(2024, 1, 1, 14, 30))
        30

    Cost
        O(1)
    """
    return time_val.minute

Month(date_val: datetime) -> int

Description Retorna número de mes de una fecha.

Args date_val: Fecha.

Returns int: Mes (1-12).

Usage Example >>> month(datetime(2024, 6, 15)) 6

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
def Month(date_val: datetime) -> int:
    """
    Description
        Retorna número de mes de una fecha.

    Args
        date_val: Fecha.

    Returns
        int: Mes (1-12).

    Usage Example
        >>> month(datetime(2024, 6, 15))
        6

    Cost
        O(1)
    """
    if isinstance(date_val, datetime):
        return date_val.month
    return date_val.month

MonthName(month_num: int, abbreviate: bool = False) -> str

Description Retorna nombre de mes.

Args month_num: Número de mes (1-12). abbreviate: Si True, retorna abreviatura.

Returns str: Nombre del mes.

Usage Example >>> monthname(1) 'January' >>> monthname(1, True) 'Jan'

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
def MonthName(month_num: int, abbreviate: bool = False) -> str:
    """
    Description
        Retorna nombre de mes.

    Args
        month_num: Número de mes (1-12).
        abbreviate: Si True, retorna abreviatura.

    Returns
        str: Nombre del mes.

    Usage Example
        >>> monthname(1)
        'January'
        >>> monthname(1, True)
        'Jan'

    Cost
        O(1)
    """
    from datetime import datetime as _dt
    ref = _dt(2000, month_num, 1)
    return _core_month_name(ref, language='en')[:3] if abbreviate else _core_month_name(ref, language='en')

Now() -> datetime

Description Retorna fecha y hora actuales del sistema.

Returns datetime: Fecha y hora actuales.

Usage Example >>> now() datetime.datetime(2024, 1, 15, 14, 30, 0)

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
def Now() -> datetime:
    """
    Description
        Retorna fecha y hora actuales del sistema.

    Returns
        datetime: Fecha y hora actuales.

    Usage Example
        >>> now()
        datetime.datetime(2024, 1, 15, 14, 30, 0)

    Cost
        O(1)
    """
    return _core_current_datetime()

Second(time_val: datetime) -> int

Description Retorna segundos de una expresión de tiempo.

Args time_val: Valor de fecha/hora.

Returns int: Segundos (0-59).

Usage Example >>> second(datetime(2024, 1, 1, 14, 30, 45)) 45

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
def Second(time_val: datetime) -> int:
    """
    Description
        Retorna segundos de una expresión de tiempo.

    Args
        time_val: Valor de fecha/hora.

    Returns
        int: Segundos (0-59).

    Usage Example
        >>> second(datetime(2024, 1, 1, 14, 30, 45))
        45

    Cost
        O(1)
    """
    return time_val.second

TimeSerial(hour: int, minute: int, second: int) -> time

Description Retorna valor tipo Time pasando hora, minutos y segundos.

Args hour: Hora. minute: Minutos. second: Segundos.

Returns time: Objeto hora.

Usage Example >>> timeserial(14, 30, 0) datetime.time(14, 30)

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
def TimeSerial(hour: int, minute: int, second: int) -> time:
    """
    Description
        Retorna valor tipo Time pasando hora, minutos y segundos.

    Args
        hour: Hora.
        minute: Minutos.
        second: Segundos.

    Returns
        time: Objeto hora.

    Usage Example
        >>> timeserial(14, 30, 0)
        datetime.time(14, 30)

    Cost
        O(1)
    """
    return _core_parts_to_time(hour, minute, second)

Time_() -> time

Description Retorna hora actual del sistema.

Returns time: Hora actual.

Usage Example >>> time_() datetime.time(14, 30, 0)

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
def Time_() -> time:
    """
    Description
        Retorna hora actual del sistema.

    Returns
        time: Hora actual.

    Usage Example
        >>> time_()
        datetime.time(14, 30, 0)

    Cost
        O(1)
    """
    return datetime.now().time()

Timer() -> float

Description Retorna número de segundos transcurridos desde medianoche.

Returns float: Segundos desde medianoche.

Usage Example >>> timer() 52200.5

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
def Timer() -> float:
    """
    Description
        Retorna número de segundos transcurridos desde medianoche.

    Returns
        float: Segundos desde medianoche.

    Usage Example
        >>> timer()
        52200.5

    Cost
        O(1)
    """
    return _core_seconds_since_midnight()

WeekDay(date_val: datetime, first_day_of_week: int = 1) -> int

Description Retorna número indicando día de la semana.

Args date_val: Fecha. first_day_of_week: Primer día semana (0-7).

Returns int: Día de semana (1=domingo, 2=lunes, ...).

Usage Example >>> weekday(datetime(2024, 1, 1)) 2

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
def WeekDay(date_val: datetime, first_day_of_week: int = 1) -> int:
    """
    Description
        Retorna número indicando día de la semana.

    Args
        date_val: Fecha.
        first_day_of_week: Primer día semana (0-7).

    Returns
        int: Día de semana (1=domingo, 2=lunes, ...).

    Usage Example
        >>> weekday(datetime(2024, 1, 1))
        2

    Cost
        O(1)
    """
    return _core_weekday_number(date_val, start_day='anglo') + 1

WeekDayName(weekday_num: int, abbreviate: bool = False, first_day_of_week: int = 1) -> str

Description Retorna día de semana como cadena.

Args weekday_num: Número de día (1-7). abbreviate: Si True, retorna abreviatura. first_day_of_week: Primer día semana.

Returns str: Nombre del día.

Usage Example >>> weekdayname(1) 'Sunday' >>> weekdayname(2, True) 'Mon'

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
def WeekDayName(
    weekday_num: int,
    abbreviate: bool = False,
    first_day_of_week: int = 1
) -> str:
    """
    Description
        Retorna día de semana como cadena.

    Args
        weekday_num: Número de día (1-7).
        abbreviate: Si True, retorna abreviatura.
        first_day_of_week: Primer día semana.

    Returns
        str: Nombre del día.

    Usage Example
        >>> weekdayname(1)
        'Sunday'
        >>> weekdayname(2, True)
        'Mon'

    Cost
        O(1)
    """
    days_full = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
    days_abbr = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"]

    if not 1 <= weekday_num <= 7:
        raise ValueError("Día debe estar entre 1 y 7")

    if abbreviate:
        return days_abbr[weekday_num - 1]
    return days_full[weekday_num - 1]

Year(date_val: datetime) -> int

Description Retorna año de una fecha.

Args date_val: Fecha.

Returns int: Año.

Usage Example >>> year(datetime(2024, 6, 15)) 2024

Cost O(1)

Source code in shortfx/fxVBA/date_functions.py 
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
def Year(date_val: datetime) -> int:
    """
    Description
        Retorna año de una fecha.

    Args
        date_val: Fecha.

    Returns
        int: Año.

    Usage Example
        >>> year(datetime(2024, 6, 15))
        2024

    Cost
        O(1)
    """
    if isinstance(date_val, datetime):
        return date_val.year
    return date_val.year