This commit is contained in:
Iliyan Angelov
2025-09-19 11:58:53 +03:00
parent 306b20e24a
commit 6b247e5b9f
11423 changed files with 1500615 additions and 778 deletions

View File

@@ -0,0 +1,550 @@
Metadata-Version: 2.4
Name: python-crontab
Version: 3.3.0
Summary: Python Crontab API
Home-page: https://gitlab.com/doctormo/python-crontab/
Author: Martin Owens
Author-email: doctormo@gmail.com
License: LGPLv3
Platform: linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Development Status :: 6 - Mature
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX :: SunOS/Solaris
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Provides: crontab
Provides: crontabs
Provides: cronlog
Description-Content-Type: text/x-rst
License-File: COPYING
License-File: AUTHORS
Provides-Extra: cron-schedule
Requires-Dist: croniter; extra == "cron-schedule"
Provides-Extra: cron-description
Requires-Dist: cron-descriptor; extra == "cron-description"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: provides
Dynamic: provides-extra
Dynamic: summary
Python Crontab
--------------
.. image:: https://gitlab.com/doctormo/python-crontab/raw/master/branding.svg
.. image:: https://badge.fury.io/py/python-crontab.svg
:target: https://badge.fury.io/py/python-crontab
.. image:: https://img.shields.io/badge/License-LGPL%20v3-blue.svg
:target: https://gitlab.com/doctormo/python-crontab/raw/master/COPYING
Bug Reports and Development
===========================
Please report any problems to the `GitLab issues tracker <https://gitlab.com/doctormo/python-crontab/issues>`_. Please use Git and push patches to the `GitLab project code hosting <https://gitlab.com/doctormo/python-crontab>`_.
**Note:** If you get the error ``got an unexpected keyword argument 'user'`` when using CronTab, you have the wrong module installed. You need to install ``python-crontab`` and not ``crontab`` from pypi or your local package manager and try again.
Description
===========
Crontab module for reading and writing crontab files and accessing the system cron
automatically and simply using a direct API.
Comparing the `below chart <http://en.wikipedia.org/wiki/Cron#CRON_expression>`_
you will note that W, L, # and ? symbols are not supported as they are not
standard Linux or SystemV crontab format.
+-------------+-----------+-----------------+-------------------+-------------+
|Field Name |Mandatory |Allowed Values |Special Characters |Extra Values |
+=============+===========+=================+===================+=============+
|Minutes |Yes |0-59 |\* / , - | < > |
+-------------+-----------+-----------------+-------------------+-------------+
|Hours |Yes |0-23 |\* / , - | < > |
+-------------+-----------+-----------------+-------------------+-------------+
|Day of month |Yes |1-31 |\* / , - | < > |
+-------------+-----------+-----------------+-------------------+-------------+
|Month |Yes |1-12 or JAN-DEC |\* / , - | < > |
+-------------+-----------+-----------------+-------------------+-------------+
|Day of week |Yes |0-6 or SUN-SAT |\* / , - | < > |
+-------------+-----------+-----------------+-------------------+-------------+
Extra Values are '<' for minimum value, such as 0 for minutes or 1 for months.
And '>' for maximum value, such as 23 for hours or 12 for months.
Supported special cases allow crontab lines to not use fields.
These are the supported aliases which are not available in SystemV mode:
=========== ============
Case Meaning
=========== ============
@reboot Every boot
@hourly 0 * * * *
@daily 0 0 * * *
@weekly 0 0 * * 0
@monthly 0 0 1 * *
@yearly 0 0 1 1 *
@annually 0 0 1 1 *
@midnight 0 0 * * *
=========== ============
To control the output of specials see `SPECIALS_CONVERSION` below.
How to Use the Module
=====================
Here is a simple example of how python-crontab is typically used. First the
CronTab class is used to instantiate a cron object, then the cron object is used
to declaratively manipulate the cron (spawning a new job in this case). Lastly,
declared changes get written to the crontab by calling write on the object::
from crontab import CronTab
cron = CronTab(user='root')
job = cron.new(command='echo hello_world')
job.minute.every(1)
cron.write()
Alternatively, you can use the with context manager which will automatically
call write on the cron object upon exit::
with CronTab(user='root') as cron:
job = cron.new(command='echo hello_world')
job.minute.every(1)
print('cron.write() was just executed')
**Note:** Several users have reported their new crontabs not saving automatically or that the module doesn't do anything. You **MUST** use write() if you want your edits to be saved out. See below for full details on the use of the write function.
Getting access to a crontab can happen in five ways, three system methods that
will work only on Unix and require you to have the right permissions::
from crontab import CronTab
empty_cron = CronTab()
my_user_cron = CronTab(user=True)
users_cron = CronTab(user='username')
And two ways from non-system sources that will work on Windows too::
file_cron = CronTab(tabfile='filename.tab')
mem_cron = CronTab(tab="""
* * * * * command
""")
Special per-command user flag for vixie cron format (new in 1.9)::
system_cron = CronTab(tabfile='/etc/crontab', user=False)
job = system_cron[0]
job.user != None
system_cron.new(command='new_command', user='root')
Creating a new job is as simple as::
job = cron.new(command='/usr/bin/echo')
And setting the job's time restrictions::
job.minute.during(5,50).every(5)
job.hour.every(4)
job.day.on(4, 5, 6)
job.dow.on('SUN')
job.dow.on('SUN', 'FRI')
job.month.during('APR', 'NOV')
Each time restriction will clear the previous restriction::
job.hour.every(10) # Set to * */10 * * *
job.hour.on(2) # Set to * 2 * * *
Appending restrictions is explicit::
job.hour.every(10) # Set to * */10 * * *
job.hour.also.on(2) # Set to * 2,*/10 * * *
Setting all time slices at once::
job.setall(2, 10, '2-4', '*/2', None)
job.setall('2 10 * * *')
Setting the slice to a python date object::
job.setall(time(10, 2))
job.setall(date(2000, 4, 2))
job.setall(datetime(2000, 4, 2, 10, 2))
Run a jobs command. Running the job here will not effect it's
existing schedule with another crontab process::
job_standard_output = job.run()
Creating a job with a comment::
job = cron.new(command='/foo/bar', comment='SomeID')
Creating a job in the middle of the crontab::
job = cron.new('/bin/a', before='someID')
job = cron.new('/bin/b', before=jobItem)
job = cron.new('/bin/c', before=re.compile('id*'))
job = cron.new('/bin/d', before=cron.find_command('/usr/bin/existing'))
Get the comment or command for a job::
command = job.command
comment = job.comment
Modify the comment or command on a job::
job.set_command("new_script.sh")
job.set_comment("New ID or comment here")
Disabled or Enable Job::
job.enable()
job.enable(False)
False is job.is_enabled()
Validity Check::
True is job.is_valid()
Use a special syntax::
job.every_reboot()
Find an existing job by command sub-match or regular expression::
iter = cron.find_command('bar') # matches foobar1
iter = cron.find_command(re.compile(r'b[ab]r$'))
Find an existing job by comment exact match or regular expression::
iter = cron.find_comment('ID or some text')
iter = cron.find_comment(re.compile(' or \w'))
Find an existing job by schedule::
iter = cron.find_time(2, 10, '2-4', '*/2', None)
iter = cron.find_time("*/2 * * * *")
Clean a job of all rules::
job.clear()
Iterate through all jobs, this includes disabled (commented out) cron jobs::
for job in cron:
print(job)
Iterate through all lines, this includes all comments and empty lines::
for line in cron.lines:
print(line)
Remove Items::
cron.remove( job )
cron.remove_all('echo')
cron.remove_all(comment='foo')
cron.remove_all(time='*/2')
Clear entire cron of all jobs::
cron.remove_all()
Write CronTab back to system or filename::
cron.write()
Write CronTab to new filename::
cron.write( 'output.tab' )
Write to this user's crontab (unix only)::
cron.write_to_user( user=True )
Write to some other user's crontab::
cron.write_to_user( user='bob' )
Validate a cron time string::
from crontab import CronSlices
bool = CronSlices.is_valid('0/2 * * * *')
Compare list of cron objects against another and return the difference::
difference = set([CronItem1, CronItem2, CronItem3]) - set([CronItem2, CronItem3])
Compare two CronItems for equality::
CronItem1 = CronTab(tab="* * * * * COMMAND # Example Job")
CronItem2 = CronTab(tab="10 * * * * COMMAND # Example Job 2")
if CronItem1 != CronItem2:
print("Cronjobs do not match")
Environment Variables
=====================
Some versions of vixie cron support variables outside of the command line.
Sometimes just update the envronment when commands are run, the Cronie fork
of vixie cron also supports CRON_TZ which looks like a regular variable but
actually changes the times the jobs are run at.
Very old vixie crons don't support per-job variables, but most do.
Iterate through cron level environment variables::
for (name, value) in cron.env.items():
print(name)
print(value)
Create new or update cron level environment variables::
print(cron.env['SHELL'])
cron.env['SHELL'] = '/bin/bash'
print(cron.env)
Each job can also have a list of environment variables::
for job in cron:
job.env['NEW_VAR'] = 'A'
print(job.env)
Specials Mode
=============
You may need to control the output of special schedules such as `@hourly`. This can be done with the `crontab.SPECIALS_CONVERSION` package variable.
Enable conversion to a special on write (default)::
crontab.SPECIALS_CONVERSION = True
Enabled conversion to normal output on write::
crontab.SPECIALS_CONVERSION = False
Do no conversion and write whatever was read in::
crontab.SPECIALS_CONVERSION = None
Proceeding Unit Confusion
=========================
It is sometimes logical to think that `job.hour.every(2)` will set all proceeding
units to '0' and thus result in "0 \*/2 * * \*". Instead you are controlling
only the hours units and the minute column is unaffected. The real result would
be "\* \*/2 * * \*" and maybe unexpected to those unfamiliar with crontabs.
There is a special 'every' method on a job to clear the job's existing schedule
and replace it with a simple single unit::
job.every(4).hours() == '0 */4 * * *'
job.every().dom() == '0 0 * * *'
job.every().month() == '0 0 0 * *'
job.every(2).dows() == '0 0 * * */2'
This is a convenience method only, it does normal things with the existing api.
Running the Scheduler
=====================
The module is able to run a cron tab as a daemon as long as the optional
croniter module is installed; each process will block and errors will
be logged (new in 2.0).
(note this functionality is new and not perfect, if you find bugs report them!)
Running the scheduler::
tab = CronTab(tabfile='MyScripts.tab')
for result in tab.run_scheduler():
print("Return code: {result.returncode}")
print("Standard Out: {result.stdout}")
print("Standard Err: {result.stderr}")
Do not do this, it won't work because it returns generator function::
tab.run_scheduler()
Timeout and cadence can be changed for testing or error management::
for result in tab.run_scheduler(timeout=600):
print("Will run jobs every 1 minutes for ten minutes from now()")
for result in tab.run_scheduler(cadence=1, warp=True):
print("Will run jobs every 1 second, counting each second as 1 minute")
Frequency Calculation
=====================
Every job's schedule has a frequency. We can attempt to calculate the number
of times a job would execute in a give amount of time. We have two variants
`frequency_per_*` and `frequency_at_*` calculations. The `freqency_at_*`
always returnes *times* a job would execute and is aware of leap years.
`frequency_per_*`
-----------------
For `frequency_per_*` We have three simple methods::
job.setall("1,2 1,2 * * *")
job.frequency_per_day() == 4
The per year frequency method will tell you how many **days** a year the
job would execute::
job.setall("* * 1,2 1,2 *")
job.frequency_per_year(year=2010) == 4
These are combined to give the number of times a job will execute in any year::
job.setall("1,2 1,2 1,2 1,2 *")
job.frequency(year=2010) == 16
Frequency can be quickly checked using python built-in operators::
job < "*/2 * * * *"
job > job2
job.slices == "*/5"
`frequency_at_*`
----------------
For `frequency_at_*` We have four simple methods.
The at per hour frequency method will tell you how many times the job would
execute at a given hour::
job.setall("*/2 0 * * *")
job.frequency_at_hour() == 30
job.frequency_at_hour(year=2010, month=1, day=1, hour=0) == 30 # even hour
job.frequency_at_hour(year=2010, month=1, day=1, hour=1) == 0 # odd hour
The at day frequency method parameterized tells you how many times the job
would execute at a given day::
job.setall("0 0 * * 1,2")
job.frequency_at_day(year=2010, month=1, day=18) == 24 # Mon Jan 18th 2020
job.frequency_at_day(year=2010, month=1, day=21) == 0 # Thu Jan 21th 2020
The at month frequency method will tell you how many times the job would
execute at a given month::
job.setall("0 0 * * *")
job.frequency_at_month() == <output_of_current_month>
job.frequency_at_month(year=2010, month=1) == 31
job.frequency_at_month(year=2010, month=2) == 28
job.frequency_at_month(year=2012, month=2) == 29 # leap year
The at year frequency method will tell you how many times a year the
job would execute::
job.setall("* * 3,29 2 *")
job.frequency_at_year(year=2021) == 24
job.frequency_at_year(year=2024) == 48 # leap year
Log Functionality
=================
The log functionality will read a cron log backwards to find you the last run
instances of your crontab and cron jobs.
The crontab will limit the returned entries to the user the crontab is for::
cron = CronTab(user='root')
for d in cron.log:
print(d['pid'] + " - " + d['date'])
Each job can return a log iterator too, these are filtered so you can see when
the last execution was::
for d in cron.find_command('echo')[0].log:
print(d['pid'] + " - " + d['date'])
All System CronTabs Functionality
=================================
The crontabs (note the plural) module can attempt to find all crontabs on the
system. This works well for Linux systems with known locations for cron files
and user spolls. It will even extract anacron jobs so you can get a picture
of all the jobs running on your system::
from crontabs import CronTabs
for cron in CronTabs():
print(repr(cron))
All jobs can be brought together to run various searches, all jobs are added
to a CronTab object which can be used as documented above::
jobs = CronTabs().all.find_command('foo')
Schedule Functionality
======================
If you have the croniter python module installed, you will have access to a
schedule on each job. For example if you want to know when a job will next run::
schedule = job.schedule(date_from=datetime.now())
This creates a schedule croniter based on the job from the time specified. The
default date_from is the current date/time if not specified. Next we can get
the datetime of the next job::
datetime = schedule.get_next()
Or the previous::
datetime = schedule.get_prev()
The get methods work in the same way as the default croniter, except that they
will return datetime objects by default instead of floats. If you want the
original functionality, pass float into the method when calling::
datetime = schedule.get_current(float)
If you don't have the croniter module installed, you'll get an ImportError when
you first try using the schedule function on your cron job object.
Descriptor Functionality
========================
If you have the cron-descriptor module installed, you will be able to ask for a
translated string which describes the frequency of the job in the current
locale language. This should be mostly human readable.
print(job.description(use_24hour_time_format=True))
See cron-descriptor for details of the supported languages and options.
Extra Support
=============
- Customise the location of the crontab command by setting the global CRON_COMMAND
or the per-object cron_command attribute.
- Support for vixie cron with username addition with user flag
- Support for SunOS, AIX & HP with compatibility 'SystemV' mode.
- Python 3 (3.7, 3.8, 3.10) tested, python 2.6, 2.7 removed from support.
- Windows support works for non-system crontabs only.
( see mem_cron and file_cron examples above for usage )

View File

@@ -0,0 +1,13 @@
__pycache__/cronlog.cpython-312.pyc,,
__pycache__/crontab.cpython-312.pyc,,
__pycache__/crontabs.cpython-312.pyc,,
cronlog.py,sha256=ODFXVfxM7w3cqXCxb2tPYwX-QW4ALOm0cEm993i6Xkw,3903
crontab.py,sha256=FjzoYMJ1TqE3zMLGgjYgaRKp9t5bVXTfImWKx6RSBLE,51600
crontabs.py,sha256=uFToT3xNZbORXKVpJ4dr6O-smgIWGNcvEIGe3fS694Y,4570
python_crontab-3.3.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
python_crontab-3.3.0.dist-info/METADATA,sha256=rVGaRhEGt9P0fP-ZyqCW3cY2VLqwT0adEi5I_zoS45Q,17925
python_crontab-3.3.0.dist-info/RECORD,,
python_crontab-3.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
python_crontab-3.3.0.dist-info/licenses/AUTHORS,sha256=selKy827LPN6tG9BXW6Lv9aSwoyKK49qz2uw1AxgoGo,34
python_crontab-3.3.0.dist-info/licenses/COPYING,sha256=2n6rt7r999OuXp8iOqW9we7ORaxWncIbOwN1ILRGR2g,7651
python_crontab-3.3.0.dist-info/top_level.txt,sha256=6sgDMPsFZoGe1YGl_bAydk6yhopfR8GJ2VZWrU4cDKs,25

View File

@@ -0,0 +1,5 @@
Wheel-Version: 1.0
Generator: setuptools (80.9.0)
Root-Is-Purelib: true
Tag: py3-none-any

View File

@@ -0,0 +1 @@
Martin Owens (doctormo@gmail.com)

View File

@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

View File

@@ -0,0 +1,3 @@
cronlog
crontab
crontabs