asfexample 0.0.2__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.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,5 @@
1
+ ASF Tooling Example
2
+ Copyright 2025-2026 The Apache Software Foundation
3
+
4
+ This product includes software developed at
5
+ The Apache Software Foundation (https://www.apache.org/).
@@ -0,0 +1,67 @@
1
+ Metadata-Version: 2.4
2
+ Name: asfexample
3
+ Version: 0.0.2
4
+ Summary: Example package for ASF Tooling
5
+ Author: ASF Tooling
6
+ Author-email: ASF Tooling <dev@tooling.apache.org>
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ License-File: NOTICE
10
+ Classifier: Programming Language :: Python :: 3 :: Only
11
+ Classifier: Programming Language :: Python :: 3.13
12
+ Classifier: Operating System :: OS Independent
13
+ Requires-Dist: pygit2>=1.18.1
14
+ Requires-Dist: tomlkit>=0.13.3
15
+ Requires-Python: >=3.13
16
+ Project-URL: Source, https://github.com/apache/tooling-asf-example
17
+ Description-Content-Type: text/markdown
18
+
19
+ # asfexample
20
+
21
+ **This package does not have official Apache Software Foundation (ASF) releases.**
22
+
23
+ This is an example test package issued by Tooling at the ASF. It contains no stable user facing functionality. We do not make guarantees about any of the interfaces contained herein, nor the continued existence of this package.
24
+
25
+ The purpose of this package is to test:
26
+
27
+ - Proposed package naming conventions and version schemes within ASF Infra and ASF Tooling
28
+ - GHA workflows for trickle down use in other ASF Tooling projects
29
+ - Interaction with the ATR platform presently under development by ASF Tooling
30
+
31
+ ## Proposed conventions
32
+
33
+ The proposed packaging conventions are:
34
+
35
+ - Use `asf${NAME}` or `${NAME}` for PyPI package names, depending on whether the package is for ASF use only or not
36
+ - Ensure that package code is in `${NAME}/` only
37
+ - Use `0.0.N` for versions, starting with `0.0.1`
38
+ - Increment `N` for each released version
39
+ - Use `0.0.(N+1).dev0+dev` for non-release `main` commits, starting with `0.0.1.dev0+dev`
40
+
41
+ The `+dev` makes it a local version, which PyPI will not accept, so a build from source can never be published as a release. The `.dev0` makes it a pre-release, so installers that can see both choose the release.
42
+
43
+ A package having three commits on `main`, then a release, then two more commits to `main`, then another release, will for example use the following versions:
44
+
45
+ ```
46
+ 0.0.1.dev0+dev
47
+ 0.0.1.dev0+dev
48
+ 0.0.1.dev0+dev
49
+ 0.0.1
50
+ 0.0.2.dev0+dev
51
+ 0.0.2.dev0+dev
52
+ 0.0.2
53
+ ```
54
+
55
+ These packaging conventions are proposed only for ASF Infra and Tooling packages which will be published to PyPI. Other packages, for internal use, may use any packaging conventions. Aligning with these conventions, if adopted, would, however, make it easier to promote internal packages to PyPI.
56
+
57
+ ## Releasing
58
+
59
+ To release `0.0.N`, run `uv version 0.0.N`, commit, tag that commit `v0.0.N`, and push both together with `git push --atomic origin main v0.0.N`. A tag pushed on its own after its commit is not checked by the hooks.
60
+
61
+ The upload waits for approval. One of the other maintainers listed in `.asf.yaml` must approve it on GitHub, and two members of ASF Tooling must approve it at https://releases.apache.org/gates.
62
+
63
+ Afterwards, run `uv version 0.0.(N+1).dev0+dev` with the next number filled in, commit, and push. Always set the version explicitly: `uv version --bump stable` keeps the `+dev`.
64
+
65
+ ## Development
66
+
67
+ Run `uv run prek install` once after cloning. Its hooks run the linters and check the version scheme on every commit, and add the type checks and tests on every push.
@@ -0,0 +1,49 @@
1
+ # asfexample
2
+
3
+ **This package does not have official Apache Software Foundation (ASF) releases.**
4
+
5
+ This is an example test package issued by Tooling at the ASF. It contains no stable user facing functionality. We do not make guarantees about any of the interfaces contained herein, nor the continued existence of this package.
6
+
7
+ The purpose of this package is to test:
8
+
9
+ - Proposed package naming conventions and version schemes within ASF Infra and ASF Tooling
10
+ - GHA workflows for trickle down use in other ASF Tooling projects
11
+ - Interaction with the ATR platform presently under development by ASF Tooling
12
+
13
+ ## Proposed conventions
14
+
15
+ The proposed packaging conventions are:
16
+
17
+ - Use `asf${NAME}` or `${NAME}` for PyPI package names, depending on whether the package is for ASF use only or not
18
+ - Ensure that package code is in `${NAME}/` only
19
+ - Use `0.0.N` for versions, starting with `0.0.1`
20
+ - Increment `N` for each released version
21
+ - Use `0.0.(N+1).dev0+dev` for non-release `main` commits, starting with `0.0.1.dev0+dev`
22
+
23
+ The `+dev` makes it a local version, which PyPI will not accept, so a build from source can never be published as a release. The `.dev0` makes it a pre-release, so installers that can see both choose the release.
24
+
25
+ A package having three commits on `main`, then a release, then two more commits to `main`, then another release, will for example use the following versions:
26
+
27
+ ```
28
+ 0.0.1.dev0+dev
29
+ 0.0.1.dev0+dev
30
+ 0.0.1.dev0+dev
31
+ 0.0.1
32
+ 0.0.2.dev0+dev
33
+ 0.0.2.dev0+dev
34
+ 0.0.2
35
+ ```
36
+
37
+ These packaging conventions are proposed only for ASF Infra and Tooling packages which will be published to PyPI. Other packages, for internal use, may use any packaging conventions. Aligning with these conventions, if adopted, would, however, make it easier to promote internal packages to PyPI.
38
+
39
+ ## Releasing
40
+
41
+ To release `0.0.N`, run `uv version 0.0.N`, commit, tag that commit `v0.0.N`, and push both together with `git push --atomic origin main v0.0.N`. A tag pushed on its own after its commit is not checked by the hooks.
42
+
43
+ The upload waits for approval. One of the other maintainers listed in `.asf.yaml` must approve it on GitHub, and two members of ASF Tooling must approve it at https://releases.apache.org/gates.
44
+
45
+ Afterwards, run `uv version 0.0.(N+1).dev0+dev` with the next number filled in, commit, and push. Always set the version explicitly: `uv version --bump stable` keeps the `+dev`.
46
+
47
+ ## Development
48
+
49
+ Run `uv run prek install` once after cloning. Its hooks run the linters and check the version scheme on every commit, and add the type checks and tests on every push.
@@ -0,0 +1,66 @@
1
+ [build-system]
2
+ requires = ["uv_build>=0.13.5,<0.14"]
3
+ build-backend = "uv_build"
4
+
5
+ [project]
6
+ name = "asfexample"
7
+ version = "0.0.2"
8
+ description = "Example package for ASF Tooling"
9
+ readme = "README.md"
10
+ requires-python = ">=3.13"
11
+ license = "Apache-2.0"
12
+ license-files = [
13
+ "LICENSE",
14
+ "NOTICE",
15
+ ]
16
+ classifiers = [
17
+ "Programming Language :: Python :: 3 :: Only",
18
+ "Programming Language :: Python :: 3.13",
19
+ "Operating System :: OS Independent",
20
+ ]
21
+ dependencies = [
22
+ "pygit2>=1.18.1",
23
+ "tomlkit>=0.13.3",
24
+ ]
25
+
26
+ [[project.authors]]
27
+ name = "ASF Tooling"
28
+ email = "dev@tooling.apache.org"
29
+
30
+ [project.urls]
31
+ Source = "https://github.com/apache/tooling-asf-example"
32
+
33
+ [project.scripts]
34
+ asfexample = "asfexample:main"
35
+
36
+ [dependency-groups]
37
+ dev = [
38
+ { include-group = "test" },
39
+ "prek",
40
+ "pyright",
41
+ "ruff",
42
+ "zizmor",
43
+ ]
44
+ test = ["pytest"]
45
+
46
+ [tool.ruff]
47
+ line-length = 120
48
+
49
+ [tool.ruff.lint]
50
+ ignore = []
51
+ select = [
52
+ "ASYNC",
53
+ "C90",
54
+ "E",
55
+ "F",
56
+ "I",
57
+ "N",
58
+ "RUF",
59
+ "TC",
60
+ "TID",
61
+ "UP",
62
+ "W",
63
+ ]
64
+
65
+ [tool.uv]
66
+ exclude-newer = "5 days"
@@ -0,0 +1,54 @@
1
+ [build-system]
2
+ requires = ["uv_build>=0.13.5,<0.14"]
3
+ build-backend = "uv_build"
4
+
5
+ [project]
6
+ name = "asfexample"
7
+ version = "0.0.2"
8
+ description = "Example package for ASF Tooling"
9
+ readme = "README.md"
10
+ requires-python = ">=3.13"
11
+ license = "Apache-2.0"
12
+ license-files = ["LICENSE", "NOTICE"]
13
+ authors = [{name = "ASF Tooling", email = "dev@tooling.apache.org"}]
14
+ classifiers = [
15
+ "Programming Language :: Python :: 3 :: Only",
16
+ "Programming Language :: Python :: 3.13",
17
+ "Operating System :: OS Independent",
18
+ ]
19
+ dependencies = [
20
+ "pygit2>=1.18.1",
21
+ "tomlkit>=0.13.3",
22
+ ]
23
+
24
+ [project.urls]
25
+ Source = "https://github.com/apache/tooling-asf-example"
26
+
27
+ [project.scripts]
28
+ asfexample = "asfexample:main"
29
+
30
+ [dependency-groups]
31
+ dev = [{ include-group = "test" }, "prek", "pyright", "ruff", "zizmor"]
32
+ test = ["pytest"]
33
+
34
+ [tool.ruff]
35
+ line-length = 120
36
+
37
+ [tool.ruff.lint]
38
+ ignore = []
39
+ select = [
40
+ "ASYNC", # flake8-async
41
+ "C90", # cyclomatic-complexity
42
+ "E", # pycodestyle
43
+ "F", # pyflakes
44
+ "I", # isort
45
+ "N", # pep8-naming
46
+ "RUF", # ruff-checks
47
+ "TC", # flake8-type-checking
48
+ "TID", # flake8-tidy-imports
49
+ "UP", # pyupgrade
50
+ "W" # pycodestyle warning
51
+ ]
52
+
53
+ [tool.uv]
54
+ exclude-newer = "5 days"
@@ -0,0 +1,261 @@
1
+ # Licensed to the Apache Software Foundation (ASF) under one
2
+ # or more contributor license agreements. See the NOTICE file
3
+ # distributed with this work for additional information
4
+ # regarding copyright ownership. The ASF licenses this file
5
+ # to you under the Apache License, Version 2.0 (the
6
+ # "License"); you may not use this file except in compliance
7
+ # with the License. You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ from __future__ import annotations
19
+
20
+ import argparse
21
+ import dataclasses
22
+ import enum
23
+ import importlib.metadata
24
+ import os
25
+ import pathlib
26
+ import re
27
+ import sys
28
+ import tempfile
29
+ from typing import Final, Literal, NoReturn
30
+
31
+ import pygit2
32
+ import tomlkit
33
+ import tomlkit.container
34
+ import tomlkit.items
35
+
36
+ # TODO: Move most of this to __main__.py or wherever is appropriate
37
+
38
+ PROJECT: Final[str] = "asfexample"
39
+
40
+
41
+ class BumpMode(enum.Enum):
42
+ RELEASE = "release"
43
+ DEV = "dev"
44
+ SPECIFIC = "specific"
45
+
46
+
47
+ @dataclasses.dataclass(frozen=True)
48
+ class HeadVersion:
49
+ major: int
50
+ minor: int
51
+ patch: int
52
+ dev: int | None
53
+
54
+ def __str__(self) -> str:
55
+ if self.dev is None:
56
+ return f"{self.major}.{self.minor}.{self.patch}"
57
+ return f"{self.major}.{self.minor}.{self.patch}.dev{self.dev}+dev"
58
+
59
+
60
+ ZERO_VERSION_SENTINEL: Final[HeadVersion] = HeadVersion(major=0, minor=0, patch=0, dev=None)
61
+
62
+
63
+ def bump_mode_from_args(
64
+ args: argparse.Namespace,
65
+ ) -> (
66
+ tuple[Literal[BumpMode.RELEASE], None] | tuple[Literal[BumpMode.DEV], None] | tuple[Literal[BumpMode.SPECIFIC], str]
67
+ ):
68
+ trace(f"args: {args}")
69
+ if args.bump_release:
70
+ return BumpMode.RELEASE, None
71
+ elif args.bump_dev:
72
+ return BumpMode.DEV, None
73
+ elif args.bump_specific is not None:
74
+ return BumpMode.SPECIFIC, args.bump_specific
75
+ report_error_and_exit("--bump-dev, --bump-release, or --bump-specific is required")
76
+
77
+
78
+ def cli_argument_parser() -> argparse.ArgumentParser:
79
+ parser = argparse.ArgumentParser(prog=PROJECT, add_help=True)
80
+ group = parser.add_mutually_exclusive_group()
81
+ group.add_argument("--bump-dev", action="store_true", help="bump to a dev version")
82
+ group.add_argument("--bump-release", action="store_true", help="bump to a release version")
83
+ group.add_argument("--bump-specific", metavar="V", help="bump to a specific version")
84
+ group.add_argument("--version", action="store_true", help="report the current version")
85
+ return parser
86
+
87
+
88
+ def current_repository(current_path: pathlib.Path) -> pygit2.Repository:
89
+ trace(f"current_path: {current_path}")
90
+ repository_directory = pygit2.discover_repository(str(current_path))
91
+ if repository_directory is None:
92
+ report_error_and_exit("not inside a git repository")
93
+ return pygit2.Repository(repository_directory)
94
+
95
+
96
+ def calculate_bumped_version(
97
+ repository: pygit2.Repository, mode: BumpMode, specific: str | None
98
+ ) -> tuple[HeadVersion, str]:
99
+ trace(f"calculate bumped version from mode: {mode}, specific: {specific}")
100
+ match mode:
101
+ case BumpMode.SPECIFIC:
102
+ if specific is None:
103
+ report_error_and_exit("specific version required")
104
+ return ZERO_VERSION_SENTINEL, str(parse_version(specific))
105
+ case BumpMode.RELEASE:
106
+ head_version = read_head_version(repository)
107
+ if head_version.dev is None:
108
+ report_error_and_exit(f"a dev version is required at HEAD to release, not {head_version}")
109
+ bumped = HeadVersion(
110
+ head_version.major,
111
+ head_version.minor,
112
+ head_version.patch,
113
+ None,
114
+ )
115
+ return head_version, str(bumped)
116
+ case BumpMode.DEV:
117
+ head_version = read_head_version(repository)
118
+ if head_version.dev is None:
119
+ bumped = HeadVersion(
120
+ head_version.major,
121
+ head_version.minor,
122
+ head_version.patch + 1,
123
+ 0,
124
+ )
125
+ return head_version, str(bumped)
126
+ return head_version, str(head_version)
127
+
128
+
129
+ def main() -> NoReturn:
130
+ raise SystemExit(run_cli())
131
+
132
+
133
+ def parse_version(version: str) -> HeadVersion:
134
+ trace(f"parsing version to HeadVersion: {version}")
135
+ match = re.fullmatch(r"(\d+)\.(\d+)\.(\d+)(?:\.dev(0)\+dev)?", version)
136
+ if not match:
137
+ report_error_and_exit(f"unsupported version format: {version}")
138
+ major = int(match.group(1))
139
+ minor = int(match.group(2))
140
+ patch = int(match.group(3))
141
+ dev = int(match.group(4)) if match.group(4) is not None else None
142
+ return HeadVersion(major=major, minor=minor, patch=patch, dev=dev)
143
+
144
+
145
+ def project_root_or_exit(project_root: pathlib.Path, project_name: str) -> None:
146
+ trace(f"check project root: {project_root}, project_name: {project_name}")
147
+ pyproject_path = project_root / "pyproject.toml"
148
+ if not pyproject_path.is_file():
149
+ report_error_and_exit(
150
+ f"must run from project root with pyproject.toml for {project_name}",
151
+ )
152
+ with pyproject_path.open("r", encoding="utf-8") as f:
153
+ data = tomlkit.load(f)
154
+ name = data.get("project", {}).get("name")
155
+ if name != project_name:
156
+ report_error_and_exit(f"pyproject.toml does not belong to '{project_name}'")
157
+
158
+
159
+ def read_head_version(repo: pygit2.Repository) -> HeadVersion:
160
+ trace(f"read head version from repository: {repo}")
161
+ if repo.is_bare:
162
+ report_error_and_exit("a working tree, not a bare git repository, is required")
163
+ try:
164
+ obj = repo.revparse_single("HEAD:pyproject.toml")
165
+ except Exception:
166
+ # This may be the first commit with pyproject.toml
167
+ return ZERO_VERSION_SENTINEL
168
+ if not isinstance(obj, pygit2.Blob):
169
+ report_error_and_exit("pyproject.toml is in HEAD, but not a regular file")
170
+ content = obj.data.decode("utf-8")
171
+ data = tomlkit.parse(content)
172
+ head_version = data.get("project", {}).get("version")
173
+ # TODO: Not tomlkit.items.String?
174
+ if not isinstance(head_version, str):
175
+ report_error_and_exit("version missing in pyproject.toml in HEAD")
176
+ return parse_version(head_version)
177
+
178
+
179
+ def replace_key_in_section(text: str, section: str, key: str, value: str) -> str:
180
+ trace(f"replace key in section: section: {section}, key: {key}, value: {value}")
181
+ # TODO: This is very messy and probably wrong, needs improvement
182
+ doc = tomlkit.parse(text)
183
+ current: tomlkit.container.Container = doc
184
+ for part in section.split("."):
185
+ item = current.get(part)
186
+ if not isinstance(item, tomlkit.items.Table):
187
+ current[part] = tomlkit.table()
188
+ item = current[part]
189
+ if not isinstance(item, tomlkit.items.Table):
190
+ # Should be impossible
191
+ report_error_and_exit(f"expected table, got {type(item)}")
192
+ current = item.value
193
+ current[key] = value
194
+ return tomlkit.dumps(doc)
195
+
196
+
197
+ def report_error_and_exit(message: str) -> NoReturn:
198
+ print(f"error: {message}", file=sys.stderr)
199
+ raise SystemExit(2)
200
+
201
+
202
+ def run_cli() -> int:
203
+ parser = cli_argument_parser()
204
+ args = parser.parse_args()
205
+ return run_using_args(args)
206
+
207
+
208
+ def run_using_args(args: argparse.Namespace) -> int:
209
+ # Report the current version if --version is present
210
+ if args.version:
211
+ print(importlib.metadata.version(PROJECT))
212
+ return 0
213
+
214
+ # Check that we are in the correct directory
215
+ current_path = pathlib.Path.cwd()
216
+ project_root_or_exit(current_path, PROJECT)
217
+
218
+ # Get the pygit2 repository, bump mode, and optional specific version
219
+ repository = current_repository(current_path)
220
+ mode, specific = bump_mode_from_args(args)
221
+
222
+ # Calculate the bumped version
223
+ head_version, bumped_version = calculate_bumped_version(repository, mode, specific)
224
+
225
+ # TODO: Allow paths to files containing the version to be specified
226
+ update_pyproject_version(bumped_version)
227
+
228
+ # Report the result
229
+ print(f"{head_version} -> {bumped_version}")
230
+ return 0
231
+
232
+
233
+ def trace(message: str) -> None:
234
+ print(f"trace: {message}", file=sys.stderr)
235
+
236
+
237
+ def update_pyproject_version(bumped_version: str) -> None:
238
+ trace(f"update pyproject version with bumped version: {bumped_version}")
239
+ pyproject_path = pathlib.Path("pyproject.toml")
240
+ tmp_fd, tmp_name = tempfile.mkstemp(prefix="pyproject.", suffix=".tmp", dir=str(pyproject_path.parent))
241
+ try:
242
+ with (
243
+ os.fdopen(tmp_fd, "w", encoding="utf-8", newline="") as tmp,
244
+ pyproject_path.open("r", encoding="utf-8", newline="") as src,
245
+ ):
246
+ content = src.read()
247
+ content = replace_key_in_section(content, "project", "version", bumped_version)
248
+ tmp.write(content)
249
+ os.replace(tmp_name, pyproject_path)
250
+ except Exception as exc:
251
+ try:
252
+ os.remove(tmp_name)
253
+ except Exception:
254
+ pass
255
+ report_error_and_exit(
256
+ f"failed to update pyproject.toml: {exc}; project may be in an inconsistent version state"
257
+ )
258
+
259
+
260
+ if __name__ == "__main__":
261
+ main()