CodeMirror/manuskript
1
0
Fork 0
mirror of https://github.com/olivierkes/manuskript.git synced 2024-06-14 08:54:34 +12:00
Code Issues Projects Releases Wiki Activity

Fixes docstrings

Browse source
This commit is contained in:
Olivier Keshavjee 2017-11-06 09:30:33 +01:00
parent 572feb5409
commit 72b44fe90d
1 changed files with 20 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
manuskript/importer/opml.py
View file

@ -1,7 +1,6 @@
#!/usr/bin/env python #!/usr/bin/env python
# --!-- coding: utf8 --!-- # --!-- coding: utf8 --!--
# Import/export outline cards in OPML format
from PyQt5.QtWidgets import QMessageBox from PyQt5.QtWidgets import QMessageBox
from manuskript.models.outlineModel import outlineItem from manuskript.models.outlineModel import outlineItem
from manuskript.enums import Outline from manuskript.enums import Outline
@ -10,6 +9,9 @@ from manuskript.functions import mainWindow
def importOpml(opmlFilePath, idx): def importOpml(opmlFilePath, idx):
"""
Import/export outline cards in OPML format.
"""
ret = False ret = False
mw = mainWindow() mw = mainWindow()
@ -62,10 +64,9 @@ def importOpml(opmlFilePath, idx):
def parseItems(underElement, parentItem): def parseItems(underElement, parentItem):
text = underElement.get('text') text = underElement.get('text')
if text is not None: if text is not None:
"""
In the case where the title is exceptionally long, trim it so it isn't # In the case where the title is exceptionally long, trim it so it isn't
distracting in the tab label # distracting in the tab label
"""
title = text[0:32] title = text[0:32]
if len(title) < len(text): if len(title) < len(text):
title += '...' title += '...'
@ -79,11 +80,10 @@ def parseItems(underElement, parentItem):
body = restoreNewLines(note) body = restoreNewLines(note)
summary = body[0:128] summary = body[0:128]
else: else:
"""
There's no note (body), but there is a title. Fill the # There's no note (body), but there is a title. Fill the
body with the title to support cards that consist only # body with the title to support cards that consist only
of a title. # of a title.
"""
body = text body = text
card.setData(Outline.summaryFull.value, summary) card.setData(Outline.summaryFull.value, summary)
@ -101,35 +101,26 @@ def parseItems(underElement, parentItem):
return return
"""
Since XML parsers are notorious for stripping out significant newlines,
save them in a form we can restore after the parse.
"""
def saveNewlines(inString): def saveNewlines(inString):
"""
Since XML parsers are notorious for stripping out significant newlines,
save them in a form we can restore after the parse.
"""
inString = inString.replace("\r\n", "\n") inString = inString.replace("\r\n", "\n")
inString = inString.replace("\n", "{{lf}}") inString = inString.replace("\n", "{{lf}}")
return inString return inString
"""
Restore any significant newlines
"""
def restoreNewLines(inString): def restoreNewLines(inString):
"""
Restore any significant newlines
"""
return inString.replace("{{lf}}", "\n") return inString.replace("{{lf}}", "\n")
"""
Determine whether or not a string only contains whitespace.
"""
def isWhitespaceOnly(inString): def isWhitespaceOnly(inString):
"""
Determine whether or not a string only contains whitespace.
"""
str = restoreNewLines(inString) str = restoreNewLines(inString)
str = ''.join(str.split()) str = ''.join(str.split())