fix: Type error with YAML dates in frontmatter #49
Conversation
When valid YAML dates or times are added to the page frontmatter, the
YAML parser will already convert them to datetime.date or
datetime.datetime objects.
Example:
---
date: 2023-04-12
---
This resulted in #strptime raising a TypeError because datetime.date
isn't a string. This commit changes the plugin code to always accept a
native datetime.date or datetime.datetime, even if meta_time_format is
not set, and handle them without string parsing.
Close liang2kl#48
jgraichen
force-pushed
the
fix/yaml-datetime
branch
from
5325de3
to
e07b738
Compare
mkdocs_blogging_plugin/plugin.py
Outdated
| timestamp = self._parse_time(page.meta["date"]) | ||
| if not timestamp: | ||
| else: |
There was a problem hiding this comment.
If time is included in the page meta but is not a date time, and meta_time_format is not set, this will end up with timestamp = None.
For example:
---
time: 5 minutes
date: 2024-04-12
---
The time meta could be meant for another plugin.
Using is None would try with "date" if "time" is present but cannot be parsed.
There was a problem hiding this comment.
Okay, I understand. Thank you for the explanation.
liang2kl
force-pushed
the
fix/yaml-datetime
branch
from
1460a4f
to
e07b738
Compare
|
By the way, could you please update the docs? The related stuff should be in the "Global Settings" section of |
|
I added an extra test about the fallback if
I've added a note. |
When valid YAML dates or times are added to the page frontmatter, the YAML parser will already convert them to
datetime.dateordatetime.datetimeobjects.Example:
This resulted in #strptime raising a
TypeErrorbecausedatetime.dateisn't a string. This commit changes the plugin code to always accept a nativedatetime.dateordatetime.datetime, even ifmeta_time_formatis not set, and handle them without string parsing.Close #48