Changes between Version 11 and Version 12 of WikiStart

Timestamp:

07/27/21 13:30:44 (3 years ago)

Author:

Wouter Pasman

Comment:

--

WikiStart

@@ -33 +33 @@
 
 
+== Writing a party
+Example parties can be found [source:/exampleparties here]. You can easily clone a party with SVN using {{{svn co https://tracinsy.ewi.tudelft.nl/pub/svn/GeniusWebPython/exampleparties/randomparty/}}} (this clones randomparty, use a different name to fetch another example).
+
+After cloning, create your venv and install the requirements, eg
+{{{
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+}}}
+
+You can now run the junit tests.
+
+You may have to take different or additional steps if you use an IDE like eclipse with pydev, or pycharm. 
+
+A party is compiled with python. Compile with {{{python3 setup.py sdist}}}. This gives you a  you get a {{{dist/yourparty-X.Y.Z.tar.gz}}} that can be copied into the pypartiesserver for deployment.
+
+The basic structure of a party that supports the SAOP behaviour looks like this
+{{{
+class RandomParty (DefaultParty):
+    """
+    Offers random bids until a bid with sufficient utility is offered
+    """
+    def __init__(self):
+        super().__init__()
+        self.getReporter().log(logging.INFO,"party is initialized")
+        self._profile = None
+        self._lastReceivedBid:Bid = None
+
+    def notifyChange(self, info: Inform):
+        #self.getReporter().log(logging.INFO,"received info:"+str(info))
+        if isinstance(info,Settings) :
+            settings:Settings=cast(Settings,info)    
+            self._me = settings.getID()
+            self._protocol:str = str(settings.getProtocol().getURI())
+            self._progress = settings.getProgress()
+            if "Learn" ==  self._protocol:
+                self.getConnection().send(LearningDone(self._me))
+            else:
+                self._profile = ProfileConnectionFactory.create(info.getProfile().getURI(), self.getReporter())
+        elif isinstance(info, ActionDone):
+            action:Action=cast( ActionDone,info).getAction()
+            if isinstance(action, Offer):
+                self._lastReceivedBid = cast(Offer, action).getBid()
+        elif isinstance(info, YourTurn):
+            self._myTurn()
+            if isinstance(self._progress, ProgressRounds) :
+                self._progress = self._progress.advance()
+        elif isinstance(info, Finished):
+            self.terminate()
+        else:
+            self.getReporter().log(logging.WARNING, "Ignoring unknown info "+str(info))
+
+
+    def getCapabilities(self) -> Capabilities:
+        return Capabilities( set([ "SAOP", "Learn"]), set(['geniusweb.profile.utilityspace.LinearAdditive']))
+
+    def getDescription(self) -> str:
+        return "Offers random bids until a bid with sufficient utility is offered"
+
+    def _myTurn(self):
+        if self._lastReceivedBid != None and \
+            self._profile.getProfile().getUtility(self._lastReceivedBid) > 0.6:
+            action = Accept(self._me, self._lastReceivedBid)
+        else:
+            for _attempt in range(20):
+                bid = self._getRandomBid(self._profile.getProfile().getDomain())
+                if self._isGood(bid):
+                    break
+            action = Offer(self._me, bid);
+        self.getConnection().send(action)
+
+    def _isGood(self, bid:Bid)->bool:
+        profile = self._profile.getProfile()
+        return profile.getUtility(bid) > 0.6
+
+...
+}}}
+
+The party must follow the behaviours that it promises. The example above folows the SAOP behaviour.  
+
+Notice, above is slightly simplified code, for fully working code check the [source:/exampleparties/randomparty/src/main/java/geniusweb/exampleparties/randomparty/RandomParty.java source code].
+
+=== Throwing exceptions
+A special warning is in place regarding throwing exceptions from your implementation, particularly from notifyChange. In line with the general Listener interface, exceptions are only logged and your party usually is immediately disconnected if it throws any exception. Make sure that you free up any used resources to avoid memory leaks if you really need to throw an exception. 
+
+=== Preparing the jar file
+In order to put your party on the [https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWebPartiesServer partiesserver] for running, you need a jar file of your party.
+
+Normally the party includes all dependencies. The jar files are loaded with an isolated jar class loader that should avoid collisions with possibly identically named but possibly different packages in other jar files.
+
+
+Party jar files must have a Main-Class set in the MANIFEST.MF file. This main-class must implement Party and have a no-arg constructor. 
+
+The example randomparty does this from the maven build script.
+
+We recommend to do initialization of the party only in the init() and not in the constructor or static code. 
+This because instances of your class can be made both for extracting general info as getDescription(), or to really run your class. 
+
+
 == GeniusWeb sources