Source code for matrixctl.commands.delete_local_media.parser

# matrixctl
# Copyright (c) 2020-2023  Michael Sasser <Michael@MichaelSasser.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""Add the ``delete-local_media`` subcommand to ``matrixctl``."""

from __future__ import annotations

import typing as t

from argparse import ArgumentParser
from argparse import _SubParsersAction

from matrixctl.command import SubCommand
from matrixctl.command import subparser


__author__: str = "Michael Sasser"
__email__: str = "Michael@MichaelSasser.org"




@subparser(SubCommand.MEDIA)
def subparser_delete_local_media(
    subparsers: _SubParsersAction[t.Any],
    common_parser: ArgumentParser,
) -> None:
    """Create a subparser for the ``matrixctl delete-local_media`` command.

    Parameters
    ----------
    subparsers : argparse._SubParsersAction of typing.Any
        The object which is returned by
        ``parser.add_subparsers()``.

    Returns
    -------
    None

    """
    parser: ArgumentParser = subparsers.add_parser(
        "delete-local-media",
        help=("Purge local, cached media tht wasn't accessed lately"),
        parents=[common_parser],
    )
    parser.add_argument(
        "timestamp",
        type=int,
        nargs="?",
        default=None,
        help=(
            "A timestamp (UNIX epoch) of how long ago the media must have "
            "been accessed in order to keep it."
        ),
    )
    parser.add_argument(
        "--no-keep-profiles",
        action="store_false",
        help=(
            "Also delete files that are **still being used** e.g. "
            "user/room avatars"
        ),
    )
    parser.add_argument(
        "-g",
        "--greater-than",
        type=int,
        default=0,
        help=(
            "Keep media files smaller than this size in bytes. (default: 0)"
        ),
    )
    parser.add_argument(
        "-f",
        "--force",
        action="store_true",
        help="Force the operation, no questions asked",
    )
    parser.set_defaults(addon="delete_local_media")



# vim: set ft=python :