teamcity-messages-extra

teamcity-messages (JetBrains official package) is missing the convenience methods and optional output suppression provided by this package.

This package will try to address some of the missing features by extending official one. It's not a fork, teamcity-messages is an actual dependency so that any dependency analysis tools (eg, dependency-check) properly identify it.

Requires teamcity-messages>=1.33, with compatibility tested through 1.33. Newer versions are allowed, but importing teamcity_extra emits a RuntimeWarning requesting a compatibility review and a GitHub issue.

Usage

Just import teamcity_extra instead of teamcity. Everything from the official package will be available, plus the extra.

Instead of:

from teamcity.messages import TeamcityServiceMessages

Use:

from teamcity_extra.messages import TeamcityServiceMessages

Extra

TeamcityServiceMessages.testMetadata

testMetadata service message

TeamcityServiceMessages.buildStatisticValue

buildStatisticValue service message

TeamcityServiceMessages.addBuildTag

addBuildTag service message

TeamcityServiceMessages.addBuildTag

removeBuildTag service message

TeamcityServiceMessages.NO_OUTPUT

NO_OUTPUT output will make all service message calls / methods in TeamcityServiceMessages to not print anything.

This allows for simpler code when teamcity output is optional

from teamcity_extra.messages import TeamcityServiceMessages, NO_OUTPUT

# None is the default value (stdout)
tsm = TeamcityServiceMessages(output=None if should_report_to_teamcity() else NO_OUTPUT)

with tsm.test('thisTest'):
    doWhatever()