iicd/Inkycal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Implementation of interface (template) for all modules

Browse Source 
- Correct setup of logging
- all inkycal-modules inherit from the given template
- Added basic, optional validation
- more code cleanups
- fixed a few minor bugs
This commit is contained in:
Ace
2020-05-23 01:45:40 +02:00
parent f631733bf5
commit c3fbd79eda
14 changed files with 481 additions and 352 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
inkycal/modules/inkycal_agenda.py
View File

@@ -5,85 +5,74 @@ Agenda module for Inky-Calendar Project
Copyright by aceisace
"""
from inkycal.modules.template import inkycal_module
from inkycal.custom import *
import calendar as cal
import arrow
from inkycal.modules.ical_parser import icalendar
size = (400, 520)
config = {'week_starts_on': 'Monday', 'ical_urls': ['https://calendar.google.com/calendar/ical/en.usa%23holiday%40group.v.calendar.google.com/public/basic.ics']}
import calendar as cal
import arrow
filename = os.path.basename(__file__).split('.py')[0]
logger = logging.getLogger(filename)
logger.setLevel(level=logging.INFO)
class agenda:
class agenda(inkycal_module):
"""Agenda class
Create agenda and show events from given icalendars
"""
logger = logging.getLogger(__name__)
logging.basicConfig(level=logging.DEBUG)
def __init__(self, section_size, section_config):
"""Initialize inkycal_agenda module"""
self.name = os.path.basename(__file__).split('.py')[0]
self.config = section_config
self.width, self.height = section_size
self.background_colour = 'white'
self.font_colour = 'black'
self.fontsize = 12
self.font = ImageFont.truetype(
fonts['NotoSans-SemiCondensed'], size = self.fontsize)
self.padding_x = 0.02 #rename to margin?
self.padding_y = 0.05
# Section specific config
# Format for formatting dates
super().__init__(section_size, section_config)
# Module specific parameters
required = ['week_starts_on', 'ical_urls']
for param in required:
if not param in section_config:
raise Exception('config is missing {}'.format(param))
# module name
self.name = filename
# module specific parameters
self.date_format = 'ddd D MMM'
# Fromat for formatting event timings
self.time_format = "HH:mm" #use auto for 24/12 hour format?
self.language = 'en' # Grab from settings file?
self.time_format = "HH:mm"
self.language = 'en'
self.timezone = get_system_tz()
# urls of icalendars
self.ical_urls = config['ical_urls']
# filepaths of icalendar files
self.ical_files = []
# give an OK message
print('{0} loaded'.format(self.name))
def set(self, **kwargs):
"""Manually set some parameters of this module"""
for key, value in kwargs.items():
if key in self.__dict__:
setattr(self, key, value)
else:
print('{0} does not exist'.format(key))
pass
def get(self, **kwargs):
"""Manually get some parameters of this module"""
for key, value in kwargs.items():
if key in self.__dict__:
getattr(self, key, value)
else:
print('{0} does not exist'.format(key))
pass
def get_options(self):
"""Get all options which can be changed"""
return self.__dict__
def _validate(self):
"""Validate module-specific parameters"""
if not isinstance(self.date_format, str):
print('date_format has to be an arrow-compatible token')
if not isinstance(self.time_format, str):
print('time_format has to be an arrow-compatible token')
if not isinstance(self.language, str):
print('language has to be a string: "en" ')
if not isinstance(self.timezone, str):
print('The timezone has bo be a string.')
if not isinstance(self.ical_urls, list):
print('ical_urls has to be a list ["url1", "url2"] ')
if not isinstance(self.ical_files, list):
print('ical_files has to be a list ["path1", "path2"] ')
def generate_image(self):
"""Generate image for this module"""
# Define new image size with respect to padding
im_width = int(self.width - (self.width * 2 * self.padding_x))
im_height = int(self.height - (self.height * 2 * self.padding_y))
im_width = int(self.width - (self.width * 2 * self.margin_x))
im_height = int(self.height - (self.height * 2 * self.margin_y))
im_size = im_width, im_height
logging.info('Image size: {0}'.format(im_size))
logger.info('Image size: {0}'.format(im_size))
# Create an image for black pixels and one for coloured pixels
im_black = Image.new('RGB', size = im_size, color = self.background_colour)
im_black = Image.new('RGB', size = im_size, color = 'white')
im_colour = Image.new('RGB', size = im_size, color = 'white')
# Calculate the max number of lines that can fit on the image
@@ -91,7 +80,7 @@ class agenda:
line_height = int(self.font.getsize('hg')[1]) + line_spacing
line_width = im_width
max_lines = im_height // line_height
logging.debug(('max lines:',max_lines))
logger.debug(('max lines:',max_lines))
# Create timeline for agenda
now = arrow.now()
@@ -117,37 +106,37 @@ class agenda:
# Sort events by beginning time
parser.sort()
# parser.show_events()
# Set the width for date, time and event titles
date_width = int(max([self.font.getsize(
dates['begin'].format(self.date_format, locale=self.language))[0]
for dates in agenda_events]) * 1.2)
logging.debug(('date_width:', date_width))
logger.debug(('date_width:', date_width))
# Check if any events were filtered
if upcoming_events:
# Find out how much space the event times take
time_width = int(max([self.font.getsize(
events['begin'].format(self.time_format, locale=self.language))[0]
for events in upcoming_events]) * 1.2)
logging.debug(('time_width:', time_width))
logger.debug(('time_width:', time_width))
# Calculate x-pos for time
x_time = date_width
logging.debug(('x-time:', x_time))
logger.debug(('x-time:', x_time))
# Find out how much space is left for event titles
event_width = im_width - time_width - date_width
logging.debug(('width for events:', event_width))
logger.debug(('width for events:', event_width))
# Calculate x-pos for event titles
x_event = date_width + time_width
logging.debug(('x-event:', x_event))
logger.debug(('x-event:', x_event))
# Calculate positions for each line
line_pos = [(0, int(line * line_height)) for line in range(max_lines)]
logging.debug(('line_pos:', line_pos))
logger.debug(('line_pos:', line_pos))
# Merge list of dates and list of events
agenda_events += upcoming_events
@@ -159,7 +148,7 @@ class agenda:
# Delete more entries than can be displayed (max lines)
del agenda_events[max_lines:]
#print(agenda_events)
self._agenda_events = agenda_events
cursor = 0
for _ in agenda_events:
@@ -170,7 +159,7 @@ class agenda:
ImageDraw.Draw(im_colour).line(
(0, line_pos[cursor][1], im_width, line_pos[cursor][1]),
fill = 'black')
write(im_black, line_pos[cursor], (date_width, line_height),
title, font = self.font, alignment='left')
@@ -185,12 +174,12 @@ class agenda:
write(im_black, (x_time, line_pos[cursor][1]),
(time_width, line_height), time,
font = self.font, alignment='left')
write(im_black, (x_event, line_pos[cursor][1]),
(event_width, line_height),
'• '+title, font = self.font, alignment='left')
cursor += 1
# If no events were found, write only dates and lines
else:
cursor = 0
@@ -199,25 +188,21 @@ class agenda:
ImageDraw.Draw(im_colour).line(
(0, line_pos[cursor][1], im_width, line_pos[cursor][1]),
fill = 'black')
write(im_black, line_pos[cursor], (date_width, line_height),
title, font = self.font, alignment='left')
cursor += 1
logging.info('no events found')
############################################################################
# Exception handling
############################################################################
logger.info('no events found')
# Save image of black and colour channel in image-folder
im_black.save(images+self.name+'.png')
im_colour.save(images+self.name+'_colour.png')
if __name__ == '__main__':
print('running {0} in standalone mode'.format(
os.path.basename(__file__).split('.py')[0]))
print('running {0} in standalone mode'.format(filename))
# remove below line later!
a = agenda(size, config).generate_image()
##size = (400, 520)
##config = {'week_starts_on': 'Monday', 'ical_urls': ['https://calendar.google.com/calendar/ical/en.usa%23holiday%40group.v.calendar.google.com/public/basic.ics']}
##a = agenda(size, config).generate_image()