Interactive and asynchronous stdin console written in pure Python and asyncio with extension support Can be used together with any Python project that uses asyncio, especially servers and web-based apps. Only POSIX operating systems are supported, such as Linux, *BSD, Solaris etc. Windows support isn't coming soon.
Simple quickstart that will bring on the working command prompt in asyncio environment:
importasynciofromadmin_consoleimportAdminCommandExecutor, basic_command_set, colorsasyncdefmain():
console=AdminCommandExecutor(use_config=False) # do not load config.json in the current directorybasic_command_set(console) # exit, extlist, extload, extunload etc.# Custom prompt formattingconsole.promptheader="Tutorial! "console.promptarrow="->"console.prompt_format['bold'] =Trueconsole.prompt_format['fgcolor'] =colors.GREENawaitconsole.load_extensions() # will create an "extensions/" in the working directoryawaitconsole.prompt_loop() # blocks until > exit is invokedif__name__=="__main__":
asyncio.run(main())
# Note: create extdep.txt in the extensions folder to sequentally load modules# Tutorial! -> Example of how to handle command dispatching and how to cancel some commands
fromadmin_consoleimportAdminCommand# Add handlerasyncdefhandler(cmd: AdminCommand, executor: AdminCommandExecutor, *args):
executor.print("Command executed! If this command's name contains bad, it is cancelled!")
if'bad'incmd.name:
returnFalse# cancel!console.cmdexec_event.add_handler(handler)
# Wait for the eventawaitconsole.cmdexec_event.wait_for_successful()
console.print("Some command is executed!")
# Wait until an event happens and then determine if this event passesasyncwithconsole.cmdexec_event.wait_and_handle() ashandle:
# success is True if this event is not cancelled, False otherwise# args is the list and kwargs is the dictionary of the arguments of an eventsuccess, args, kwargs=handle()
ifnotsuccess:
# event is already cancelledpasselifargs[0] ="bad"andkwargs["user"] ="hacker":
# cancel an eventhandle(False)
# Trigger an event and decide if it happened correctlycustom_event=console.events['some_custom_event'] # collections.defaultdict creates a new instance if there is no such an elementasyncwithcustom_event.emit_and_handle("good", "argument", 123, before=True) ashandle:
# putting before=True to evaluate the code before handlershandle(True) # make this event uncancellable, next time handle(False) call won't have an effectExtensions are importable Python script files (name.py) and they should be put in the extensions/ directory of the script.
Each extension script should have async def extension_init(self) and async def extension_cleanup(self) async function definitions,
where self is an instance of AdminCommandExtension. Example:
fromadmin_consoleimportAdminCommandExtensionasyncdefextension_init(self: AdminCommandExtension):
self.msg("Welcome here! Registering commands...")
asyncdefmy_command(cmd: AdminCommandExecutor, arg1: str, arg2: int, arg3: bool, arg4: float, arg5: str):
# do it yourselfpassasyncdefmy_command_tab(cmd: AdminCommandExecutor, *args, argl: str):
_len=len(args)
ifargl:
_len+=1if_len==0:
# arg1 is being tabbed, which is a single wordreturn"foo", "bar", "lore", "bug"elif_len==1:
# arg2 is being tabbed, which is int# do not tabcomplete an integer...passelif_len==2:
# it is possible to tabcomplete a boolean, which is just yes or noreturn"yes", "no"self.add_command(my_command, 'my-command', ((str, 'some word'), (int, 'your amount'), (bool, 'yes or no?'), (float, 'write precise PI here'), (None, 'long line...')), my_command_tab)
# do LITERALLY anything at the extension load time, but be careful: it stops the other extensions from loading while this function is runningasyncdefextension_cleanup(self: AdminCommandExtension):
self.msg("Goodbye...")Make a file at the extensions directory with the contents above. The extension should be .py, otherwise the script won't be imported.
To tell the extension loader to load scripts in the specified order, make extdep.txt in the extensions/ directory
and fill the file names (without .py) on each line.
Simple rendered reference is here: https://nobwow.github.io/admin_console.html
pip install -U git+https://github.com/NobWow/admin-console-python.git