explore_md_file.py.bak

'''
author : qkzk

explore an md file (formated as the example path) and return a list of event

each event is a dic and has the keys :
            * 'start':datetime,
            * 'end':datetime,
            * 'location':str
            * 'summary':str ('%' if no summary were given)
            * 'description':str (possibly empty or multiline)
            * 'colorId':str ('1' to '11')

'''

import markdown
import datetime
from pprint import pprint

import pytz

example_week_md_path = "/home/quentin/gdrive/dev/python/boulot_utils/cahier_texte_generator/calendrier/2019/periode_1/semaine_36.md"

traduction_day = {
    # on pourrait utiliser des locales et traduire automatiquement...
    "Lundi":     "Monday",
    "Mardi":     "Tuesday",
    "Mercredi":  "Wednesday",
    "Jeudi":     "Thursday",
    "Vendredi":  "Friday",
    "Samedi":    "Saturday",
    "Dimanche":  "Sunday",
}
traduction_month = {
    "janvier":   "January",
    "février":   "February",
    "mars":      "March",
    "avril":     "April",
    "mai":       "May",
    "juin":      "June",
    "juillet":   "July",
    "août":      "August",
    "septembre": "September",
    "octobre":   "October",
    "novembre":  "November",
    "décembre":  "December",
}

monthes_end_year = ["January",
                    "February",
                    "March",
                    "April",
                    "May",
                    "June",
                    "July", ]

colors = {
    # rainbow order
    "11": "#dc2127",  # rouge
    "4": "#ff887c",   # Rosé
    "6": "#ffb878",   # orange clair
    "5": "#fbd75b",   # Jaune un peu foncé
    "10": "#51b749",  # vert clair
    "2": "#7ae7bf",   # jade
    "1": "#a4bdfc",   # Bleu pale
    "7": "#46d6db",   # bleu clair
    "9": "#5484ed",   # bleu foncé
    "3": "#dbadff",   # Violet clair
    "8": "#e1e1e1",   # gris clair
}

student_class_colors = {
    "7": ["2nd"],
    "8": ["aero"],
    "3": ["tmg"],
    "1": ["ap", "orientation"],
    "3": ["l2s3", "l1s2", "l2s4", "croqmaths", "imt"],
    "2": ["réunion", "reunion", "conseil", "PP", "default"],
    "5": ["1ere"],
    "4": ["tale"],
}


def get_event_color(string):
    '''
    Search for keywords in the description of the event.
    Return the color number (string) if something is found

    @param string: (str) the description of the event
    @return: (str or None) the
    '''
    words = string.lower().split(' ')
    print(words)
    for nb, tags in student_class_colors.items():
        for tag in tags:
            if tag.lower in string.lower():
                return nb
    # print("nothing found")
    return None


def explore_md_file(path):
    '''
    open a file and return the list of lines as str

    @param path: (str) the path of the given file
    @return: (list of str) every line is a string
    '''
    with open(path, mode='r') as f:
        file_lines = f.readlines()
        # print(file_lines)
    return file_lines


def get_date_from_line(line):
    '''
    Extract the date from a line :
    ## Lundi 02 septembre   -----> 2019-09-02 00:00:00
    ## Lundi 02 mai         -----> 2020-05-02 00:00:00

    @param line: (str) a line from the .md file
    @return: (datetime.datetime obj) a datetime at midnight (ie a date)
    '''
    # new date
    date_str = line[3:]
    date_list = date_str.strip().split(' ')
    # print(date_list)
    day_of_the_week = traduction_day[date_list[0]]
    day_nb = date_list[1]
    month = traduction_month[date_list[2]]
    year = get_current_year(month)
    date_str_strp = '-'.join([month, day_nb])
    date_str_strp = str(year) + '-' + date_str_strp
    date_day = datetime.datetime.strptime(date_str_strp, '%Y-%B-%d')

    return date_day


def get_current_year(md_month):
    '''
    Return the correct year.
    The year is either the current year or the next.
    It's the next only if we're setting events for
    after january 1st during the beggining of the current school year
    ie : today is 2019/09/31 and event is 2020/01/31

    @param md_month: (str)
    @return: (int)
    '''
    # TODO : ugly
    now = datetime.datetime.now()
    year = now.year
    month = now.month
    if md_month in monthes_end_year and month in range(8, 13):
        # is it before or after the end of civil year ?
        year += 1
    return year


def get_events_from_str(events_dic_str_from_lines):
    '''
    loop through the lines and extrac the events
    return them as a dict of datetime: list of events

    @param events_dic_str_from_lines : (str) formated like :

    * 8h-8h55 - s213 - 2nde 3
    * corriger exo machin chose
    * rendre devoir
    rendre travail truc
    @return: (dic) the events of that date datetime: list of events
        each event has the keys :
            * 'start':datetime,
            * 'end':datetime,
            * 'location':str
            * 'summary':str ('%' if no summary were given)
            * 'description':str (possibly empty or multiline)
            * 'colorId':str ('1' to '11')
    '''
    event_per_date = {}
    for dt_key, string_list in events_dic_str_from_lines.items():
        # print(dt_key, string_list)
        event_list = []
        for string_event in string_list:
            first_line = string_event[0]
            # * 8h55-9h50 - s215
            first_string_list = first_line.strip().split(' - ')
            # print(first_string_list)

            hours = first_string_list[0]
            start, end = get_hours(dt_key, hours)
            if len(first_string_list) > 1:
                location = first_string_list[1]
            event = {
                "start": start,
                "end": end,
                "location": location,
            }
            if len(first_string_list) > 2:
                student_class = first_string_list[2]
                event["summary"] = student_class
            else:
                event["summary"] = '%'
            color_retrieved = get_event_color(event["summary"])
            if color_retrieved:
                event["colorId"] = color_retrieved
                print(event["colorId"])
            if len(first_line) > 1:
                description = '\n'.join(string_event[1:])
                description = description.strip()
                description_html = get_html(description)
                event["description"] = description_html
            event_list.append(event)
        event_per_date[dt_key] = event_list
    return event_per_date


def get_html(description):
    '''
    format a string from markdown to html
    @param description: (str) mardkdown formated string
    @return: (str) equivalent string in html format
    '''
    description_html = markdown.markdown(description)
    return description_html


def get_hours(dt_key, hours):
    """
    Extract the start and end datetime of a given string

    @param dt_key: datetime.datetime(2019, 9, 6, 0, 0)
    @param hours: (str) '* 8h55-9h50'
    @return: (tuple) (start, end)
        example :
        'end': datetime.datetime(2019, 9, 2, 10, 55),
        'start': datetime.datetime(2019, 9, 2, 10, 0),


        start = {
            'dateTime': '2019-08-09T14:00:00+02:00',
            'timeZone': 'Europe/Paris',
            }
        end = {
        'dateTime': '2019-08-09T15:00:00+02:00'}
        'timeZone': 'Europe/Paris',
        }
    """
    hours = hours[2:]
    hours_list = hours.split('-')

    start_str = hours_list[0]
    end_str = hours_list[1]

    start_hour, start_minute = get_hours_minute(start_str)
    end_hour, end_minute = get_hours_minute(end_str)

    year = dt_key.year
    month = dt_key.month
    day = dt_key.day

    start = datetime.datetime(year, month, day, start_hour, start_minute)
    end = datetime.datetime(year, month, day, end_hour, end_minute)

    start = {'dateTime': format_dt_for_event(start), 'timeZone': 'Europe/Paris'}
    end = {'dateTime': format_dt_for_event(end), 'timeZone': 'Europe/Paris'}

    return start, end


def get_hours_minute(time_str):
    '''
    Extract an hour a minute from a string
    we could use datetime.strptime but it's dirtier and quicker (to code)
    @param time_str: (str) french time format : 8h35
    @return: (tuple of int) (hour, minute) : (8, 35)
    '''
    time_list = time_str.split('h')
    time_hour = int(time_list[0])
    time_minute = 0 if time_list[1] == '' else int(time_list[1])
    return time_hour, time_minute


def get_offset_at_given_date(time_of_event):
    '''
    Get the offset (1 or 2 at a give date)

    During summer Europe/Paris is +2 hours offset from UTC
    During summer Europe/Paris is +1 hours offset from UTC

    @param time_of_event: (datetime)
    @return: (int)
    '''
    cet = pytz.timezone('CET')
    offset_delta = cet.utcoffset(time_of_event)
    offset_hours = int(offset_delta.total_seconds()/3600)
    return offset_hours


def format_dt_for_event(time_of_event):
    '''
    '2019-08-09T15:00:00+02:00'

    The date is correctly offseted (+1 or +2 according to offset)
    '''

    offset = get_offset_at_given_date(time_of_event)

    # time_format = "%Y-%m-%dT%H:%M:00+02:00"
    time_format = f"%Y-%m-%dT%H:%M:00+0{offset}:00"
    return datetime.datetime.strftime(time_of_event, time_format)


def get_event_from_lines(file_lines):
    '''
    Extract the events from lines of a file

    Return them as a dic of list of dic (to be flattened)
    see other functions for more detailled description of the events

    @param file_lines: (list of str) the lines of the md file
    @return : (dic)
    '''
    events_dic_str_from_lines = {}

    nb_file_lines = len(file_lines)

    for line_nb in range(nb_file_lines):
        line = file_lines[line_nb]

        if line.startswith('##'):
            # it's a new day...
            events_list_from_day = []
            date_day = get_date_from_line(line)
            # next line must be blank
            line_nb += 2
            if line_nb >= nb_file_lines:
                break
            line = file_lines[line_nb]
            while line.startswith('*'):
                # we extract the events from the day
                events_list_from_day.append([line.strip()])
                line_nb += 1
                line = file_lines[line_nb]
                while line.startswith('  ') or line in ['\n', '\r\n']:
                    # each description must be INSIDE the event so
                    # spaces must be present at the beginning of the line
                    events_list_from_day[-1].append(line.strip())
                    line_nb += 1
                    line = file_lines[line_nb]
            events_dic_str_from_lines[date_day] = events_list_from_day

        line_nb += 1
        # sunday is ommited if empty
    return events_dic_str_from_lines


def extract_events_from_file(path=None):
    '''
    Extract all the events of a week, given by a md file
    see example_week_md_path file for a given format

    @param path: (str) path of the .md file
    @return : (list) all the events of a given week
    each event has the keys :
            * 'start':datetime,
            * 'end':datetime,
            * 'location':str
            * 'summary':str ('%' if no summary were given)
            * 'description':str (possibly empty or multiline)
            * 'colorId':str ('1' to '11')

    '''
    if not path:
        # example mode
        print("PATH NOT PROVIDED USING DEFAULT PATH")
        path = example_week_md_path
    file_lines = explore_md_file(path)
    # pprint(file_lines)
    events_dic_str_from_lines = get_event_from_lines(file_lines)
    # pprint(events_dic_str_from_lines)
    events_from_str = get_events_from_str(events_dic_str_from_lines)
    # pprint(events_from_str)
    nested_events = list(events_from_str.values())
    flat_events = [item for sublist in nested_events for item in sublist]
    print(flat_events)
    return flat_events


if __name__ == '__main__':
    # events = extract_events_from_file()
    # pprint(events)

    print(get_event_color("2ND9"))