Add pre-commit fixes

jacomago · jacomago · commit 8b7a41e7ff92 · 2025-01-10T16:18:53.000+01:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -40,4 +40,4 @@ jobs:
       run: docker image prune -af
     - name: Test with pytest
       run: |
-        python -m unittest discover -v -s test -p "test*.py"   
+        python -m unittest discover -v -s test -p "test*.py"
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,4 @@
 *.pyc
 build/
 *.egg-info/
-.vscode
+.vscode
diff --git a/README.md b/README.md
@@ -6,20 +6,20 @@ A python client library for ChannelFinder.
 
 The python channelfinder client library can be configured by setting up a `channelfinderapi.conf` file in the following locations
 
-`/etc/channelfinderapi.conf`    
-`~/.channelfinderapi.conf`   
-`channelfinderapi.conf`  
+`/etc/channelfinderapi.conf`
+`~/.channelfinderapi.conf`
+`channelfinderapi.conf`
 
-The example preferences:  
+The example preferences:
 
 ```
-cat ~/channelfinderapi.conf  
-[DEFAULT]  
-BaseURL=http://localhost:8080/ChannelFinder  
-username=MyUserName  
-password=MyPassword  
+cat ~/channelfinderapi.conf
+[DEFAULT]
+BaseURL=http://localhost:8080/ChannelFinder
+username=MyUserName
+password=MyPassword
 ```
- 
+
 ## Development
 
 To install with dependancies for testing.
@@ -38,4 +38,4 @@ To run all tests:
 
 ```bash
 python -m unittest discover -v -s test -p "test*.py"
-```
+```
diff --git a/channelfinder/CFDataTypes.py b/channelfinder/CFDataTypes.py
@@ -22,7 +22,7 @@ def cmp(a, b):
 class Channel(object):
     # TODO
     # updated the properties data structure by splitting it into 2 dict
-    
+
     # All the attributes are private and read only in an attempt to make the channel object immutable
     Name = property(lambda self: self.__Name)
     Owner = property(lambda self: self.__Owner)
@@ -42,7 +42,7 @@ def __init__(self, name, owner, properties=None, tags=None):
         self.__Owner = str(owner).strip()
         self.Properties = properties
         self.Tags = tags
-    
+
     ## TODO don't recreate the dictionary with every get
     def getProperties(self):
         """
@@ -85,10 +85,10 @@ def __init__(self, name, owner, value=None):
         self.Value = value
         if self.Value:
             str(value).strip()
-    
-    def __cmp__(self, *arg, **kwargs):  
+
+    def __cmp__(self, *arg, **kwargs):
         if arg[0] is None:
-            return 1      
+            return 1
         return cmp((self.Name, self.Value), (arg[0].Name, arg[0].Value))
 
 
@@ -99,7 +99,7 @@ def __init__(self, name, owner):
         """
         self.Name = str(name).strip()
         self.Owner = str(owner).strip()
-    
+
     def __cmp__(self, *arg, **kwargs):
         if arg[0] is None:
             return 1
diff --git a/channelfinder/ChannelFinderClient.py b/channelfinder/ChannelFinderClient.py
@@ -97,39 +97,39 @@ def set(self, **kwds):
         set(channels = [Channel])
         >>> set(channels=[{'name':'chName1','owner':'chOwner'},{'name':'chName2','owner':'chOwner'}])
         >>> set(channels=[{'name':'chName1','owner':'chOwner', 'tags':[...], 'properties':[...]}, {...}])
-        
+
         set(tag = Tag)
         >>> set(tag={'name':'tagName','owner':'tagOwner'})
-        
+
         set(tags = [Tag])
         >>> set(tags=[{'name':'tag1','tagOwner'},{'name':'tag2','owner':'tagOwner'}])
-        
+
         set(property = Property )
         >>> set(property={'name':'propertyName','owner':'propertyOwner'})
-        
+
         set(properties = [Property])
-        >>> set(properties=[{'name':'prop1','owner':'propOwner'},'prop2','propOwner']) 
-                   
+        >>> set(properties=[{'name':'prop1','owner':'propOwner'},'prop2','propOwner'])
+
         *** IMP NOTE: Following operation are destructive ***
         *** if you simply want to append a tag or property use the update operation***
-        
+
         set(tag=Tag, channelName=String)
         >>> set(tag={'name':'tagName','owner':'tagOwner'}, channelName='chName')
         # will create/replace specified Tag
         # and add it to the channel with the name = channelName
-        
+
         set(tag=Tag, channelNames=[String])
         >>> set (tag={'name':'tagName','owner':'tagOwner'}, channelNames=['ch1','ch2','ch3'])
-        # will create/replace the specified Tag 
+        # will create/replace the specified Tag
         # and add it to the channels with the names specified in channelNames
         # and delete it from all other channels
-        
+
         set(property=Property, channelNames=[String])
         >>> set(property={'name':'propName','owner':'propOwner','value':'propValue'}, channels=[...])
         # will create/replace the specified Property
         # and add it to the channels with the names specified in channels
         # and delete it from all other channels
-        
+
         """
         if len(kwds) == 1:
             self.__handleSingleAddParameter(**kwds)
diff --git a/channelfinder/__init__.py b/channelfinder/__init__.py
@@ -1,2 +1,2 @@
 from .CFDataTypes import *
-from .ChannelFinderClient import *
+from .ChannelFinderClient import *
diff --git a/channelfinder/_conf.py b/channelfinder/_conf.py
@@ -37,4 +37,4 @@ def __loadConfig():
         'channelfinderapi.conf'
     ])
     return cf
-basecfg=__loadConfig()
+basecfg=__loadConfig()
diff --git a/channelfinder/cfMonitorTest.py b/channelfinder/cfMonitorTest.py
@@ -31,7 +31,7 @@
         2:'Major  '}
 
 
-def main():    
+def main():
     requiredOpts = ['initial-file', 'final-file']
     usage = "usage: %prog -i initial-file -f final-file directory "
     parser = OptionParser(usage=usage)
@@ -54,7 +54,7 @@ def main():
 def mainRun(opts, args):
     for directory in args:
         initialFile = os.path.normpath(directory + '/' + opts.initialFile)
-        iHostName, iIocName = getArgsFromFilename(initialFile)  
+        iHostName, iIocName = getArgsFromFilename(initialFile)
         finalFile = os.path.normpath(directory + '/' + opts.finalFile)
         fHostName, fIocName = getArgsFromFilename(finalFile)
         if getPVNames(initialFile) != getPVNames(finalFile):
@@ -66,7 +66,7 @@ def mainRun(opts, args):
         Touch the initial file and check channelfinder
         '''
         touch(initialFile)
-        sleep(2)        
+        sleep(2)
         check(pvNames, iHostName, iIocName)
         '''
         Touch the final file and check channelfinder
@@ -110,7 +110,7 @@ def getArgsFromFilename(completeFilePath):
         iocName = match.group(1)
     else:
         iocName = None
-    return hostName, iocName    
+    return hostName, iocName
 
 def getPVNames(completeFilePath, pattern=None):
     try:
@@ -125,7 +125,7 @@ def getPVNames(completeFilePath, pattern=None):
         return None
     finally:
         f.close()
-            
+
 if __name__ == '__main__':
-    main()   
+    main()
     pass
diff --git a/channelfinder/cfPropertyManager/CFPropertyManager.py b/channelfinder/cfPropertyManager/CFPropertyManager.py
@@ -241,7 +241,3 @@ def run(dbl_path,cfg_path):
         print("IOError: " + e.message)
     else:
         startClient()
-
-
-
-
diff --git a/channelfinder/cfPropertyManager/__init__.py b/channelfinder/cfPropertyManager/__init__.py
@@ -1 +1 @@
-from .CFPropertyManager import *
+from .CFPropertyManager import *
diff --git a/channelfinder/cfPropertyManager/cf-property-manager-config.cfg b/channelfinder/cfPropertyManager/cf-property-manager-config.cfg
@@ -1,3 +1,3 @@
 devName=[{][^:}][^:}]*
 devType=[:][^{]*?[:}](?!.*[{])
-IGNORE=.*WtrSkid.*
+IGNORE=.*WtrSkid.*
diff --git a/channelfinder/cfUpdate/CFUpdateIOC.py b/channelfinder/cfUpdate/CFUpdateIOC.py
@@ -55,14 +55,14 @@ def getPVNames(completeFilePath, pattern=None):
 def updateChannelFinder(pvNames, hostName, iocName, time, owner,
                         service=None, username=None, password=None):
     '''
-    pvNames = list of pvNames 
+    pvNames = list of pvNames
     ([] permitted will effectively remove the hostname, iocname from all channels)
     hostName = pv hostName (None not permitted)
     iocName = pv iocName (None not permitted)
     owner = the owner of the channels and properties being added, this can be different from the user
     e.g. user = abc might create a channel with owner = group-abc
     time = the time at which these channels are being created/modified
-    [optional] if not specified the default values are used by the 
+    [optional] if not specified the default values are used by the
     channelfinderapi lib
     service = channelfinder service URL
     username = channelfinder username
@@ -123,7 +123,7 @@ def updateChannel(channel, owner, hostName=None, iocName=None, pvStatus='Inactiv
     '''
     Helper to update a channel object so as to not affect the existing properties
     '''
-    
+
     # properties list devoid of hostName and iocName properties
     if channel[u'properties']:
         properties = [property for property in channel[u'properties']
@@ -137,7 +137,7 @@ def updateChannel(channel, owner, hostName=None, iocName=None, pvStatus='Inactiv
     if pvStatus:
         properties.append({u'name' : u'pvStatus', u'owner':owner, u'value' : pvStatus})
     if time:
-        properties.append({u'name' : u'time', u'owner':owner, u'value' : time}) 
+        properties.append({u'name' : u'time', u'owner':owner, u'value' : time})
     channel[u'properties'] = properties
     return channel
 
@@ -153,7 +153,7 @@ def createChannel(chName, chOwner, hostName=None, iocName=None, pvStatus=u'Inact
     if pvStatus:
         ch[u'properties'].append({u'name' : u'pvStatus', u'owner':chOwner, u'value' : pvStatus})
     if time:
-        ch[u'properties'].append({u'name' : u'time', u'owner':chOwner, u'value' : time}) 
+        ch[u'properties'].append({u'name' : u'time', u'owner':chOwner, u'value' : time})
     return ch
 
 def checkPropertiesExist(client, propOwner):
@@ -211,7 +211,7 @@ def mainRun(opts, args):
                             service=__getDefaultConfig('BaseURL',opts.serviceURL),
                             username=__getDefaultConfig('username',opts.username),
                             password=__getDefaultConfig('password',opts.password))
-            
+
 def __getDefaultConfig(arg, value):
         if value is None:
             try:
@@ -220,7 +220,7 @@ def __getDefaultConfig(arg, value):
                 return None
         else:
             return value
-        
+
 def main():
     usage = "usage: %prog [options] filename"
     parser = OptionParser(usage=usage)
@@ -259,8 +259,8 @@ def getPassword(option, opt_str, value, parser):
     Simple method to prompt user for password
     TODO do not show the password.
     '''
-    parser.values.password = getpass()        
-            
+    parser.values.password = getpass()
+
 if __name__ == '__main__':
     main()
     pass
diff --git a/channelfinder/util/ChannelUtil.py b/channelfinder/util/ChannelUtil.py
@@ -13,12 +13,12 @@ class ChannelUtil(object):
     """
     Utiltity class
     """
-    
+
     def __init__(self):
         """
         Constructor
         """
-    
+
     @classmethod
     def getAllTags(cls, channels):
         """
@@ -34,13 +34,13 @@ def getAllTags(cls, channels):
             return list(uniqueNames)
         else:
             return None
-        
+
     @classmethod
     def getAllProperties(cls, channels):
         """
         getAllProperties([Channel]) -> [String]
         returns a list of the propertyNames of all the properties on the set of channels
-        """      
+        """
         if isinstance(channels, list):
             allProperties = []
             for channel in channels:
@@ -51,8 +51,8 @@ def getAllProperties(cls, channels):
             return list(uniqueNames)
         else:
             return None
-    
-    @classmethod 
+
+    @classmethod
     def getAllPropValues(cls, channels, propertyName, key=None):
         """
         given the list of channels return a list of all values
@@ -62,8 +62,8 @@ def getAllPropValues(cls, channels, propertyName, key=None):
             if ch.Properties:
                 match = [property for property in ch.Properties if property.Name == propertyName]
                 ret.append(match[0].Value)
-        return sorted(ret, key=key)     
-    
+        return sorted(ret, key=key)
+
     @classmethod
     def validateChannelsWithTag(cls, channels, tag):
         """
@@ -74,20 +74,20 @@ def validateChannelsWithTag(cls, channels, tag):
         and false if anyone channel does not have that tag
         """
         return cls.channelsValidityCheck(channels, TagValidator(tag))
-        
+
     @classmethod
     def validateChannelWithProperty(cls, channels, prop):
         """
         Utility method to validate a group of channels to ensure they all have the property 'prop'
         e.g.
         ChannelUtil.validateChannelWithProperty(client.find(ElemName='The Magnet'), Property('length','propOwner','0.3'))
-        
-        This will return True if all channels with property ElemName with value 'The Magnet' also have the 
+
+        This will return True if all channels with property ElemName with value 'The Magnet' also have the
         property length with value 0.3
         """
         return cls.channelsValidityCheck(channels, PropertyValidator(prop))
-    
-    
+
+
     @classmethod
     def channelsValidityCheck(cls, channels, validator):
         """
@@ -96,5 +96,5 @@ def channelsValidityCheck(cls, channels, validator):
         """
         for ch in channels:
             if not validator.validate(ch):
-                return False            
+                return False
         return True
diff --git a/channelfinder/util/Validators.py b/channelfinder/util/Validators.py
@@ -30,7 +30,7 @@ def __init__(self, prop):
         Constructor
         '''
         self.property = prop
-    
+
     def validate(self, channel):
         props = [p.Name for p in channel.Properties]
         # for p in channel.Properties:
diff --git a/channelfinder/util/__init__.py b/channelfinder/util/__init__.py
@@ -1 +1 @@
-from .ChannelUtil import ChannelUtil
+from .ChannelUtil import ChannelUtil
diff --git a/example/demo.py b/example/demo.py
diff --git a/test/_testConf.py b/test/_testConf.py
diff --git a/test/testCFUpdateIOC.py b/test/testCFUpdateIOC.py
diff --git a/test/testChannelFinderClient.py b/test/testChannelFinderClient.py
diff --git a/test/testChannelUtil.py b/test/testChannelUtil.py

-Original file line number
+Diff line change
 *.pyc
 build/
 *.egg-info/
 -.vscode
 +.vscode
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`from .CFDataTypes import *`
`2`		`-from .ChannelFinderClient import *`
	`2`	`+from .ChannelFinderClient import *`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-from .CFPropertyManager import *`
	`1`	`+from .CFPropertyManager import *`