habitmove/loop/repetitions.py

import sqlite3
import re


def migrate(db, habitlist, events):
    c = db.cursor()
    habits = simple_habits_list(c, habitlist)
    repetitions = extract_all_repetitions(habits, events)
    for rep in repetitions:
        add_to_database(c, rep["id"], rep["timestamp"])


def extract_all_repetitions(habits, events):
    """Return list of all repetitions found of habits in events passed in.
    Parameters:
    habits (list): Collection of habits, with minimum necessary fields description and id.
    events (list): Collection of events, with minimum necessary field end.
    Returns:
    repetitions (list): Collection of events transformed into Loop repetitions.
                        Contains fields id, timestamp, value (for ranges).
    """
    repetitions = []
    for event in events:
        text = event["note"]
        tags = extract_tags(text)
        for habit in habits:
            for tag in tags:
                if habit["description"] in tag[0]:
                    print(f"found event: {habit['name']} in {text} at {event['end']}")
                    repetitions.append({"id": habit["id"], "timestamp": event["end"]})
    return repetitions


def extract_tags(text, tagmarker="#"):
    """Return lists of tuples of all event tags found in text.
    Parameters:
    text (str): The text to search through.
    tagmarker (str): Optional character marking beginning of tag, defaults to '#'.
    Returns:
    tags (list): List of tuples in the form [('tag', '3'), ('anothertag', '')].
    """
    found_tags = re.findall(rf"{tagmarker}(\w+)(?:\((\d+)\))?", text)
    return found_tags


def simple_habits_list(c, habitlist):
    """Return simplified collection of habits, only carrying name, tag, id.
    Parameters:
    c (sqlite.db.cursor): SQL cursor of database to query.
    habitlist (list): Full habit collection to return a simplified view of.
    Returns:
    habitlist (list): Simple habitlist, habit name, tag, and id.
                      Copy of original, changes do not affect original.
    """
    simple = []
    for h in habitlist:
        simple.append(
            {
                "name": h["name"],
                "description": h["description"],
                "id": fetch_habit_id(c, h["uuid"]),
            }
        )
    return simple


def fetch_habit_id(c, uuid):
    """Return sqlite internal id for habit with uuid.
    Parameters:
    c (sqlite.db.cursor): SQL cursor of database to query.
    uuid (str): Unique id of habit to query for.
    Returns:
    id (int): SQLite internal id for habit queried for.
    """
    c.execute("select id from Habits where uuid = ?", ([uuid]))
    id = c.fetchone()
    if id is not None:
        return id[0]


# does not do:
# ranges in habits (should check for habit being range, then taking #habit(3) number into account)
# also, range trackers: multiply value by 1,000
# non-range habits but still #habit(3) number included, adding multiple?


def add_to_database(cursor, habit_id, timestamp, value=2):
    try:
        cursor.execute(
            """
            INSERT INTO
            Repetitions(id, habit, timestamp, value)
            VALUES (NULL, ?, ?, ?)
            """,
            (habit_id, timestamp, value),
        )
    except sqlite3.IntegrityError:
        # TODO better error handling
        print(f"fail to register {habit_id}: timestamp {timestamp} not unique")
        pass