dycw-utilities 0.166.30__py3-none-any.whl → 0.185.8__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. dycw_utilities-0.185.8.dist-info/METADATA +33 -0
  2. dycw_utilities-0.185.8.dist-info/RECORD +90 -0
  3. {dycw_utilities-0.166.30.dist-info → dycw_utilities-0.185.8.dist-info}/WHEEL +1 -1
  4. {dycw_utilities-0.166.30.dist-info → dycw_utilities-0.185.8.dist-info}/entry_points.txt +1 -0
  5. utilities/__init__.py +1 -1
  6. utilities/altair.py +17 -10
  7. utilities/asyncio.py +50 -72
  8. utilities/atools.py +9 -11
  9. utilities/cachetools.py +16 -11
  10. utilities/click.py +76 -19
  11. utilities/concurrent.py +1 -1
  12. utilities/constants.py +492 -0
  13. utilities/contextlib.py +23 -30
  14. utilities/contextvars.py +1 -23
  15. utilities/core.py +2581 -0
  16. utilities/dataclasses.py +16 -119
  17. utilities/docker.py +387 -0
  18. utilities/enum.py +1 -1
  19. utilities/errors.py +2 -16
  20. utilities/fastapi.py +5 -5
  21. utilities/fpdf2.py +2 -1
  22. utilities/functions.py +34 -265
  23. utilities/http.py +2 -3
  24. utilities/hypothesis.py +84 -29
  25. utilities/importlib.py +17 -1
  26. utilities/iterables.py +39 -575
  27. utilities/jinja2.py +145 -0
  28. utilities/jupyter.py +5 -3
  29. utilities/libcst.py +1 -1
  30. utilities/lightweight_charts.py +4 -6
  31. utilities/logging.py +24 -24
  32. utilities/math.py +1 -36
  33. utilities/more_itertools.py +4 -6
  34. utilities/numpy.py +2 -1
  35. utilities/operator.py +2 -2
  36. utilities/orjson.py +42 -43
  37. utilities/os.py +4 -147
  38. utilities/packaging.py +129 -0
  39. utilities/parse.py +35 -15
  40. utilities/pathlib.py +3 -120
  41. utilities/platform.py +8 -90
  42. utilities/polars.py +38 -32
  43. utilities/postgres.py +37 -33
  44. utilities/pottery.py +20 -18
  45. utilities/pqdm.py +3 -4
  46. utilities/psutil.py +2 -3
  47. utilities/pydantic.py +25 -0
  48. utilities/pydantic_settings.py +87 -16
  49. utilities/pydantic_settings_sops.py +16 -3
  50. utilities/pyinstrument.py +4 -4
  51. utilities/pytest.py +96 -125
  52. utilities/pytest_plugins/pytest_regressions.py +2 -2
  53. utilities/pytest_regressions.py +32 -11
  54. utilities/random.py +2 -8
  55. utilities/redis.py +98 -94
  56. utilities/reprlib.py +11 -118
  57. utilities/shellingham.py +66 -0
  58. utilities/shutil.py +25 -0
  59. utilities/slack_sdk.py +13 -12
  60. utilities/sqlalchemy.py +57 -30
  61. utilities/sqlalchemy_polars.py +16 -25
  62. utilities/subprocess.py +2590 -0
  63. utilities/tabulate.py +32 -0
  64. utilities/testbook.py +8 -8
  65. utilities/text.py +24 -99
  66. utilities/throttle.py +159 -0
  67. utilities/time.py +18 -0
  68. utilities/timer.py +31 -14
  69. utilities/traceback.py +16 -23
  70. utilities/types.py +42 -2
  71. utilities/typing.py +26 -14
  72. utilities/uuid.py +1 -1
  73. utilities/version.py +202 -45
  74. utilities/whenever.py +53 -150
  75. dycw_utilities-0.166.30.dist-info/METADATA +0 -41
  76. dycw_utilities-0.166.30.dist-info/RECORD +0 -98
  77. dycw_utilities-0.166.30.dist-info/licenses/LICENSE +0 -21
  78. utilities/aeventkit.py +0 -388
  79. utilities/atomicwrites.py +0 -182
  80. utilities/cryptography.py +0 -41
  81. utilities/getpass.py +0 -8
  82. utilities/git.py +0 -19
  83. utilities/gzip.py +0 -31
  84. utilities/json.py +0 -70
  85. utilities/pickle.py +0 -25
  86. utilities/re.py +0 -156
  87. utilities/sentinel.py +0 -73
  88. utilities/socket.py +0 -8
  89. utilities/string.py +0 -20
  90. utilities/tempfile.py +0 -77
  91. utilities/typed_settings.py +0 -152
  92. utilities/tzdata.py +0 -11
  93. utilities/tzlocal.py +0 -28
  94. utilities/warnings.py +0 -65
  95. utilities/zipfile.py +0 -25
  96. utilities/zoneinfo.py +0 -133
utilities/traceback.py CHANGED
@@ -13,28 +13,22 @@ from sys import stderr
13
13
  from traceback import TracebackException
14
14
  from typing import TYPE_CHECKING, override
15
15
 
16
- from utilities.atomicwrites import writer
17
- from utilities.errors import repr_error
18
- from utilities.iterables import OneEmptyError, one
19
- from utilities.pathlib import module_path, to_path
20
- from utilities.reprlib import (
16
+ from utilities.constants import (
17
+ LOCAL_TIME_ZONE_NAME,
21
18
  RICH_EXPAND_ALL,
22
19
  RICH_INDENT_SIZE,
23
20
  RICH_MAX_DEPTH,
24
21
  RICH_MAX_LENGTH,
25
22
  RICH_MAX_STRING,
26
23
  RICH_MAX_WIDTH,
27
- yield_mapping_repr,
28
24
  )
25
+ from utilities.core import OneEmptyError, get_now, get_now_local, one, write_text
26
+ from utilities.errors import repr_error
27
+ from utilities.pathlib import module_path, to_path
28
+ from utilities.reprlib import yield_mapping_repr
29
29
  from utilities.text import to_bool
30
- from utilities.tzlocal import LOCAL_TIME_ZONE_NAME
31
- from utilities.version import to_version
32
- from utilities.whenever import (
33
- format_compact,
34
- get_now,
35
- get_now_local,
36
- to_zoned_date_time,
37
- )
30
+ from utilities.version import to_version3
31
+ from utilities.whenever import format_compact, to_zoned_date_time
38
32
 
39
33
  if TYPE_CHECKING:
40
34
  from collections.abc import Callable, Iterator
@@ -48,7 +42,7 @@ if TYPE_CHECKING:
48
42
  MaybeCallableZonedDateTimeLike,
49
43
  PathLike,
50
44
  )
51
- from utilities.version import MaybeCallableVersionLike
45
+ from utilities.version import MaybeCallableVersion3Like
52
46
 
53
47
 
54
48
  ##
@@ -60,7 +54,7 @@ def format_exception_stack(
60
54
  *,
61
55
  header: bool = False,
62
56
  start: MaybeCallableZonedDateTimeLike = get_now,
63
- version: MaybeCallableVersionLike | None = None,
57
+ version: MaybeCallableVersion3Like | None = None,
64
58
  capture_locals: bool = False,
65
59
  max_width: int = RICH_MAX_WIDTH,
66
60
  indent_size: int = RICH_INDENT_SIZE,
@@ -91,18 +85,18 @@ def format_exception_stack(
91
85
  def _yield_header_lines(
92
86
  *,
93
87
  start: MaybeCallableZonedDateTimeLike = get_now,
94
- version: MaybeCallableVersionLike | None = None,
88
+ version: MaybeCallableVersion3Like | None = None,
95
89
  ) -> Iterator[str]:
96
90
  """Yield the header lines."""
97
91
  now = get_now_local()
98
92
  yield f"Date/time | {format_compact(now)}"
99
93
  start_use = to_zoned_date_time(start).to_tz(LOCAL_TIME_ZONE_NAME)
100
94
  yield f"Started | {format_compact(start_use)}"
101
- yield f"Duration | {(now - start_use).format_common_iso()}"
95
+ yield f"Duration | {(now - start_use).format_iso()}"
102
96
  yield f"User | {getuser()}"
103
97
  yield f"Host | {gethostname()}"
104
98
  yield f"Process ID | {getpid()}"
105
- version_use = "" if version is None else to_version(version)
99
+ version_use = "" if version is None else to_version3(version)
106
100
  yield f"Version | {version_use}"
107
101
  yield ""
108
102
 
@@ -197,7 +191,7 @@ def _trim_path(path: PathLike, pattern: str, /) -> Path | None:
197
191
  def make_except_hook(
198
192
  *,
199
193
  start: MaybeCallableZonedDateTimeLike = get_now,
200
- version: MaybeCallableVersionLike | None = None,
194
+ version: MaybeCallableVersion3Like | None = None,
201
195
  path: MaybeCallablePathLike | None = None,
202
196
  path_max_age: Delta | None = None,
203
197
  max_width: int = RICH_MAX_WIDTH,
@@ -236,7 +230,7 @@ def _make_except_hook_inner(
236
230
  /,
237
231
  *,
238
232
  start: MaybeCallableZonedDateTimeLike = get_now,
239
- version: MaybeCallableVersionLike | None = None,
233
+ version: MaybeCallableVersion3Like | None = None,
240
234
  path: MaybeCallablePathLike | None = None,
241
235
  path_max_age: Delta | None = None,
242
236
  max_width: int = RICH_MAX_WIDTH,
@@ -272,8 +266,7 @@ def _make_except_hook_inner(
272
266
  max_depth=max_depth,
273
267
  expand_all=expand_all,
274
268
  )
275
- with writer(path_log, overwrite=True) as temp:
276
- _ = temp.write_text(full)
269
+ write_text(path_log, full, overwrite=True)
277
270
  if path_max_age is not None:
278
271
  _make_except_hook_purge(path, path_max_age)
279
272
  if slack_url is not None: # pragma: no cover
utilities/types.py CHANGED
@@ -11,6 +11,7 @@ from re import Pattern
11
11
  from types import TracebackType
12
12
  from typing import (
13
13
  Any,
14
+ BinaryIO,
14
15
  ClassVar,
15
16
  Literal,
16
17
  Protocol,
@@ -65,6 +66,7 @@ type OpenMode = Literal[
65
66
  type MaybeCallable[T] = T | Callable[[], T]
66
67
  type MaybeStr[T] = T | str
67
68
  type MaybeType[T] = T | type[T]
69
+ type StrDict = dict[str, Any]
68
70
  type StrMapping = Mapping[str, Any]
69
71
  type StrStrMapping = Mapping[str, str]
70
72
  type TupleOrStrMapping = tuple[Any, ...] | StrMapping
@@ -89,6 +91,11 @@ class SupportsKeysAndGetItem(Protocol[_T, _T_co]):
89
91
  def __getitem__(self, key: _T, /) -> _T_co: ... # pragma: no cover
90
92
 
91
93
 
94
+ # compression
95
+ type Compression = Literal["bz2", "gzip", "lzma"]
96
+ type PathToBinaryIO = Callable[[PathLike], BinaryIO]
97
+
98
+
92
99
  # concurrent
93
100
  type Parallelism = Literal["processes", "threads"]
94
101
 
@@ -98,7 +105,7 @@ type Parallelism = Literal["processes", "threads"]
98
105
  class Dataclass(Protocol):
99
106
  """Protocol for `dataclass` classes."""
100
107
 
101
- __dataclass_fields__: ClassVar[dict[str, Any]]
108
+ __dataclass_fields__: ClassVar[StrDict]
102
109
 
103
110
 
104
111
  # datetime
@@ -127,7 +134,7 @@ type SequenceLT[T] = list[T] | tuple[T, ...]
127
134
  # iterables - dervied
128
135
  type MaybeSequence[T] = T | SequenceLT[T]
129
136
  type SequenceStr = SequenceLT[str]
130
- type CollectionStr = dict[str, Any] | frozenset[str] | set[str] | SequenceStr
137
+ type CollectionStr = StrDict | frozenset[str] | set[str] | SequenceStr
131
138
  # iterables - maybe str
132
139
  type MaybeCollectionStr = str | CollectionStr
133
140
  type MaybeSequenceStr = str | SequenceStr
@@ -213,16 +220,26 @@ class SupportsRound(Protocol[_T_co]):
213
220
  def __round__(self, ndigits: int, /) -> _T_co: ...
214
221
 
215
222
 
223
+ # os
224
+ type CopyOrMove = Literal["copy", "move"]
225
+ type IntOrAll = int | Literal["all"]
226
+
227
+
216
228
  # parse
217
229
  type ParseObjectExtra = Mapping[Any, Callable[[str], Any]]
218
230
  type SerializeObjectExtra = Mapping[Any, Callable[[Any], str]]
219
231
 
220
232
 
221
233
  # pathlib
234
+ type FileOrDir = Literal["file", "dir"]
222
235
  type PathLike = MaybeStr[Path]
223
236
  type MaybeCallablePathLike = MaybeCallable[PathLike]
224
237
 
225
238
 
239
+ # platform
240
+ type System = Literal["windows", "mac", "linux"]
241
+
242
+
226
243
  # random
227
244
  type Seed = int | float | str | bytes | bytearray | Random
228
245
 
@@ -231,10 +248,18 @@ type Seed = int | float | str | bytes | bytearray | Random
231
248
  type PatternLike = MaybeStr[Pattern[str]]
232
249
 
233
250
 
251
+ # retry
252
+ type Retry = tuple[int, Duration | None]
253
+
254
+
234
255
  # text
235
256
  type MaybeCallableStr = MaybeCallable[str]
236
257
 
237
258
 
259
+ # time
260
+ type Duration = Number | TimeDelta
261
+
262
+
238
263
  # traceback
239
264
  type ExcInfo = tuple[type[BaseException], BaseException, TracebackType]
240
265
  type OptExcInfo = ExcInfo | tuple[None, None, None]
@@ -245,6 +270,11 @@ type UUIDLike = MaybeStr[UUID]
245
270
  type MaybeCallableUUIDLike = MaybeCallable[UUIDLike | Seed]
246
271
 
247
272
 
273
+ # warnings
274
+ type FilterWarningsAction = Literal[
275
+ "error", "ignore", "always", "default", "module", "once"
276
+ ]
277
+
248
278
  # whenever
249
279
  type DateDeltaLike = MaybeStr[DateDelta]
250
280
  type DateLike = MaybeStr[Date]
@@ -288,6 +318,8 @@ type TimeZoneLike = (
288
318
 
289
319
  __all__ = [
290
320
  "TIME_ZONES",
321
+ "Compression",
322
+ "CopyOrMove",
291
323
  "Coro",
292
324
  "Dataclass",
293
325
  "DateDeltaLike",
@@ -296,11 +328,15 @@ __all__ = [
296
328
  "DateTimeDeltaLike",
297
329
  "DateTimeRoundMode",
298
330
  "Delta",
331
+ "Duration",
299
332
  "EnumLike",
300
333
  "ExcInfo",
301
334
  "ExceptionTypeLike",
335
+ "FileOrDir",
336
+ "FilterWarningsAction",
302
337
  "IPv4AddressLike",
303
338
  "IPv6AddressLike",
339
+ "IntOrAll",
304
340
  "LogLevel",
305
341
  "LoggerLike",
306
342
  "MathRoundMode",
@@ -330,12 +366,15 @@ __all__ = [
330
366
  "Parallelism",
331
367
  "ParseObjectExtra",
332
368
  "PathLike",
369
+ "PathToBinaryIO",
333
370
  "PatternLike",
334
371
  "PlainDateTimeLike",
372
+ "Retry",
335
373
  "Seed",
336
374
  "SequenceStr",
337
375
  "SerializeObjectExtra",
338
376
  "Sign",
377
+ "StrDict",
339
378
  "StrMapping",
340
379
  "StrStrMapping",
341
380
  "SupportsAbs",
@@ -351,6 +390,7 @@ __all__ = [
351
390
  "SupportsLT",
352
391
  "SupportsRichComparison",
353
392
  "SupportsRound",
393
+ "System",
354
394
  "TimeDeltaLike",
355
395
  "TimeLike",
356
396
  "TimeOrDateTimeDelta",
utilities/typing.py CHANGED
@@ -19,7 +19,6 @@ from typing import (
19
19
  TypeGuard,
20
20
  Union, # pyright: ignore[reportDeprecated]
21
21
  _TypedDictMeta, # pyright: ignore[reportAttributeAccessIssue]
22
- cast,
23
22
  get_origin,
24
23
  overload,
25
24
  override,
@@ -40,9 +39,16 @@ from whenever import (
40
39
  ZonedDateTime,
41
40
  )
42
41
 
43
- from utilities.iterables import unique_everseen
44
- from utilities.sentinel import Sentinel
45
- from utilities.types import Dataclass, StrMapping, TupleOrStrMapping, TypeLike
42
+ from utilities.constants import Sentinel
43
+ from utilities.core import unique_everseen
44
+ from utilities.types import (
45
+ Dataclass,
46
+ StrDict,
47
+ StrMapping,
48
+ StrStrMapping,
49
+ TupleOrStrMapping,
50
+ TypeLike,
51
+ )
46
52
 
47
53
 
48
54
  def get_args(obj: Any, /, *, optional_drop_none: bool = False) -> tuple[Any, ...]:
@@ -58,7 +64,7 @@ def get_args(obj: Any, /, *, optional_drop_none: bool = False) -> tuple[Any, ...
58
64
  ##
59
65
 
60
66
 
61
- def get_forward_ref_args(obj: Any, /) -> Mapping[str, str]:
67
+ def get_forward_ref_args(obj: Any, /) -> StrStrMapping:
62
68
  """Get the forward args."""
63
69
  return {
64
70
  k: v.__forward_arg__
@@ -139,7 +145,7 @@ def get_type_hints(
139
145
  globalns: StrMapping | None = None,
140
146
  localns: StrMapping | None = None,
141
147
  warn_name_errors: bool = False,
142
- ) -> dict[str, Any]:
148
+ ) -> StrDict:
143
149
  """Get the type hints of an object."""
144
150
  _ = {
145
151
  Date,
@@ -164,7 +170,7 @@ def get_type_hints(
164
170
  }
165
171
  globalns_use = globals() | ({} if globalns is None else dict(globalns))
166
172
  localns_use = {} if localns is None else dict(localns)
167
- result: dict[str, Any] = obj.__annotations__
173
+ result: StrDict = obj.__annotations__
168
174
  result = result | dict(get_forward_ref_args(obj))
169
175
  try:
170
176
  hints = _get_type_hints(
@@ -398,11 +404,8 @@ def _is_instance_typed_dict[T: _TypedDictMeta](
398
404
  localns: StrMapping | None = None,
399
405
  warn_name_errors: bool = False,
400
406
  ) -> TypeGuard[T]:
401
- if not isinstance(obj, dict):
402
- return False
403
- if not all(isinstance(k, str) for k in obj):
407
+ if not is_str_dict(obj):
404
408
  return False
405
- obj = cast("dict[str, Any]", obj)
406
409
  hints = get_type_hints(
407
410
  type_, globalns=globalns, localns=localns, warn_name_errors=warn_name_errors
408
411
  )
@@ -743,7 +746,15 @@ def is_set_type(obj: Any, /) -> bool:
743
746
  ##
744
747
 
745
748
 
746
- def is_string_mapping(obj: Any, /) -> TypeGuard[StrMapping]:
749
+ def is_str_dict(obj: Any, /) -> TypeGuard[StrDict]:
750
+ """Check if an object is a string mapping."""
751
+ return isinstance(obj, Mapping) and is_iterable_of(obj, str)
752
+
753
+
754
+ ##
755
+
756
+
757
+ def is_str_mapping(obj: Any, /) -> TypeGuard[StrMapping]:
747
758
  """Check if an object is a string mapping."""
748
759
  return isinstance(obj, Mapping) and is_iterable_of(obj, str)
749
760
 
@@ -846,7 +857,7 @@ def is_tuple(obj: Any, /) -> TypeGuard[tuple[Any, ...]]:
846
857
 
847
858
  def is_tuple_or_str_mapping(obj: Any, /) -> TypeGuard[TupleOrStrMapping]:
848
859
  """Check if an object is a tuple or string mapping."""
849
- return is_tuple(obj) or is_string_mapping(obj)
860
+ return is_tuple(obj) or is_str_mapping(obj)
850
861
 
851
862
 
852
863
  ##
@@ -937,7 +948,8 @@ __all__ = [
937
948
  "is_sequence_of_tuple_or_str_mapping",
938
949
  "is_sequence_type",
939
950
  "is_set_type",
940
- "is_string_mapping",
951
+ "is_str_dict",
952
+ "is_str_mapping",
941
953
  "is_subclass_gen",
942
954
  "is_tuple",
943
955
  "is_tuple_or_str_mapping",
utilities/uuid.py CHANGED
@@ -5,8 +5,8 @@ from random import Random
5
5
  from typing import TYPE_CHECKING, assert_never, overload
6
6
  from uuid import UUID, uuid4
7
7
 
8
+ from utilities.constants import Sentinel
8
9
  from utilities.random import get_state
9
- from utilities.sentinel import Sentinel
10
10
 
11
11
  if TYPE_CHECKING:
12
12
  from utilities.types import MaybeCallableUUIDLike, Seed