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: 535 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 535 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 523 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5300 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1088 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4418 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4250 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 19111 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1058 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 36236 [[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: 6 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 8 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 26 [[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: 34 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 34 [[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: #37023, #13376, #37009 [[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

2043 / 2043

Bug

10547 / 10904

New feature

3863 / 4246

Cleanup/optimization

5510 / 5827

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 35178)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#37022 worksforme manage.py runserver fails with "nodename nor servname provided" when run using an rfc6761 hostname Chris Rose
Description
$ uv run manage.py runserver nomnom.dev.localhost:8441
Watching for file changes with StatReloader
2026-04-03T15:53:16.440737Z [info     ] Watching for file changes with StatReloader [django.utils.autoreload]
Performing system checks...

System check identified no issues (0 silenced).
Error: [Errno 8] nodename nor servname provided, or not known

nomnom.dev.localhost doesn't directly resolve in DNS, but it is a valid RFC 6761 special use domain.

I've attached my settings, and because ALLOWED_HOSTS is relevant, here's that value from manage.py shell:

uv run manage.py shell
45 objects imported automatically (use -v 2 for details).

Python 3.13.12 (main, Feb  3 2026, 17:53:27) [Clang 17.0.0 (clang-1700.6.3.2)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>> from django.conf import settings
>>> settings.ALLOWED_HOSTS
['nomnom.dev.localhost']
>>>
#37018 wontfix Generated migrations should use tuples instead of lists Daniel Quinn
Description

When running makemigrations, the typical output contains a Migration class with at least two attributes: dependencies and operations, both of which are mutable lists rather than immutable tuples. This upsets my linter (ruff) which I think rightly complains that we've got a class here with mutable default values:

error[RUF012]: Mutable default value for class attribute
  --> plugins/generic_to_clickhouse/migrations/0001_initial.py:13:20
   |
11 |     initial = True
12 |
13 |     dependencies = []
   |                    ^^
14 |
15 |     operations = (
   |
help: Consider initializing in `__init__` or annotating with `typing.ClassVar`

Digging through the source, I see that this is just the result of a hard-coded template using [ instead of (, so I have to assume that a fix would be pretty straightforward.

So unless there's a reason we want these values to be mutable, I'm happy to do this work. I just don't want to do the work and have it rejected for unforseen reasons.

#37017 fixed alogout() doesn't clear request.user Jacob Walls Jacob Walls
Description

As of Django 6.0, alogout() no longer clears request.user, only request.auser. If code accesses request.user before RemoteUserMiddleware (or similar) runs alogout(), then it is possible for request.user to be stale, and for a resource behind authentication to be visible to a logged-out user.

user and auser aren't really two concepts: just two getters for the same underlying concept. (Thanks, function color problem!)

(I'm suggesting this was an oversight in 31a43c571f4d036827d4fd7a5f615591637dc1be. This was discussed during development, but it may not have been clear how this would arise in practice.)

The security team considered a report about this suggesting the following order of middlewares:

MIDDLEWARE = [
    "django.middleware.security.SecurityMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "app.middleware.MaterializeUserMiddleware",  # e.g. a logging middleware like Sentry
    "django.contrib.auth.middleware.RemoteUserMiddleware",
    "django.contrib.auth.middleware.LoginRequiredMiddleware",
]

The problem does not reproduce if RemoteUserMiddleware is moved one position earlier. The security team closed the report on this basis (that is, anything responsible for logout should happen before other code that might be interested in that logout). Our docs say RemoteUserMiddleware should be placed "after" AuthenticationMiddleware, but does not clarify whether this entails directly after.

Still seems like something to fix to make auth easier to reason about.

Thanks Peng Zhou for the report.

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

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