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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
|
import argparse
import sys
from pathlib import Path
from typing import Mapping, Optional
from dunamai import check_version, Version, Pattern, Style, Vcs, VERSION_SOURCE_PATTERN
common_sub_args = [
{
"triggers": ["--metadata"],
"action": "store_true",
"dest": "metadata",
"default": None,
"help": "Always include metadata. Ignored when --format is used",
},
{
"triggers": ["--no-metadata"],
"action": "store_false",
"dest": "metadata",
"default": None,
"help": "Never include metadata. Ignored when --format is used",
},
{
"triggers": ["--dirty"],
"action": "store_true",
"dest": "dirty",
"help": "Include dirty flag if applicable. Ignored when --format is used",
},
{
"vcs": [Vcs.Git],
"triggers": ["--ignore-untracked"],
"action": "store_true",
"dest": "ignore_untracked",
"help": "Ignore untracked files when determining whether the repository is dirty",
},
{
"triggers": ["--tagged-metadata"],
"action": "store_true",
"dest": "tagged_metadata",
"help": "Include tagged metadata if applicable. Ignored when --format is used",
},
{
"triggers": ["--pattern"],
"default": VERSION_SOURCE_PATTERN,
"help": (
"Regular expression matched against the version source."
" This must contain one capture group named `base` corresponding to"
" the release segment of the source."
" Optionally, it may contain another two groups named `stage` and `revision`"
" corresponding to a prerelease type (such as 'alpha' or 'rc') and number"
" (such as in 'alpha-2' or 'rc3')."
" It may also contain a group named `tagged_metadata` corresponding to extra"
" metadata after the main part of the version (typically after a plus sign)."
" There may also be a group named `epoch` for the PEP 440 concept."
" If the `base` group is not present, then instead this will be interpreted"
" as a named preset, which may be one of the following: {}"
).format(", ".join(["`{}`".format(x.value) for x in Pattern])),
},
{
"triggers": ["--pattern-prefix"],
"help": "Insert this after the pattern's start anchor (`^`).",
},
{
"triggers": ["--format"],
"help": (
"Custom output format. Available substitutions:"
" {base}, {stage}, {revision}, {distance}, {commit}, {dirty},"
" {tagged_metadata}, {epoch}, {branch}, {branch_escaped}, {timestamp},"
" {major}, {minor}, {patch}"
),
},
{
"triggers": ["--style"],
"choices": [x.value for x in Style],
"help": (
"Preconfigured output format."
" Will default to PEP 440 if not set and no custom format given."
" If you specify both a style and a custom format, then the format"
" will be validated against the style's rules"
),
},
{
"triggers": ["--latest-tag"],
"action": "store_true",
"dest": "latest_tag",
"default": False,
"help": "Only inspect the latest tag on the latest tagged commit for a pattern match",
},
{
"triggers": ["--strict"],
"action": "store_true",
"dest": "strict",
"default": False,
"help": ("Elevate warnings to errors. When there are no tags, fail instead of falling back to 0.0.0"),
},
{
"triggers": ["--path"],
"help": "Directory to inspect, if not the current working directory",
},
{
"triggers": ["--debug"],
"action": "store_true",
"dest": "debug",
"default": False,
"help": "Display additional information on stderr for troubleshooting",
},
{
"triggers": ["--bump"],
"action": "store_true",
"dest": "bump",
"default": False,
"help": (
"Increment the last part of the version `base` by 1,"
" unless the `stage` is set, in which case increment the `revision`"
" by 1 or set it to a default of 2 if there was no `revision`"
" Does nothing when on a commit with a version tag."
),
},
{
"vcs": [Vcs.Git, Vcs.Mercurial],
"triggers": ["--full-commit"],
"action": "store_true",
"dest": "full_commit",
"default": False,
"help": "Get the full commit hash instead of the short form",
},
{
"triggers": ["--commit-length"],
"dest": "commit_length",
"type": int,
"help": "Use this many characters from the start of the full commit hash",
},
{
"triggers": ["--commit-prefix"],
"dest": "commit_prefix",
"type": str,
"help": "Add this prefix when serializing commit IDs",
},
{
"triggers": ["--escape-with"],
"dest": "escape_with",
"type": str,
"help": "When escaping, replace with this substitution. The default is simply to remove invalid characters.",
},
{
"vcs": [Vcs.Git],
"triggers": ["--tag-branch"],
"help": "Branch on which to find tags, if different than the current branch",
},
{
"vcs": [Vcs.Subversion],
"triggers": ["--tag-dir"],
"default": "tags",
"help": "Location of tags relative to the root",
},
]
cli_spec = {
"description": "Generate dynamic versions",
"sub_dest": "command",
"sub": {
"from": {
"description": "Generate version from a particular VCS",
"sub_dest": "vcs",
"sub": {
Vcs.Any.value: {
"description": "Generate version from any detected VCS",
"args": common_sub_args,
},
Vcs.Git.value: {
"description": "Generate version from Git",
"args": common_sub_args,
},
Vcs.Mercurial.value: {
"description": "Generate version from Mercurial",
"args": common_sub_args,
},
Vcs.Darcs.value: {
"description": "Generate version from Darcs",
"args": common_sub_args,
},
Vcs.Subversion.value: {
"description": "Generate version from Subversion",
"args": common_sub_args,
},
Vcs.Bazaar.value: {
"description": "Generate version from Bazaar",
"args": common_sub_args,
},
Vcs.Fossil.value: {
"description": "Generate version from Fossil",
"args": common_sub_args,
},
Vcs.Pijul.value: {
"description": "Generate version from Pijul",
"args": common_sub_args,
},
},
},
"check": {
"description": "Check if a version is valid for a style",
"args": [
{
"triggers": [],
"dest": "version",
"help": "Version to check; may be piped in",
"nargs": "?",
},
{
"triggers": ["--style"],
"choices": [x.value for x in Style],
"default": Style.Pep440.value,
"help": "Style against which to check",
},
],
},
},
}
def build_parser(
spec: Mapping, parser: Optional[argparse.ArgumentParser] = None, vcs: Optional[Vcs] = None
) -> argparse.ArgumentParser:
if parser is None:
parser = argparse.ArgumentParser(
description=spec["description"], formatter_class=argparse.ArgumentDefaultsHelpFormatter
)
if "args" in spec:
for arg in spec["args"]:
help = arg["help"]
if "vcs" in arg:
if vcs not in [*arg["vcs"], Vcs.Any]:
continue
help += " (only: {})".format(", ".join([x.name for x in arg["vcs"]]))
triggers = arg["triggers"]
parser.add_argument(
*triggers,
help=help,
**{k: v for k, v in arg.items() if k not in ["triggers", "help", "vcs"]},
)
if "sub" in spec:
subparsers = parser.add_subparsers(dest=spec["sub_dest"])
subparsers.required = True
for name, sub_spec in spec["sub"].items():
subparser = subparsers.add_parser(
name,
description=sub_spec.get("description"),
help=sub_spec.get("description"),
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
)
build_parser(sub_spec, subparser, Vcs(name) if spec["sub_dest"] == "vcs" else None)
return parser
def get_parser() -> argparse.ArgumentParser:
return build_parser(cli_spec)
def parse_args(argv=None) -> argparse.Namespace:
return get_parser().parse_args(argv)
def from_stdin(value: Optional[str]) -> Optional[str]:
if value is not None:
return value
if not sys.stdin.isatty():
return sys.stdin.readline().strip()
return None
def from_vcs(
vcs: Vcs,
pattern: str,
metadata: Optional[bool],
dirty: bool,
format: Optional[str],
style: Optional[Style],
latest_tag: bool,
tag_dir: str,
debug: bool,
bump: bool,
tagged_metadata: bool,
tag_branch: Optional[str],
full_commit: bool,
strict: bool,
path: Optional[Path],
pattern_prefix: Optional[str],
ignore_untracked: bool,
commit_length: Optional[int],
commit_prefix: Optional[str],
escape_with: Optional[str],
) -> None:
version = Version.from_vcs(
vcs,
pattern,
latest_tag,
tag_dir,
tag_branch,
full_commit,
strict,
path,
pattern_prefix,
ignore_untracked,
commit_length,
)
for concern in version.concerns:
print("Warning: {}".format(concern.message()), file=sys.stderr)
print(version.serialize(metadata, dirty, format, style, bump, tagged_metadata, commit_prefix, escape_with))
if debug:
print("# Matched tag: {}".format(version._matched_tag), file=sys.stderr)
print("# Newer unmatched tags: {}".format(version._newer_unmatched_tags), file=sys.stderr)
def main() -> None:
args = parse_args()
try:
if args.command == "from":
tag_dir = getattr(args, "tag_dir", "tags")
tag_branch = getattr(args, "tag_branch", None)
full_commit = getattr(args, "full_commit", False)
ignore_untracked = getattr(args, "ignore_untracked", False)
commit_length = getattr(args, "commit_length", None)
commit_prefix = getattr(args, "commit_prefix", None)
escape_with = getattr(args, "escape_with", None)
from_vcs(
Vcs(args.vcs),
args.pattern,
args.metadata,
args.dirty,
args.format,
Style(args.style) if args.style else None,
args.latest_tag,
tag_dir,
args.debug,
args.bump,
args.tagged_metadata,
tag_branch,
full_commit,
args.strict,
Path(args.path) if args.path is not None else None,
args.pattern_prefix,
ignore_untracked,
commit_length,
commit_prefix,
escape_with,
)
elif args.command == "check":
version = from_stdin(args.version)
if version is None:
raise ValueError("A version must be specified")
check_version(version, Style(args.style))
except Exception as e:
print(e, file=sys.stderr)
sys.exit(1)
if __name__ == "__main__":
main()
|