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: 691 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 691 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 271 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 5031 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1058 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4261 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4015 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 18269 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 962 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 34546 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1489 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 54 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 8 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 24 [[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: 32 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 32 [[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: #34853, #24076, #34479 [[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

1937 / 1937

Bug

9813 / 10136

New feature

3567 / 3945

Cleanup/optimization

5046 / 5306

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#35316 wontfix Support scalars as query parameters in admin changelist filters (for backward compatibility). nobody Manolis Stamatogiannakis
Description

Ticket #1873 added support for multi-valued query parameters in admin changelist filters. Because only list types are supported, older code that e.g. extends SimpleListFilter or BooleanFieldListFilter will break.

The latter (extending BooleanFieldListFilter) may even be completely unsupported. See notes in PR for #1873.

Overall, user code needs to introduce version conditionals if it is required to support both Django 4.x and Django 5. The reason is that Django 4.x only supports scalar types as query parameter values, while Django 5 only supports lists.

Since supporting both scalars and lists should be possible without adding complexity to the Django codebase, it would be good to continue supporting scalars, perhaps with a deprecation warning, if necessary.

#35315 invalid 5.0.3: pytest fails with tons of ImportErrors nobody Tomasz Kłoczko
Description

On testing I'm using python 3.9.18 and pytest 8.1.1. Looks like on scanning units pytest fails +500 errors like below

==================================== ERRORS ====================================
________ ERROR collecting tests/admin_changelist/test_date_hierarchy.py ________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/django-5.0.3/tests/admin_changelist/test_date_hierarchy.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.9/importlib/__init__.py:127: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests/admin_changelist/test_date_hierarchy.py:3: in <module>
    from django.contrib.admin.options import IncorrectLookupParameters
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/contrib/admin/__init__.py:2: in <module>
    from django.contrib.admin.filters import (
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/contrib/admin/filters.py:12: in <module>
    from django.contrib.admin.options import IncorrectLookupParameters
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/contrib/admin/options.py:10: in <module>
    from django import forms
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/forms/__init__.py:6: in <module>
    from django.forms.boundfield import *  # NOQA
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/forms/boundfield.py:4: in <module>
    from django.forms.utils import RenderableFieldMixin, pretty_name
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/forms/utils.py:6: in <module>
    from django.forms.renderers import get_default_renderer
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/forms/renderers.py:6: in <module>
    from django.template.backends.django import DjangoTemplates
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/template/__init__.py:44: in <module>
    from .engine import Engine
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/template/engine.py:7: in <module>
    from .base import Template
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/template/base.py:60: in <module>
    from django.utils.html import conditional_escape, escape
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/utils/html.py:11: in <module>
    from django.utils.encoding import punycode
../../BUILDROOT/python-django-5.0.3-4.fc36.x86_64/usr/lib/python3.9/site-packages/django/utils/encoding.py:5: in <module>
    from types import NoneType
E   ImportError: cannot import name 'NoneType' from 'types' (/usr/lib64/python3.9/types.py)
#35314 duplicate Django 5 breaks value of Date field rendering correctly in template nobody Michael
Description

This used to work correctly in Django 4. Django 5 removed USE_L10N setting from settings.py

When rendering an input field that is of type date:

  /home/michael/.venv/project/lib/python3.11/site-packages/django/forms/boundfield.py(108)as_widget()
-> return widget.render(
  /home/michael/.venv/project/lib/python3.11/site-packages/django/forms/widgets.py(279)render()
-> context = self.get_context(name, value, attrs)
  /home/michael/.venv/project/lib/python3.11/site-packages/django/forms/widgets.py(332)get_context()
-> context = super().get_context(name, value, attrs)
  /home/michael/.venv/project/lib/python3.11/site-packages/django/forms/widgets.py(271)get_context()
-> "value": self.format_value(value),
  /home/michael/.venv/project/lib/python3.11/site-packages/django/forms/widgets.py(555)format_value()
-> value, self.format or formats.get_format(self.format_key)[0]

We see that formats.get_format(self.format_key) only passes in 1 argument to:

# django/utils/formats.py(109)get_format()

def get_format(format_type, lang=None, use_l10n=None):
    """
    For a specific format type, return the format for the current
    language (locale). Default to the format in the settings.
    format_type is the name of the format, e.g. 'DATE_FORMAT'.

    If use_l10n is provided and is not None, it forces the value to
    be localized (or not), otherwise it's always localized.
    """
    if use_l10n is None:
        use_l10n = True
    if use_l10n and lang is None:
        lang = get_language()
    format_type = str(format_type)  # format_type may be lazy.
    cache_key = (format_type, lang)
    try:
        return _format_cache[cache_key]
    except KeyError:
        pass

this means use_l10n initial value is None, which means it will be set to True via the logic:

    if use_l10n is None:
        use_l10n = True

So then it sets a language, in my case en-gb, which makes results in a cache_key of ('DATE_INPUT_FORMATS', 'en-gb')

Which means the get_format method returns ['%d/%m/%Y', '%d/%m/%y', '%Y-%m-%d'] Which is really bad when format_type = 'DATE_INPUT_FORMATS', because HTML inputs must always be in the format YYYY/MM/DD, and hence selecting the first format of %d/%m/%Y results in an error in your HTML template when your input is rendered like <input type="date" value="31/12/2024"> instead of <input type="date" value="2024/12/31">

Not that it changes anything, but here is my DATE_INPUT_FORMATS from settings.py (it has no USE_L10N setting as unfortunately that has been removed):

DATE_INPUT_FORMATS = [
    '%Y-%m-%d',
]
1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

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