Changes between Version 3 and Version 4 of TracDev/DataModels

Timestamp:

Oct 28, 2005, 4:44:33 AM (19 years ago)

Author:

Matthew Good

Comment:

more examples of the model api

TracDev/DataModels

@@ -6 +6 @@
 
 Data Model - [source:/trunk/trac/ticket/model.py trac.ticket.model.Ticket]
+
+'''Example:'''
 {{{
 #!python
-29      class Ticket(object):
-30      
-31          def __init__(self, env, tkt_id=None, db=None):
+from trac.env import Environment
+from trac.ticket.model import Ticket
+
+env = Environment('/path/to/trac/env')
+
+# Create a new ticket:
+tkt = Ticket(env)
+tkt['reporter'] = 'me'
+tkt['summary'] = 'my new ticket'
+tkt['description'] = 'some bogus description'
+tkt.insert()
+
+# To read an existing ticket pass its id to the constructor:
+tkt = Ticket(env, 1)
+print tkt['priority']
+
+# Update another ticket:
+tkt = Ticket(env, 2)
+tkt['status'] = 'closed'
+tkt['resolution'] = 'fixed'
+tkt.save_changes(author='me', comment='progammaticly closed a ticket')
+
+# And finally deleting:
+tkt = Ticket(env, 3)
+tkt.delete()
 }}}
 
-The fields on a model object can be edited by treating the object as a dictionary.  If you change any of the fields you must call save_changes() to have them persisted.
-
-To edit a ticket...
-{{{
-#!python
-  import trac.env
-  import trac.ticket.model
-
-  # Open Trac environment
-  t = trac.env.Environment("path/to/trac/env")
-  
-  # Get the ticket you are after (how can we query for tickets?)
-  myticket = trac.ticket.model.Ticket(t, tkt_id=1)
-
-  # Read a ticket field
-  print "Changing description for ticket called %s" %myticket["summary"]
-
-  #Write a ticket field
-  myticket["description"] = "My ticket now has a new description."
-
-  #Save your changes
-  myticket.save_changes("myusername","Just changed the description")
-}}}
-  
-For usage examples, see [source:/trunk/trac/ticket/web_ui.py trac.ticket.web_ui].
+For more examples, see [source:/trunk/trac/ticket/web_ui.py trac.ticket.web_ui].
 
 == !WikiPage ==
 
 Data Model - [source:/trunk/trac/wiki/model.py trac.wiki.model.WikiPage]
+
+'''Example:'''
 {{{
 #!python
-26      class WikiPage(object):
-27          """Represents a wiki page (new or existing)."""
-28      
-29          def __init__(self, env, name=None, version=None, db=None):
+from trac.env import Environment
+from trac.ticket.model import Ticket
+
+env = Environment('/path/to/trac/env')
+
+# Read an existing or new WikiPage:
+page = WikiPage(env, 'MyWikiPage')
+# Check if this is a new page:
+print page.exists
+# Update the content:
+page.text = 'page content goes here'
+page.save(author='me', comment='I can edit the Wiki!', remote_addr='127.0.0.1')
+
+# Read a specific page version:
+page = WikiPage(env, 'TracFaq', 1)
+print page.text
+
+# Delete a page:
+page = WikiPage(env, 'BadWikiPage')
+page.delete()
+
+# Or delete only a specific version of a page:
+page = WikiPage(env, 'AnotherPage')
+page.delete(version=5)
+
 }}}
 
-The !WikiPage has an optional parameter for the version, and you probably won't need to bother with the last parameter which is an optional db connection.
-
-For usage examples, see [source:/trunk/trac/wiki/web_ui.py trac.wiki.web_ui].
+For more examples, see [source:/trunk/trac/wiki/web_ui.py trac.wiki.web_ui].
 
 ----