|
| 1 | +""" |
| 2 | +sphinxnotes.any.indexers |
| 3 | +~~~~~~~~~~~~~~~~~~~~~~~~ |
| 4 | +
|
| 5 | +:cls:`objects.Indexer` implementations. |
| 6 | +
|
| 7 | +:copyright: Copyright 2024 Shengyu Zhang |
| 8 | +:license: BSD, see LICENSE for details. |
| 9 | +""" |
| 10 | + |
| 11 | +from typing import Iterable, Literal, Callable |
| 12 | +from time import strptime, strftime |
| 13 | + |
| 14 | +from .objects import Indexer, Category, Value |
| 15 | + |
| 16 | + |
| 17 | +class LiteralIndexer(Indexer): |
| 18 | + name = 'literal' |
| 19 | + |
| 20 | + def classify(self, objref: Value) -> list[Category]: |
| 21 | + entries = [] |
| 22 | + for v in objref.as_list(): |
| 23 | + entries.append(Category(main=v)) |
| 24 | + return entries |
| 25 | + |
| 26 | + def anchor(self, refval: str) -> str: |
| 27 | + return refval |
| 28 | + |
| 29 | + |
| 30 | +DEFAULT_INDEXER = LiteralIndexer() |
| 31 | + |
| 32 | + |
| 33 | +class PathIndexer(Indexer): |
| 34 | + name = 'path' |
| 35 | + |
| 36 | + def __init__(self, sep: str, maxsplit: Literal[1, 2]): |
| 37 | + self.sep = sep |
| 38 | + self.maxsplit = maxsplit |
| 39 | + |
| 40 | + def classify(self, objref: Value) -> list[Category]: |
| 41 | + entries = [] |
| 42 | + for v in objref.as_list(): |
| 43 | + comps = v.split(self.sep, maxsplit=self.maxsplit) |
| 44 | + category = Category(main=comps[0], extra=v) |
| 45 | + if self.maxsplit == 2: |
| 46 | + category.sub = v[1] if len(comps) > 1 else None |
| 47 | + entries.append(category) |
| 48 | + return entries |
| 49 | + |
| 50 | + def anchor(self, refval: str) -> str: |
| 51 | + return refval.split(self.sep, maxsplit=self.maxsplit)[0] |
| 52 | + |
| 53 | + |
| 54 | +# I am Chinese :D |
| 55 | +# So the date formats follow Chinese conventions. |
| 56 | +# TODO: conf |
| 57 | +INPUTFMTS = ['%Y-%m-%d', '%Y-%m', '%Y'] |
| 58 | +DISPFMTS_Y = '%Y 年' |
| 59 | +DISPFMTS_M = '%m 月' |
| 60 | +DISPFMTS_YM = '%Y 年 %m 月' |
| 61 | +DISPFMTS_MD = '%m 月 %d 日，%a' |
| 62 | + |
| 63 | + |
| 64 | +class YearIndexer(Indexer): |
| 65 | + name = 'year' |
| 66 | + |
| 67 | + def __init__( |
| 68 | + self, |
| 69 | + inputfmts: list[str] = INPUTFMTS, |
| 70 | + dispfmt_y: str = DISPFMTS_Y, |
| 71 | + dispfmt_m: str = DISPFMTS_M, |
| 72 | + dispfmt_md: str = DISPFMTS_MD, |
| 73 | + ): |
| 74 | + """*xxxfmt* are date format used by time.strptime/strftime. |
| 75 | +
|
| 76 | + .. seealso:: https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes""" |
| 77 | + self.inputfmts = inputfmts |
| 78 | + self.dispfmt_y = dispfmt_y |
| 79 | + self.dispfmt_m = dispfmt_m |
| 80 | + self.dispfmt_md = dispfmt_md |
| 81 | + |
| 82 | + def classify(self, objref: Value) -> list[Category]: |
| 83 | + entries = [] |
| 84 | + for v in objref.as_list(): |
| 85 | + for datefmt in self.inputfmts: |
| 86 | + try: |
| 87 | + t = strptime(v, datefmt) |
| 88 | + except ValueError: |
| 89 | + continue # try next datefmt |
| 90 | + entries.append( |
| 91 | + Category( |
| 92 | + main=strftime(self.dispfmt_y, t), |
| 93 | + sub=strftime(self.dispfmt_m, t), |
| 94 | + extra=strftime(self.dispfmt_md, t), |
| 95 | + ) |
| 96 | + ) |
| 97 | + return entries |
| 98 | + |
| 99 | + def sort( |
| 100 | + self, data: Iterable[Indexer._T], key: Callable[[Indexer._T], Category] |
| 101 | + ) -> list[Indexer._T]: |
| 102 | + def sort_by_time(x: Category): |
| 103 | + t1 = strptime(x.main, self.dispfmt_y) |
| 104 | + t2 = strptime(x.sub, self.dispfmt_m) if x.sub else None |
| 105 | + t3 = strptime(x.extra, self.dispfmt_md) if x.extra else None |
| 106 | + return (t1, t2, t3) |
| 107 | + |
| 108 | + return sorted(data, key=lambda x: sort_by_time(key(x)), reverse=True) |
| 109 | + |
| 110 | + def anchor(self, refval: str) -> str: |
| 111 | + for datefmt in self.inputfmts: |
| 112 | + try: |
| 113 | + t = strptime(refval, datefmt) |
| 114 | + except ValueError: |
| 115 | + continue # try next datefmt |
| 116 | + anchor = strftime(self.dispfmt_y, t) |
| 117 | + return f'cap-{anchor}' |
| 118 | + return '' |
| 119 | + |
| 120 | + |
| 121 | +class MonthIndexer(Indexer): |
| 122 | + name = 'month' |
| 123 | + |
| 124 | + def __init__( |
| 125 | + self, |
| 126 | + inputfmts: list[str] = INPUTFMTS, |
| 127 | + dispfmt_ym: str = DISPFMTS_YM, |
| 128 | + dispfmt_md: str = DISPFMTS_MD, |
| 129 | + ): |
| 130 | + self.inputfmts = inputfmts |
| 131 | + self.dispfmt_ym = dispfmt_ym |
| 132 | + self.dispfmt_md = dispfmt_md |
| 133 | + |
| 134 | + def classify(self, objref: Value) -> list[Category]: |
| 135 | + entries = [] |
| 136 | + for v in objref.as_list(): |
| 137 | + for datefmt in self.inputfmts: |
| 138 | + try: |
| 139 | + t = strptime(v, datefmt) |
| 140 | + except ValueError: |
| 141 | + continue # try next datefmt |
| 142 | + entries.append( |
| 143 | + Category( |
| 144 | + main=strftime(self.dispfmt_ym, t), |
| 145 | + extra=strftime(self.dispfmt_md, t), |
| 146 | + ) |
| 147 | + ) |
| 148 | + return entries |
| 149 | + |
| 150 | + def sort( |
| 151 | + self, data: Iterable[Indexer._T], key: Callable[[Indexer._T], Category] |
| 152 | + ) -> list[Indexer._T]: |
| 153 | + def sort_by_time(x: Category): |
| 154 | + t1 = strptime(x.main, self.dispfmt_ym) |
| 155 | + t2 = strptime(x.sub, self.dispfmt_md) if x.sub else None |
| 156 | + return (t1, t2) |
| 157 | + |
| 158 | + return sorted(data, key=lambda x: sort_by_time(key(x)), reverse=True) |
| 159 | + |
| 160 | + def anchor(self, refval: str) -> str: |
| 161 | + for datefmt in self.inputfmts: |
| 162 | + try: |
| 163 | + t = strptime(refval, datefmt) |
| 164 | + except ValueError: |
| 165 | + continue # try next datefmt |
| 166 | + anchor = strftime(self.dispfmt_ym, t) |
| 167 | + return f'cap-{anchor}' |
| 168 | + return '' |
0 commit comments