drewcassidy/yaclog
1
0
Fork 0
mirror of https://github.com/drewcassidy/yaclog.git synced 2024-09-01 14:58:58 +00:00
Code Issues Projects Releases Wiki Activity

Version entries now have line numbers again

Browse Source
This commit is contained in:
Andrew Cassidy 2021-04-29 23:53:00 -07:00
parent 2be155c1c0
commit 17a17fea41
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
yaclog/changelog.py
View File

@ -14,6 +14,8 @@
# You should have received a copy of the GNU Affero General Public License # You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>. # along with this program. If not, see <https://www.gnu.org/licenses/>.
from __future__ import annotations
import datetime import datetime
import os import os
import re import re
@ -35,7 +37,7 @@ class VersionEntry:
def __init__(self, name: str = 'Unreleased', def __init__(self, name: str = 'Unreleased',
date: Optional[datetime.date] = None, tags: Optional[List[str]] = None, date: Optional[datetime.date] = None, tags: Optional[List[str]] = None,
link: Optional[str] = None, link_id: Optional[str] = None): link: Optional[str] = None, link_id: Optional[str] = None, line_no: Optional[int] = None):
""" """
Create a new version entry Create a new version entry
@ -44,6 +46,7 @@ class VersionEntry:
:param tags: The version's tags :param tags: The version's tags
:param link: The version's URL :param link: The version's URL
:param link_id: The version's link ID :param link_id: The version's link ID
:param line_no What line in the original file the version starts on
""" """
self.name: str = name self.name: str = name
@ -61,7 +64,7 @@ class VersionEntry:
self.link_id: Optional[str] = link_id self.link_id: Optional[str] = link_id
"""The version's link ID, uses the version name by default when writing""" """The version's link ID, uses the version name by default when writing"""
self.line_no: Optional[int] = None self.line_no: Optional[int] = line_no
"""What line the version occurs at in the file, or None if the version was not read from a file. """What line the version occurs at in the file, or None if the version was not read from a file.
This is not guaranteed to be correct after the changelog has been modified, This is not guaranteed to be correct after the changelog has been modified,
and it has no effect on the written file""" and it has no effect on the written file"""
@ -71,8 +74,15 @@ class VersionEntry:
Uncategorized changes have a section of an empty string.""" Uncategorized changes have a section of an empty string."""
@classmethod @classmethod
def from_header(cls, header: str): def from_header(cls, header: str, line_no: Optional[int] = None) -> VersionEntry:
version = cls() """
Create a new version entry from a markdown header
:param header: A markdown header to parse
:param line_no: Line number the header is on
:return: a new VersionEntry with the header's information
"""
version = cls(line_no=line_no)
match = cls.header_regex.match(header) match = cls.header_regex.match(header)
assert match, f'failed to parse version header: "{header}"' assert match, f'failed to parse version header: "{header}"'
@ -83,7 +93,7 @@ class VersionEntry:
try: try:
version.date = datetime.date.fromisoformat(match['date']) version.date = datetime.date.fromisoformat(match['date'])
except ValueError: except ValueError:
return cls(name=header.lstrip('#').strip()) return cls(name=header.lstrip('#').strip(), line_no=line_no)
if match['tags']: if match['tags']:
version.tags = [m['tag'].upper() for m in cls.tag_regex.finditer(match['tags'])] version.tags = [m['tag'].upper() for m in cls.tag_regex.finditer(match['tags'])]
@ -224,7 +234,7 @@ class Changelog:
if token.kind == 'h2': if token.kind == 'h2':
# start of a version # start of a version
self.versions.append(VersionEntry.from_header(text)) self.versions.append(VersionEntry.from_header(text, line_no=token.line_no))
section = '' section = ''
elif len(self.versions) == 0: elif len(self.versions) == 0: