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: 622 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 622 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 447 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5252 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1080 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4372 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4205 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18838 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1069 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 35803 [[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: 0 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 8 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 25 [[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: 33 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 33 [[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: #36426, #33180, #28646 [[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

2021 / 2022
Bug

10352 / 10723
New feature

3788 / 4176
Cleanup/optimization

5358 / 5666

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

1 2 3 4 5 6 7 8 9 10 11 →
Ticket Resolution Summary Owner Reporter
#36585 wontfix Add `DateConverter` for path resolving Y3K Y3K
Description

(I searched for Converter on both tickets and feature submissions, didn't get any meaninful results.)

I believe there is value on having a built in DateConverter that follows ISO8601 format for path.

The ​code example that Django currently has in the docs does not produce ISO compatible date paths (i.e. month and day are not zero-padded).

#36577 fixed Remove try/except around GIS layermapping imports Adam Johnson Adam Johnson
Description

I tried ​ty on a client project and it reported this error: 

warning[possibly-unbound-import]: Member `LayerMapError` of module `django.contrib.gis.utils` is possibly unbound
  --> ...
   |
36 | from django.contrib.contenttypes.models import ContentType
37 | from django.contrib.gis.geos import GEOSGeometry, MultiPolygon, Point, Polygon
38 | from django.contrib.gis.utils import LayerMapError
   |                                      ^^^^^^^^^^^^^
39 | from django.contrib.messages import get_messages
40 | from django.contrib.messages.middleware import MessageMiddleware
   |
info: rule `possibly-unbound-import` is enabled by default

Looking at the django.contrib.gis.utils source code, there’s a try/except ImproperlyConfigured around the import of LayerMapError and LayerMapping: 

try:
    # LayerMapping requires DJANGO_SETTINGS_MODULE to be set,
    # and ImproperlyConfigured is raised if that's not the case.
    from django.contrib.gis.utils.layermapping import LayerMapError, LayerMapping

    __all__ += ["LayerMapError", "LayerMapping"]

except ImproperlyConfigured:
    pass

This block blames back to 79e68c225b926302ebb29c808dda8afa49856f5c, the initial merge of django.contrib.gis into Django core.

I looked at the code and couldn’t see how ImproperlyConfigured could be raised at import time, and also tried it, with no error: 

$ python -c 'import django.contrib.gis.utils.layermapping'  # succeeds

I think the code path to ImproperlyConfigured has long been removed, potentially in one of the bigger changes to django.contrib.gis.utils.layermapping, such as ff60c5f9de3e8690d1e86f3e9e3f7248a15397c8 (multiple database support), but that’s hard to test since it requires running Python 2.7!

#36576 duplicate /admin/logout/ requires having admin access Alex Dehnert
Description

If I visit /admin/logout/ while logged in as a user that doesn't have admin/staff access, I'm redirected to /admin/ and then to /admin/login/, *without* being logged out of my existing user. This feels like a bug, for several reasons:

  • If I don't have permission to access /admin/logout/ for some reason, shouldn't I get told that, not just redirected to a login screen and left to guess?
  • The ​docstring for logout() says "This should *not* assume the user is already logged in.", which isn't quite the same as "should log you out regardless of what user you are" but sorta hints in that direction to me
  • The ​release notes for 4.1 suggest using admin:logout to log out, without any caveats about "all your users need to be staff" (my instinct is the recommendation should be logout not admin:logout regardless -- #36575 -- but it still suggests that this behavior is unexpected).

I looked briefly and didn't understand *how* /admin/logout/ requires admin access; I'm mildly suspicious of the ​@login_not_required decorator on `login` but I don't know if that's actually relevant.

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

See also: TracQuery, TracTickets, TracReports

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