Version 7 (modified by trac, 5 years ago) (diff)

--

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#28247 duplicate Don't require last_login property on custom user models nobody Linus Lewandowski
Description

Right now, custom user models are required to provide last_login property - because django.contrib.auth.models always sets up a user_logged_in handler that updates this field.

It's trivial to add a try/except that'll make it not required.

#28245 invalid timezone.UTC() is not exported, but is attempted to be accessed nobody Christopher Dieringer
Description

problem statement

timezone.UTC() is called, but no such function is exported.

solution

it seems that mapping timezone.UTC() ==> timezone.utc may be what is desired

how to reproduce

  • send an ISO compliant datetime w/ UTC offset to a DateTimeField(), e.g. 2017-05-30T17:17:21-07:00

stack

the pertinent part of the stack here reveals all:

File "/path/to/rest_framework/fields.py" in to_internal_value

  1.                         return self.enforce_timezone(parsed)

File "/path/to/rest_framework/fields.py" in enforce_timezone

  1.             return timezone.make_naive(value, timezone.UTC())

Exception Type: AttributeError at /rest/v1/api/schedules Exception Value: module 'django.utils.timezone' has no attribute 'UTC'

#28244 wontfix Exceptions derived from BaseException instead of Exception are not caught by convert_exception_to_response() nobody alexpirine
Description

Hello,

Python documentation states:

In Python, all exceptions must be instances of a class that derives from BaseException.

Deriving exceptions from Exception is a recommendation, but does not seem to be an absolute requirement:

programmers are encouraged to derive new exceptions from the Exception class or one of its subclasses, and not from BaseException.

So, if BaseException is used instead of Exception, Django's convert_exception_to_response doesn't catch it, and crashes instead:

def convert_exception_to_response(get_response):
    @wraps(get_response)
    def inner(request):
        try:
            response = get_response(request)
        except Exception as exc:
            response = response_for_exception(request, exc)
        return response
    return inner

If you run it on gunicorn with nginx, which is often the case, you will see upstream prematurely closed connection while reading response header from upstream errors, without any additional info, and without any logs whatsoever, even if you properly configured a logging system.

Only running manage.py runserver will display the full stack trace:

Traceback (most recent call last):
  File "…/python3.6/wsgiref/handlers.py", line 137, in run
    self.result = application(self.environ, self.start_response)
  File "…/django/contrib/staticfiles/handlers.py", line 63, in __call__
    return self.application(environ, start_response)
  File "…/django/core/handlers/wsgi.py", line 157, in __call__
    response = self.get_response(request)
  File "…/django/core/handlers/base.py", line 124, in get_response
    response = self._middleware_chain(request)
  File "…/django/core/handlers/exception.py", line 41, in inner
    response = get_response(request)
  File "…/django/utils/deprecation.py", line 140, in __call__
    response = self.get_response(request)
  File "…/django/core/handlers/exception.py", line 41, in inner
    response = get_response(request)
  [… and so on, depending on how much middleware you have …]
  File "…/django/utils/deprecation.py", line 140, in __call__
    response = self.get_response(request)
  File "…/django/core/handlers/exception.py", line 41, in inner
    response = get_response(request)
  File "…/django/core/handlers/base.py", line 185, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "…/django/views/decorators/http.py", line 40, in inner
    return func(request, *args, **kwargs)
  File "…/your_project/views.py", line 42, in your_func
    …
your_project.YourErrorInheritedFromBaseException: Your error message

Of course I fixed my code by inheriting from Exception.

But I wonder if catching BaseException instead of Exception would be a good change?

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

Back to Top