cron-converter 1.0.1

Cron-converter 提供了一个 Cron 字符串解析器（从 string/lists 到 string/lists ）和具有类似 cron 格式的 datetime 对象的迭代。
该项目将是roccivic在 Python 中对 JS cron-converter的换位。

安装

点

pip install cron-converter

利用

from cron_converter import Cron

创建一个新实例

cron_instance = Cron()

或者

cron_instance = Cron('*/10 9-17 1 * *')

或（带有构造函数选项）

cron_instance = Cron('*/10 9-17 1 * *', {
  'output_weekday_names': True,
  'output_month_names': True
})

解析一个 cron 字符串

# Every 10 mins between 9am and 5pm on the 1st of every month
# In the case of the second or third creation method this step is not required
cron_instance.from_string('*/10 9-17 1 * *')

# Prints: '*/10 9-17 1 * *'
print(cron_instance.to_string())
# Alternatively, you could print directly the object obtaining the same result:
# print(cron_instance) # Prints: '*/10 9-17 1 * *'

# Prints:
# [
#   [ 0, 10, 20, 30, 40, 50 ],
#   [ 9, 10, 11, 12, 13, 14, 15, 16, 17 ],
#   [ 1 ],
#   [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ],
#   [ 0, 1, 2, 3, 4, 5, 6 ]
# ]
print(cron_instance.to_list())

解析数组

cron_instance.from_list([[0], [1], [1], [5], [0,2,4,6]])

# Prints: '0 1 1 5 */2'
print(cron_instance.to_string())

构造函数选项

可能的选项：

• output_weekday_names：假（默认）
• output_month_mames：假（默认）
• output_hashes：假（默认）

output_weekday_names 和 output_month_mames

cron_instance = Cron(None, {
  'output_weekday_names': True,
  'output_month_names': True
})
cron_instance.from_string('*/5 9-17/2 * 1-3 1-5')
# Prints: '*/5 9-17/2 * JAN-MAR MON-FRI'
print(cron_instance)

或者

cron_instance = Cron('*/5 9-17/2 * 1-3 1-5', {
  'output_weekday_names': True,
  'output_month_names': True
})
# Prints: '*/5 9-17/2 * JAN-MAR MON-FRI'
print(cron_instance)

输出哈希

cron_instance = Cron('*/5 9-17/2 * 1-3 1-5', {
  'output_hashes': True
})
# Prints: 'H/5 H(9-17)/2 H 1-3 1-5'
print(cron_instance.to_string())

获取计划执行时间。原始日期时间示例

# Parse a string to init a schedule
cron_instance.from_string('*/5 * * * *')

# Raw datetime without timezone info (not aware)
reference = datetime.now()
# Get the iterator, initialised to now
schedule = cron_instance.schedule(reference)

# Calls to .next() and .prev()
# return a Datetime object

# Examples with time now: '2021-01-01T09:32:00
# Prints: '2021-01-01T09:35:00'
print(schedule.next().isoformat())
# Prints: '2021-01-01T09:40:00'
print(schedule.next().isoformat())

# Reset
schedule.reset()

# Prints: '2021-01-01T09:30:00'
print(schedule.prev().isoformat())
# Prints: '2021-01-01T09:25:00'
print(schedule.prev().isoformat())

关于夏令时

请务必使用可识别 TZ 的日期时间来初始化您的 cron-converter 实例，以使其正常工作！

调度程序有两个可选的互斥参数：start_date或timezone_str。默认情况下（无参数），如果您未指定任何日期时间对象，则调度程序开始计数与 UTC 日期时间（ utcnow() ）。start_date如果您提供timezone_str调度程序将从本地化的现在日期时间（datetime.now(tz_object)）开始计数。

从本地化的现在日期时间开始的示例

from cron_converter import Cron

cron  =  Cron ( '0 0 * * *' )
计划 =  cron 。schedule ( timezone_str = 'Europe/Rome' ) 
# 打印：结果 datetime + utc offset 
print ( schedule . next ())

使用 pytz 的示例：

从 pytz 导入 时区
从 datetime 导入 datetime
from cron_converter import Cron

tz  =  timezone ( 'Europe/Rome' ) 
local_date  =  tz 。本地化( datetime ( 2021 ,  1 ,  1 )) 
cron  =  Cron ( '0 0 * * *' ) 
schedule  =  cron 。时间表（开始日期=本地日期）
下一个时间表 = 时间表。下一个() 
next_next_schedule  = 时间表。下一个（）
# 打印：'2021-01-01T00:00:00+01:00' 
print ( next_schedule .isoformat ( ) ) # 打印：'2021-01-02T00:00:00+01:00 ' print ( next_next_schedule .isoformat ( ))

使用 python_dateutil 的示例：

import dateutil.tz
from datetime import datetime
from cron_converter import Cron

tz = dateutil.tz.gettz('Asia/Tokyo')
local_date = datetime(2021, 1, 1, tzinfo=tz)
cron = Cron('0 0 * * *')
schedule = cron.schedule(start_date=local_date)
next_schedule = schedule.next()
next_next_schedule = schedule.next()
# Prints: '2021-01-01T00:00:00+09:00'
print(next_schedule.isoformat())
# Prints: '2021-01-02T00:00:00+09:00'
print(next_next_schedule.isoformat())

关于 Cron 调度时间频率

可以比较 Cron 对象调度频率。谢谢@zevaverbach。

# Hours
Cron('0 1 * * 1-5') == Cron('0 2 * * 1-5') # True
Cron('0 1,2,3 * * 1-5') > Cron('0 1,23 * * 1-5') # True
# Minutes
Cron('* 1 * * 1-5') == Cron('0-59 1 * * 1-5') # True
Cron('1-30 1 * * 1-5') > Cron('1-29 1 * * 1-5') # True
# Days
Cron('* 1 1 * 1-5') == Cron('0-59 1 2 * 1-5') # True
Cron('* 1 1,2 * 1-5') > Cron('* 1 6 * 1-5') # True
# Month
Cron('* 1 1 11 1-5') == Cron('* 1 1 1 1-5') # True
Cron('* 1 6 * 1-5') > Cron('* 1 6 1 1-5') # True
# WeekDay
Cron('* 1 1 11 *') == Cron('* 1 1 11 0-6') # True
Cron('* 1 6 * 1-5') > Cron('* 1 6 * 1-4') # True

约秒重复

Cron-converter 无法执行第二次重复 crontabs 形式。

开发和测试

git clone https://github.com/Sonic0/cron-converter
cd cron-converter
...
python -m unittest discover -s tests/unit
python -m unittest discover -s tests/integration

项目信息

这个 repo 是一个名为Cron-Converter的项目组的一部分。其相关存储库：

• 本地 crontab
• 本地 crontab-ansible-过滤器
• 本地 crontab-serverless 基础设施
• 本地 crontab-web 转换器