nestedtextto
1.0.0
Dieses Projekt wurde zur Anerkennung für die Gestaltung von Nesttext, die Lesbarkeit von YamlPath -Abfragen, die Nützlichkeit von CATTRs und die Freude an Plumbum und Ward erstellt - keine davon sind die Projekte dieses Autors.
Dieses Projekt NesttextTO bietet sechs Befehlszeilen -Tools für eine bequeme Umwandlung zwischen NestedText und anderen Formaten:
nt2json , nt2toml , nt2yamljson2nt , toml2nt , yaml2ntAus den Nesttext -Dokumenten mit Schwerpunkt hinzugefügt:
NestiertText ist ein Dateiformat zum Halten strukturierter Daten, die von Personen eingegeben, bearbeitet oder angesehen werden sollen. Es organisiert die Daten in eine verschachtelte Sammlung von Wörterbüchern , Listen und Zeichenfolgen, ohne dass es erforderlich ist, zu zitieren oder zu entkommen . Eine eindeutige Funktion dieses Dateiformats ist, dass es nur einen Skalartyp unterstützt: Zeichenfolgen . Während die Entscheidung, Ganzzahl, real, Datum usw. zu vermeiden, kontrastiv erscheinen, führt sie zu einfacheren Datendateien und Anwendungen, die robuster sind.
Bei der Konvertierung von Nesttext in Formate, die mehr Werttypen unterstützen, sind alle einfachen Werte standardmäßig Zeichenfolgen. Sie können jedoch Optionen zur Verfügung stellen, um Werte als Zahlen, Booleschen, Nulls oder Daten/Zeiten zu werfen, wenn das Zielformat es unter Verwendung der leistungsstarken und prägnanten YAML -Pfad -Abfrage -Syntax unterstützt.
$ cat example.nt people :
-
name : Bill Sky
problems : 99
happy : False
-
name : Vorbis Florbis
problems : 6
happy : yes $ nt2json example.nt --number /people/problems --boolean /people/happy {
"people" : [
{
"name" : " Bill Sky " ,
"problems" : 99 ,
"happy" : false
},
{
"name" : " Vorbis Florbis " ,
"problems" : 6 ,
"happy" : true
}
]
}Sie können diese Typ -Mappings stattdessen in einer Nesttext -Schema -Datei speichern.
$ cat example.types.nt boolean :
- /people/happy
number :
- /people/problemsDer folgende Befehl ergibt dann auch das obige JSON:
$ nt2json example.nt --schema example.types.ntEin solches Schema kann automatisch aus JSON/TOML/YAML generiert werden:
$ json2nt --to-schema example.jsonOptionen können vor oder nach dem Dokument bereitgestellt werden, und der Inhalt kann direkt in den Befehl geleitet werden, anstatt eine Datei anzugeben.
Weitere Informationen zum YAML -Pfad -Syntax finden Sie im YAML -Pfad -Wiki.
Zum Beispiel könnten Sie alle Gegenstände anpassen, die wahrscheinlich in jeder Tiefe als Booleaner gedacht sind, mit --boolean '/**[.=~/^(?i)(yes|no|true|false)$/]'
Wenn Sie keine TOML -Unterstützung benötigen, können Sie die folgenden [toml] -Bits weglassen.
Hier sind einige Möglichkeiten, es zu installieren:
$ uv tool install ' nt2[toml] ' # Install using uv (Python all-around manager)
$ pipx install ' nt2[toml] ' # Install using pipx (Python app manager)
$ pipz install ' nt2[toml] ' # Install using zpy (Python app and environment manager for Zsh)
$ pip install --user ' nt2[toml] ' # Install in your user's environment
$ pip install ' nt2[toml] ' # Install in current environment Ich empfehle, UV, PIPX oder pipz von ZPY zu verwenden.
Fügen Sie diese Zeile für die ZSH -Fertigstellung jederzeit nach compinit zu Ihrem .zshrc hinzu:
if (( $ + functions[compdef] )) && (( $ + commands[nt 2 json] )) compdef _gnu_generic nt2yaml nt2toml nt2json json2nt toml2nt yaml2nt nt2json 0.2.7
Read NestedText and output its content as JSON.
By default, generated JSON values will only contain strings, arrays, and maps,
but you can cast nodes matching YAML Paths to boolean, null, or number.
Casting switches may be before or after file arguments.
Examples:
nt2json example.nt
nt2json <example.nt
cat example.nt | nt2json
nt2json --int People.age --boolean 'People."is a wizard"' example.nt
Usage:
nt2json [SWITCHES] input_files...
Meta-switches:
-h, --help Prints this help message and quits
-v, --version Prints the program's version and quits
Switches:
--boolean, -b YAMLPATH:str Cast each node matching the given YAML Path
query as boolean; may be given multiple
times
--null, -n YAMLPATH:str Cast each node matching the given YAML Path
query as null, if it is an empty string; may
be given multiple times
--number, --int, --float, -i, -f YAMLPATH:str
Cast each node matching the given YAML Path
query as a number; may be given multiple
times
--schema, -s NESTEDTEXTFILE:ExistingFile
Cast nodes matching YAML Path queries
specified in a NestedText document. It must
be a map with one or more of the keys:
'null', 'boolean', 'number'Each key's value
is a list of YAML Paths.; may be given
multiple times
nt2yaml 0.2.7
Read NestedText and output its content as YAML.
By default, generated YAML values will only contain strings, arrays, and maps,
but you can cast nodes matching YAML Paths to boolean, null, number, or date.
Casting switches may be before or after file arguments.
Examples:
nt2yaml example.nt
nt2yaml <example.nt
cat example.nt | nt2yaml
nt2yaml --int People.age --boolean 'People."is a wizard"' example.nt
Usage:
nt2yaml [SWITCHES] input_files...
Meta-switches:
-h, --help Prints this help message and quits
-v, --version Prints the program's version and quits
Switches:
--boolean, -b YAMLPATH:str Cast each node matching the given YAML Path
query as boolean; may be given multiple
times
--date, -d YAMLPATH:str Cast each node matching the given YAML Path
query as a date, assuming it's ISO 8601; may
be given multiple times
--null, -n YAMLPATH:str Cast each node matching the given YAML Path
query as null, if it is an empty string; may
be given multiple times
--number, --int, --float, -i, -f YAMLPATH:str
Cast each node matching the given YAML Path
query as a number; may be given multiple
times
--schema, -s NESTEDTEXTFILE:ExistingFile
Cast nodes matching YAML Path queries
specified in a NestedText document. It must
be a map with one or more of the keys:
'null', 'boolean', 'number'Each key's value
is a list of YAML Paths.; may be given
multiple times
nt2toml 0.2.7
Read NestedText and output its content as TOML.
By default, generated TOML values will only contain strings, arrays, and maps,
but you can cast nodes matching YAML Paths to boolean, number, or date.
Casting switches may be before or after file arguments.
Examples:
nt2toml example.nt
nt2toml <example.nt
cat example.nt | nt2toml
nt2toml --int People.age --boolean 'People."is a wizard"' example.nt
Usage:
nt2toml [SWITCHES] input_files...
Meta-switches:
-h, --help Prints this help message and quits
-v, --version Prints the program's version and quits
Switches:
--boolean, -b YAMLPATH:str Cast each node matching the given YAML Path
query as boolean; may be given multiple
times
--date, -d YAMLPATH:str Cast each node matching the given YAML Path
query as a date, assuming it's ISO 8601; may
be given multiple times
--number, --int, --float, -i, -f YAMLPATH:str
Cast each node matching the given YAML Path
query as a number; may be given multiple
times
--schema, -s NESTEDTEXTFILE:ExistingFile
Cast nodes matching YAML Path queries
specified in a NestedText document. It must
be a map with one or more of the keys:
'null', 'boolean', 'number'Each key's value
is a list of YAML Paths.; may be given
multiple times
json2nt 0.2.7
Read JSON and output its content as NestedText.
Examples:
json2nt example.json
json2nt <example.json
cat example.json | json2nt
Usage:
json2nt [SWITCHES] input_files...
Meta-switches:
-h, --help Prints this help message and quits
-v, --version Prints the program's version and quits
Switches:
--to-schema, -s Rather than convert the inputs, generate a schema
yaml2nt 0.2.7
Read YAML and output its content as NestedText.
Examples:
yaml2nt example.yml
yaml2nt <example.yml
cat example.yml | yaml2nt
Usage:
yaml2nt [SWITCHES] input_files...
Meta-switches:
-h, --help Prints this help message and quits
-v, --version Prints the program's version and quits
Switches:
--to-schema, -s Rather than convert the inputs, generate a schema
toml2nt 0.2.7
Read TOML and output its content as NestedText.
Examples:
toml2nt example.yml
toml2nt <example.yml
cat example.yml | toml2nt
Usage:
toml2nt [SWITCHES] input_files...
Meta-switches:
-h, --help Prints this help message and quits
-v, --version Prints the program's version and quits
Switches:
--to-schema, -s Rather than convert the inputs, generate a schema
YAML unterstützt offiziell Nicht-String-Schlüsseltypen wie Karten, Listen und Zahlen. Die Unterstützung für Nicht-String-Schlüsseln variiert von einem Yaml-Parser zum nächsten und wird derzeit nicht von NesttextTO behandelt.
Wenn jemand daran interessiert ist, NesttextTO mit Nicht-String-Schlüsseltypen zu verwenden, öffnen Sie bitte ein Problem und ich werde sehen, was ich tun kann!
$ cat log.jsonl{ "chat_id" : 651321 , "event" : " receiving code " , "user_first_name" : " Andy " , "user_id" : 651321 }
{ "event" : " guessed syntax " , "ext" : null , "probability" : 0.05201493203639984 , "probability_min" : 0.12 , "syntax" : " Matlab " }
{ "chat_id" : 651321 , "event" : " colorizing code " , "syntax" : " py3 " , "user_first_name" : " Andy " , "user_id" : 651321 }
{ "event" : " Got deletion request " , "reply_to_msg_user_id" : 651321 , "user_id" : 651321 }
{"chat_id": 651321, "event": "failed to delete message (it's probably gone already)", "exception": "Traceback (most recent call last):n File "/home/andy/Code/colorcodebot/app/colorcodebot.py", line 278, in delete_after_delayn bot.delete_message(message.chat.id, message.message_id)n File "/home/andy/.local/share/venvs/84f7fb558856f9ccc2c54e3d122862b6/venv/lib/python3.10/site-packages/telebot/__init__.py", line 1081, in delete_messagen return apihelper.delete_message(self.token, chat_id, message_id, timeout)n File "/home/andy/.local/share/venvs/84f7fb558856f9ccc2c54e3d122862b6/venv/lib/python3.10/site-packages/telebot/apihelper.py", line 1299, in delete_messagen return _make_request(token, method_url, params=payload, method='post')n File "/home/andy/.local/share/venvs/84f7fb558856f9ccc2c54e3d122862b6/venv/lib/python3.10/site-packages/telebot/apihelper.py", line 152, in _make_requestn json_result = _check_result(method_name, result)n File "/home/andy/.local/share/venvs/84f7fb558856f9ccc2c54e3d122862b6/venv/lib/python3.10/site-packages/telebot/apihelper.py", line 179, in _check_resultn raise ApiTelegramException(method_name, result, result_json)ntelebot.apihelper.ApiTelegramException: A request to the Telegram API was unsuccessful. Error code: 400. Description: Bad Request: message to delete not found"}$ json2nt log.jsonl-
chat_id : 651321
event : receiving code
user_first_name : Andy
user_id : 651321
-
event : guessed syntax
ext :
probability : 0.05201493203639984
probability_min : 0.12
syntax : Matlab
-
chat_id : 651321
event : colorizing code
syntax : py3
user_first_name : Andy
user_id : 651321
-
event : Got deletion request
reply_to_msg_user_id : 651321
user_id : 651321
-
chat_id : 651321
event : failed to delete message (it's probably gone already)
exception :
> Traceback (most recent call last):
> File "/home/andy/Code/colorcodebot/app/colorcodebot.py", line 278, in delete_after_delay
> bot.delete_message(message.chat.id, message.message_id)
> File "/home/andy/.local/share/venvs/84f7fb558856f9ccc2c54e3d122862b6/venv/lib/python3.10/site-packages/telebot/__init__.py", line 1081, in delete_message
> return apihelper.delete_message(self.token, chat_id, message_id, timeout)
> File "/home/andy/.local/share/venvs/84f7fb558856f9ccc2c54e3d122862b6/venv/lib/python3.10/site-packages/telebot/apihelper.py", line 1299, in delete_message
> return _make_request(token, method_url, params=payload, method='post')
> File "/home/andy/.local/share/venvs/84f7fb558856f9ccc2c54e3d122862b6/venv/lib/python3.10/site-packages/telebot/apihelper.py", line 152, in _make_request
> json_result = _check_result(method_name, result)
> File "/home/andy/.local/share/venvs/84f7fb558856f9ccc2c54e3d122862b6/venv/lib/python3.10/site-packages/telebot/apihelper.py", line 179, in _check_result
> raise ApiTelegramException(method_name, result, result_json)
> telebot.apihelper.ApiTelegramException: A request to the Telegram API was unsuccessful. Error code: 400. Description: Bad Request: message to delete not found 
Für die lokale Entwicklung wird dann empfohlen, ein Venv zu aktivieren
$ pip install -r local-requirements.txtVon dort aus möchten Sie sich möglicherweise gemeinsame Aufgabendefinitionen ansehen:
$ task -l
$ nox -lUnd Sie möchten möglicherweise die Struktur und die In-Code-Dokumentation als rendertes HTML am Standort Github Pages durchsuchen.
