Skip to content

Commit f503d83

Browse files
committed
repurpose release_number to version to make it more useful
1 parent 939e427 commit f503d83

2 files changed

Lines changed: 15 additions & 18 deletions

File tree

imap_data_access/cli.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ def _release_parser(args: argparse.Namespace):
354354
release_type=args.release_type,
355355
start_date=args.start_date,
356356
end_date=args.end_date,
357-
release_number=getattr(args, "release_number", None),
357+
release_version=args.version,
358358
table=getattr(args, "table", None),
359359
descriptor=getattr(args, "descriptor", None),
360360
)
@@ -726,11 +726,15 @@ def main():
726726
choices=[e.value for e in ReleaseType],
727727
)
728728
parser_release.add_argument(
729-
"--release-number",
730-
type=int,
729+
"--version",
730+
type=str,
731731
required=False,
732-
metavar="NUMBER",
733-
help="Release number (required only when --release-type is 'release'). ",
732+
default="latest",
733+
metavar="str",
734+
help=(
735+
"Data version on which the release operation will be applied. "
736+
"E.g., 'v001.000' or 'latest' (default)"
737+
),
734738
)
735739
parser_release.add_argument(
736740
"--table",

imap_data_access/io.py

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ def release(
538538
release_type: str,
539539
start_date: str,
540540
end_date: str,
541-
release_number: Optional[int] = None,
541+
release_version: str = "latest",
542542
table: Optional[str] = None,
543543
descriptor: Optional[str] = None,
544544
) -> None:
@@ -554,9 +554,10 @@ def release(
554554
Start date in YYYYMMDD format
555555
end_date : str
556556
End date in YYYYMMDD format
557-
release_number : int, optional
558-
Release number. Defaults to ``None``. Required if release_type is
559-
'release' and should be an integer value
557+
release_version : str, optional
558+
Data version on which the release operation will be applied. For example,
559+
release type 'release' will mark version 'v001.000' or 'latest' (default)
560+
as released.
560561
table : str, optional
561562
Table for the release (``ancillary`` or ``science``). Optional.
562563
descriptor : str, optional
@@ -590,12 +591,6 @@ def release(
590591
f"Not a valid release type, please choose from {valid_release_types}"
591592
)
592593

593-
# Validate release_type == "release" requires release_number
594-
if release_type == ReleaseType.RELEASE.value and release_number is None:
595-
raise ValueError(
596-
"The 'release_number' parameter is required for 'release' release type."
597-
)
598-
599594
# Validate start_date
600595
if not file_validation.ImapFilePath.is_valid_date(start_date):
601596
raise ValueError("Not a valid start date, use format 'YYYYMMDD'.")
@@ -618,9 +613,7 @@ def release(
618613
"start_date": start_date,
619614
"end_date": end_date,
620615
}
621-
# Add release_number only if release_type is 'release'
622-
if release_type == ReleaseType.RELEASE.value:
623-
release_params["release_number"] = release_number
616+
release_params["release_version"] = release_version
624617

625618
# Add optional parameters if provided
626619
if table is not None:

0 commit comments

Comments
 (0)