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:	426	[[TicketQuery(status=new&milestone=,count)]]
Number of new tickets:	426	[[TicketQuery(status=new,count)]]
Number of reopened tickets:	0	[[TicketQuery(status=reopened,count)]]
Number of assigned tickets:	670	[[TicketQuery(status=assigned,count)]]
Number of invalid tickets:	5321	[[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets:	1093	[[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets:	4447	[[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets:	4286	[[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets:	19430	[[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset):	1096	[[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets:	36712	[[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:	34	[[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:	#36350, #37379, #37473	[[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	2051 / 2052
Bug	10758 / 11135
New feature	3920 / 4310
Cleanup/optimization	5673 / 6000

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:

Results (1 - 3 of 35616)

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

Ticket	Resolution	Summary	Owner	Reporter
#37494	wontfix	Document that RunPython callables receive a StateApps instance		Thibaut Decombe
#37489	fixed	Missing inline doc comment for Field.template_name.	Zishan Kadri	Zishan Kadri
#37488	needsnewfeatureprocess	DuckDB database backend for Django.		Łukasz Wieczorek

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

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

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

Ticket	Resolution	Summary	Owner	Reporter
#37494	wontfix	Document that RunPython callables receive a StateApps instance		Thibaut Decombe
Description	The ​`RunPython` docs say the first argument passed to code / reverse_code is "an instance of django.apps.registry.Apps containing historical models". At runtime it is a django.db.migrations.state.StateApps (see django/db/migrations/operations/special.py, ​RunPython.database_forwards(). This difference matters to users who follow the docs literally, especially when annotating migration functions: def forwards(apps: Apps, schema_editor: BaseDatabaseSchemaEditor) -> None: Person = apps.get_model("myapp", "Person") Apps is also the type of the global registry (django.apps.apps), whose get_model() returns the current models from models.py. With the documented annotation, tools such as the django-stubs mypy plugin can't tell this historical registry apart from the global one. They resolve get_model() to the current model class, which may have different fields than the historical model (​https://github.com/typeddjango/django-stubs/issues/3584). Proposal: mention django.db.migrations.state.StateApps (as a subclass of Apps) in the RunPython docs.
#37489	fixed	Missing inline doc comment for Field.template_name.	Zishan Kadri	Zishan Kadri
Description	Field.__init__() has inline comments documenting most of its arguments (required, label, initial, etc.), but template_name is missing one. I propose adding a short comment in the same style: # template_name -- Name of the template to use in Field.as_field_group. # By default Django uses the "django/forms/field.html" # template which is designed for use with the default # "django/forms/div.html" form style.
#37488	needsnewfeatureprocess	DuckDB database backend for Django.		Łukasz Wieczorek
Description	Trying to get rid of SQLite in favor DuckDB. ​https://github.com/wieczorek1990/django ​https://github.com/wieczorek1990/django-with-duckdb

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

---

See also: TracQuery, TracTickets, TracReports