bitten/bitten-test: bitten/api.py annotate

annotate bitten/api.py @ 895:7d93d6358fe0

Use our own HTTPBasicAuthHandler under Python 2.6 to avoid issue http://bugs.python.org/issue8797. Fixes #658.

author	hodgestar
date	Wed, 09 Mar 2011 14:48:35 +0000
parents	7c80375d4817
children

rev	line source
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	1 # -- coding: utf-8 --
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	2 #
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	3 # Copyright (C) 2005-2007 Christopher Lenz <cmlenz@gmx.de>
832 7c80375d4817 Updated copyright to 2010. osimons parents: 677 diff changeset	4 # Copyright (C) 2007-2010 Edgewall Software
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	5 # All rights reserved.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	6 #
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	7 # This software is licensed as described in the file COPYING, which
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	8 # you should have received as part of this distribution. The terms
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	9 # are also available at http://bitten.edgewall.org/wiki/License.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	10
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	11 """Interfaces of extension points provided by the Bitten Trac plugin."""
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	12
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	13 from trac.core import *
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	14
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	15 __all__ = ['IBuildListener', 'ILogFormatter', 'IReportChartGenerator',
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	16 'IReportSummarizer']
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	17 __docformat__ = 'restructuredtext en'
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	18
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	19
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	20 class IBuildListener(Interface):
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	21 """Extension point interface for components that need to be notified of
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	22 build events.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	23
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	24 Note that these will be notified in the process running the build master,
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	25 not the web interface.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	26 """
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	27
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	28 def build_started(build):
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	29 """Called when a build slave has accepted a build initiation.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	30
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	31 :param build: the build that was started
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	32 :type build: `Build`
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	33 """
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	34
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	35 def build_aborted(build):
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	36 """Called when a build slave cancels a build or disconnects.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	37
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	38 :param build: the build that was aborted
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	39 :type build: `Build`
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	40 """
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	41
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	42 def build_completed(build):
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	43 """Called when a build slave has completed a build, regardless of the
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	44 outcome.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	45
623 31954f250366 Fix typo in `build_completed` docstring mgood parents: 503 diff changeset	46 :param build: the build that was completed
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	47 :type build: `Build`
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	48 """
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	49
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	50
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	51 class ILogFormatter(Interface):
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	52 """Extension point interface for components that format build log
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	53 messages."""
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	54
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	55 def get_formatter(req, build):
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	56 """Return a function that gets called for every log message.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	57
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	58 The function must take four positional arguments, ``step``,
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	59 ``generator``, ``level`` and ``message``, and return the formatted
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	60 message as a string.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	61
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	62 :param req: the request object
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	63 :param build: the build to which the logs belong that should be
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	64 formatted
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	65 :type build: `Build`
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	66 :return: the formatted log message
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	67 :rtype: `basestring`
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	68 """
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	69
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	70
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	71 class IReportSummarizer(Interface):
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	72 """Extension point interface for components that render a summary of reports
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	73 of some kind."""
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	74
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	75 def get_supported_categories():
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	76 """Return a list of strings identifying the types of reports this
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	77 component supports.
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	78 """
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	79
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	80 def render_summary(req, config, build, step, category):
503 a7c795920c4a Merging trac-0.11 branch to trunk. This revision is equivalent to [571]. wbell parents: 411 diff changeset	81 """Render a summary for the given report.
a7c795920c4a Merging trac-0.11 branch to trunk. This revision is equivalent to [571]. wbell parents: 411 diff changeset	82
677 639e5c466c96 0.6dev: Documentation fixes for all `build_doc` errors and warnings. osimons parents: 623 diff changeset	83 This function should return a tuple of the form ``(template, data)``,
639e5c466c96 0.6dev: Documentation fixes for all `build_doc` errors and warnings. osimons parents: 623 diff changeset	84 where ``template` is the name of the template to use and ``data`` is
639e5c466c96 0.6dev: Documentation fixes for all `build_doc` errors and warnings. osimons parents: 623 diff changeset	85 the data to be passed to the template.
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	86
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	87 :param req: the request object
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	88 :param config: the build configuration
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	89 :type config: `BuildConfig`
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	90 :param build: the build
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	91 :type build: `Build`
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	92 :param step: the build step
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	93 :type step: `BuildStep`
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	94 :param category: the category of the report that should be summarized
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	95 :type category: `basestring`
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	96 """
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	97
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	98
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	99 class IReportChartGenerator(Interface):
503 a7c795920c4a Merging trac-0.11 branch to trunk. This revision is equivalent to [571]. wbell parents: 411 diff changeset	100 """Extension point interface for components that generate a chart for a
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	101 set of reports."""
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	102
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	103 def get_supported_categories():
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	104 """Return a list of strings identifying the types of reports this
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	105 component supports.
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	106 """
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	107
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	108 def generate_chart_data(req, config, category):
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	109 """Generate the data for a report chart.
7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	110
677 639e5c466c96 0.6dev: Documentation fixes for all `build_doc` errors and warnings. osimons parents: 623 diff changeset	111 This function should return a tuple of the form ``(template, data)``,
639e5c466c96 0.6dev: Documentation fixes for all `build_doc` errors and warnings. osimons parents: 623 diff changeset	112 where ``template`` is the name of the template to use and ``data`` is
639e5c466c96 0.6dev: Documentation fixes for all `build_doc` errors and warnings. osimons parents: 623 diff changeset	113 the data to be passed to the template.
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	114
411 a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	115 :param req: the request object
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	116 :param config: the build configuration
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	117 :type config: `BuildConfig`
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	118 :param category: the category of reports to include in the chart
a169d2e96463 Use reStructuredText as the API documentation syntax. cmlenz parents: 410 diff changeset	119 :type category: `basestring`
410 7930cdd83d13 More restructuring: got rid of the `trac_ext` subpackage, which makes no sense now that the master is also coupled to Trac. cmlenz parents: diff changeset	120 """

Mercurial > bitten > bitten-test

annotate bitten/api.py @ 895:7d93d6358fe0