Edgewall Software

This page documents the 1.2 release. Documentation for other releases can be found here.

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: 23 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 1047 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 14 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 21 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 1507 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1404 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 2174 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 965 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 4416 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 26 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 12120 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1820 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 4 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 13 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 12 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 1 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 24 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 25 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 1 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #12130, #13242, #13243 [[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 anonymous
Summary Add a new project summary module.

Format: list

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

This is displayed as:

#181
Wiki preview injects new lines
#204
request for colour legend (or something similar) for ticket groups in reports
#226
Ticket Dependencies
#239
Link to diff of specifik wiki change instead of the page itself
#351
All ticket modifications should be tracked in timeline
#413
Installing on Windows, drive other than C:
#450
Diffviewer should try to convert the text into utf-8.
#475
merging of similar tickets
#519
Python process sometimes hangs on Windows Server 2003
#529
IE 5-6 over HTTPS broken downloads

[[TicketQuery(id=123)]]

This is displayed as:

#123
No SQL error display

Format: compact

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

This is displayed as:

#181, #204, #226, #239, #351, #413, #450, #475, #519, #529

Format: count

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

This is displayed as:

10

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

defect

5 / 5

enhancement

2 / 2

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13242 fixed UndefinedError: the inline if-expression on line 109 in 'theme.html' evaluated to false and no else section was defined. Ryan J Ollos Ryan J Ollos
Description

Tests pass with Jinja2 2.10.3, but 2.11 released on 27 Jan 2020 has the following failure:

SKIP_FUNCTIONAL_TESTS=1 python  -m unittest -f -c trac.test.test_suite
..............................E
======================================================================
ERROR: test_preview_valid_xhtml (trac.tests.attachment.AttachmentModuleTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "trac/tests/attachment.py", line 610, in test_preview_valid_xhtml
    result = render(attachment)
  File "trac/tests/attachment.py", line 605, in render
    {'fragment': True})
  File "trac/web/chrome.py", line 1441, in render_template
    fragment, iterable, method)
  File "trac/web/chrome.py", line 1526, in _render_jinja_template
    s = self.render_template_string(template, data, text)
  File "trac/web/chrome.py", line 1675, in render_template_string
    string = template.render(data)
  File "/Users/rjollos/.pyenv/versions/trac-2.7.15/lib/python2.7/site-packages/jinja2/environment.py", line 1090, in render
    self.environment.handle_exception()
  File "/Users/rjollos/.pyenv/versions/trac-2.7.15/lib/python2.7/site-packages/jinja2/environment.py", line 832, in handle_exception
    reraise(*rewrite_traceback_stack(source=source))
  File "trac/templates/attachment.html", line 14, in top-level template code
    # set parent = attachments.parent if attachments else attachment.resource.parent
  File "trac/templates/layout.html", line 12, in top-level template code
    # import "macros.html" as jmacros with context
  File "trac/templates/theme.html", line 22, in top-level template code
    # block body
  File "trac/templates/theme.html", line 109, in block "body"
    # include resourcepath_template if resourcepath_template ignore missing
  File "/Users/rjollos/.pyenv/versions/trac-2.7.15/lib/python2.7/site-packages/jinja2/loaders.py", line 179, in get_source
    pieces = split_template_path(template)
  File "/Users/rjollos/.pyenv/versions/trac-2.7.15/lib/python2.7/site-packages/jinja2/loaders.py", line 28, in split_template_path
    for piece in template.split("/"):
UndefinedError: the inline if-expression on line 109 in 'theme.html' evaluated to false and no else section was defined.

----------------------------------------------------------------------
Ran 31 tests in 0.466s

FAILED (errors=1)
make: *** [unit-test] Error 1
#13240 fixed AppVeyor: 13 errors due to TracError: Cannot load Python bindings for SQLite Jun Omae Jun Omae
Description

https://ci.appveyor.com/project/edgewall-org/trac/builds/29943185

======================================================================
ERROR: test_abs_href (trac.tests.env.EnvironmentTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "C:\projects\trac\trac\tests\env.py", line 61, in setUp
    self.env = Environment(env_path, create=True)
  File "C:\projects\trac\trac\core.py", line 124, in __call__
    self.__init__(*args, **kwargs)
  File "C:\projects\trac\trac\env.py", line 289, in __init__
    self.create(options)
  File "C:\projects\trac\trac\env.py", line 612, in create
    DatabaseManager(self).init_db()
  File "C:\projects\trac\trac\db\api.py", line 250, in init_db
    connector, args = self.get_connector()
  File "C:\projects\trac\trac\db\api.py", line 339, in get_connector
    raise TracError(connector.error)
TracError: Cannot load Python bindings for SQLite
...
Ran 1915 tests in 559.667s
FAILED (errors=13)
make: *** [Makefile:445: unit-test] Error 1
#13238 fixed Travis CI: ImportError: No module named _md5 Jun Omae Ryan J Ollos
Description

https://travis-ci.org/edgewall/trac/jobs/628381820

$ if [ "$TRAVIS_OS_NAME" = osx ]; then
    test -d $HOME/venv-lib || mkdir $HOME/venv-lib
    eval "$(pyenv init -)"
    pyver_latest="$(pyenv install -l | grep -E "^[ ]*${pyver/./\\.}\.[0-9]+$" | tail -1 | tr -d '[:blank:]')"
    venv="$HOME/venv-$pyver_latest"
    pyenv install --skip-existing $pyver_latest
    pyenv shell $pyver_latest
    pip install --upgrade virtualenv
    python -m virtualenv $venv
    source $venv/bin/activate
  fi
  
Traceback (most recent call last):
  File "/Users/travis/.pyenv/versions/2.6.9/bin/pip", line 7, in <module>
    from pip import main
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/pip/__init__.py", line 21, in <module>
    from pip._vendor.urllib3.exceptions import DependencyWarning
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/pip/_vendor/urllib3/__init__.py", line 8, in <module>
    from .connectionpool import (
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/pip/_vendor/urllib3/connectionpool.py", line 29, in <module>
    from .connection import (
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/pip/_vendor/urllib3/connection.py", line 39, in <module>
    from .util.ssl_ import (
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/pip/_vendor/urllib3/util/__init__.py", line 6, in <module>
    from .ssl_ import (
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/pip/_vendor/urllib3/util/ssl_.py", line 7, in <module>
    from hashlib import md5, sha1, sha256
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/hashlib.py", line 136, in <module>
    md5 = __get_builtin_constructor('md5')
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/hashlib.py", line 63, in __get_builtin_constructor
    import _md5
ImportError: No module named _md5
New python executable in /Users/travis/venv-2.6.9/bin/python
Installing setuptools<37, pip, wheel<0.30...
  Complete output from command /Users/travis/venv-2.6.9/bin/python - setuptools<37 pip wheel<0.30:
  Traceback (most recent call last):
  File "<stdin>", line 11, in <module>
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv_support/pip-9.0.3-py2.py3-none-any.whl/pip/__init__.py", line 21, in <module>
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv_support/pip-9.0.3-py2.py3-none-any.whl/pip/_vendor/urllib3/__init__.py", line 8, in <module>
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv_support/pip-9.0.3-py2.py3-none-any.whl/pip/_vendor/urllib3/connectionpool.py", line 29, in <module>
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv_support/pip-9.0.3-py2.py3-none-any.whl/pip/_vendor/urllib3/connection.py", line 39, in <module>
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv_support/pip-9.0.3-py2.py3-none-any.whl/pip/_vendor/urllib3/util/__init__.py", line 6, in <module>
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv_support/pip-9.0.3-py2.py3-none-any.whl/pip/_vendor/urllib3/util/ssl_.py", line 7, in <module>
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/hashlib.py", line 136, in <module>
    md5 = __get_builtin_constructor('md5')
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/hashlib.py", line 63, in __get_builtin_constructor
    import _md5
ImportError: No module named _md5
----------------------------------------
...Installing setuptools<37, pip, wheel<0.30...done.
Traceback (most recent call last):
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/runpy.py", line 122, in _run_module_as_main
    "__main__", fname, loader, pkg_name)
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/runpy.py", line 34, in _run_code
    exec code in run_globals
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv.py", line 2349, in <module>
    main()
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv.py", line 712, in main
    symlink=options.symlink)
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv.py", line 953, in create_environment
    download=download,
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv.py", line 904, in install_wheel
    call_subprocess(cmd, show_stdout=False, extra_env=env, stdin=SCRIPT)
  File "/Users/travis/.pyenv/versions/2.6.9/lib/python2.6/site-packages/virtualenv.py", line 796, in call_subprocess
    % (cmd_desc, proc.returncode))
OSError: Command /Users/travis/venv-2.6.9/bin/python - setuptools<37 pip wheel<0.30 failed with error code 1
/Users/travis/.travis/functions: line 118: /Users/travis/venv-2.6.9/bin/activate: No such file or directory
The command "if [ "$TRAVIS_OS_NAME" = osx ]; then
    test -d $HOME/venv-lib || mkdir $HOME/venv-lib
    eval "$(pyenv init -)"
    pyver_latest="$(pyenv install -l | grep -E "^[ ]*${pyver/./\\.}\.[0-9]+$" | tail -1 | tr -d '[:blank:]')"
    venv="$HOME/venv-$pyver_latest"
    pyenv install --skip-existing $pyver_latest
    pyenv shell $pyver_latest
    pip install --upgrade virtualenv
    python -m virtualenv $venv
    source $venv/bin/activate
  fi
  " failed and exited with 1 during .
Your build has been stopped.
1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Last modified 4 months ago Last modified on Oct 15, 2019, 6:32:29 AM
Note: See TracWiki for help on using the wiki.