changes_0.2

Differences between revisions 2 and 4 (spanning 2 versions)
Revision 2 as of 2007-06-07 08:26:35
Size: 624
Editor: i59F779EF
Comment:
Revision 4 as of 2007-06-20 07:46:15
Size: 2124
Editor: a89-182-212-242
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
As part of my Google Summer of code project I'm going to rewrite python-launchpad-bugs. This wiki-page will give a view of my ideas and a starting point for further discussions. As part of my Google Summer of code project I'm going to rewrite python-launchpad-bugs. This wiki-page will give a view of my ideas and a starting point for further discussions. Some of the following items are already implemented in my developing branch [http://bazaar.launchpad.net/~thekorn/python-launchpad-bugs/api.changes.gsoc]
Line 6: Line 7:
I would like to split the existing HTMLOperations module into a BugList and a Bug module
I would like to split the existing `HTMLOperations` module into a `Buglist` and a `Bug` module.

 * all connection related functions like `safe_urlopen()` will be moved to utils
 * setting the `cookie_handler` should be a global option


== Buglist ==

This module will basically consist of the old `BugList` and `BugPage` classes.

=== BugList ===

 * Filtering should be a global option
 * the only required parameter in the constructor is `url`
 * `BugList.bugs` will be a `SET`

I almost finished the `Buglist` module, I wrote a small script `api_test_Buglist.py` to give an overview over the new API.


== Bug ==

`api_test_Bug.py` shows the state of the developing progress.

 * objectify the current Bug -class:
  * `Comments`, `Attachments` and `InfoTable` are new container classes
  * `Comment`, `Attachment` and `Info` - objects are elements of this containers

 * changeable elements have their own `edit`,`add` or `remove` method: e.g.
  * `Comments` will have a `add` method
  * `Attachments` will have `add` and `remove`
  * `Info` will have an `edit` method
  * `Comment` and `InfoTable` are read-only

 * 'edit local and apply at once' - approach

 The following lines of code should explain that approach:

{{{
bug = Bug(1)
bug.attachments.add('fix.patch', comment='first attempt to fix that issue')
bug.status = 'Needs Info'
bug.tags.append('bitesize')
bug.apply
}}}

(This is still work in progress)

As part of my Google Summer of code project I'm going to rewrite python-launchpad-bugs. This wiki-page will give a view of my ideas and a starting point for further discussions. Some of the following items are already implemented in my developing branch [http://bazaar.launchpad.net/~thekorn/python-launchpad-bugs/api.changes.gsoc]

Splitting HTMLOperations.py

I would like to split the existing HTMLOperations module into a Buglist and a Bug module.

  • all connection related functions like safe_urlopen() will be moved to utils

  • setting the cookie_handler should be a global option

Buglist

This module will basically consist of the old BugList and BugPage classes.

BugList

  • Filtering should be a global option
  • the only required parameter in the constructor is url

  • BugList.bugs will be a SET

I almost finished the Buglist module, I wrote a small script api_test_Buglist.py to give an overview over the new API.

Bug

api_test_Bug.py shows the state of the developing progress.

  • objectify the current Bug -class:
    • Comments, Attachments and InfoTable are new container classes

    • Comment, Attachment and Info - objects are elements of this containers

  • changeable elements have their own edit,add or remove method: e.g.

    • Comments will have a add method

    • Attachments will have add and remove

    • Info will have an edit method

    • Comment and InfoTable are read-only

  • 'edit local and apply at once' - approach The following lines of code should explain that approach:

bug = Bug(1)
bug.attachments.add('fix.patch', comment='first attempt to fix that issue')
bug.status = 'Needs Info'
bug.tags.append('bitesize')
bug.apply

Use a LaunchpadConnector class

We could use a LaunchpadConnector class and have several backends implementing it. That way we can have an easy transition to XMLRPC once we get it from Launchpad.


Go Back to [:BugHelper/Dev].BR CategoryBugHelper

BugHelper/Dev/python-launchpad-bugs/changes_0.2 (last edited 2008-08-06 17:01:19 by localhost)