comb-utils 0.3.0__tar.gz → 0.5.0__tar.gz

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.
@@ -1,10 +1,10 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: comb_utils
3
- Version: 0.3.0
3
+ Version: 0.5.0
4
4
  Summary: Handy utils for Python projects.
5
5
  Author: Kaleb Coberly
6
6
  Maintainer-email: kaleb.coberly@gmail.com
7
- Requires-Python: >=3.11
7
+ Requires-Python: >=3.12
8
8
  Description-Content-Type: text/markdown
9
9
  License-File: LICENSE
10
10
  Requires-Dist: typeguard
@@ -17,6 +17,7 @@ Requires-Dist: comb_utils[test]; extra == "dev"
17
17
  Provides-Extra: build
18
18
  Requires-Dist: build; extra == "build"
19
19
  Requires-Dist: twine; extra == "build"
20
+ Requires-Dist: wheel; extra == "build"
20
21
  Provides-Extra: doc
21
22
  Requires-Dist: furo; extra == "doc"
22
23
  Requires-Dist: sphinx; extra == "doc"
@@ -1,6 +1,6 @@
1
1
  [metadata]
2
2
  name = comb_utils
3
- version = 0.3.0
3
+ version = 0.5.0
4
4
  description = Handy utils for Python projects.
5
5
  long_description = file: README.md
6
6
  long_description_content_type = text/markdown
@@ -9,7 +9,7 @@ maintainer_email = kaleb.coberly@gmail.com
9
9
  copyright = 2025, Kaleb Coberly
10
10
 
11
11
  [options]
12
- python_requires = >=3.11
12
+ python_requires = >=3.12
13
13
  package_dir =
14
14
  =src
15
15
  packages = find:
@@ -29,6 +29,7 @@ dev =
29
29
  build =
30
30
  build
31
31
  twine
32
+ wheel
32
33
  doc =
33
34
  furo
34
35
  sphinx
@@ -1,7 +1,7 @@
1
1
  """Docstring formatting for sphinx API docs and click CLI help."""
2
2
 
3
3
  from dataclasses import dataclass
4
- from typing import Final
4
+ from typing import Any, Final
5
5
 
6
6
  from typeguard import typechecked
7
7
 
@@ -28,17 +28,20 @@ class ErrorDocString:
28
28
 
29
29
 
30
30
  class DocString:
31
- """Class to format docstrings for public API `sphinx` docs and CLI `click` help.
31
+ """Class to format docstrings and store argument defaults for public API `sphinx` docs \
32
+ and CLI `click` help.
32
33
 
33
34
  Args:
34
35
  opening: The opening docstring.
35
36
  args: Argument names and their docstrings.
37
+ defaults: The parameter defaults.
36
38
  raises: Objects holding error types with their docstrings.
37
39
  returns: The returns docstrings.
38
40
  """
39
41
 
40
42
  opening: str = ""
41
43
  args: dict[str, str] = {}
44
+ defaults: dict[str, Any] = {}
42
45
  raises: list[ErrorDocString] = []
43
46
  returns: list[str] = []
44
47
 
@@ -47,12 +50,14 @@ class DocString:
47
50
  self,
48
51
  opening: str,
49
52
  args: dict[str, str],
53
+ defaults: dict[str, Any],
50
54
  raises: list[ErrorDocString],
51
55
  returns: list[str],
52
56
  ) -> None:
53
57
  """Initialize the docstring parts."""
54
58
  self.opening = opening
55
59
  self.args = args
60
+ self.defaults = defaults
56
61
  self.raises = raises
57
62
  self.returns = returns
58
63
 
@@ -1,10 +1,10 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: comb_utils
3
- Version: 0.3.0
3
+ Version: 0.5.0
4
4
  Summary: Handy utils for Python projects.
5
5
  Author: Kaleb Coberly
6
6
  Maintainer-email: kaleb.coberly@gmail.com
7
- Requires-Python: >=3.11
7
+ Requires-Python: >=3.12
8
8
  Description-Content-Type: text/markdown
9
9
  License-File: LICENSE
10
10
  Requires-Dist: typeguard
@@ -17,6 +17,7 @@ Requires-Dist: comb_utils[test]; extra == "dev"
17
17
  Provides-Extra: build
18
18
  Requires-Dist: build; extra == "build"
19
19
  Requires-Dist: twine; extra == "build"
20
+ Requires-Dist: wheel; extra == "build"
20
21
  Provides-Extra: doc
21
22
  Requires-Dist: furo; extra == "doc"
22
23
  Requires-Dist: sphinx; extra == "doc"
@@ -4,6 +4,7 @@ requests<3.0.0,>=2.32.3
4
4
  [build]
5
5
  build
6
6
  twine
7
+ wheel
7
8
 
8
9
  [dev]
9
10
  comb_utils[build]
File without changes
File without changes
File without changes