Skip to content

Sorting

ballsdex.core.utils.sorting

filter_balls 

filter_balls(filter: FilteringChoices, queryset: QuerySet[BallInstance], guild_id: int | None = None) -> QuerySet[BallInstance]

Edit a list of ball instances in place to apply the selected filtering options.

Parameters:

  • filter (FilteringChoices) –

    One of the supported filtering methods

  • queryset (QuerySet[BallInstance]) –

    A ballinstance queryset.

  • guild_id (int | None, default: None ) –

    The ID of the server to filter by. Only used for the this_server filter. If not provided, this filter will be ignored.

Returns:

Source code in ballsdex/core/utils/sorting.py 
54
55
56
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
def filter_balls(
    filter: FilteringChoices, queryset: "QuerySet[BallInstance]", guild_id: int | None = None
) -> "QuerySet[BallInstance]":
    """
    Edit a list of ball instances in place to apply the selected filtering options.

    Parameters
    ----------
    filter: FilteringChoices
        One of the supported filtering methods
    queryset: QuerySet[BallInstance]
        A ballinstance queryset.
    guild_id: int | None
        The ID of the server to filter by. Only used for the ``this_server`` filter.
        If not provided, this filter will be ignored.

    Returns
    -------
    QuerySet[BallInstance]
        The modified query applying the filtering.
    """
    if filter == FilteringChoices.only_specials:
        return queryset.exclude(special=None)
    elif filter == FilteringChoices.non_specials:
        return queryset.filter(special=None)
    elif filter == FilteringChoices.self_caught:
        return queryset.filter(trade_player=None)
    elif filter == FilteringChoices.this_server and guild_id is not None:
        return queryset.filter(server_id=guild_id)
    else:
        return queryset

sort_balls 

sort_balls(sort: SortingChoices, queryset: QS) -> QS

Edit a queryset in place to apply the selected sorting options. You can call this function multiple times with the same queryset to have multiple sort methods.

Parameters:

  • sort (SortingChoices) –

    One of the supported sorting methods

  • queryset (QS) –

    An existing queryset of ball instances. This can be obtained with, for example, BallInstance.all() or BallInstance.filter(player=x) without awaiting the result!

Returns:

  • QuerySet[BallInstance] –

    The same queryset modified to apply the ordering. Await it to obtain the result.

Source code in ballsdex/core/utils/sorting.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def sort_balls[QS: QuerySet[BallInstance]](sort: SortingChoices, queryset: QS) -> QS:
    """
    Edit a queryset in place to apply the selected sorting options. You can call this function
    multiple times with the same queryset to have multiple sort methods.

    Parameters
    ----------
    sort: SortingChoices
        One of the supported sorting methods
    queryset: QuerySet[BallInstance]
        An existing queryset of ball instances. This can be obtained with, for example,
        ``BallInstance.all()`` or ``BallInstance.filter(player=x)``
        **without awaiting the result!**

    Returns
    -------
    QuerySet[BallInstance]
        The same queryset modified to apply the ordering. Await it to obtain the result.
    """
    if sort == SortingChoices.duplicates:
        return queryset.annotate(count=RawSQL("COUNT(*) OVER (PARTITION BY ball_id)", ())).order_by("-count")
    elif sort == SortingChoices.stats_bonus:
        return queryset.annotate(stats_bonus=F("health_bonus") + F("attack_bonus")).order_by("-stats_bonus")
    elif sort == SortingChoices.health or sort == SortingChoices.attack:
        # Use the sorting name as the annotation key to avoid issues when this function
        # is called multiple times. Using the same annotation name twice will error.
        return queryset.annotate(
            **{f"{sort.value}_sort": F(f"{sort.value}_bonus") + F(f"ball__{sort.value}")}
        ).order_by(f"-{sort.value}_sort")
    elif sort == SortingChoices.total_stats:
        return (
            queryset.select_related("ball")
            .annotate(stats=RawSQL("ball.health + ball.attack :: BIGINT", ()))
            .order_by("-stats")
        )
    elif sort == SortingChoices.rarity:
        return queryset.order_by(sort.value, "ball__country")
    else:
        return queryset.order_by(sort.value)