1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
|
"""
This module provides utility functions for formatting strings and dates.
Functions:
camel_to_underscore(name: str) -> str:
Convert camel case style naming to underscore/snake case style naming.
apply_recursive(function: Callable[[str], str], data: OptionalScope = None,
**kwargs: Any) -> OptionalScope:
Apply a function to all keys in a scope recursively.
timesince(dt: Union[datetime.datetime, datetime.timedelta],
default: str = 'just now') -> str:
Returns string representing 'time since' e.g. 3 days ago, 5 hours ago.
"""
# pyright: reportUnnecessaryIsInstance=false
import datetime
from python_utils import types
def camel_to_underscore(name: str) -> str:
"""Convert camel case style naming to underscore/snake case style naming.
If there are existing underscores they will be collapsed with the
to-be-added underscores. Multiple consecutive capital letters will not be
split except for the last one.
>>> camel_to_underscore('SpamEggsAndBacon')
'spam_eggs_and_bacon'
>>> camel_to_underscore('Spam_and_bacon')
'spam_and_bacon'
>>> camel_to_underscore('Spam_And_Bacon')
'spam_and_bacon'
>>> camel_to_underscore('__SpamAndBacon__')
'__spam_and_bacon__'
>>> camel_to_underscore('__SpamANDBacon__')
'__spam_and_bacon__'
"""
output: types.List[str] = []
for i, c in enumerate(name):
if i > 0:
pc = name[i - 1]
if c.isupper() and not pc.isupper() and pc != '_':
# Uppercase and the previous character isn't upper/underscore?
# Add the underscore
output.append('_')
elif i > 3 and not c.isupper():
# Will return the last 3 letters to check if we are changing
# case
previous = name[i - 3 : i]
if previous.isalpha() and previous.isupper():
output.insert(len(output) - 1, '_')
output.append(c.lower())
return ''.join(output)
def apply_recursive(
function: types.Callable[[str], str],
data: types.OptionalScope = None,
**kwargs: types.Any,
) -> types.OptionalScope:
"""
Apply a function to all keys in a scope recursively.
>>> apply_recursive(camel_to_underscore, {'SpamEggsAndBacon': 'spam'})
{'spam_eggs_and_bacon': 'spam'}
>>> apply_recursive(
... camel_to_underscore,
... {
... 'SpamEggsAndBacon': {
... 'SpamEggsAndBacon': 'spam',
... }
... },
... )
{'spam_eggs_and_bacon': {'spam_eggs_and_bacon': 'spam'}}
>>> a = {'a_b_c': 123, 'def': {'DeF': 456}}
>>> b = apply_recursive(camel_to_underscore, a)
>>> b
{'a_b_c': 123, 'def': {'de_f': 456}}
>>> apply_recursive(camel_to_underscore, None)
"""
if data is None:
return None
elif isinstance(data, dict):
return {
function(key): apply_recursive(function, value, **kwargs)
for key, value in data.items()
}
else:
return data
def timesince(
dt: types.Union[datetime.datetime, datetime.timedelta],
default: str = 'just now',
) -> str:
"""
Returns string representing 'time since' e.g.
3 days ago, 5 hours ago etc.
>>> now = datetime.datetime.now()
>>> timesince(now)
'just now'
>>> timesince(now - datetime.timedelta(seconds=1))
'1 second ago'
>>> timesince(now - datetime.timedelta(seconds=2))
'2 seconds ago'
>>> timesince(now - datetime.timedelta(seconds=60))
'1 minute ago'
>>> timesince(now - datetime.timedelta(seconds=61))
'1 minute and 1 second ago'
>>> timesince(now - datetime.timedelta(seconds=62))
'1 minute and 2 seconds ago'
>>> timesince(now - datetime.timedelta(seconds=120))
'2 minutes ago'
>>> timesince(now - datetime.timedelta(seconds=121))
'2 minutes and 1 second ago'
>>> timesince(now - datetime.timedelta(seconds=122))
'2 minutes and 2 seconds ago'
>>> timesince(now - datetime.timedelta(seconds=3599))
'59 minutes and 59 seconds ago'
>>> timesince(now - datetime.timedelta(seconds=3600))
'1 hour ago'
>>> timesince(now - datetime.timedelta(seconds=3601))
'1 hour and 1 second ago'
>>> timesince(now - datetime.timedelta(seconds=3602))
'1 hour and 2 seconds ago'
>>> timesince(now - datetime.timedelta(seconds=3660))
'1 hour and 1 minute ago'
>>> timesince(now - datetime.timedelta(seconds=3661))
'1 hour and 1 minute ago'
>>> timesince(now - datetime.timedelta(seconds=3720))
'1 hour and 2 minutes ago'
>>> timesince(now - datetime.timedelta(seconds=3721))
'1 hour and 2 minutes ago'
>>> timesince(datetime.timedelta(seconds=3721))
'1 hour and 2 minutes ago'
"""
if isinstance(dt, datetime.timedelta):
diff = dt
else:
now = datetime.datetime.now()
diff = abs(now - dt)
periods = (
(diff.days / 365, 'year', 'years'),
(diff.days % 365 / 30, 'month', 'months'),
(diff.days % 30 / 7, 'week', 'weeks'),
(diff.days % 7, 'day', 'days'),
(diff.seconds / 3600, 'hour', 'hours'),
(diff.seconds % 3600 / 60, 'minute', 'minutes'),
(diff.seconds % 60, 'second', 'seconds'),
)
output: types.List[str] = []
for period, singular, plural in periods:
int_period = int(period)
if int_period == 1:
output.append(f'{int_period} {singular}')
elif int_period:
output.append(f'{int_period} {plural}')
if output:
return f'{" and ".join(output[:2])} ago'
return default
|