proc-locks fixes

2026-04-26 21:04:16 +02:00 · 2022-09-13 20:40:48 -07:00
parent 140dc656a2
commit c348fa89a9
3 changed files with 187 additions and 54 deletions
@@ -0,0 +1,130 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_locks"></a>
+
+# jc.parsers.proc\_locks
+
+jc - JSON Convert `/proc/locks` file parser
+
+Usage (cli):
+
+    $ cat /proc/locks | jc --proc
+
+or
+
+    $ jc /proc/locks
+
+or
+
+    $ cat /proc/locks | jc --proc-locks
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_locks_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_locks', proc_locks_file)
+
+Schema:
+
+    [
+      {
+        "id":                   integer,
+        "class":                string,
+        "type":                 string,
+        "access":               string,
+        "pid":                  integer,
+        "maj":                  string,
+        "min":                  string,
+        "inode":                integer,
+        "start":                string,
+        "end":                  string
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/locks | jc --proc -p
+    [
+      {
+        "id": 1,
+        "class": "POSIX",
+        "type": "ADVISORY",
+        "access": "WRITE",
+        "pid": 877,
+        "maj": "00",
+        "min": "19",
+        "inode": 812,
+        "start": "0",
+        "end": "EOF"
+      },
+      {
+        "id": 2,
+        "class": "FLOCK",
+        "type": "ADVISORY",
+        "access": "WRITE",
+        "pid": 854,
+        "maj": "00",
+        "min": "19",
+        "inode": 805,
+        "start": "0",
+        "end": "EOF"
+      },
+      ...
+    ]
+
+    $ proc_locks | jc --proc_locks -p -r
+    [
+      {
+        "id": "1",
+        "class": "POSIX",
+        "type": "ADVISORY",
+        "access": "WRITE",
+        "pid": "877",
+        "maj": "00",
+        "min": "19",
+        "inode": "812",
+        "start": "0",
+        "end": "EOF"
+      },
+      {
+        "id": "2",
+        "class": "FLOCK",
+        "type": "ADVISORY",
+        "access": "WRITE",
+        "pid": "854",
+        "maj": "00",
+        "min": "19",
+        "inode": "805",
+        "start": "0",
+        "end": "EOF"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_locks.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+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.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)