greatday.repo module

Contains the Repo class.

class FileRepo(path)

Bases: potoroo._repo.Repo[str, greatday.todo.GreatTodo]

Repo that stores Todos on disk.

Parameters

path (Union[str, Path]) –

add(todo, /, *, key=None)

Write a new Todo to disk.

Returns a unique identifier that has been associated with this Todo.

Parameters

• todo (GreatTodo) –

• key (Optional[str]) –

Return type

Union[Ok[str, ErisError], Err[str, ErisError]]

all()

Retreive all Todos stored on disk.

get(key)

Retrieve a Todo from disk.

Parameters

key (str) –

Return type

ErisResult[GreatTodo | None]

remove(key)

Remove a Todo from disk.

Parameters

key (str) –

Return type

ErisResult[GreatTodo | None]

class SQLRepo(url, *, engine_factory=<functools._lru_cache_wrapper object>, verbose=0)

Bases: potoroo._repo.TaggedRepo[str, greatday.todo.GreatTodo, greatday.tag.GreatTag]

Repo that stores Todos in sqlite database.

Parameters

• url (str) –

• engine_factory (CreateEngineType) –

• verbose (int) –

add(todo, /, *, key=None)

Adds a new Todo to the DB.

Returns a unique identifier that has been associated with this Todo.

Parameters

• todo (GreatTodo) –

• key (Optional[str]) –

Return type

Union[Ok[str, ErisError], Err[str, ErisError]]

all()

Returns all Todos contained in the underlying SQL database.

get(key)

Retrieve a Todo from the DB.

Parameters

key (str) –

Return type

ErisResult[GreatTodo | None]

get_by_tag(tag)

Get Todo(s) from DB by using a tag.

remove(key)

Remove a Todo from the DB.

Parameters

key (str) –

Return type

ErisResult[GreatTodo | None]

remove_by_tag(tag)

Removes Todo(s) from DB by using a tag.

class SQLTag(session, tag)

Bases: object

Wrapper around Tag objects that helps build SQL statements.

Parameters

• session (Session) –

• tag (Tag) –

date_range_parser(stmt)

Parser for create/done dates (e.g. ‘^2000-01-01’ or ‘$5d:0d’).

Parameters

stmt (SelectOfScalar) –

Return type

SelectOfScalar

desc_parser(stmt)

Parser for todo description (e.g. ‘“foo”’ or ‘!”bar”’)

Parameters

stmt (SelectOfScalar) –

Return type

SelectOfScalar

done_parser(stmt)

Parser for done status (i.e. ‘x’ or ‘o’).

Parameters

stmt (SelectOfScalar) –

Return type

SelectOfScalar

metatag_parser(stmt)

Parser for metatags (e.g. ‘due<=0d’).

Parameters

stmt (SelectOfScalar) –

Return type

SelectOfScalar

prefix_tag_parser(stmt)

Parser for prefix tags (e.g. ‘@home’ or ‘+greatday’).

Parameters

stmt (SelectOfScalar) –

Return type

SelectOfScalar

priority_range_parser(stmt)

Parser for priority range (e.g. ‘(a-c)’).

Parameters

stmt (SelectOfScalar) –

Return type

SelectOfScalar

session

tag

to_stmt()

Constructs a SQL statement from the provided Tag object.

Return type

SelectOfScalar