-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #267 from quartiq/py-qol
py client: quality of life
- Loading branch information
Showing
7 changed files
with
758 additions
and
416 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| """Miniconf Client""" | ||
|
|
||
| from .miniconf import Miniconf, Client, MQTTv5, MiniconfException | ||
| from .discover import discover, discover_one | ||
| from . import sync, async_ | ||
| from .async_ import Miniconf, Client, MQTTv5, MiniconfException, discover, one |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,128 +1,9 @@ | ||
| """Miniconf command line interfae | ||
| """ | ||
| Command line interface for Miniconf-over-MQTT (asynchronous) | ||
| """ | ||
|
|
||
| import asyncio | ||
| import argparse | ||
| import logging | ||
| import json | ||
| import sys | ||
| import os | ||
|
|
||
| from .miniconf import Miniconf, MiniconfException, Client, MQTTv5 | ||
| from .discover import discover_one | ||
|
|
||
| if sys.platform.lower() == "win32" or os.name.lower() == "nt": | ||
| from asyncio import set_event_loop_policy, WindowsSelectorEventLoopPolicy | ||
|
|
||
| set_event_loop_policy(WindowsSelectorEventLoopPolicy()) | ||
|
|
||
|
|
||
| def main(): | ||
| """Main program entry point.""" | ||
| parser = argparse.ArgumentParser( | ||
| description="Miniconf command line interface.", | ||
| formatter_class=argparse.RawDescriptionHelpFormatter, | ||
| epilog="""Examples (with a target at prefix 'app/id'): | ||
| %(prog)s app/id '/stream="192.0.2.16:9293"' | ||
| %(prog)s -d app/+ /afe/0 # GET | ||
| %(prog)s -d app/+ '/afe/0="G10"' # SET | ||
| %(prog)s -d app/+ /afe/0= # CLEAR | ||
| %(prog)s -d app/+ /afe? # LIST-GET | ||
| %(prog)s -d app/+ 'afe! # DUMP | ||
| """, | ||
| ) | ||
| parser.add_argument( | ||
| "-v", "--verbose", action="count", default=0, help="Increase logging verbosity" | ||
| ) | ||
| parser.add_argument( | ||
| "--broker", "-b", default="mqtt", type=str, help="The MQTT broker address" | ||
| ) | ||
| parser.add_argument( | ||
| "--retain", | ||
| "-r", | ||
| default=False, | ||
| action="store_true", | ||
| help="Retain the settings that are being set on the broker", | ||
| ) | ||
| parser.add_argument( | ||
| "--discover", "-d", action="store_true", help="Detect device prefix" | ||
| ) | ||
| parser.add_argument( | ||
| "prefix", | ||
| type=str, | ||
| help="The MQTT topic prefix of the target or a prefix filter for discovery", | ||
| ) | ||
| parser.add_argument( | ||
| "commands", | ||
| metavar="CMD", | ||
| nargs="*", | ||
| help="Path to get ('PATH') or path and JSON encoded value to set " | ||
| "('PATH=VALUE') or path to clear ('PATH=') or path to list (`PATH?`) or " | ||
| "path to dump (`PATH!`). " | ||
| "Use sufficient shell escaping.", | ||
| ) | ||
| args = parser.parse_args() | ||
|
|
||
| logging.basicConfig( | ||
| format="%(asctime)s [%(levelname)s] %(name)s: %(message)s", | ||
| level=logging.WARN - 10 * args.verbose, | ||
| ) | ||
|
|
||
| async def run(): | ||
| async with Client( | ||
| args.broker, protocol=MQTTv5, logger=logging.getLogger("aiomqtt-client") | ||
| ) as client: | ||
| if args.discover: | ||
| prefix, _alive = await discover_one(client, args.prefix) | ||
| else: | ||
| prefix = args.prefix | ||
|
|
||
| interface = Miniconf(client, prefix) | ||
|
|
||
| for arg in args.commands: | ||
| if arg.endswith("?"): | ||
| path = arg.removesuffix("?") | ||
| assert path.startswith("/") or not path | ||
| paths = await interface.list(path) | ||
| # Note: There is no way for the CLI tool to reliably | ||
| # distinguish a one-element leaf get responce from a | ||
| # one-element inner list response without looking at | ||
| # the payload. | ||
| # The only way is to note that a JSON payload of a | ||
| # get can not start with the / that a list response | ||
| # starts with. | ||
| if len(paths) == 1 and not paths[0].startswith("/"): | ||
| print(f"{path}={paths[0]}") | ||
| continue | ||
| for p in paths: | ||
| try: | ||
| value = await interface.get(p) | ||
| print(f"{p}={value}") | ||
| except MiniconfException as err: | ||
| print(f"{p}: {repr(err)}") | ||
| elif arg.endswith("!"): | ||
| path = arg.removesuffix("!") | ||
| assert path.startswith("/") or not path | ||
| await interface.dump(path) | ||
| print(f"{path}: Dumped into MQTT namespace") | ||
| elif "=" in arg: | ||
| path, value = arg.split("=", 1) | ||
| assert path.startswith("/") or not path | ||
| if not value: | ||
| await interface.clear(path) | ||
| print(f"{path}: Cleared retained") | ||
| else: | ||
| await interface.set(path, json.loads(value), args.retain) | ||
| print(f"{path}={value}") | ||
| else: | ||
| path = arg | ||
| assert path.startswith("/") or not path | ||
| value = await interface.get(path) | ||
| print(f"{path}={value}") | ||
| await interface.close() | ||
|
|
||
| asyncio.run(run()) | ||
|
|
||
| from .async_ import _main | ||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
| asyncio.run(_main()) |
Oops, something went wrong.