jepler/leapseconddata
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Document the commandline program

Browse source
This commit is contained in:
Jeff Epler 2024-07-06 16:31:06 -05:00
parent 24d1b5dfaa
commit 4541b73a1f
2 changed files with 48 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -15,3 +15,27 @@ fixed to the earth's rotation.
This module provides a class for parsing and validating the standard
`leap-seconds.list` file. Once parsed, it is possible to retrieve the
full list of leap seconds, or find the TAI-UTC offset for any UTC time.
# `leapsecond` program
Access leap second data from the command line.
```
Usage: leapsecond [OPTIONS] COMMAND [ARGS]...
Access leap second database information
Options:
--url TEXT URL for leap second data (unspecified to use default
source
--debug / --no-debug
--help Show this message and exit.
Commands:
convert Convert timestamps between TAI and UTC
info Show information about leap second database
next-leapsecond Get the next leap second after a given UTC timestamp
offset Get the UTC offset for a given moment, in seconds
previous-leapsecond Get the last leap second before a given UTC timestamp
table Print information about leap seconds
```

38
leapseconddata/__main__.py
View file

@ -34,8 +34,13 @@ class State:
leap_second_data: LeapSecondData
@click.group()
@click.option("--url", type=str, default=None)
@click.group(help="Access leap second database information")
@click.option(
"--url",
type=str,
default=None,
help="URL for leap second data (unspecified to use default source",
)
@click.option("--debug/--no-debug", type=bool)
@click.pass_context
def cli(ctx, url, debug) -> None:
@ -48,7 +53,7 @@ def cli(ctx, url, debug) -> None:
ctx.obj = LeapSecondData.from_url(url)
@cli.command()
@cli.command(help="Show information about leap second database")
@click.pass_context
def info(ctx) -> None:
leap_second_data = ctx.obj
@ -58,10 +63,10 @@ def info(ctx) -> None:
print(f"{len(leap_second_data.leap_seconds)-1} leap seconds")
@cli.command()
@cli.command(help="Get the UTC offset for a given moment, in seconds")
@click.pass_context
@click.option("--tai/--utc", "is_tai", default=False)
@click.argument("timestamp", type=UTCDateTime(), default=utcnow())
@click.argument("timestamp", type=UTCDateTime(), default=utcnow(), metavar="TIMESTAMP")
def offset(ctx, is_tai, timestamp: datetime.datetime) -> None:
leap_second_data = ctx.obj
if is_tai:
@ -69,10 +74,12 @@ def offset(ctx, is_tai, timestamp: datetime.datetime) -> None:
print(f"{leap_second_data.tai_offset(timestamp).total_seconds():.0f}")
@cli.command()
@cli.command(help="Convert timestamps between TAI and UTC")
@click.pass_context
@click.option("--to-tai/--to-utc", default=True)
@click.argument("timestamp", type=UTCDateTime(), default=None, required=False)
@click.argument(
"timestamp", type=UTCDateTime(), default=None, required=False, metavar="TIMESTAMP"
)
def convert(ctx, to_tai: bool, timestamp: datetime.datetime = None) -> None:
leap_second_data = ctx.obj
if to_tai:
@ -90,9 +97,9 @@ def convert(ctx, to_tai: bool, timestamp: datetime.datetime = None) -> None:
print(f"{when_utc:%Y-%m-%d %H:%M:%S} UTC")
@cli.command()
@cli.command(help="Get the next leap second after a given UTC timestamp")
@click.pass_context
@click.argument("timestamp", type=UTCDateTime(), default=utcnow())
@click.argument("timestamp", type=UTCDateTime(), default=utcnow(), metavar="TIMESTAMP")
def next_leapsecond(ctx, timestamp: datetime.datetime) -> None:
leap_second_data = ctx.obj
ls = min(
@ -106,9 +113,9 @@ def next_leapsecond(ctx, timestamp: datetime.datetime) -> None:
print(f"{ls.start:%Y-%m-%d %H:%M:%S} UTC")
@cli.command()
@cli.command(help="Get the last leap second before a given UTC timestamp")
@click.pass_context
@click.argument("timestamp", type=UTCDateTime(), default=utcnow())
@click.argument("timestamp", type=UTCDateTime(), default=utcnow(), metavar="TIMESTAMP")
def previous_leapsecond(ctx, timestamp: datetime.datetime) -> None:
leap_second_data = ctx.obj
ls = max(
@ -122,11 +129,14 @@ def previous_leapsecond(ctx, timestamp: datetime.datetime) -> None:
print(f"{ls.start:%Y-%m-%d %H:%M:%S} UTC")
@cli.command()
@cli.command(help="Print information about leap seconds")
@click.argument(
"start", type=UTCDateTime(), default=datetime.datetime(1972, 1, 1, tzinfo=utc)
"start",
type=UTCDateTime(),
default=datetime.datetime(1972, 1, 1, tzinfo=utc),
metavar="START-TIMESTAMP",
)
@click.argument("end", type=UTCDateTime(), default=utcnow())
@click.argument("end", type=UTCDateTime(), default=utcnow(), metavar="[END-TIMESTAMP]")
@click.pass_context
def table(ctx, start, end) -> None:
leap_second_data = ctx.obj