mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
c5729420a4
* Update authors to "jrnl contributors" to comply with GPL3 * Include jrnl email address with contributors * Include GPL notice in jrnl --version * Apply consistent copyright and license to all Python files * Add copyright and license to documentation * Add copyright and license to docs theme * Wiping poetry cache to try to resolve a test issue * Testing with Python 3.9.0 in attempt to bypass GitHub Actions failure in 3.9.1 * make format * Exclude Windows Python 3.9 build which is failing due to a GitHub Actions problem * Modify testing to get around this 3.9 issue... * Fix exclude
135 lines
5 KiB
Python
135 lines
5 KiB
Python
#!/usr/bin/env python
|
|
# encoding: utf-8
|
|
# Copyright (C) 2012-2021 jrnl contributors
|
|
# License: https://www.gnu.org/licenses/gpl-3.0.html
|
|
|
|
import os
|
|
import re
|
|
import sys
|
|
|
|
from jrnl.color import ERROR_COLOR
|
|
from jrnl.color import RESET_COLOR
|
|
from jrnl.color import WARNING_COLOR
|
|
|
|
from .text_exporter import TextExporter
|
|
|
|
|
|
class YAMLExporter(TextExporter):
|
|
"""This Exporter can convert entries and journals into Markdown formatted text with YAML front matter."""
|
|
|
|
names = ["yaml"]
|
|
extension = "md"
|
|
|
|
@classmethod
|
|
def export_entry(cls, entry, to_multifile=True):
|
|
"""Returns a markdown representation of a single entry, with YAML front matter."""
|
|
if to_multifile is False:
|
|
print(
|
|
f"{ERROR_COLOR}ERROR{RESET_COLOR}: YAML export must be to individual files. Please \
|
|
specify a directory to export to.",
|
|
file=sys.stderr,
|
|
)
|
|
return
|
|
|
|
date_str = entry.date.strftime(entry.journal.config["timeformat"])
|
|
body_wrapper = "\n" if entry.body else ""
|
|
body = body_wrapper + entry.body
|
|
|
|
tagsymbols = entry.journal.config["tagsymbols"]
|
|
# see also Entry.Entry.rag_regex
|
|
multi_tag_regex = re.compile(fr"(?u)^\s*([{tagsymbols}][-+*#/\w]+\s*)+$")
|
|
|
|
"""Increase heading levels in body text"""
|
|
newbody = ""
|
|
heading = "#"
|
|
previous_line = ""
|
|
warn_on_heading_level = False
|
|
for line in body.splitlines(True):
|
|
if re.match(r"^#+ ", line):
|
|
"""ATX style headings"""
|
|
newbody = newbody + previous_line + heading + line
|
|
if re.match(r"^#######+ ", heading + line):
|
|
warn_on_heading_level = True
|
|
line = ""
|
|
elif re.match(r"^=+$", line.rstrip()) and not re.match(
|
|
r"^$", previous_line.strip()
|
|
):
|
|
"""Setext style H1"""
|
|
newbody = newbody + heading + "# " + previous_line
|
|
line = ""
|
|
elif re.match(r"^-+$", line.rstrip()) and not re.match(
|
|
r"^$", previous_line.strip()
|
|
):
|
|
"""Setext style H2"""
|
|
newbody = newbody + heading + "## " + previous_line
|
|
line = ""
|
|
elif multi_tag_regex.match(line):
|
|
"""Tag only lines"""
|
|
line = ""
|
|
else:
|
|
newbody = newbody + previous_line
|
|
previous_line = line
|
|
newbody = newbody + previous_line # add very last line
|
|
|
|
# make sure the export ends with a blank line
|
|
if previous_line not in ["\r", "\n", "\r\n", "\n\r"]:
|
|
newbody = newbody + os.linesep
|
|
|
|
if warn_on_heading_level is True:
|
|
print(
|
|
"{}WARNING{}: Headings increased past H6 on export - {} {}".format(
|
|
WARNING_COLOR, RESET_COLOR, date_str, entry.title
|
|
),
|
|
file=sys.stderr,
|
|
)
|
|
|
|
dayone_attributes = ""
|
|
if hasattr(entry, "uuid"):
|
|
dayone_attributes += "uuid: " + entry.uuid + "\n"
|
|
if (
|
|
hasattr(entry, "creator_device_agent")
|
|
or hasattr(entry, "creator_generation_date")
|
|
or hasattr(entry, "creator_host_name")
|
|
or hasattr(entry, "creator_os_agent")
|
|
or hasattr(entry, "creator_software_agent")
|
|
):
|
|
dayone_attributes += "creator:\n"
|
|
if hasattr(entry, "creator_device_agent"):
|
|
dayone_attributes += f" device agent: {entry.creator_device_agent}\n"
|
|
if hasattr(entry, "creator_generation_date"):
|
|
dayone_attributes += " generation date: {}\n".format(
|
|
str(entry.creator_generation_date)
|
|
)
|
|
if hasattr(entry, "creator_host_name"):
|
|
dayone_attributes += f" host name: {entry.creator_host_name}\n"
|
|
if hasattr(entry, "creator_os_agent"):
|
|
dayone_attributes += f" os agent: {entry.creator_os_agent}\n"
|
|
if hasattr(entry, "creator_software_agent"):
|
|
dayone_attributes += (
|
|
f" software agent: {entry.creator_software_agent}\n"
|
|
)
|
|
|
|
# TODO: copy over pictures, if present
|
|
# source directory is entry.journal.config['journal']
|
|
# output directory is...?
|
|
|
|
return "title: {title}\ndate: {date}\nstarred: {starred}\ntags: {tags}\n{dayone} {body} {space}".format(
|
|
date=date_str,
|
|
title=entry.title,
|
|
starred=entry.starred,
|
|
tags=", ".join([tag[1:] for tag in entry.tags]),
|
|
dayone=dayone_attributes,
|
|
body=newbody,
|
|
space="",
|
|
)
|
|
|
|
@classmethod
|
|
def export_journal(cls, journal):
|
|
"""Returns an error, as YAML export requires a directory as a target."""
|
|
print(
|
|
"{}ERROR{}: YAML export must be to individual files. Please specify a directory to export to.".format(
|
|
ERROR_COLOR, RESET_COLOR
|
|
),
|
|
file=sys.stderr,
|
|
)
|
|
return
|