Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • ec325a8
  • /
  • scripts
  • /
  • cancel_overdue_orders.py
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge
swh:1:cnt:1d64f677798c502136bbb9221e2bc616a2811b12
directory badge
swh:1:dir:13c996cc896df00c72ea79a948959f08af0c56d5

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
cancel_overdue_orders.py
"""Cancel open orders older than N days.

:Copyright: 2019-2025 Jan Korneffel, Jochen Kupperschmidt
:License: Revised BSD (see `LICENSE` file for details)
"""

from datetime import timedelta

import click
from flask_babel import force_locale, gettext

from byceps.services.shop.order import (
    order_command_service,
    order_service,
    signals as shop_order_signals,
)
from byceps.services.shop.order.email import order_email_service
from byceps.services.shop.order.errors import (
    OrderActionFailedError,
    OrderAlreadyCanceledError,
)
from byceps.services.shop.order.models.order import Order
from byceps.util.result import Err, Ok

from _util import call_with_app_context
from _validators import validate_user_screen_name


@click.command()
@click.option('--shop-id', required=True)
@click.option('--minimum-age-in-days', required=True, type=click.INT)
@click.option('--canceler', required=True, callback=validate_user_screen_name)
@click.option('--locale', required=True, default='en')
@click.option('--reason')
@click.option('--notify/--no-notify', required=True)
@click.option('--limit', default=100)
def execute(
    shop_id,
    minimum_age_in_days: int,
    canceler,
    locale: str,
    reason: str | None,
    notify: bool,
    limit: int,
):
    overdue_orders = _collect_overdue_orders(
        shop_id, minimum_age_in_days, limit
    )
    for order in overdue_orders:
        with force_locale(locale):
            _cancel_order(order, canceler, reason, notify)


def _collect_overdue_orders(
    shop_id, minimum_age_in_days: int, limit: int
) -> list[Order]:
    older_than = timedelta(days=minimum_age_in_days)
    overdue_orders = order_service.get_overdue_orders(
        shop_id, older_than, limit=limit
    )
    click.secho(f'Found {len(overdue_orders)} overdue orders.', fg='yellow')
    return overdue_orders


def _cancel_order(order, canceler, reason: str | None, notify: bool) -> None:
    if not reason:
        reason = gettext(
            'The payment deadline has been exceed. '
            'Place a new order if you are still interested in attending.'
        )

    match order_command_service.cancel_order(order.id, canceler, reason):
        case Ok((canceled_order, canceled_event)):
            shop_order_signals.order_canceled.send(None, event=canceled_event)
            click.secho(
                f'Order {order.order_number} was successfully canceled.',
                fg='green',
            )

            if notify:
                _notify_orderer(canceled_order)
        case Err(e):
            if isinstance(e, OrderAlreadyCanceledError):
                message = (
                    f'Order {order.order_number} has already been canceled.'
                )
            elif isinstance(e, OrderActionFailedError):
                message = f'An error occurred on action execution for order {order.order_number}: {e.details}'
            else:
                message = f'Order {order.order_number} could not be canceled.'
            click.secho(message, fg='red')


def _notify_orderer(order) -> None:
    order_email_service.send_email_for_canceled_order_to_orderer(order)
    click.secho(
        f'Notified orderer of canceled order {order.order_number}.', fg='green'
    )


if __name__ == '__main__':
    call_with_app_context(execute)

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API