pywargame 0.3.1__py3-none-any.whl

pywargame/vassal/moduledata.py

@@ -0,0 +1,275 @@
+## BEGIN_IMPORT
+from common import VerboseGuard
+from . base import *
+from . element import Element
+## END_IMPORT
+
+# --------------------------------------------------------------------
+class Data(Element):
+    TAG = 'data'
+    def __init__(self,doc,node=None,version='1'):
+        super(Data,self).__init__(doc,self.TAG,node=node,version=version)
+        
+    def addVersion(self,**kwargs):
+        '''Add a `Version` element to this
+
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        
+        Returns
+        -------
+        element : Version
+            The added element
+        '''
+        return self.add(Version,**kwargs)
+    def addVASSALVersion(self,**kwargs):
+        '''Add a `VASSALVersion` element to this
+
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        
+        Returns
+        -------
+        element : VASSALVersion
+            The added element
+        '''
+        return self.add(VASSALVersion,**kwargs)
+    def addName(self,**kwargs):
+        '''Add a `Name` element to this
+
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        
+        Returns
+        -------
+        element : Name
+            The added element
+        '''
+        return self.add(Name,**kwargs)
+    def addDescription(self,**kwargs):
+        '''Add a `Description` element to this
+
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        
+        Returns
+        -------
+        element : Description
+            The added element
+        '''
+        return self.add(Description,**kwargs)
+    def addDateSaved(self,**kwargs):
+        '''Add a `DateSaved` element to this
+
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        
+        Returns
+        -------
+        element : DateSaved
+            The added element
+        '''
+        return self.add(DateSaved,**kwargs)
+    def getVersion(self,single=True):
+        '''Get all or a sole `Version` element(s) from this
+
+        Parameters
+        ----------
+        single : bool
+            If `True`, there can be only one `Version` child, otherwise fail.
+            If `False` return all `Version` children in this element
+        
+        Returns
+        -------
+        children : list
+            List of `Version` children (even if `single=True`)
+        '''
+        return self.getAllElements(Version,single=single)
+    def getVASSALVersion(self,single=True):
+        '''Get all or a sole `VASSALVersion` element(s) from this
+
+        Parameters
+        ----------
+        single : bool        
+            If `True`, there can be only one `VASSALVersion` child,
+            otherwise fail.  If `False` return all `VASSALVersion`
+            children in this element
+        
+        Returns
+        -------
+        children : list
+            List of `VASSALVersion` children (even if `single=True`)
+
+        '''
+        return self.getAllElements(VASSALVersion,single=single)
+    def getName(self,single=True):
+        return self.getAllElements(Name,single=single)
+    def getDescription(self,single=True):
+        '''Get all or a sole `Description` element(s) from this
+
+        Parameters
+        ----------
+        single : bool
+            If `True`, there can be only one `Description` child,
+            otherwise fail.  If `False` return all `De` children in
+            this element
+        
+        Returns
+        -------
+        children : list
+            List of `De` children (even if `single=True`)
+
+        '''
+        return self.getAllElements(Description,single=single)
+    def getDateSaved(self,single=True):
+        '''Get all or a sole `DateSaved` element(s) from this
+
+        Parameters
+        ----------
+        single : bool
+            If `True`, there can be only one `DateSaved` child, otherwise fail.
+            If `False` return all `DateSaved` children in this element
+        
+        Returns
+        -------
+        children : list
+            List of `DateSaved` children (even if `single=True`)
+        '''
+        return self.getAllElements(DateSaved,single=single)
+    
+registerElement(Data)
+
+# --------------------------------------------------------------------
+class DataElement(Element):
+    def __init__(self,data,tag,node=None,**kwargs):
+        super(DataElement,self).__init__(data,tag,node=node,**kwargs)
+
+    def getData(self):
+        return self.getParent(Data)
+
+# --------------------------------------------------------------------
+class Version(DataElement):
+    TAG = 'version'
+    def __init__(self,data,node=None,version=''):
+        super(Version,self).__init__(data,self.TAG,node=node)
+        if node is None:
+            self.addText(version)
+
+registerElement(Version)
+
+# --------------------------------------------------------------------
+class Extra1(DataElement):
+    TAG = 'extra1'
+    def __init__(self,data,node=None,extra=''):
+        super(Extra1,self).__init__(data,self.TAG,node=node)
+        if node is None:
+            self.addText(extra)
+
+registerElement(Extra1)
+
+# --------------------------------------------------------------------
+class Extra2(DataElement):
+    TAG = 'extra2'
+    def __init__(self,data,node=None,extra=''):
+        super(Extra2,self).__init__(data,self.TAG,node=node)
+        if node is None:
+            self.addText(extra)
+
+registerElement(Extra2)
+
+# --------------------------------------------------------------------
+class VASSALVersion(DataElement):
+    TAG = 'VassalVersion'
+    def __init__(self,data,node=None,version='3.6.7'):
+        super(VASSALVersion,self).__init__(data,self.TAG,node=node)
+        if node is None:
+            self.addText(version)
+
+registerElement(VASSALVersion)
+
+# --------------------------------------------------------------------
+class Name(DataElement):
+    TAG = 'name'
+    def __init__(self,data,node=None,name=''):
+        super(Name,self).__init__(data,self.TAG,node=node)
+        if node is None:
+            self.addText(name)
+            
+registerElement(Name)
+
+# --------------------------------------------------------------------
+class Description(DataElement):
+    TAG = 'description'
+    def __init__(self,data,node=None,description=''):
+        super(Description,self).__init__(data,self.TAG,node=node)
+        if node is None:
+            self.addText(description)
+
+registerElement(Description)
+
+# --------------------------------------------------------------------
+class DateSaved(DataElement):
+    TAG = 'dateSaved'
+    def __init__(self,data,node=None,milisecondsSinceEpoch=-1):
+        super(DateSaved,self).__init__(data,self.TAG,node=node)
+        if node is None:
+            from time import time
+            s = f'{int(time()*1000)}' if milisecondsSinceEpoch < 0 else \
+                str(milisecondsSinceEpoch)
+            self.addText(s)
+            
+registerElement(DateSaved)
+
+# --------------------------------------------------------------------
+class ModuleData(Element):
+
+    def __init__(self,root=None):
+        '''Construct from a DOM object, if given, otherwise make new'''
+        #from xml.dom.minidom import Document
+        super(ModuleData,self).__init__(None,'',None)
+        
+        self._root = root
+        self._tag  = 'moduledata'
+        if self._root is None:
+            self._root = xmlns.Document()
+
+        self._node = self._root
+
+    def addData(self,**kwargs):
+        '''Add a `Data` element to this
+
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        
+        Returns
+        -------
+        element : Data
+            The added element
+        '''
+        return Data(self,**kwargs)
+
+    def getData(self):
+        return Data(self,
+                    node=self._root.getElementsByTagName(Data.TAG)[0])
+
+    def encode(self):
+        return self._root.toprettyxml(indent=' ',
+                                      encoding="UTF-8",
+                                      standalone=False)
+
+
+#
+# EOF
+#

pywargame/vassal/mrgcollect.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python
+import sys
+sys.path.append('..')
+
+from common import Verbose, VerboseGuard
+from common.collector import Collector
+
+        
+if __name__ == '__main__':
+    from argparse import ArgumentParser, FileType  
+
+    ap = ArgumentParser(description='Collect to single script')
+    ap.add_argument('output',
+                    type=FileType('w'),
+                    nargs='?',
+                    default='vslmerge.py',
+                    help='Output script name')
+    ap.add_argument('-v','--verbose',action='store_true',
+                    help='Be verbose')
+
+    args = ap.parse_args()
+
+    Verbose().setVerbose(args.verbose)
+
+    c = Collector(executable=True)
+    c.run(args.output,
+          'vassal.py',
+          'merger.py',
+          'merge.py')
+
+    

pywargame/vassal/patch.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+#
+# Patch a module
+## BEGIN_IMPORTS
+from vassal.vmod import VMod
+from common import Verbose
+## END_IMPORT
+
+# ====================================================================
+def patchIt(args):
+    Verbose().setVerbose(args.verbose)
+    
+    vmodname  = args.output.name
+    patchname = args.patch.name
+    args.output.close()
+    args.patch .close()
+    
+    VMod.patch(vmodname, patchname, args.verbose)
+
+# ====================================================================
+if __name__ == '__main__':
+    from argparse import ArgumentParser, FileType
+
+    ap = ArgumentParser(description='Patch a module with a Python script')
+    ap.add_argument('output',
+                    help='Module to patch, will be overwritten',
+                    type=FileType('r'))
+    ap.add_argument('patch',
+                    help='Python script to patch module',
+                    type=FileType('r'),
+                    nargs='?',
+                    default='patch.py')
+    ap.add_argument('-V','--verbose',
+                    help='Be verbose',
+                    action='store_true')
+
+    args = ap.parse_args()
+
+    
+    patchIt(args)
+
+#
+# EOF
+#

pywargame/vassal/patchcollect.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+import sys
+sys.path.append('..')
+
+from common import Verbose, VerboseGuard
+from common.collector import Collector
+
+        
+if __name__ == '__main__':
+    from argparse import ArgumentParser, FileType  
+
+    ap = ArgumentParser(description='Collect to single script')
+    ap.add_argument('output',
+                    type=FileType('w'),
+                    nargs='?',
+                    default='vmodpatch.py',
+                    help='Output script name')
+    ap.add_argument('-v','--verbose',action='store_true',
+                    help='Be verbose')
+
+    args = ap.parse_args()
+
+    Verbose().setVerbose(args.verbose)
+
+    c = Collector()
+    c.run(args.output,
+          'vassal.py',
+          'patch.py')

pywargame/vassal/player.py

@@ -0,0 +1,83 @@
+## BEGIN_IMPORT
+from common import VerboseGuard
+from . base import *
+from . element import Element
+from . gameelements import GameElement
+## END_IMPORT
+
+# --------------------------------------------------------------------
+class PlayerRoster(GameElement):
+    TAG = Element.MODULE+'PlayerRoster'
+    def __init__(self,doc,node=None,buttonKeyStroke='',
+               buttonText='Retire',
+               buttonToolTip='Switch sides, become observer, or release faction'):
+        '''Add a player roster to the module
+        
+        Parameters
+        ----------
+        doc : Element
+            Parent
+        node : xml.dom.Element
+            Node to read state from
+        buttonText : str
+            Text on button
+        buttonTooltip : str
+            Tool tip to show when hovering over button
+        '''
+        super(PlayerRoster,self).__init__(doc,self.TAG,node=node,
+                                          buttonKeyStroke = buttonKeyStroke,
+                                          buttonText      = buttonText,
+                                          buttonToolTip   = buttonToolTip)
+    def addSide(self,name):
+        '''Add a `Side` element to this
+
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        
+        Returns
+        -------
+        element : Side
+            The added element
+        '''
+        return self.add(PlayerSide,name=name)
+    def getSides(self):
+        '''Get all sides'''
+        return self.getAllElements(PlayerSide,False)
+    def encode(self):
+        '''Encode for save'''
+        return ['PLAYER\ta\ta\t<observer>']
+
+registerElement(PlayerRoster)
+
+# --------------------------------------------------------------------
+class PlayerSide(Element):
+    TAG = 'entry'
+    UNIQUE = ['name']
+    def __init__(self,doc,node=None,name=''):
+        '''Adds a side to the player roster
+
+        Parameters
+        ----------
+        doc : Element
+            Parent
+        node : xml.dom.Element
+            Node to read state from
+        name : str
+            Name of side 
+        '''
+        super(PlayerSide,self).__init__(doc,self.TAG,node=node)
+        if node is None:
+            self.addText(name)
+
+    def getPlayerRoster(self):
+        '''Get Parent element'''
+        return self.getParent(PlayerRoster)
+
+registerElement(PlayerSide)
+
+
+#
+# EOF
+#