From 51cbfff8808156f7a35d7bf89baf93bceae5dc17 Mon Sep 17 00:00:00 2001 From: Johannes Findeisen Date: Mon, 27 May 2013 03:54:04 +0200 Subject: [PATCH] many cleanups and new docs --- docs/api-objects.txt | 2 + docs/class-tree.html | 2 +- docs/help.html | 2 +- docs/identifier-index.html | 35 ++-- docs/linspector-module.html | 2 +- docs/linspector-pysrc.html | 2 +- docs/linspector.lib-module.html | 2 +- docs/linspector.lib-pysrc.html | 2 +- docs/linspector.lib.config-module.html | 2 +- docs/linspector.lib.config-pysrc.html | 2 +- docs/linspector.lib.config.config-module.html | 2 +- docs/linspector.lib.config.config-pysrc.html | 2 +- ...pector.lib.config.config.Config-class.html | 2 +- .../linspector.lib.config.filters-module.html | 2 +- docs/linspector.lib.config.filters-pysrc.html | 2 +- ...ector.lib.config.filters.Filter-class.html | 2 +- ...nspector.lib.config.hostgroups-module.html | 2 +- ...inspector.lib.config.hostgroups-pysrc.html | 2 +- ...lib.config.hostgroups.HostGroup-class.html | 2 +- ...fig.hostgroups.HostGroupService-class.html | 2 +- docs/linspector.lib.config.hosts-module.html | 2 +- docs/linspector.lib.config.hosts-pysrc.html | 6 +- ...inspector.lib.config.hosts.Host-class.html | 2 +- ...or.lib.config.hosts.HostService-class.html | 2 +- .../linspector.lib.config.layouts-module.html | 2 +- docs/linspector.lib.config.layouts-pysrc.html | 2 +- ...ector.lib.config.layouts.Layout-class.html | 2 +- ...r.lib.config.layouts.LayoutList-class.html | 2 +- .../linspector.lib.config.members-module.html | 2 +- docs/linspector.lib.config.members-pysrc.html | 6 +- ...ector.lib.config.members.Member-class.html | 2 +- ...lib.config.members.MemberFilter-class.html | 4 +- .../linspector.lib.config.periods-module.html | 4 +- docs/linspector.lib.config.periods-pysrc.html | 196 +++++++++--------- ...r.lib.config.periods.CronPeriod-class.html | 4 +- ...r.lib.config.periods.DatePeriod-class.html | 2 +- ...b.config.periods.IntervalPeriod-class.html | 2 +- ...ector.lib.config.periods.Period-class.html | 2 +- ...linspector.lib.config.services-module.html | 2 +- .../linspector.lib.config.services-pysrc.html | 2 +- ...tor.lib.config.services.Service-class.html | 2 +- docs/linspector.lib.core-module.html | 2 +- docs/linspector.lib.core-pysrc.html | 2 +- docs/linspector.lib.core.command-module.html | 2 +- docs/linspector.lib.core.command-pysrc.html | 4 +- ...pector.lib.core.command.Command-class.html | 2 +- docs/linspector.lib.core.daemon-module.html | 2 +- docs/linspector.lib.core.daemon-pysrc.html | 2 +- ...nspector.lib.core.daemon.Daemon-class.html | 2 +- docs/linspector.lib.core.job-module.html | 2 +- docs/linspector.lib.core.job-pysrc.html | 12 +- ...linspector.lib.core.job.JobInfo-class.html | 35 +++- ...tor.lib.core.linspector_daemon-module.html | 2 +- ...ctor.lib.core.linspector_daemon-pysrc.html | 2 +- ...spector_daemon.LinspectorDaemon-class.html | 2 +- docs/linspector.lib.core.logger-module.html | 2 +- docs/linspector.lib.core.logger-pysrc.html | 2 +- ...nspector.lib.core.logger.Logger-class.html | 2 +- docs/module-tree.html | 2 +- lib/config/config.py | 2 +- lib/config/filters.py | 2 +- lib/config/hosts.py | 4 +- lib/config/members.py | 4 +- lib/config/periods.py | 39 ++-- lib/core/command.py | 4 +- lib/core/job.py | 6 +- lib/core/logger.py | 4 +- linspector | 17 +- linspector.json | 14 +- 69 files changed, 261 insertions(+), 239 deletions(-) diff --git a/docs/api-objects.txt b/docs/api-objects.txt index b96a950..9a30442 100644 --- a/docs/api-objects.txt +++ b/docs/api-objects.txt @@ -115,6 +115,8 @@ linspector.lib.core.daemon.Daemon.__init__ linspector.lib.core.daemon.Daemon-cla linspector.lib.core.daemon.Daemon.restart linspector.lib.core.daemon.Daemon-class.html#restart linspector.lib.core.job.JobInfo linspector.lib.core.job.JobInfo-class.html linspector.lib.core.job.JobInfo.__str__ linspector.lib.core.job.JobInfo-class.html#__str__ +linspector.lib.core.job.JobInfo.handleCall linspector.lib.core.job.JobInfo-class.html#handleCall +linspector.lib.core.job.JobInfo.setLogger linspector.lib.core.job.JobInfo-class.html#setLogger linspector.lib.core.job.JobInfo.__init__ linspector.lib.core.job.JobInfo-class.html#__init__ linspector.lib.core.linspector_daemon.LinspectorDaemon linspector.lib.core.linspector_daemon.LinspectorDaemon-class.html linspector.lib.core.daemon.Daemon.delpid linspector.lib.core.daemon.Daemon-class.html#delpid diff --git a/docs/class-tree.html b/docs/class-tree.html index 094856d..de0088e 100644 --- a/docs/class-tree.html +++ b/docs/class-tree.html @@ -134,7 +134,7 @@ @@ -536,7 +543,7 @@
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013 @@ -342,18 +343,24 @@ - - + - - + + + + + +
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013 + + + + + - - - - -
handleCall()
+(in JobInfo)		HostGroup
+(in linspector.lib.config.hostgroups)		hosts
+(in linspector.lib.config)
hasProcessed()
(in Command)		 hostgroups
@@ -218,13 +226,6 @@ (in linspector.lib.config.hostgroups)		  
HostGroup
-(in linspector.lib.config.hostgroups)		hosts
-(in linspector.lib.config)		 

I

Service
(in linspector.lib.config.services)		services
-(in linspector.lib.config)		start()
+		setCommand()
+(in HostService)		stop()
(in Daemon)
serviceList()
(in linspector.lib.config.services)		setCommand()
-(in HostService)		stop()
+		setLogger()
+(in JobInfo)		 
services
+(in linspector.lib.config)		start()
(in Daemon)		 
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013 10 self.comment = comment 11
12 - def __str__(self): -
13 ret = "Host('Name: " + self.name + "', 'access: " + self.host + "', " +
13 ret = "Host('Name: " + self.name + "', 'Access: " + self.host + "', " 14 if self.parent != "": - 15 ret += "'parent: " + self.parent + "', " + 15 ret += "'Parent: " + self.parent + "', " 16 ret += "'HostServices: {" 17 for s in self.services: 18 ret += str(s) + "\n" @@ -199,7 +199,7 @@ expandto(location.href);
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013 18 19
20 -class MemberFilter: -
21 - def __init__(self, filt, Value): -
22 self.filt = filt +
21 - def __init__(self, filter, Value): +
22 self.filter = filter 23 self.value = Value
24
25 - def __str__(self): @@ -137,7 +137,7 @@ expandto(location.href);
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013
__init__(self, - filt, + filter, Value) source code @@ -137,7 +137,7 @@
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013   - __package__ = 'linspector.lib.config' + __package__ = None
@@ -190,7 +190,7 @@
- Generated by Epydoc 3.0.1 on Mon May 27 01:45:23 2013 + Generated by Epydoc 3.0.1 on Mon May 27 03:53:16 2013

Source Code for Module linspector.lib.config.periods

-  1  from apscheduler.scheduler import Scheduler 
-  2   
-  3   
-
  4 -class Period(object): 
-
  5 -    def __init__(self, name): 
-
  6          self.name = name 
-
  7       
-
  8 -    def getName(self): 
-
  9          return self.name 
-
 10           
-
 11 -    def createJob(self, scheduler, jobInfo, func): 
-
 12          pass 
-
 13           
- 14   
-
 15 -class IntervalPeriod(Period): 
-
 16 -    def __init__(self, name="", weeks=0,days=0, hours=0, minutes=0, seconds=0, start_date=None, 
- 17                   comment=None): 
-
 18          super(IntervalPeriod, self).
 1 -class Period(object): 
+
 2 -    def __init__(self, name): 
+
 3          self.name = name 
+
 4       
+
 5 -    def getName(self): 
+
 6          return self.name 
+
 7           
+
 8 -    def createJob(self, scheduler, jobInfo, func): 
+
 9          pass 
+
10           
+11   
+
12 -class IntervalPeriod(Period): 
+
13 -    def __init__(self, name="", weeks=0, days=0, hours=0, minutes=0, seconds=0, start_date=None, comment=None): 
+
14          super(IntervalPeriod, self).__init__(name) 
- 19           
- 20          self.days = days                  # number of days to wait 
- 21          self.weeks = weeks                # number of weeks to wait 
- 22          self.hours = hours                # number of hours to wait 
- 23          self.minutes = minutes            # number of minutes to wait 
- 24          self.seconds = seconds            # number of seconds to wait 
- 25          self.start_date = start_date      # when to first execute  
- 26          self.comment = comment            # comment 
-
 27           
-
 28 -    def createJob(self, scheduler, jobInfo, func): 
-
 29          return scheduler.add_interval_job(func, self.weeks, self.hours, self.minutes, self.seconds, self.start_date, jobInfo) 
-
 30       
- 31           
-
 32 -    def __str__(self): 
-
 33          ret = "IntervalPeriod(Name: " + self.name + ")" 
- 34          return ret     
-
 35   
- 36   
-
 37 -class CronPeriod(Period): 
-
 38 -    def __init__(self, name="", year="*", month="*", day="*", week="*", 
- 39                   day_of_week="*", hour="*", minute="*", second="0", 
- 40                   comment=None): 
-
 41          super(CronPeriod, self).15           
+16          self.days = days                  # number of days to wait 
+17          self.weeks = weeks                # number of weeks to wait 
+18          self.hours = hours                # number of hours to wait 
+19          self.minutes = minutes            # number of minutes to wait 
+20          self.seconds = seconds            # number of seconds to wait 
+21          self.start_date = start_date      # when to first execute  
+22          self.comment = comment            # comment 
+
23           
+
24 -    def createJob(self, scheduler, jobInfo, func): 
+
25          return scheduler.add_interval_job(func, weeks=self.weeks, hours=self.hours, minutes=self.minutes, 
+26                                            seconds=self.seconds, start_date=self.start_date, args=[jobInfo]) 
+
27   
+
28 -    def __str__(self): 
+
29          ret = "IntervalPeriod(Name: " + self.name + ")" 
+30          return ret     
+
31   
+32   
+
33 -class CronPeriod(Period): 
+
34 -    def __init__(self, name="", year="*", month="*", day="*", week="*", day_of_week="*", hour="*", minute="*", 
+35                   second="0", start_date=None, comment=None): 
+
36          super(CronPeriod, self).__init__(name) 
- 42          self.year = year                # 4-digit year number 
- 43          self.month = month              # month number (1-12) 
- 44          self.day = day                  # day of the month (1-31) 
- 45          self.week = week                # ISO week number (1-53) 
- 46          self.day_of_week = day_of_week  # number or name of weekday (0-6 or mon,tue,wed,thu,fri,sat,sun) 
- 47          self.hour = hour                # hour (0-23) 
- 48          self.minute = minute            # minute (0-59) 
- 49          self.second = second            # second (0-59) 
- 50          self.comment = comment 
- 51          self.date = date 
-
 52   
-
 53 -    def __str__(self): 
-
 54          ret = "CronPeriod(Name: " + self.name + ")" 
- 55          return ret 
-
 56           
-
 57 -    def createJob(self, scheduler, jobInfo, func): 
-
 58          return scheduler.add_cron_job(func, self.year, self.month, self.day, self.week, self.day_of_week, self.hour, self.minute, self.second, jobInfo) 
-
 59               
- 60           
-
 61 -class DatePeriod(Period): 
-
 62 -    def __init__(self, name, date, comment=None): 
-
 63          super(DatePeriod, self).37          self.year = year                # 4-digit year number 
+38          self.month = month              # month number (1-12) 
+39          self.day = day                  # day of the month (1-31) 
+40          self.week = week                # ISO week number (1-53) 
+41          self.day_of_week = day_of_week  # number or name of weekday (0-6 or mon,tue,wed,thu,fri,sat,sun) 
+42          self.hour = hour                # hour (0-23) 
+43          self.minute = minute            # minute (0-59) 
+44          self.second = second            # second (0-59) 
+45          self.start_date = start_date 
+46          self.comment = comment 
+
47   
+
48 -    def __str__(self): 
+
49          ret = "CronPeriod(Name: " + self.name + ")" 
+50          return ret 
+
51           
+
52 -    def createJob(self, scheduler, jobInfo, func): 
+
53          return scheduler.add_cron_job(func, year=self.year, month=self.month, day=self.day, week=self.week, 
+54                                        day_of_week=self.day_of_week, hour=self.hour, minute=self.minute, 
+55                                        second=self.second, start_date=self.start_date, args=[jobInfo]) 
+
56               
+57           
+
58 -class DatePeriod(Period): 
+
59 -    def __init__(self, name, date, comment=None): 
+
60          super(DatePeriod, self).__init__(name) 
- 64          self.date = date 
- 65          self.comment = comment 
-
 66   
-
 67 -    def __str__(self): 
-
 68          ret = "DatePeriod(Name: " + self.name + ","+ str(self.date) + ")" 
- 69          return ret 
-
 70           
-
 71 -    def createJob(self, scheduler, jobInfo, func): 
-
 72          return scheduler.add_date_job(func, self.date, jobInfo) 
-
 73   
- 74   
- 75   
- 76   
- 77   
-
 78 -def parsePeriodList(periodlist,log): 
-
 79      periods=[] 
- 80      for name, values in periodlist.items(): 
- 81          if "date" in values: 
- 82              periods.append(DatePeriod(name, **values)) 
- 83              break 
- 84           
- 85          for i in [ "weeks","days", "hours", "minutes", "seconds", "start_date"]: 
- 86              if i in values: 
- 87                  periods.append(IntervalPeriod(name, **values)) 
- 88                  break 
- 89           
- 90          for i in ["year", "month", "day", "week", "day_of_week", "hour", "minute", "second"]: 
- 91              if i in values: 
- 92                  periods.append(CronPeriod(name, **values)) 
- 93                  break 
- 94           
- 95          log.w("ignoring Period: " +str(name)) 
- 96          log.w("reason: could not determine PeriodType: " + str(values)) 
- 97           
- 98           
- 99      return periods 
-
100