This commit is contained in:
santaspeen 2022-02-20 22:13:31 +03:00
parent eba17bdd81
commit 931be6aa5e
13 changed files with 488 additions and 1 deletions

8
.idea/.gitignore generated vendored Normal file
View File

@ -0,0 +1,8 @@
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml

10
.idea/CLI-in-Python.iml generated Normal file
View File

@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/scr" isTestSource="false" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>

View File

@ -0,0 +1,45 @@
<component name="InspectionProjectProfileManager">
<profile version="1.0">
<option name="myName" value="Project Default" />
<inspection_tool class="DuplicatedCode" enabled="true" level="WEAK WARNING" enabled_by_default="true">
<Languages>
<language minSize="56" name="Python" />
</Languages>
</inspection_tool>
<inspection_tool class="PyArgumentEqualDefaultInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
<inspection_tool class="PyAugmentAssignmentInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
<inspection_tool class="PyBehaveInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PyClassicStyleClassInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PyMandatoryEncodingInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PyMissingTypeHintsInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
<inspection_tool class="PyPep8Inspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
<option name="ignoredErrors">
<list>
<option value="E501" />
<option value="E266" />
</list>
</option>
</inspection_tool>
<inspection_tool class="PyShadowingBuiltinsInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
<option name="ignoredNames">
<list>
<option value="Console" />
</list>
</option>
</inspection_tool>
<inspection_tool class="PyUnresolvedReferencesInspection" enabled="true" level="WARNING" enabled_by_default="true">
<option name="ignoredIdentifiers">
<list>
<option value="core.Console.Console.__create_help_message" />
<option value="core.Console.Console.__exit" />
<option value="core.Console.Console.__alias" />
<option value="core.Console.Console.__create_message" />
<option value="core.Console.Console.__builtins_print" />
<option value="core.Console.Console.__prompt_in" />
<option value="core.Console.Console.__not_found" />
<option value="console.__lshift__" />
</list>
</option>
</inspection_tool>
</profile>
</component>

View File

@ -0,0 +1,6 @@
<component name="InspectionProjectProfileManager">
<settings>
<option name="USE_PROJECT_PROFILE" value="false" />
<version value="1.0" />
</settings>
</component>

4
.idea/misc.xml generated Normal file
View File

@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectRootManager" version="2" project-jdk-name="Python 3.10" project-jdk-type="Python SDK" />
</project>

8
.idea/modules.xml generated Normal file
View File

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/CLI-in-Python.iml" filepath="$PROJECT_DIR$/.idea/CLI-in-Python.iml" />
</modules>
</component>
</project>

6
.idea/vcs.xml generated Normal file
View File

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>

View File

@ -11,4 +11,6 @@
* [Мой Telegram](https://t.me/SantaSpeen "SantaSpeen"): https://t.me/SantaSpeen * [Мой Telegram](https://t.me/SantaSpeen "SantaSpeen"): https://t.me/SantaSpeen
Используемые библиотеки: Используемые библиотеки:
*

42
scr/builtins_fix.pyi Normal file
View File

@ -0,0 +1,42 @@
class Console(object):
def __init__(self,
prompt_in: str = ">",
prompt_out: str = "]:",
not_found: str = "Command \"%s\" not found in alias.") -> None: ...
def __getitem__(self, item): ...
@property
def alias(self) -> dict: ...
def add(self, key: str, func: function) -> dict: ...
def log(self, s: str, r='\r') -> None: ...
def write(self, s: str, r='\r') -> None: ...
def __lshift__(self, s: AnyStr) -> None: ...
def logger_hook(self) -> None: ...
def builtins_hook(self) -> None: ...
def run(self) -> None: ...
def run_while(self, whl) -> None:...
class console(object):
@staticmethod
def alias() -> dict: ...
@staticmethod
def add(key: str, func: function) -> dict: ...
@staticmethod
def run() -> None: ...
@staticmethod
def run_while(whl: Any) -> None: ...
@staticmethod
def builtins_hook() -> None: ...
@staticmethod
def logger_hook() -> None: ...
@staticmethod
def log(s: str) -> None: ...
@staticmethod
def write(s: str) -> None: ...
@staticmethod
def __lshift__(s: AnyStr) -> None: ...

215
scr/console/Console.py Normal file
View File

@ -0,0 +1,215 @@
# -*- coding: utf-8 -*-
# Developed by Ahegao Devs
# Written by: SantaSpeen
# Licence: MIT
# (c) ahegao.ovh 2022
import builtins
import logging
import sys
import traceback
from typing import AnyStr
class ConsoleIO:
@staticmethod
def write(s: AnyStr):
sys.stdout.write(s)
@staticmethod
def write_err(s: AnyStr):
sys.stderr.write(s)
@staticmethod
def read():
return sys.stdin.readline().strip()
# noinspection PyUnusedLocal, PyShadowingBuiltins, PyUnresolvedReferences
class Console:
def __init__(self,
prompt_in: str = ">",
prompt_out: str = "]:",
not_found: str = "Command \"%s\" not found in alias.",
file: str or None = None,
debug: bool = False) -> None:
"""
def __init__(self,
prompt_in: str = ">",
prompt_out: str = "]:",
not_found: str = "Command \"%s\" not found in alias.") -> None:
:param prompt_in:
:param prompt_out:
:param not_found:
"""
self.__prompt_in = prompt_in
self.__prompt_out = prompt_out
self.__not_found = not_found + "\n"
self.__is_debug = debug
self.__print = print
self.__file = file
self.__alias = {
"help": self.__create_help_message,
}
self.get_IO = ConsoleIO
def __debug(self, *x):
if self.__is_debug:
x = list(x)
x.insert(0, "\r CONSOLE DEBUG:")
self.__print(*x)
def __getitem__(self, item):
print(item)
@staticmethod
def __get_max_len(arg) -> int:
arg = list(arg)
i = 0
for a in arg:
l = len(a)
if l > i:
i = l
return i
# noinspection PyStringFormat
def __create_help_message(self, x) -> AnyStr:
""" Print help message and alias of console commands"""
self.__debug("creating help message")
max_len = self.__get_max_len(self.__alias.keys())
if max_len < 7:
max_len = 7
message = f"%{max_len}s : Help message\n" % "Command"
for k, v in self.__alias.items():
doc = v.__doc__
if doc is None:
doc = " No help message found"
message += f" %{max_len}s :%s\n" % (k, doc)
return message
def __create_message(self, text, r="\r"):
self.__debug("create message to output")
return r + self.__prompt_out + " " + text + "\n\r" + self.__prompt_in + " "
@property
def alias(self) -> dict:
"""
def alias(self) -> dict:
:return: dict of alias
"""
return self.__alias.copy()
def add(self, key: str, func) -> dict:
"""
def add(self, key: str, func) -> dict:
:param key:
:param func:
:return:
"""
key = key.format(" ", "-")
if not isinstance(key, str):
raise TypeError("key must be string")
self.__debug(f"added user command: key={key}; func={func}")
self.__alias.update({key: func})
return self.__alias.copy()
def write(self, s: AnyStr, r="\r"):
s = s.replace("\n\t", "\n" + self.__prompt_out + " ").replace("\t", " ")
ConsoleIO.write(self.__create_message(s, r))
def log(self, s: AnyStr, r='\r') -> None:
self.write(s, r)
def __lshift__(self, s: AnyStr) -> None:
self.write(s)
def __builtins_print(self,
*values: object,
sep: str or None = " ",
end: str or None = None,
file: str or None = None,
flush: bool = False,
loading: bool = False) -> None:
val = list(values)
if len(val) > 0:
val.insert(0, "\r" + self.__prompt_out)
if not loading:
val.append("\r\n" + self.__prompt_in + " ")
end = "" if end is None else end
self.__print(*tuple(val), sep=sep, end=end, file=file, flush=flush)
def logger_hook(self) -> None:
self.__debug("used logger_hook")
def emit(cls, record):
try:
msg = cls.format(record)
ConsoleIO.write(self.__create_message(msg))
cls.flush()
except RecursionError: # See issue 36272
raise
except Exception:
cls.handleError(record)
logging.StreamHandler.emit = emit
def builtins_hook(self) -> None:
"""
def builtins_hook(self) -> None:
:return: None
"""
self.__debug("used builtins_hook")
builtins.Console = Console
builtins.console = self
builtins.print = self.__builtins_print
def run(self) -> None:
"""
def run(self) -> None:
:return: None
"""
self.run_while(True)
def run_while(self, whl) -> None:
"""
def run_while(self, whl) -> None:
:param whl: run while what?
:return: None
"""
self.__debug(f"run while {whl}")
while whl:
try:
ConsoleIO.write("\r" + self.__prompt_in + " ")
cmd_in = ConsoleIO.read()
cmd = cmd_in.split(" ")[0]
if cmd == "":
pass
else:
command = self.__alias.get(cmd)
if command:
x = cmd_in[len(cmd) + 1:]
output = command(x)
if isinstance(output, str):
self.log(output)
else:
self.log(self.__not_found % cmd)
except Exception as e:
if e == KeyboardInterrupt:
raise e
ConsoleIO.write_err("\rDuring the execution of the command, an error occurred:\n\n" +
str(traceback.format_exc()) +
"\nType Enter to continue.")

45
scr/console/Console.pyi Normal file
View File

@ -0,0 +1,45 @@
# -*- coding: utf-8 -*-
# Developed by Ahegao Devs
# Written by: SantaSpeen
# Licence: MIT
# (c) ahegao.ovh 2022
from _typeshed import SupportsWrite
from builtins import function
from typing import AnyStr
class ConsoleIO:
@staticmethod
def write(s: AnyStr): ...
@staticmethod
def write_err(s: AnyStr): ...
@staticmethod
def read(): ...
class Console(object):
def __init__(self,
prompt_in: str = ">",
prompt_out: str = "]:",
not_found: str = "Command \"%s\" not found in alias.",
file: SupportsWrite[str] or None = Console,
debug: bool = False) -> None:
self.get_IO: ConsoleIO
def __getitem__(self, item): ...
@property
def alias(self) -> dict: ...
def add(self, key: str, func: function) -> dict: ...
def log(self, s: AnyStr, r='\r') -> None: ...
def write(self, s: AnyStr, r='\r') -> None: ...
def logger_hook(self) -> None: ...
def builtins_hook(self) -> None: ...
def run(self) -> None: ...
def run_while(self, whl) -> None:...

1
scr/console/__init__.py Normal file
View File

@ -0,0 +1 @@
from .Console import Console, ConsoleIO

95
scr/main.py Normal file
View File

@ -0,0 +1,95 @@
import logging
import os
from console import Console, ConsoleIO
# Init modules
cli = Console() # Console(debug=True)
logging.basicConfig(level=logging.NOTSET, format="%(asctime)s - %(name)-5s - %(levelname)-7s - %(message)s")
def cli_print():
""" How can I write text to the console? Read below! """
cli.log("cli.og")
cli.write("cli.write")
print("\r...", end="\n\n\n")
def logger_preview():
""" I use logging and want its output to be in the console! """
cli.logger_hook()
# All calls below will be implemented via Console
logging.debug("Debug log")
logging.warning('Warning log')
logging.error("Error log")
logging.info("Info log")
print("\r...", end="\n\n\n")
def builtins_preview():
""" I want print to be output like cli.log """
# Output below without hook
print("No builtins_hook here")
print("No builtins_hook here, but file=cli, end=''", file=cli, end="")
cli.builtins_hook()
# Output below from the hook
# After hook cli = console
print("builtins_hook here")
console.write("console.write")
console.log("console.log")
console['[] log']
console << "<< log"
ConsoleIO.write("\r...\n\n") # Or console.get_IO.write("\r...\n\n")
def cli_echo(x: str):
""" Help message here """
message = "Echo message: " + x
return message
def cli_error(x):
""" Print error message """
raise Exception("Test error message")
def cli_exit():
""" Kill process """
pid = os.getpid()
os.system(f"kill {pid}")
def cli_mode():
print("type help")
cli.add("echo", cli_echo)
cli.add("error", cli_error)
cli.add("exit", cli_exit)
cli.run()
# Or you may use
# cli.run_while(lambda: <some code>)
if __name__ == '__main__':
cli_print()
logger_preview()
builtins_preview()
cli_mode()