python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-15 01:24:29 +02:00
Code Issues Releases Activity

created docstring+another explanations seperated.

Browse Source
This commit is contained in:
Eden Refael
2024-11-29 11:43:46 +02:00
parent 8f20ea4114
commit 896660017c
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
jc/parsers/amixer.py
View File

@ -38,6 +38,17 @@ def parse(
Main text parsing function, The amixer is alsa mixer tool and output, Will work with Linux OS only. Main text parsing function, The amixer is alsa mixer tool and output, Will work with Linux OS only.
Parameters:
data: (string) text data to parse
raw: (boolean) unprocessed output if True
quiet: (boolean) suppress warning messages if True
Returns:
List of Dictionaries. Raw or processed structured data.
push test
"""
"""
The Algorithm for parsing the `amixer sget` command, Input Explained/Rules/Pseudo Algorithm: The Algorithm for parsing the `amixer sget` command, Input Explained/Rules/Pseudo Algorithm:
1. There will always be the first line which tells the user about the control name. 1. There will always be the first line which tells the user about the control name.
2. There will always be the Capabilities which include many of capabilities - It will be listed and separated by `" "`. 2. There will always be the Capabilities which include many of capabilities - It will be listed and separated by `" "`.
@ -91,17 +102,6 @@ def parse(
Mono: Mono:
Front Left: Playback 0 [0%] [-65.25dB] [off] Front Left: Playback 0 [0%] [-65.25dB] [off]
Front Right: Playback 0 [0%] [-65.25dB] [off] Front Right: Playback 0 [0%] [-65.25dB] [off]
Parameters:
data: (string) text data to parse
raw: (boolean) unprocessed output if True
quiet: (boolean) suppress warning messages if True
Returns:
List of Dictionaries. Raw or processed structured data.
push test
""" """
# checks os compatibility and print a stderr massage if not compatible. quiet True could remove this check. # checks os compatibility and print a stderr massage if not compatible. quiet True could remove this check.
jc.utils.compatibility(__name__, info.compatible, quiet) jc.utils.compatibility(__name__, info.compatible, quiet)