mark/surplus
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

s+/#17: fix cli and better help message

Browse source
This commit is contained in:
Mark Joshwel 2023-09-02 04:37:41 +00:00
parent fd66a53c11
commit 30e6c009cc
1 changed files with 32 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
surplus.py
View file

@ -153,16 +153,17 @@ class Result(NamedTuple, Generic[ResultType]):
methods methods
def __bool__(self) -> bool: ... def __bool__(self) -> bool: ...
def get(self) -> ResultType: ... def get(self) -> ResultType: ...
def cry(self) -> str: ... def cry(self, string: bool = False) -> str: ...
example example
# do something # do something
try: try:
file_contents = Path(...).read_text() file_contents = Path(...).read_text()
except Exception as exc: except Exception as exc:
# must pass a default value
result = Result[str]("", error=exc) result = Result[str]("", error=exc)
else: else:
result = Result[str] result = Result[str](file_contents)
# handle result # handle result
if not result: if not result:
@ -690,8 +691,11 @@ def handle_args() -> Behaviour:
"--convert-to", "--convert-to",
type=str, type=str,
choices=[str(v.value) for v in ConversionResultTypeEnum], choices=[str(v.value) for v in ConversionResultTypeEnum],
help="converts query to another type", help=(
default="", "converts query a specific output type, defaults to "
f"'{Behaviour([]).convert_to_type.value}'"
),
default=Behaviour([]).convert_to_type.value,
) )
args = parser.parse_args() args = parser.parse_args()
@ -721,6 +725,8 @@ def surplus(
type of query object type of query object
behaviour: Behaviour behaviour: Behaviour
program behaviour namedtuple program behaviour namedtuple
returns Result[str]
""" """
def _unique(l: Sequence[str]) -> list[str]: def _unique(l: Sequence[str]) -> list[str]:
@ -735,6 +741,7 @@ def surplus(
# TODO # TODO
return "" return ""
"""
# get latlong and handle result # get latlong and handle result
latlong = query.to_lat_long_coord(geocoder=behaviour.geocoder) latlong = query.to_lat_long_coord(geocoder=behaviour.geocoder)
@ -743,6 +750,7 @@ def surplus(
if behaviour.debug: if behaviour.debug:
behaviour.stderr.write(f"debug: {latlong.get()=}\n") behaviour.stderr.write(f"debug: {latlong.get()=}\n")
"""
# operate on query # operate on query
text: str = "" text: str = ""
@ -750,12 +758,27 @@ def surplus(
match behaviour.convert_to_type: match behaviour.convert_to_type:
case ConversionResultTypeEnum.SHAREABLE_TEXT: case ConversionResultTypeEnum.SHAREABLE_TEXT:
# TODO # TODO
return Result[str]("", error="TODO") return Result[str](text, error="TODO")
case _: case ConversionResultTypeEnum.PLUS_CODE:
# TODO: https://github.com/markjoshwel/surplus/issues/18 # TODO: https://github.com/markjoshwel/surplus/issues/18
return Result[str]( return Result[str](
"", error="conversion functionality is not implemented yet" text, error="converting to Plus Code is not implemented yet"
)
case ConversionResultTypeEnum.LOCAL_CODE:
# TODO: https://github.com/markjoshwel/surplus/issues/18
return Result[str](
text, error="converting to Plus Code is not implemented yet"
)
case ConversionResultTypeEnum.LATLONG:
# TODO: https://github.com/markjoshwel/surplus/issues/18
return Result[str](text, error="converting to Latlong is not implemented yet")
case _:
return Result[str](
"", error=f"unknown conversion result type '{behaviour.convert_to_type}'"
) )
@ -763,6 +786,8 @@ def surplus(
def cli() -> int: def cli() -> int:
"""command-line entry point, returns an exit code int"""
# handle arguments and print version header # handle arguments and print version header
behaviour = handle_args() behaviour = handle_args()