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: 480 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 480 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 580 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5313 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1090 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4431 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4257 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 19231 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1060 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 36403 [[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: 56 [[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: #37172, #37188, #37187 [[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

2045 / 2045
Bug

10617 / 10970
New feature

3889 / 4273
Cleanup/optimization

5578 / 5900

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

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#37189 invalid Dutch translation for MinimumLengthValidator error message is incorrect Bart Dikmans
Description

The MinimumLengthValidator for the dutch (nl) language is not correctly translating the message. This happens due to the contrib-> auth -> locale -> nl django.po file containing old values.

I compared the Dutch one to other versions the change seems simple:

Dutch version: msgid "" "This password is too short. It must contain at least %(min_length)d " "character." msgid_plural "" "This password is too short. It must contain at least %(min_length)d " "characters."

English/Spanish/German version: msgid "This password is too short. It must contain at least %d character." msgid_plural "" "This password is too short. It must contain at least %d characters."

Should be a quick fix for anyone with permission to the translation files

#37188 needsnewfeatureprocess compilemessages should ignore common environment and dependency directories by default Ayoub Bouaik Ayoub Bouaik
Description

The compilemessages management command recursively traverses the entire project tree looking for locale directories. However, it currently lacks default ignore patterns for common python virtual environments (venv, .venv, env, .env) and modern frontend package management directories (node_modules).

Because of this, if a project contains a third-party package inside node_modules or a local virtual environment that includes localized files with formatting quirks (such as a Byte Order Mark), compilemessages attempts to process them, resulting in unexpected execution overhead or critical crashes on files the developer did not write.

Steps to Reproduce Inside a clean project workspace, run the following commands to simulate a third-party dependency with a BOM-encoded translation file:

  1. Create a dummy package locale path: mkdir -p node_modules/mock-package/locale/en/LC_MESSAGES/
  1. Add a dummy translation file containing a UTF-8 BOM flag: printf '\xEF\xBB\xBF# Dummy translation file\nmsgid ""\nmsgstr ""\n' > node_modules/mock-package/locale/en/LC_MESSAGES/django.po
  1. Attempt to compile messages: python manage.py compilemessages

Expected Behavior Django should automatically skip top-level dependency and virtual environment folders like node_modules, venv, and .venv unless explicitly instructed otherwise via the -i / --ignore CLI flags.

Actual Output / Traceback The /home/ayoub/django_test/node_modules/mock-package/locale/en/LC_MESSAGES/django.po file has a BOM (Byte Order Mark). Django only supports .po files encoded in UTF-8 and without any BOM. CommandError: compilemessages generated one or more errors.

#37186 invalid Document form Field's template_name argument Tim Schilling
Description

The change to support form field rendering in Ticket #34077 stopped short of documenting that a field can have a customized template specified on the field itself. This template would be passed to the ​BoundField which we have public documentation for.

This change would mean documenting template_name in the ​Field.__init__ method here.

I suppose one reason to not do this is if this particular API isn't something we want to commit to. I think since it hasn't changed in a few years, it appears stable.

The usage we'd want to make developers aware of is that they can do today: 

class ProfileForm(forms.Form):
    image = forms.ImageField(
        template_name="my_forms/fields/image_with_preview.html"
    )
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