Bugsy¶

class bugsy.Bugsy(username=None, password=None, userid=None, cookie=None, bugzilla_url='https://bugzilla.mozilla.org/rest')[source]¶

Bugsy allows easy getting and putting of Bugzilla bugs

get(bug_number)[source]¶

Get a bug from Bugzilla. If there is a login token created during object initialisation it will be part of the query string passed to Bugzilla

Parameters:	bug_number – Bug Number that will be searched. If found will return a Bug object.

>>> bugzilla = Bugsy()
>>> bug = bugzilla.get(123456)

put(bug)[source]¶

This method allows you to create or update a bug on Bugzilla. You will have had to pass in a valid username and password to the object initialisation and recieved back a token.

Parameters:	bug – A Bug object either created by hand or by using get()

If there is no valid token then a BugsyException will be raised. If the object passed in is not a Bug then a BugsyException will be raised.

>>> bugzilla = Bugsy()
>>> bug = bugzilla.get(123456)
>>> bug.summary = "I like cheese and sausages"
>>> bugzilla.put(bug)

request(path, method='GET', **kwargs)[source]¶

Perform a HTTP request.

Given a relative Bugzilla URL path, an optional request method, and arguments suitable for requests.Request(), perform a HTTP request.

class bugsy.BugsyException(msg)[source]¶

If while interacting with Bugzilla and we try do something that is not supported this error will be raised.

class bugsy.LoginException(msg)[source]¶

If a username and password are passed in but we don’t receive a token then this error will be raised.

Bug¶

class bugsy.Bug(bugsy=None, **kwargs)[source]¶

This represents a Bugzilla Bug

OS¶

Property for getting or setting the OS that the bug occured on

>>> bug.OS
"All"

add_comment(comment)[source]¶

Adds a comment to a bug. If a bug does not have a bug ID then you need call put on the Bugsy class.

>>> bug.add_comment("I like sausages")
>>> bugzilla.put(bug)

If it does have a bug id then this will do a post to the server

>>> bug.add_comment("I like eggs too")

component¶

Property for getting the bug component

>>> bug.component
General

get_comments()[source]¶

Obtain comments for this bug.

Returns a list of Comment instances.

id¶

Property for getting the ID of a bug.

>>> bug.id
123456

platform¶

Property for getting the bug platform

>>> bug.platform
"ARM"

product¶

Property for getting the bug product

>>> bug.product
Core

resolution¶

Property for getting or setting the bug resolution

>>> bug.resolution
"FIXED"

status¶

Property for getting or setting the bug status

>>> bug.status
"REOPENED"

summary¶

Property for getting and setting the bug summary

>>> bug.summary
"I like cheese"

to_dict()[source]¶

Return the raw dict that is used inside this object

update()[source]¶

Update this object with the latest changes from Bugzilla

>>> bug.status
'NEW'
#Changes happen on Bugzilla
>>> bug.update()
>>> bug.status
'FIXED'

version¶

Property for getting the bug platform

>>> bug.version
"TRUNK"

class bugsy.BugException(msg)[source]¶

If we try do something that is not allowed to a bug then this error is raised

Comment¶

class bugsy.Comment(**kwargs)[source]¶

Represents a single Bugzilla comment.

To get comments you need to do the following

>>> bugs = bugzilla.search_for.keywords("checkin-needed").search()
>>> comments = bugs[0].get_comments()
>>> comments[0].text # Returns the comment 0 of the first checkin-needed bug

id¶

Return the comment id that is associated with Bugzilla.

text¶

Return the text that is in this comment

>>> comment.text # David really likes cheese apparently

Search¶

class bugsy.Search(bugsy)[source]¶

This allows searching for bugs in Bugzilla

assigned_to(*args)[source]¶

When search() is called it will search for bugs assigned to these users

Parameters:	args – items passed in will be turned into a list
Returns:	Search

>>> bugzilla.search_for.assigned_to("dburns@mozilla.com")

bug_number(bug_numbers)[source]¶

When you want to search for a bugs and be able to change the fields returned.

Parameters:	bug_numbers – A string for the bug number or a list of strings
Returns:	Search

>>> bugzilla.search_for.bug_number(['123123', '123456'])

change_history_fields(fields, value=None)[source]¶

include_fields(*args)[source]¶

Include fields is the fields that you want to be returned when searching. These are in addition to the fields that are always included below.

Parameters:	args – items passed in will be turned into a list
Returns:	Search

>>> bugzilla.search_for.include_fields("flags")

The following fields are always included in search:

‘version’, ‘id’, ‘summary’, ‘status’, ‘op_sys’, ‘resolution’, ‘product’, ‘component’, ‘platform’

keywords(*args)[source]¶

When search() is called it will search for the keywords passed in here

Parameters:	args – items passed in will be turned into a list
Returns:	Search

>>> bugzilla.search_for.keywords("checkin-needed")

search()[source]¶

Call the Bugzilla endpoint that will do the search. It will take the information used in other methods on the Search object and build up the query string. If no bugs are found then an empty list is returned.

>>> bugs = bugzilla.search_for\
...                .keywords("checkin-needed")\
...                .include_fields("flags")\
...                .search()

summary(*args)[source]¶

When search is called it will search for bugs with the words passed into the methods

Parameters:	args – items passed in will be turned into a list
Returns:	Search

>>> bugzilla.search_for.summary("663399")

timeframe(start, end)[source]¶

When you want to search bugs for a certain time frame.

Parameters:	start – end –
Returns:	Search

whiteboard(*args)[source]¶

When search is called it will search for bugs with the words passed into the methods

Parameters:	args – items passed in will be turned into a list
Returns:	Search

>>> bugzilla.search_for.whiteboard("affects")