Trac Ticket Queries

In addition to reports, Trac provides support for custom ticket queries, used to display lists of tickets meeting a specified set of criteria.

To configure and execute a custom query, switch to the View Tickets module from the navigation bar, and select the Custom Query link.

Filters

When you first go to the query page the default filter will display tickets relevant to you:

  • If logged in then all open tickets it will display open tickets assigned to you.
  • If not logged in but you have specified a name or email address in the preferences then it will display all open tickets where your email (or name if email not defined) is in the CC list.
  • If not logged and no name/email defined in the preferences then all open issues are displayed.

Current filters can be removed by clicking the button to the left with the minus sign on the label. New filters are added from the pulldown lists at the bottom corners of the filters box ('And' conditions on the left, 'Or' conditions on the right). Filters with either a text box or a pulldown menu of options can be added multiple times to perform an or of the criteria.

You can use the fields just below the filters box to group the results based on a field, or display the full description for each ticket.

Once you've edited your filters click the Update button to refresh your results.

Clicking on one of the query results will take you to that ticket. You can navigate through the results by clicking the Next Ticket or Previous Ticket links just below the main menu bar, or click the Back to Query link to return to the query page.

You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Query links after saving your results. When you return to the query any tickets which were edited will be displayed with italicized text. If one of the tickets was edited such that it no longer matches the query criteria the text will also be greyed. Lastly, if a new ticket matching the query criteria has been created, it will be shown in bold.

The query results can be refreshed and cleared of these status indicators by clicking the Update button again.

Saving Queries

Trac allows you to save the query as a named query accessible from the reports module. To save a query ensure that you have Updated the view and then click the Save query button displayed beneath the results. You can also save references to queries in Wiki content, as described below.

Note: one way to easily build queries like the ones below, you can build and test the queries in the Custom report module and when ready - click Save query. This will build the query string for you. All you need to do is remove the extra line breaks.

Note: you must have the REPORT_CREATE permission in order to save queries to the list of default reports. The Save query button will only appear if you are logged in as a user that has been granted this permission. If your account does not have permission to create reports, you can still use the methods below to save a query.

You may want to save some queries so that you can come back to them later. You can do this by making a link to the query from any Wiki page.

[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]

Which is displayed as:

Active tickets against 1.0

This uses a very simple query language to specify the criteria (see Query Language).

Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading ? character:

[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]

Which is displayed as:

Assigned tickets by owner

Using the [[TicketQuery]] Macro

The TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

Example:

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

This is displayed as:

No results

Just like the query: wiki links, the parameter of this macro expects a query string formatted according to the rules of the simple ticket query language. This also allows displaying the link and description of a single ticket:

[[TicketQuery(id=123)]]

This is displayed as:

#123
Typo in the model_api/#field-types

A more compact representation without the ticket summaries is also available:

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

This is displayed as:

No results

Finally, if you wish to receive only the number of defects that match the query, use the count parameter.

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

This is displayed as:

0

Customizing the table format

You can also customize the columns displayed in the table format (format=table) by using col=<field> - you can specify multiple fields and what order they are displayed by placing pipes (|) between the columns like below:

[[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 also have full rows by using rows=<field> like below:

[[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 24974)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#26934 duplicate Admin inline save fails when inline contains readonly primary key nobody LeeKevin
Description

Example:

For an AbstractBaseCode model (password reset), the "code" field is as follows (note the primary_key argument):

	code = models.CharField(_('code'), max_length=40, primary_key=True)

And the inline admin class is:

class PasswordResetCodeInline(admin.TabularInline):
    model = PasswordResetCode
    fieldsets = (
        (None, {
            'fields': ('code', 'created_at')
        }),
    )
    readonly_fields = ('code', 'created_at')

    def has_add_permission(self, request):
        return False

When saving a user in Django admin, which contains the PasswordResetCodeInline, the following error is issued:

MultiValueDictKeyError at /admin/accounts/user/30/change/
"'passwordresetcode_set-0-code'"

Exception location: /.../python3.5/site-packages/django/utils/datastructures.py in __getitem__, line 85

This occurs because line 587 in ModelForm._construct_form in forms/models.py looks for the primary key "code" within the editable fields. Since it is readonly, there is no input or hidden field passed along that includes the primary key.

Here is a snippet where the error occurs (on the last line):

    def _construct_form(self, i, **kwargs):
        if self.is_bound and i < self.initial_form_count():
            pk_key = "%s-%s" % (self.add_prefix(i), self.model._meta.pk.name)
            pk = self.data[pk_key]

Traceback:

Traceback (most recent call last):
  File "/.../lib/python3.5/site-packages/django/core/handlers/base.py", line 149, in get_response
    response = self.process_exception_by_middleware(e, request)
  File "/.../lib/python3.5/site-packages/django/core/handlers/base.py", line 147, in get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/.../lib/python3.5/site-packages/django/contrib/admin/options.py", line 541, in wrapper
    return self.admin_site.admin_view(view)(*args, **kwargs)
  File "/.../lib/python3.5/site-packages/django/utils/decorators.py", line 149, in _wrapped_view
    response = view_func(request, *args, **kwargs)
  File "/.../lib/python3.5/site-packages/django/views/decorators/cache.py", line 57, in _wrapped_view_func
    response = view_func(request, *args, **kwargs)
  File "/.../lib/python3.5/site-packages/django/contrib/admin/sites.py", line 244, in inner
    return view(request, *args, **kwargs)
  File "/.../lib/python3.5/site-packages/django/contrib/admin/options.py", line 1440, in change_view
    return self.changeform_view(request, object_id, form_url, extra_context)
  File "/.../lib/python3.5/site-packages/django/utils/decorators.py", line 67, in _wrapper
    return bound_func(*args, **kwargs)
  File "/.../lib/python3.5/site-packages/django/utils/decorators.py", line 149, in _wrapped_view
    response = view_func(request, *args, **kwargs)
  File "/.../lib/python3.5/site-packages/django/utils/decorators.py", line 63, in bound_func
    return func.__get__(self, type(self))(*args2, **kwargs2)
  File "/usr/local/Cellar/python3/3.5.1/Frameworks/Python.framework/Versions/3.5/lib/python3.5/contextlib.py", line 30, in inner
    return func(*args, **kwds)
  File "/.../lib/python3.5/site-packages/django/contrib/admin/options.py", line 1377, in changeform_view
    if all_valid(formsets) and form_validated:
  File "/.../lib/python3.5/site-packages/django/forms/formsets.py", line 451, in all_valid
    if not formset.is_valid():
  File "/.../lib/python3.5/site-packages/django/forms/formsets.py", line 316, in is_valid
    self.errors
  File "/.../lib/python3.5/site-packages/django/forms/formsets.py", line 290, in errors
    self.full_clean()
  File "/.../lib/python3.5/site-packages/django/forms/formsets.py", line 338, in full_clean
    form = self.forms[i]
  File "/.../lib/python3.5/site-packages/django/utils/functional.py", line 33, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "/.../lib/python3.5/site-packages/django/forms/formsets.py", line 144, in forms
    for i in range(self.total_form_count())]
  File "/.../lib/python3.5/site-packages/django/forms/formsets.py", line 144, in <listcomp>
    for i in range(self.total_form_count())]
  File "/.../lib/python3.5/site-packages/django/forms/models.py", line 881, in _construct_form
    form = super(BaseInlineFormSet, self)._construct_form(i, **kwargs)
  File "/.../lib/python3.5/site-packages/django/forms/models.py", line 587, in _construct_form
    pk = self.data[pk_key]
  File "/.../lib/python3.5/site-packages/django/utils/datastructures.py", line 85, in __getitem__
    raise MultiValueDictKeyError(repr(key))
#26926 duplicate Dual index migration bug? nobody Vaal
Description

Example:

1) Added new field to model x_index = models.BooleanField(default=True, db_index=True, unique=True) There is an unnecessary index. But the conditions of the situation.

2) Create and run the migration. In the database this field will have only one index - unique.

3) Change the field. x_index = models.BooleanField(default=True, db_index=True) Remove the unique index.

4) Create and run the migration. Now, this field doesn't have of any indexes in database.

p.s. Mysql database

#26924 fixed i18n.test_extraction.IgnoredExtractorTests.test_media_static_dirs_ignored broken on OS X tobiasmcnulty tobiasmcnulty
Description

Confirmed by myself and lapilofu (Harris). Git bisect shows https://github.com/django/django/commit/faeeb84edfebecf5a5f40df9ef816e5f1cd457c6 (ticket #26677) as the commit that broke it.

$ PYTHONPATH=.. python runtests.py i18n.test_extraction.IgnoredExtractorTests.test_media_static_dirs_ignored
Testing against Django installed in '/Users/tobias/caktus/django/django' with up to 4 processes
Creating test database for alias 'default'...
Creating test database for alias 'other'...
F
======================================================================
FAIL: test_media_static_dirs_ignored (i18n.test_extraction.IgnoredExtractorTests)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/tobias/caktus/django/tests/i18n/test_extraction.py", line 516, in test_media_static_dirs_ignored
    self.assertIn("ignoring directory media_root", out)
AssertionError: 'ignoring directory media_root' not found in 'examining files with the extensions: .py, .html and .txt\nignoring file code.sample in .\nignoring file javascript.js in .\nignoring file not_utf8.sample in .\nignoring file __init__.cpython-35.pyc in ./__pycache__\nignoring file javascript.js in ./someapp/static\nignoring file javascript_ignored.js in ./static\nignoring file comments.thtml in ./templates\nignoring file plural.djtpl in ./templates\nignoring file template_with_error.tpl in ./templates\nprocessing file __init__.py in .\nprocessing file ignored.html in ./ignore_dir\nprocessing file media_ignored.html in ./media_root\nprocessing file static_ignored.html in ./static\nprocessing file empty.html in ./templates\nprocessing file ignored.html in ./templates/subdir\nprocessing file test.html in ./templates\nprocessing file xxx_ignored.html in ./templates\nprocessing locale de\ncopying plural forms: "Plural-Forms: nplurals=2; plural=(n != 1);\\n"\n'

----------------------------------------------------------------------
Ran 1 test in 0.084s

FAILED (failures=1)
Destroying test database for alias 'default'...
Destroying test database for alias 'other'...
1 2 3 4 5 6 7 8 9 10 11

Query Language

query: TracLinks and the [[TicketQuery]] macro both use a mini “query language” for specifying query filters. Basically, the filters are separated by ampersands (&). Each filter then consists of the ticket field name, an operator, and one or more values. More than one value are separated by a pipe (|), meaning that the filter matches any of the values. To include a literal & or | in a value, escape the character with a backslash (\).

The available operators are:

= the field content exactly matches one of the values
~= the field content contains one or more of the values
^= the field content starts with one of the values
$= the field content ends with one of the values

All of these operators can also be negated:

!= the field content matches none of the values
!~= the field content does not contain any of the values
!^= the field content does not start with any of the values
!$= the field content does not end with any of the values

The date fields created and modified can be constrained by using the = operator and specifying a value containing two dates separated by two dots (..). Either end of the date range can be left empty, meaning that the corresponding end of the range is open. The date parser understands a few natural date specifications like "3 weeks ago", "last month" and "now", as well as Bugzilla-style date specifications like "1d", "2w", "3m" or "4y" for 1 day, 2 weeks, 3 months and 4 years, respectively. Spaces in date specifications can be left out to avoid having to quote the query string.

created=2007-01-01..2008-01-01 query tickets created in 2007
created=lastmonth..thismonth query tickets created during the previous month
modified=1weekago.. query tickets that have been modified in the last week
modified=..30daysago query tickets that have been inactive for the last 30 days

See also: TracTickets, TracReports, TracGuide

Last modified 2 years ago Last modified on 02/24/14 07:33:46
Back to Top