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: 672 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5320 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1093 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4446 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4279 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 19396 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1098 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 36666 [[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: 65 [[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: #37451, #37454, #37453 [[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

2049 / 2051

Bug

10736 / 11114

New feature

3910 / 4304

Cleanup/optimization

5659 / 5982

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

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#37451 wontfix `QuerySet.get()` must not pull more than 2 rows with `DEBUG=False` mudassar Sobolev Nikita
Description

Refs https://code.djangoproject.com/ticket/6785

Source:

While this is helpful for debug inforation, it can potentially slow down production requests. With fetching 19 more entries. This can be especially slow in cases when full-scan is used.

I propose limitting this value to 2 with DEBUG=False. This keeps the best of two worlds:

  • Better debug inforation in DEBUG mode
  • Faster code in production
#37449 fixed Update Punjabi (pa) name_local to use its native script gerry132 gerry132
Description

Punjabi is currently set to "Punjabi" in LANG_INFO instead of the native "ਪੰਜਾਬੀ"

#37447 fixed makemessages fails in UTF-8 mode when processing non-UTF-8 filenames Natalia Bidart Jacob Walls
Description

Surfaced on CI just now after bumping Windows jobs to Python 3.15, now that UTF-8 mode is the ​default.

ERROR: test_unicode_file_name (i18n.test_extraction.BasicExtractorTests.test_unicode_file_name)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "C:\hostedtoolcache\windows\Python\3.15.1\x64\Lib\unittest\case.py", line 58, in testPartExecutor
    yield
  File "C:\hostedtoolcache\windows\Python\3.15.1\x64\Lib\unittest\case.py", line 691, in run
    self._callTestMethod(testMethod)
    
  File "C:\hostedtoolcache\windows\Python\3.15.1\x64\Lib\unittest\case.py", line 637, in _callTestMethod
    result = method()
    ^^^^^^^^^^^^^^^
  File "D:\a\django\django\tests\i18n\test_extraction.py", line 372, in test_unicode_file_name
    management.call_command("makemessages", locale=[LOCALE], verbosity=0)
    ^^^^^^^^^^^^^^^
  File "D:\a\django\django\django\core\management\__init__.py", line 195, in call_command
    return command.execute(*args, **defaults)
      ^^^^^^^^^^^^^^^^^
  File "D:\a\django\django\django\core\management\base.py", line 471, in execute
    output = self.handle(*args, **options)
    ^^^^^^^^^^^^^^^
  File "D:\a\django\django\django\core\management\commands\makemessages.py", line 423, in handle
    potfiles = self.build_potfiles()
    ^^^^^^^^^^^
  File "D:\a\django\django\django\core\management\commands\makemessages.py", line 504, in build_potfiles
    self.process_files(file_list)
    ^^^^^^^^^^^^^^^
  File "D:\a\django\django\django\core\management\commands\makemessages.py", line 596, in process_files
    self.process_locale_dir(locale_dir, files)
    ^^^^^^^^^^^
  File "D:\a\django\django\django\core\management\commands\makemessages.py", line 677, in process_locale_dir
    raise CommandError(
    ^^^^^^^
django.core.management.base.CommandError: errors happened while running xgettext on .\__init__.py
.\ignore_dir\ignored.html.py
.\media_root\media_ignored.html.py
.\static\static_ignored.html.py
.\templates\empty.html.py
.\templates\subdir\ignored.html.py
.\templates\test.html.py
.\templates\xxx_ignored.html.py
.\vidéo.txt.py
xgettext: error while opening ".\vidéo.txt.py" for reading: No such file or directory

I believe the fix is to write using the system locale, which we should have been doing all along (​linter rule on this topic)

  • django/core/management/commands/makemessages.py

    diff --git a/django/core/management/commands/makemessages.py b/django/core/management/commands/makemessages.py
    index 5a4bd55bb8..9db5a6ef2a 100644
    a b class Command(BaseCommand):  
    663663            return
    664664
    665665        input_files = [bf.work_path for bf in build_files]
    666         with NamedTemporaryFile(mode="w+") as input_files_list:
    667             input_files_list.write("\n".join(input_files))
     666        with NamedTemporaryFile(mode="w+b") as input_files_list:
     667            input_files_list.write(
     668                "\n".join(input_files).encode(DEFAULT_LOCALE_ENCODING)
     669            )
    668670            input_files_list.flush()
    669671            args.extend(["--files-from", input_files_list.name])
    670672            args.extend(self.xgettext_options)

If a triager confirms the approach, I can open the PR. I propose backporting to 6.1 as part of 3.15 support, but with a release note, since it affects released behavior and would have been visible on prior Python versions when running in UTF-8 mode.

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


See also: TracQuery, TracTickets, TracReports

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