mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
04f6154c93
[Travis] add a linting stage (via `black`) [Travis] update as per code review Remove "Lint" as separate stage; have `black` check the output rather than run the re-formmater
134 lines
4.2 KiB
Python
Executable file
134 lines
4.2 KiB
Python
Executable file
#!/usr/bin/env python
|
|
|
|
import re
|
|
import textwrap
|
|
from datetime import datetime
|
|
from .util import split_title
|
|
|
|
|
|
class Entry:
|
|
def __init__(self, journal, date=None, text="", starred=False):
|
|
self.journal = journal # Reference to journal mainly to access its config
|
|
self.date = date or datetime.now()
|
|
self.text = text
|
|
self._title = self._body = self._tags = None
|
|
self.starred = starred
|
|
self.modified = False
|
|
|
|
@property
|
|
def fulltext(self):
|
|
return self.title + " " + self.body
|
|
|
|
def _parse_text(self):
|
|
raw_text = self.text
|
|
lines = raw_text.splitlines()
|
|
if lines[0].strip().endswith("*"):
|
|
self.starred = True
|
|
raw_text = lines[0].strip("\n *") + "\n" + "\n".join(lines[1:])
|
|
self._title, self._body = split_title(raw_text)
|
|
if self._tags is None:
|
|
self._tags = list(self._parse_tags())
|
|
|
|
@property
|
|
def title(self):
|
|
if self._title is None:
|
|
self._parse_text()
|
|
return self._title
|
|
|
|
@property
|
|
def body(self):
|
|
if self._body is None:
|
|
self._parse_text()
|
|
return self._body
|
|
|
|
@property
|
|
def tags(self):
|
|
if self._tags is None:
|
|
self._parse_text()
|
|
return self._tags
|
|
|
|
@staticmethod
|
|
def tag_regex(tagsymbols):
|
|
pattern = fr"(?u)(?:^|\s)([{tagsymbols}][-+*#/\w]+)"
|
|
return re.compile(pattern)
|
|
|
|
def _parse_tags(self):
|
|
tagsymbols = self.journal.config["tagsymbols"]
|
|
return {
|
|
tag.lower() for tag in re.findall(Entry.tag_regex(tagsymbols), self.text)
|
|
}
|
|
|
|
def __str__(self):
|
|
"""Returns a string representation of the entry to be written into a journal file."""
|
|
date_str = self.date.strftime(self.journal.config["timeformat"])
|
|
title = "[{}] {}".format(date_str, self.title.rstrip("\n "))
|
|
if self.starred:
|
|
title += " *"
|
|
return "{title}{sep}{body}\n".format(
|
|
title=title,
|
|
sep="\n" if self.body.rstrip("\n ") else "",
|
|
body=self.body.rstrip("\n "),
|
|
)
|
|
|
|
def pprint(self, short=False):
|
|
"""Returns a pretty-printed version of the entry.
|
|
If short is true, only print the title."""
|
|
date_str = self.date.strftime(self.journal.config["timeformat"])
|
|
if self.journal.config["indent_character"]:
|
|
indent = self.journal.config["indent_character"].rstrip() + " "
|
|
else:
|
|
indent = ""
|
|
if not short and self.journal.config["linewrap"]:
|
|
title = textwrap.fill(
|
|
date_str + " " + self.title, self.journal.config["linewrap"]
|
|
)
|
|
body = "\n".join(
|
|
[
|
|
textwrap.fill(
|
|
line,
|
|
self.journal.config["linewrap"],
|
|
initial_indent=indent,
|
|
subsequent_indent=indent,
|
|
drop_whitespace=True,
|
|
)
|
|
or indent
|
|
for line in self.body.rstrip(" \n").splitlines()
|
|
]
|
|
)
|
|
else:
|
|
title = date_str + " " + self.title.rstrip("\n ")
|
|
body = self.body.rstrip("\n ")
|
|
|
|
# Suppress bodies that are just blanks and new lines.
|
|
has_body = len(self.body) > 20 or not all(
|
|
char in (" ", "\n") for char in self.body
|
|
)
|
|
|
|
if short:
|
|
return title
|
|
else:
|
|
return "{title}{sep}{body}\n".format(
|
|
title=title, sep="\n" if has_body else "", body=body if has_body else ""
|
|
)
|
|
|
|
def __repr__(self):
|
|
return "<Entry '{}' on {}>".format(
|
|
self.title.strip(), self.date.strftime("%Y-%m-%d %H:%M")
|
|
)
|
|
|
|
def __hash__(self):
|
|
return hash(self.__repr__())
|
|
|
|
def __eq__(self, other):
|
|
if (
|
|
not isinstance(other, Entry)
|
|
or self.title.strip() != other.title.strip()
|
|
or self.body.rstrip() != other.body.rstrip()
|
|
or self.date != other.date
|
|
or self.starred != other.starred
|
|
):
|
|
return False
|
|
return True
|
|
|
|
def __ne__(self, other):
|
|
return not self.__eq__(other)
|