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:	0	[[TicketQuery(status=new&milestone=,count)]]
Number of new tickets:	1	[[TicketQuery(status=new,count)]]
Number of reopened tickets:	0	[[TicketQuery(status=reopened,count)]]
Number of assigned tickets:	2	[[TicketQuery(status=assigned,count)]]
Number of invalid tickets:	0	[[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets:	0	[[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets:	0	[[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets:	0	[[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets:	4	[[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset):	0	[[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets:	8	[[TicketQuery(count)]]
Number of tickets reported or owned by current user:	0	[[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month:	0	[[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets:	0	[[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets:	0	[[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:	0	[[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera:	0	[[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:	#7, #5, #8	[[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 frankl Enrico Schwass Summary Rewrite README.md

Format: list

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

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

No results

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:

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

1 2 →

Ticket	Resolution	Summary	Owner	Reporter
#8	fixed	Replace .cvs by json configs	Enrico Schwass	Enrico Schwass
#6	fixed	unit tests needed for class Phase.py	frankl	Enrico Schwass
#5	fixed	Replace pandas by built in csv module	frankl	Enrico Schwass

1 2 →

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

1 2 →

Ticket	Resolution	Summary	Owner	Reporter
#8	fixed	Replace .cvs by json configs	Enrico Schwass	Enrico Schwass
Description	json is better suited for configurations that relate to embedded parts of the configuration class RecurringPhaseSequence: def init(self, repetitions, list_of_phases): A schedule would be sequence of RecurringPhaseSequences. This can be easily serialized as json
#6	fixed	unit tests needed for class Phase.py	frankl	Enrico Schwass
Description	Below are possiblepytest tests for the Phase class: Autogenerated by ChatGPT `python import pytest from phase import Phase def test_phase_initialization(): phase = Phase("Warm-up", 300) assert phase.title == "Warm-up" assert phase.duration == 300 assert phase.state == "initial" assert phase.time_left == 300 def test_phase_str_representation(): phase = Phase("Warm-up", 300) expected_str = "-->Warm-up\nDuration=300\n" assert str(phase) == expected_str def test_phase_start(): phase = Phase("Warm-up", 300) phase.start() assert phase.state == "running" assert phase.running() is True def test_phase_pause(): phase = Phase("Warm-up", 300) phase.start() phase.pause() assert phase.state == "paused" assert phase.paused() is True def test_phase_abort(): phase = Phase("Warm-up", 300) phase.abort() assert phase.state == "finished" assert phase.finished() is True def test_phase_tick(): phase = Phase("Warm-up", 300) phase.start() phase.tick(60) assert phase.time_left == 240 assert phase.state == "running" def test_phase_tick_to_completion(): phase = Phase("Warm-up", 300) phase.start() phase.tick(300) assert phase.time_left == 0 assert phase.finished() is True def test_phase_tick_beyond_completion(): phase = Phase("Warm-up", 300) phase.start() phase.tick(350) assert phase.time_left == 0 assert phase.finished() is True ` ### Explanation: Initialization Test (test_phase_initialization): This checks that when a Phase object is created, all the attributes are correctly initialized. String Representation Test (test_phase_str_representation): Verifies that the __str__ method returns the expected string format. State Transition Tests (test_phase_start, test_phase_pause, test_phase_abort): These tests check that the start, pause, and abort methods correctly change the state of the phase. Running and Finished State Tests (test_phase_running, test_phase_finished): Ensure the boolean methods for checking state work correctly. Tick Tests (test_phase_tick, test_phase_tick_to_completion, test_phase_tick_beyond_completion): These tests validate that the tick method correctly decrements the time_left and appropriately changes the state when the timer reaches zero. You can run these tests using pytest to ensure the correctness of the Phase class.
#5	fixed	Replace pandas by built in csv module	frankl	Enrico Schwass
Description	To keep dependencies small, do not use external libraries for simple tasks pandas can be easily replaced by the built-in csv module or even hand-written code ​https://docs.python.org/3/library/csv.html source:flowtimer/scripts/timer.py@99dee0f​

1 2 →

---

See also: TracQuery, TracTickets, TracReports