mirror of
https://github.com/SantaSpeen/CLI-in-Python.git
synced 2025-07-01 15:25:31 +00:00
!!!!!!! ПРОЧИТАЙ МЕНЯ !!!!!!!
This commit is contained in:
parent
363a23dd70
commit
b5ae8ab7ea
81
README.md
81
README.md
@ -2,19 +2,92 @@
|
||||
|
||||
#### Версия для русских: [здесь](./README_RU.md)
|
||||
|
||||
## Консольная оболочка для программ на питоне
|
||||
## Command-line interface for programs on Python3
|
||||
|
||||
### About
|
||||
### How to run
|
||||
|
||||
1.
|
||||
```python
|
||||
from console import Console
|
||||
cli = Console(prompt_in=">", prompt_out="]:")
|
||||
|
||||
### Usage
|
||||
def cli_echo(x: str):
|
||||
""" Help message here """
|
||||
|
||||
message = "Echo message: " + x
|
||||
|
||||
return message
|
||||
|
||||
cli.add("help", cli_echo) # Add commands
|
||||
|
||||
cli.run()
|
||||
```
|
||||
|
||||
### Usage output
|
||||
|
||||
* Basic output
|
||||
|
||||
```python
|
||||
from console import Console
|
||||
|
||||
cli = Console(prompt_in=">", prompt_out="]:")
|
||||
|
||||
cli.log("cli.og")
|
||||
cli.write("cli.write")
|
||||
|
||||
# Output
|
||||
# ]: cli.og
|
||||
# ]: cli.write
|
||||
```
|
||||
|
||||
* With logging output usage
|
||||
|
||||
```python
|
||||
from console import Console
|
||||
import logging
|
||||
|
||||
cli = Console(prompt_in=">", prompt_out="]:")
|
||||
logging.basicConfig(level=logging.NOTSET, format="%(asctime)s - %(name)-5s - %(levelname)-7s - %(message)s")
|
||||
|
||||
# All calls below will be implemented via Console
|
||||
cli.logger_hook()
|
||||
logging.debug("Debug log")
|
||||
logging.warning('Warning log')
|
||||
logging.error("Error log")
|
||||
logging.info("Info log")
|
||||
|
||||
# Output
|
||||
# ]: 2022-02-20 23:22:49,731 - root - DEBUG - Debug log
|
||||
# ]: 2022-02-20 23:22:49,731 - root - WARNING - Warning log
|
||||
# ]: 2022-02-20 23:22:49,731 - root - ERROR - Error log
|
||||
# ]: 2022-02-20 23:22:49,731 - root - INFO - Info log
|
||||
```
|
||||
|
||||
* with `print()` and `console.log` output usage
|
||||
|
||||
```python
|
||||
from console import Console
|
||||
|
||||
cli = Console(prompt_in=">", prompt_out="]:")
|
||||
|
||||
cli.builtins_hook()
|
||||
|
||||
# Output below from the hook
|
||||
# After builtins_hook() => cli = console
|
||||
|
||||
print("print()")
|
||||
|
||||
console.write("console.write")
|
||||
console.log("console.log")
|
||||
|
||||
console['[] log']
|
||||
console << "<< log"
|
||||
|
||||
# Output
|
||||
# ]: print()
|
||||
# ]: console.write
|
||||
# ]: console.log
|
||||
# ]: [] log
|
||||
# ]: << log
|
||||
```
|
||||
|
||||
## Links
|
||||
|
81
README_RU.md
81
README_RU.md
@ -1,18 +1,91 @@
|
||||
# CLI in Python
|
||||
|
||||
## Консольная оболочка для программ на питоне
|
||||
## Консольная оболочка для программ на Python3
|
||||
|
||||
### О проекте
|
||||
### Как запускать
|
||||
|
||||
1.
|
||||
```python
|
||||
from console import Console
|
||||
cli = Console(prompt_in=">", prompt_out="]:")
|
||||
|
||||
### Использование
|
||||
def cli_echo(x: str):
|
||||
""" Help message here """
|
||||
|
||||
message = "Echo message: " + x
|
||||
|
||||
return message
|
||||
|
||||
cli.add("help", cli_echo) # Add commands
|
||||
|
||||
cli.run()
|
||||
```
|
||||
|
||||
### Использование вывода
|
||||
|
||||
* Базовое использование вывода
|
||||
|
||||
```python
|
||||
from console import Console
|
||||
|
||||
cli = Console(prompt_in=">", prompt_out="]:")
|
||||
|
||||
cli.log("cli.og")
|
||||
cli.write("cli.write")
|
||||
|
||||
# Output
|
||||
# ]: cli.og
|
||||
# ]: cli.write
|
||||
```
|
||||
|
||||
* Использование вывода с logging
|
||||
|
||||
```python
|
||||
from console import Console
|
||||
import logging
|
||||
|
||||
cli = Console(prompt_in=">", prompt_out="]:")
|
||||
logging.basicConfig(level=logging.NOTSET, format="%(asctime)s - %(name)-5s - %(levelname)-7s - %(message)s")
|
||||
|
||||
# All calls below will be implemented via Console
|
||||
cli.logger_hook()
|
||||
logging.debug("Debug log")
|
||||
logging.warning('Warning log')
|
||||
logging.error("Error log")
|
||||
logging.info("Info log")
|
||||
|
||||
# Output
|
||||
# ]: 2022-02-20 23:22:49,731 - root - DEBUG - Debug log
|
||||
# ]: 2022-02-20 23:22:49,731 - root - WARNING - Warning log
|
||||
# ]: 2022-02-20 23:22:49,731 - root - ERROR - Error log
|
||||
# ]: 2022-02-20 23:22:49,731 - root - INFO - Info log
|
||||
```
|
||||
|
||||
* Использование вывода с`print()` и `console.log`
|
||||
|
||||
```python
|
||||
from console import Console
|
||||
|
||||
cli = Console(prompt_in=">", prompt_out="]:")
|
||||
|
||||
cli.builtins_hook()
|
||||
|
||||
# Output below from the hook
|
||||
# After builtins_hook() => cli = console
|
||||
|
||||
print("print()")
|
||||
|
||||
console.write("console.write")
|
||||
console.log("console.log")
|
||||
|
||||
console['[] log']
|
||||
console << "<< log"
|
||||
|
||||
# Output
|
||||
# ]: print()
|
||||
# ]: console.write
|
||||
# ]: console.log
|
||||
# ]: [] log
|
||||
# ]: << log
|
||||
```
|
||||
|
||||
## Ссылки
|
||||
|
Loading…
x
Reference in New Issue
Block a user