Reference

BugzScout

class bugzscout.BugzScout(url, user, project, area)

Submit errors or issues to FogBugz via BugzScout.

__init__(url, user, project, area)

Initialize a new instance of bugzscout client.

Parameters:
  • url – string URL for bugzscout
  • user – string fogbugz user to designate when submitting via bugzscout
  • project – string fogbugz project to designate for cases
  • area – string fogbugz area to designate for cases
__repr__()

String representation of this instance.

__weakref__

list of weak references to the object (if defined)

submit_error(description, extra=None, default_message=None)

Send an error to bugzscout.

Sends a request to the fogbugz URL for this instance. If a case exists with the same description, a new occurrence will be added to that case. It is advisable to remove personal info from the description for that reason. Account ids, emails, request ids, etc, will make the occurrence counting builtin to bugzscout less useful. Those values should go in the extra parameter, though, so the developer investigating the case has access to them.

When extra is not specified, bugzscout will increase the number of occurrences for the case with the given description, but it will not include an entry for it (unless it is a new case).

Parameters:
  • description – string description for error
  • extra – string details for error
  • default_message – string default message to return in responses

Celery Extension

Asynchronously submit errors to FogBugz via BugzScout.

bugzscout.ext.celery_app.submit_error(url, user, project, area, description, extra=None, default_message=None)[source]

This is a proxy to an object that has not yet been evaulated.

Proxy will evaluate the object each time, while the promise will only evaluate it once.

Celery task for submitting errors asynchronously.

Parameters:
  • url – string URL for bugzscout
  • user – string fogbugz user to designate when submitting via bugzscout
  • project – string fogbugz project to designate for cases
  • area – string fogbugz area to designate for cases
  • description – string description for error
  • extra – string details for error
  • default_message – string default message to return in responses

Project Versions

Table Of Contents

Previous topic

Introduction

Next topic

BugzScout Command Line Interface

This Page