def main(*, id_numbers, nuke, force):
get_logger(set_info=True)
if nuke:
_delete_all(force)
else:
_delete_by_id(id_numbers)
def main(*, command, hour, minute, disabled):
get_logger(set_info=True)
hour = int(hour) if hour is not None else None
task = Task.to_be_created(command=command,
hour=hour,
minute=int(minute),
disabled=disabled)
task.create_schedule()
def main(*, task_id, **kwargs):
logger = get_logger(set_info=True)
task = get_task_from_id(task_id)
print_snake = kwargs.pop("snake")
print_only_values = kwargs.pop("no_spec")
specs = (
{spec: getattr(task, spec) for spec in kwargs if kwargs[spec]}
if any([val for val in kwargs.values()])
else {spec: getattr(task, spec) for spec in kwargs}
)
# get user path instead of server path:
if specs.get("logfile"):
specs.update({"logfile": task.logfile.replace("/user/{}/files".format(task.user), "")})
intro = "Task {} specs: ".format(task_id)
if print_only_values:
specs = "\n".join([str(val) for val in specs.values()])
logger.info(specs)
elif print_snake:
specs = ["<{}>: {}".format(spec, value) for spec, value in specs.items()]
specs.sort()
logger.info(snakesay(intro + ", ".join(specs)))
else:
table = [[spec, val] for spec, val in specs.items()]
table.sort(key=lambda x: x[0])
logger.info(intro)
logger.info(tabulate(table, tablefmt="simple"))
def main(*, task_id, **kwargs):
logger = get_logger()
if kwargs.pop("hourly"):
kwargs["interval"] = "hourly"
if kwargs.pop("daily"):
kwargs["hour"] = kwargs["hour"] if kwargs["hour"] else datetime.now(
).hour
kwargs["interval"] = "daily"
def parse_opts(*opts):
candidates = [key for key in opts if kwargs.pop(key, None)]
return candidates[0] if candidates else None
if not parse_opts("quiet"):
logger.setLevel(logging.INFO)
porcelain = parse_opts("porcelain")
enable_opt = parse_opts("toggle_enabled", "disable", "enable")
task = get_task_from_id(task_id)
params = {key: val for key, val in kwargs.items() if val}
if enable_opt:
enabled = {
"toggle_enabled": not task.enabled,
"disable": False,
"enable": True
}[enable_opt]
params.update({"enabled": enabled})
try:
task.update_schedule(params, porcelain=porcelain)
except Exception as e:
logger.warning(snakesay(str(e)))
def delete_all_tasks(
force: bool = typer.Option(
False, "-f", "--force", help="Turns off user confirmation before deleting tasks"
),
):
get_logger(set_info=True)
if not force:
user_response = typer.confirm(
"This will irrevocably delete all your tasks, proceed?"
)
if not user_response:
return None
for task in TaskList().tasks:
task.delete_schedule()
def test_returns_pa_logger(self, caplog):
# get_logger should change logger to WARNING, i.e. level 30
caplog.set_level(logging.INFO, logger="pythonanywhere")
logger = get_logger()
assert logger.name == "pythonanywhere"
assert logger.level == 30
def list_(
tablefmt: str = typer.Option(
"simple", "-f", "--format", help="Table format", callback=tablefmt_callback
)
):
"""Get list of user's scheduled tasks as a table with columns:
id, interval, at (hour:minute/minute past), status (enabled/disabled), command.
Note:
This script provides an overview of all tasks. Once a task id is
known and some specific data is required it's more convenient to get
it using `pa schedule get` command instead of parsing the table.
"""
logger = get_logger(set_info=True)
headers = "id", "interval", "at", "status", "command"
attrs = "task_id", "interval", "printable_time", "enabled", "command"
def stringify_values(task, attr):
value = getattr(task, attr)
if attr == "enabled":
value = "enabled" if value else "disabled"
return value
table = [[stringify_values(task, attr) for attr in attrs] for task in TaskList().tasks]
msg = tabulate(table, headers, tablefmt=tablefmt) if table else snakesay("No scheduled tasks")
logger.info(msg)
def test_returns_pa_logger_info(self, caplog):
# get_logger should change logger to INFO, i.e. level 20
caplog.set_level(logging.WARNING, logger="pythonanywhere")
logger = get_logger(set_info=True)
assert logger.name == "pythonanywhere"
assert logger.level == 20
def set(
command: str = typer.Option(
..., "-c", "--command", help="Task's command to be scheduled"
),
hour: int = typer.Option(
None,
"-h",
"--hour",
min=0,
max=23,
help="Sets the task to be performed daily at HOUR",
),
minute: int = typer.Option(
...,
"-m",
"--minute",
min=0,
max=59,
help="Minute on which the task will be executed",
),
disabled: bool = typer.Option(
False, "-d", "--disabled", help="Creates disabled task (otherwise enabled)"
),
):
"""Create a scheduled task.
Two categories of tasks are available: daily and hourly.
Both kinds require a command to run and scheduled time. In order to create a
daily task provide hour and minute; to create hourly task provide only minute.
If task is intended to be enabled later add --disabled flag.
Example:
Create a daily task to be run at 13:15:
pa schedule set --command "echo foo" --hour 13 --minute 15
Create an inactive hourly task to be run 27 minutes past every hour:
pa schedule set --command "echo bar" --minute 27 --disabled
Note:
Once task is created its behavior may be altered later on with
`pa schedule update` or deleted with `pa schedule delete`
commands."""
logger = get_logger(set_info=True)
task = Task.to_be_created(
command=command, hour=hour, minute=minute, disabled=disabled
)
try:
task.create_schedule()
except Exception as e:
logger.warning(snakesay(str(e)))
def main(tablefmt):
logger = get_logger(set_info=True)
headers = "id", "interval", "at", "status", "command"
attrs = "task_id", "interval", "printable_time", "enabled", "command"
def get_right_value(task, attr):
value = getattr(task, attr)
if attr == "enabled":
value = "enabled" if value else "disabled"
return value
table = [[get_right_value(task, attr) for attr in attrs] for task in TaskList().tasks]
msg = tabulate(table, headers, tablefmt=tablefmt) if table else snakesay("No scheduled tasks")
logger.info(msg)
def setup(path: str, quiet: bool) -> PAPath:
logger = get_logger(set_info=True)
if quiet:
logger.disabled = True
return PAPath(path)
def update(
task_id: int = typer.Argument(..., metavar="id"),
command: str = typer.Option(
None,
"-c",
"--command",
help="Changes command to COMMAND (multiword commands should be quoted)"
),
hour: int = typer.Option(
None,
"-o",
"--hour",
min=0,
max=23,
help="Changes hour to HOUR (in 24h format)"
),
minute: int = typer.Option(
None,
"-m",
"--minute",
min=0,
max=59,
help="Changes minute to MINUTE"
),
disable: bool = typer.Option(False, "-d", "--disable", help="Disables task"),
enable: bool = typer.Option(False, "-e", "--enable", help="Enables task"),
toggle_enabled: bool = typer.Option(
False, "-t", "--toggle-enabled", help="Toggles enable/disable state"
),
daily: bool = typer.Option(
False,
"-a",
"--daily",
help=(
"Switches interval to daily "
"(when --hour is not provided, sets it automatically to current hour)"
)
),
hourly: bool = typer.Option(
False,
"-u",
"--hourly",
help="Switches interval to hourly (takes precedence over --hour, i.e. sets hour to None)"
),
quiet: bool = typer.Option(False, "-q", "--quiet", help="Turns off messages"),
porcelain: bool = typer.Option(
False, "-p", "--porcelain", help="Prints message in easy-to-parse format"
),
):
"""Update a scheduled task.
Note that logfile name will change after updating the task but it won't be
created until first execution of the task.
To change interval from hourly to daily use --daily flag and provide --hour.
When --daily flag is not accompanied with --hour, new hour for the task
will be automatically set to current hour.
When changing interval from daily to hourly --hour flag is ignored.
Example:
Change command for a scheduled task 42:
pa schedule update 42 --command "echo new command"
Change interval of the task 42 from hourly to daily to be run at 10 am:
pa schedule update 42 --hour 10
Change interval of the task 42 from daily to hourly and set new minute:
pa schedule update 42 --minute 13 --hourly"""
kwargs = {k: v for k, v in locals().items() if k != "task_id"}
logger = get_logger()
porcelain = kwargs.pop("porcelain")
if not kwargs.pop("quiet"):
logger.setLevel(logging.INFO)
if not any(kwargs.values()):
msg = "Nothing to update!"
logger.warning(msg if porcelain else snakesay(msg))
sys.exit(1)
if kwargs.pop("hourly"):
kwargs["interval"] = "hourly"
if kwargs.pop("daily"):
kwargs["hour"] = kwargs["hour"] if kwargs["hour"] else datetime.now().hour
kwargs["interval"] = "daily"
task = get_task_from_id(task_id)
enable_opt = [k for k in ["toggle_enabled", "disable", "enable"] if kwargs.pop(k)]
params = {k: v for k, v in kwargs.items() if v}
if enable_opt:
lookup = {"toggle_enabled": not task.enabled, "disable": False, "enable": True}
params.update({"enabled": lookup[enable_opt[0]]})
try:
task.update_schedule(params, porcelain=porcelain)
except Exception as e:
logger.warning(snakesay(str(e)))
def get(
task_id: int = typer.Argument(..., metavar="id"),
command: bool = typer.Option(
False, "-c", "--command", help="Prints task's command"
),
enabled: bool = typer.Option(
False, "-e", "--enabled", help="Prints task's enabled status (True or False)"
),
expiry: bool = typer.Option(
False, "-x", "--expiry", help="Prints task's expiry date"
),
minute: bool = typer.Option(
False, "-m", "--minute", help="Prints task's scheduled minute"
),
hour: bool = typer.Option(
False, "-o", "--hour", help="Prints task's scheduled hour (if daily)"
),
interval: bool = typer.Option(
False, "-i", "--interval", help="Prints task's frequency (daily or hourly)"
),
logfile: bool = typer.Option(
False, "-l", "--logfile", help="Prints task's current log file path"
),
printable_time: bool = typer.Option(
False, "-p", "--printable-time", help="Prints task's scheduled time"
),
no_spec: bool = typer.Option(
False, "-n", "--no-spec", help="Prints only values without spec names"
),
snake: bool = typer.Option(
False, "-s", "--snakesay", help="Turns on snakesay... because why not"
)
):
"""Get scheduled task's specs.
Available specs are: command, enabled, interval, hour, minute, printable-time,
logfile, expiry. If no option specified, script will output all mentioned specs.
Note that logfile query provides path for current (last) logfile. There may be
several logfiles for each task.
If task has been updated (e.g. by `pa_update_scheduled_task.py` script) logfile
name has been changed too, but the file will not be created until first execution
of the task. Thus getting logfile path via API call does not necessarily mean the
file exists on the server yet.
Note:
Task ID may be found using pa schedule list command.
Example:
Get all specs for task with id 42:
pa schedule get 42
Get only logfile name for task with id 42:
pa schedule get 42 --logfile --no-spec"""
kwargs = {k: v for k, v in locals().items() if k != "task_id"}
logger = get_logger(set_info=True)
task = get_task_from_id(task_id)
print_snake = kwargs.pop("snake")
print_only_values = kwargs.pop("no_spec")
specs = (
{spec: getattr(task, spec) for spec in kwargs if kwargs[spec]}
if any([val for val in kwargs.values()])
else {spec: getattr(task, spec) for spec in kwargs}
)
if specs.get("logfile"):
specs.update({"logfile": task.logfile.replace(f"/user/{task.user}/files", "")})
intro = f"Task {task_id} specs: "
if print_only_values:
specs = "\n".join([str(val) for val in specs.values()])
logger.info(specs)
elif print_snake:
specs = [f"<{spec}>: {value}" for spec, value in specs.items()]
specs.sort()
logger.info(snakesay(intro + ", ".join(specs)))
else:
table = [[spec, val] for spec, val in specs.items()]
table.sort(key=lambda x: x[0])
logger.info(intro)
logger.info(tabulate(table, tablefmt="simple"))
def delete_task_by_id(id_numbers: List[int] = typer.Argument(...)):
get_logger(set_info=True)
for task_id in id_numbers:
task = get_task_from_id(task_id, no_exit=True)
task.delete_schedule()