TicketQuery Wiki Macro

The TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting. The query language used by the [[TicketQuery]] macro is described in the TracQuery page.

Usage

[[TicketQuery]]

Wiki macro listing tickets that match certain criteria.

This macro accepts a comma-separated list of keyed parameters, in the form "key=value".

If the key is the name of a field, the value must use the syntax of a filter specifier as defined in TracQuery#QueryLanguage. Note that this is not the same as the simplified URL syntax used for query: links starting with a ? character. Commas (,) can be included in field values by escaping them with a backslash (\).

Groups of field constraints to be OR-ed together can be separated by a literal or argument.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

The format parameter determines how the list of tickets is presented:

  • list -- the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line.
  • compact -- the tickets are presented as a comma-separated list of ticket IDs.
  • count -- only the count of matching tickets is displayed
  • rawcount -- only the count of matching tickets is displayed, not even with a link to the corresponding query (since 1.1.1)
  • table -- a view similar to the custom query view (but without the controls)
  • progress -- a view similar to the milestone progress bars

The max parameter can be used to limit the number of tickets shown (defaults to 0, i.e. no maximum).

The order parameter sets the field used for ordering tickets (defaults to id).

The desc parameter indicates whether the order of the tickets should be reversed (defaults to false).

The group parameter sets the field used for grouping tickets (defaults to not being set).

The groupdesc parameter indicates whether the natural display order of the groups should be reversed (defaults to false).

The verbose parameter can be set to a true value in order to get the description for the listed tickets. For table format only. deprecated in favor of the rows parameter

The rows parameter can be used to specify which field(s) should be viewed as a row, e.g. rows=description|summary

The col parameter can be used to specify which fields should be viewed as columns. For table format only.

For compatibility with Trac 0.10, if there's a last positional parameter given to the macro, it will be used to specify the format. Also, using "&" as a field separator still works (except for order) but is deprecated.

Examples

Example Result Macro
Number of Triage tickets: 614 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 614 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 452 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5255 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1080 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4374 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4207 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18862 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1066 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 35831 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1488 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 28 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 8 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 25 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 0 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 33 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 33 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 0 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #36487, #28944, #36398 [[TicketQuery(max=3,order=modified,desc=1,compact)]]

Details of ticket #1:

[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]

Ticket Owner Reporter
#1 Jacob Adrian Holovaty
Summary Create architecture for anonymous sessions

Format: list

[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

This is displayed as:

No results 

[[TicketQuery(id=123)]]

This is displayed as:

#123
Typo in the model_api/#field-types

Format: compact

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

No results

Format: count

[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

This is displayed as:

0

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

Uncategorized

2022 / 2022
Bug

10366 / 10733
New feature

3794 / 4183
Cleanup/optimization

5368 / 5677

Format: table

You can choose the columns displayed in the table format (format=table) using col=<field>. You can specify multiple fields and the order they are displayed in by placing pipes (|) between the columns: 

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

Full rows

In table format you can specify full rows using rows=<field>: 

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]

This is displayed as:

Results (1 - 3 of 34765)

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#36610 duplicate [Cache] DatabaseCache resets expiration date on incr/decr Simone Macri Simone Macri
Description

[Cache] DatabaseCache resets expiration date on incr/decr

Problem description

When using DatabaseCache with the incr() and decr() methods, if a key already has a custom timeout set, its expiration date is reset to the default value instead of keeping the existing one.

This leads to loss of the correct expiry value, causing keys with custom timeouts to be invalidated earlier or later than expected.

Steps to reproduce

  1. Configure a DatabaseCache.
  2. Save a key with an explicit timeout:

cache.set("key", 1, timeout=86400) # 1 day

  1. Check the expiration in the DB (correct: ~current_time + 86400).
  2. Increment the value with:

cache.incr("key")

  1. Check the expiration again: it is reset to the default instead of remaining unchanged.

Expected behavior

The incr() and decr() operations should not modify the expiration date of an existing key. They should preserve the previously defined timeout.

Proposed changes

  • Introduced a get_many_rows() method to isolate and directly test expiry handling.
  • Added a no_timeout flag in _base_set to distinguish cases where no new timeout should be set.
  • Updated the UPDATE logic so that incr/decr does not overwrite the expires field.
  • Added tests to ensure incr() and decr() maintain the original expiry

Affected files

  • django/core/cache/backends/db.py
#36607 invalid Improve the documentation by mentioning that "filter(a,b)" may not be the same as "filter(a).filter(b)" on querysets. Aaron
Description

Dear community,

I just got informed about the fact that "filter(a,b)" might not be the same as "filter(a).filter(b)". The following example may be useful for illustrating this. It uses some code that is inspired by our code and won't run without context, but I hope it is illustrating enough.

The intend is to filter for MaintenanceOperations. Therefore, we create one: 

op = MaintenanceOperationFactory()

These objects are children of the MaintenanceOperation: 

maint_a = UnscheduledMaintenanceFactory(operation=op, execution_start="2030-03-10T12:00:00Z")
maint_b = UnscheduledMaintenanceFactory(operation=op, execution_start="2030-05-10T12:00:00Z")

We construct a first queryset like this: 

qs1 = MaintenanceOperation.objects.filter(maintenances__execution_start__gt="2030-04-10T12:00:00Z", maintenances__execution_start__lt="2030-04-20T12:00:00Z",)

This qs evaluates to: <MaintenanceOperationQuerySet []> (aka the empty list). This happens because neither UnscheduledMaintenance meets both criteria. The underlying sql is this: 

SELECT "maintenance_maintenanceoperation"."id" FROM
"maintenance_maintenanceoperation" INNER JOIN "maintenance_maintenance" ON
("maintenance_maintenanceoperation"."id" =
"maintenance_maintenance"."operation_id") WHERE
("maintenance_maintenanceoperation"."deleted_at" IS NULL AND
"maintenance_maintenance"."execution_start" > 2030-04-10 12:00:00+00:00 AND
"maintenance_maintenance"."execution_start" < 2030-04-20 12:00:00+00:00)

To demonstrate the second case, we build the following queryset: 

qs2 = MaintenanceOperation.objects.filter(
maintenances__execution_start__gt="2030-04-10T12:00:00Z",).filter(
maintenances__execution_start__lt="2030-04-20T12:00:00Z",)

This qs evaluates to:<MaintenanceOperationQuerySet [<MaintenanceOperation: #1: beauftragt>]>(This list contains the MaintenanceOperation we created at the start) This is different from the first one, because the sql is done with another join: 

SELECT "maintenance_maintenanceoperation"."id"
FROM "maintenance_maintenanceoperation" INNER JOIN "maintenance_maintenance" ON
("maintenance_maintenanceoperation"."id" =
"maintenance_maintenance"."operation_id") INNER JOIN "maintenance_maintenance"
T3 ON ("maintenance_maintenanceoperation"."id" = T3."operation_id") WHERE
("maintenance_maintenanceoperation"."deleted_at" IS NULL AND
"maintenance_maintenance"."execution_start" > 2030-04-10 12:00:00+00:00 AND
T3."execution_start" < 2030-04-20 12:00:00+00:00)

I think this should be mentioned in the filter documentation, particularly in the section on joining filters. If this is met with approval I am open to sketching a suggestion.

#36606 fixed Optimize QuerySet.values_list(flat=True) with no fields Adam Johnson Adam Johnson
Description

Currently, QuerySet.values_list() ensures that no more than 1 field is set (​source): 

        if flat and len(fields) > 1:
            raise TypeError(
                "'flat' is not valid when values_list is called with more than one "
                "field."
            )

However, it also allows the case where *no* fields are declared, for which all fields are fetched, only to throw away all but the first one (​source): 

class FlatValuesListIterable(BaseIterable):
    """
    Iterable returned by QuerySet.values_list(flat=True) that yields single
    values.
    """

    def __iter__(self):
        queryset = self.queryset
        compiler = queryset.query.get_compiler(queryset.db)
        for row in compiler.results_iter(
            chunked_fetch=self.chunked_fetch, chunk_size=self.chunk_size
        ):
            yield row[0]

I think we can optimize this case to select only the first field in the model instead, maintaining semantics while avoiding overfetching.

This case also seems untested with the values_list() tests in tests/lookup/tests.py, so we'd want to add a test there.

1 2 3 4 5 6 7 8 9 10 11 →

See also: TracQuery, TracTickets, TracReports

Last modified 20 months ago Last modified on Jan 24, 2024, 9:58:09 AM
Note: See TracWiki for help on using the wiki.
Back to Top