Skip to content

Drafts cleanup

hypha.apply.funds.management.commands.drafts_cleanup

Command

Bases: BaseCommand

help class-attribute instance-attribute 

help = "Delete all drafts that haven't been modified in the specified time (in days)"

add_arguments 

add_arguments(parser)
Source code in hypha/apply/funds/management/commands/drafts_cleanup.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def add_arguments(self, parser):
    parser.add_argument(
        "older_than_days",
        action="store",
        type=check_not_negative,
        help="Time in days to delete drafts older than",
    )
    parser.add_argument(
        "--noinput",
        "--no-input",
        action="store_false",
        dest="interactive",
        help="Do not prompt the user for confirmation",
        required=False,
    )

handle 

handle(*args, **options)
Source code in hypha/apply/funds/management/commands/drafts_cleanup.py 
57
58
59
60
61
62
63
64
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
@transaction.atomic
def handle(self, *args, **options):
    interactive = options["interactive"]
    older_than = options["older_than_days"]

    older_than_date = timezone.now() - timedelta(days=older_than)

    old_drafts = ApplicationSubmission.objects.filter(
        status=DRAFT_STATE, draft_revision__timestamp__date__lte=older_than_date
    )

    draft_count = old_drafts.count()

    if not (draft_count := old_drafts.count()):
        self.stdout.write(
            f"No drafts older than {older_than} day{'s' if older_than > 1 else ''} exist."
        )
        return

    if interactive:
        confirm = input(
            f"This action will permanently delete {draft_count} draft{'s' if draft_count != 1 else ''}.\nAre you sure you want to do this?\n\nType 'yes' to continue, or 'no' to cancel: "
        )
    else:
        confirm = "yes"

    if confirm == "yes":
        old_drafts.delete()
        self.stdout.write(
            f"{draft_count} draft{'s' if draft_count != 1 else ''} deleted."
        )
    else:
        self.stdout.write("Deletion cancelled.")

check_not_negative 

check_not_negative(value)

Used to validate older_than_days argument

Parameters:

  • value –

    Argument to be validated

Returns:

  • int ( int ) –

    Valid non-negative value

Raises:

  • ArgumentTypeError –

    if not non-negative integer

Source code in hypha/apply/funds/management/commands/drafts_cleanup.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def check_not_negative(value) -> int:
    """Used to validate `older_than_days` argument

    Args:
        value: Argument to be validated

    Returns:
        int: Valid non-negative value

    Raises:
        argparse.ArgumentTypeError: if not non-negative integer
    """
    try:
        ivalue = int(value)
    except ValueError:
        ivalue = -1

    if ivalue < 0:
        raise argparse.ArgumentTypeError(
            f'"{value}" is an invalid non-negative integer value'
        )
    return ivalue