TeamCity Messages

1.33 · active · verified Mon Apr 13

This package integrates Python with the TeamCity Continuous Integration (CI) server, enabling the reporting of test results and other build information via TeamCity service messages. It provides integrations for popular testing frameworks like `unittest`, `pytest`, `nose`, `behave`, `twisted trial`, and code quality tools such as `flake8` and `pylint`. The current version is 1.33, with a release cadence that supports new Python versions and tool compatibility.

Warnings

breaking Older Python versions are no longer supported. Version 1.28 dropped support for Python 2.6 and 3.5. Version 1.26 dropped support for Python 3.4.
Fix: Upgrade to Python 3.6+ to use current versions of `teamcity-messages`.
gotcha Compatibility issues can arise with newer versions of integrated testing and analysis tools (e.g., `coverage`, `flake8`, `pylint`, `pytest`) if `teamcity-messages` is not updated. Ensure your `teamcity-messages` version is compatible with your test ecosystem.
Fix: Refer to the `teamcity-messages` changelog before upgrading related tools. For example, v1.33 fixed `coverage` 7.5+, v1.32 fixed `flake8` >= 5, and v1.30 fixed `pylint` >= 2.12.
gotcha For automatic test reporting with `nose`, `pytest`, and `flake8`, ensure the `TEAMCITY_VERSION` environment variable is set in your TeamCity build configuration. Without it, `teamcity-messages` might not auto-detect the TeamCity environment and report results.
Fix: Ensure `TEAMCITY_VERSION` (any non-empty value) is present in the build environment where tests are run. TeamCity agents usually set this automatically.
gotcha For `unittest` integration, direct modification of the test runner in your test script (as shown in the quickstart) is generally required. Unlike some other frameworks, `unittest` doesn't automatically hook into `teamcity-messages` without explicit code.
Fix: Implement the conditional `TeamcityTestRunner` usage in your `unittest.main()` block.
gotcha TeamCity service messages are processed only when written to standard output (stdout). If your Python code or test runner redirects stdout or writes service messages to a file, TeamCity will not be able to parse them.
Fix: Ensure service messages are printed directly to stdout. Avoid redirecting stdout when `teamcity-messages` is active in a TeamCity build step.

Install

pip install teamcity-messages Install stable version

Imports

TeamcityTestRunner
```
from teamcity.unittestpy import TeamcityTestRunner
```
Required to integrate with Python's standard unittest framework.
is_running_under_teamcity
```
from teamcity import is_running_under_teamcity
```
Useful for conditionally enabling TeamCity reporting logic.
TeamcityServiceMessages
```
from teamcity.messages import TeamcityServiceMessages
```
For sending custom service messages directly to TeamCity.

Quickstart

This example demonstrates how to integrate `teamcity-messages` with the standard `unittest` framework. It uses `is_running_under_teamcity()` to conditionally apply the `TeamcityTestRunner`, which sends test results to the TeamCity server via service messages when detected.

import unittest
from teamcity import is_running_under_teamcity
from teamcity.unittestpy import TeamcityTestRunner
import os

class MyTests(unittest.TestCase):
    def test_success(self):
        self.assertTrue(True, "This test should pass")

    def test_failure(self):
        self.assertEqual(1, 2, "This test should fail")

    def test_skipped(self):
        if os.environ.get('SKIP_TESTS') == '1':
            self.skipTest("Skipping this test due to environment variable")
        self.assertTrue(True)

if __name__ == '__main__':
    print('Running tests...')
    if is_running_under_teamcity():
        print('Running under TeamCity, using TeamcityTestRunner')
        runner = TeamcityTestRunner()
    else:
        print('Not running under TeamCity, using default TextTestRunner')
        runner = unittest.TextTestRunner()
    unittest.main(testRunner=runner, exit=False)

view raw JSON →