pylspci/searchindex.js

Search.setIndex({"docnames": ["cli", "command", "contributing", "data", "index", "low"], "filenames": ["cli.rst", "command.rst", "contributing.rst", "data.rst", "index.rst", "low.rst"], "titles": ["Command-line interface", "Command API", "Contributing", "Parsed data", "Python lspci parser", "Low-level classes"], "terms": {"onc": 0, "packag": [0, 2, 4], "i": [0, 1, 2, 3, 4], "instal": [0, 2], "an": [0, 1, 2, 3, 4, 5], "execut": [0, 4], "call": [0, 1], "pylspci": [0, 1, 2, 3, 4, 5], "should": [0, 1, 5], "creat": [0, 1, 2, 3, 5], "setuptool": 0, "you": [0, 2], "mai": [0, 2], "also": [0, 1, 2], "us": [0, 1, 2, 3, 4, 5], "python3": 0, "m": 0, "same": [0, 2], "script": [0, 4], "The": [0, 1, 2, 4, 5], "cli": [0, 4], "mimick": 0, "some": [0, 1, 2], "lspci": [0, 1, 3, 5], "": [0, 1, 2, 3, 5], "argument": [0, 1, 3, 5], "due": 0, "own": 0, "behavior": 0, "featur": [0, 2], "being": [0, 1], "implement": [0, 4], "have": [0, 2], "been": 0, "omit": [0, 3], "modifi": [0, 3], "h": 0, "pciid": [0, 1], "p": 0, "pcimap": [0, 1], "domain": [0, 1, 3, 4], "bu": [0, 1, 3, 4], "function": [0, 1, 3, 4], "d": [0, 3], "vendor": [0, 1, 3], "class": [0, 1, 3, 4], "v": 0, "k": 0, "name": [0, 1, 2, 3, 4, 5], "onli": [0, 1, 3], "n": [0, 1], "nn": [0, 1, 4], "A": [0, 1, 3, 4, 5], "method": [0, 1, 3], "f": [0, 3], "file": [0, 1, 2], "h1": 0, "h2": 0, "o": 0, "kei": 0, "valu": [0, 1, 3, 5], "json": [0, 3, 4], "raw": [0, 1], "help": [0, 1, 2, 4], "show": [0, 2], "messag": 0, "exit": 0, "id": [0, 1, 3, 4], "path": [0, 1], "altern": 0, "list": [0, 1, 3, 5], "map": [0, 1, 5], "kernel": [0, 1, 3], "modul": [0, 1, 3, 4], "slot": [0, 1, 3, 4], "ani": [0, 1, 2, 3, 5], "can": [0, 1, 2, 3, 4, 5], "set": [0, 1], "disabl": [0, 1], "slot_filt": [0, 1], "see": [0, 1, 4, 5], "slotfilt": [0, 1], "more": [0, 1, 3], "detail": [0, 1, 4], "type": [0, 1, 4, 5], "device_filt": [0, 1], "devicefilt": [0, 1], "verbos": [0, 1, 5], "displai": 0, "about": 0, "On": 0, "linux": [0, 1, 3], "abov": 0, "2": 0, "6": 0, "includ": [0, 1], "driver": [0, 1, 3], "handl": [0, 3], "each": [0, 1, 5], "abl": 0, "them": [0, 1, 2], "impli": [0, 1], "include_kernel_driv": [0, 1], "pp": 0, "bridg": [0, 1, 3], "along": [0, 1], "include_bridge_path": [0, 1], "thi": [0, 1, 2, 3, 5], "default": [0, 1, 3, 5], "nameonli": [0, 1, 4], "id_resolve_opt": [0, 1, 4], "without": 0, "look": 0, "idonli": [0, 1], "both": [0, 1, 3], "pars": [0, 1, 5], "return": [0, 1, 3, 5], "Will": 0, "automat": 0, "select": [0, 4], "best": [0, 5], "parser": [0, 1], "depend": [0, 1], "chosen": 0, "In": 0, "instanc": [0, 1, 3, 5], "verbosepars": [0, 4, 5], "object": [0, 1], "correspond": 0, "non": [0, 1], "simplepars": [0, 4, 5], "ahelp": 0, "alwai": 0, "string": [0, 1, 5], "ohelp": [0, 1, 3], "paramet": [0, 1, 3, 5], "its": 0, "descript": [0, 1, 3], "pciaccessparamet": [0, 1, 3], "directli": [0, 1], "just": 0, "becom": 0, "thin": 0, "layer": 0, "befor": 0, "librari": 0, "pcilib_param": [0, 1, 3], "get": [0, 1, 2], "avail": [0, 1, 2, 4, 5], "via": 0, "list_pcilib_param": [0, 1, 3], "access_method": [0, 1], "list_access_method": [0, 1], "hex": [0, 1], "dump": [0, 1], "from": [0, 1, 2, 3, 4, 5], "previou": [0, 1], "run": [0, 1, 2, 4, 5], "instead": [0, 1], "real": [0, 1], "hardwar": [0, 1], "adump": 0, "intel": 0, "configur": 0, "mechan": 0, "1": [0, 4], "alia": 0, "conf1": 0, "conf2": 0, "helper": [1, 5], "python": [1, 2], "wai": 1, "idresolveopt": [1, 4], "sourc": [1, 2, 3, 5], "output": [1, 3, 4, 5], "option": [1, 3, 4, 5], "hexadecim": [1, 3], "format": [1, 3], "doe": 1, "requir": [1, 2], "str": [1, 3, 5], "pci": [1, 3, 4], "access": [1, 3, 4], "underli": 1, "pcilib": [1, 3], "provid": [1, 5], "human": [1, 3], "readabl": [1, 3], "machin": 1, "rais": 1, "subprocess": 1, "calledprocesserror": 1, "zero": 1, "error": [1, 2], "code": [1, 2], "list_pcilib_params_raw": 1, "union": [1, 3, 5], "none": [1, 3], "bool": [1, 5], "fals": [1, 4, 5], "kernel_driv": [1, 5], "bridge_path": 1, "hide_single_domain": [1, 4], "true": [1, 5], "variou": 1, "convert": 1, "link": 1, "support": 1, "find": 1, "For": 1, "pass": 1, "To": [1, 2, 4], "x": 1, "load": 1, "data": [1, 2, 4, 5], "increas": 1, "radic": 1, "chang": 1, "ha": 1, "effect": 1, "add": [1, 2], "number": [1, 3], "If": [1, 2], "singl": [1, 3, 5], "0000": [1, 4], "hide": 1, "mode": [1, 4], "doc": [1, 2, 4], "filter": [1, 4], "commandbuild": 1, "kwarg": [1, 5], "build": 1, "pattern": 1, "iter": [1, 5], "over": 1, "result": [1, 5], "one": [1, 5], "time": [1, 5], "__iter__": 1, "arg": [1, 5], "cl": [1, 3], "int": [1, 3], "logic": 1, "syntax": 1, "keyword": 1, "portion": 1, "current": 1, "from_fil": 1, "check": [1, 4], "host": 1, "like": 1, "point": 1, "whether": [1, 5], "exist": 1, "immedi": 1, "delai": 1, "invoc": 1, "when": [1, 2, 3, 5], "with_id": 1, "under": [1, 2], "geograph": 1, "use_access_method": 1, "specif": 1, "all": [1, 2], "use_pciid": 1, "given": [1, 5], "use_pcimap": 1, "enabl": 1, "with_default_pars": 1, "compat": 1, "note": 1, "last": 1, "instruct": 1, "ar": [1, 2, 3], "updat": 1, "with_nam": 1, "with_pars": 1, "with_pcilib_param": 1, "overrid": [1, 5], "dict": [1, 3, 5], "rewrit": 1, "new": [1, 2, 3, 5], "reset": 1, "describ": [1, 3], "field": [1, 4, 5], "remov": 1, "four": [1, 3], "digit": [1, 3], "classmethod": 1, "t": 1, "two": [1, 3, 5], "up": [1, 3], "0x1f": [1, 3], "octal": [1, 3], "project": 2, "greatli": 2, "appreci": 2, "submit": 2, "issu": 2, "gitea": 2, "repositori": 2, "warn": 2, "ask": 2, "question": 2, "answer": 2, "report": 2, "do": 2, "forget": 2, "put": 2, "your": 2, "version": 2, "troubleshoot": 2, "most": 2, "often": 2, "come": 2, "incompat": 2, "need": 2, "virtual": 2, "envion": 2, "work": 2, "properli": 2, "virtualenvwrapp": 2, "recommend": 2, "git": 2, "clone": 2, "http": 2, "tildegit": 2, "org": 2, "lucidiot": 2, "cd": 2, "mkvirtualenv": 2, "pip": 2, "e": 2, "dev": 2, "environ": 2, "tell": 2, "let": 2, "edit": 2, "suffix": 2, "extra": 2, "standard": 2, "unittest": 2, "py": 2, "command": [2, 3, 5], "aim": 2, "100": 2, "my": 2, "whenev": 2, "except": 2, "ci": 2, "statist": 2, "local": 2, "short": [2, 3], "summari": 2, "termin": 2, "Or": 2, "gener": 2, "html": 2, "htmlcov": 2, "folder": 2, "which": 2, "brows": 2, "offlin": 2, "favorit": 2, "web": 2, "browser": 2, "line": [2, 3, 5], "reach": 2, "try": 2, "still": 2, "mention": 2, "pull": 2, "request": 2, "follow": 2, "pep": 2, "8": 2, "style": 2, "perform": 2, "flake8": 2, "tool": 2, "root": 2, "directori": 2, "484": 2, "hint": 2, "mypi": 2, "those": [2, 3], "read": 2, "sphinx": 2, "text": 2, "hold": [2, 5], "content": 2, "written": 2, "restructuredtext": 2, "thei": 2, "subject": 2, "doc8": 2, "store": 3, "namewithid": [3, 4], "subsystem_vendor": 3, "subsystem_devic": 3, "revis": 3, "progif": 3, "kernel_modul": 3, "numa_nod": 3, "iommu_group": 3, "physical_slot": 3, "as_dict": 3, "serial": 3, "serializ": 3, "iommu": 3, "group": 3, "part": [3, 5], "One": 3, "numa": 3, "node": 3, "connect": 3, "physic": 3, "program": 3, "interfac": 3, "subsystem": 3, "found": 3, "either": [3, 5], "associ": 3, "onam": 3, "identifi": 3, "dddd": 3, "bb": 3, "dd": 3, "where": 3, "b": [3, 4], "first": 3, "three": 3, "0": [3, 4], "0x0000": 3, "parent": 3, "present": 3, "index": 4, "search": 4, "page": 4, "pciutil": 4, "act": 4, "wrapper": 4, "around": 4, "produc": 4, "devic": [4, 5], "3": 4, "9248": 4, "nnmm": 4, "nnmmvvvk": 4, "import": 4, "00": 4, "01": 4, "2420": 4, "4": 4, "0e54": 4, "api": 4, "builder": 4, "low": 4, "level": 4, "contribut": 4, "bug": 4, "suggest": 4, "develop": 4, "setup": 4, "unit": 4, "test": 4, "coverag": 4, "lint": 4, "document": [4, 5], "base": 5, "default_lspci_arg": 5, "sent": 5, "abstract": 5, "multipl": 5, "simpl": 5, "mm": 5, "multilin": 5, "parse_lin": 5, "vvvmmk": 5, "vvvmm": 5, "nnk": 5, "separ": 5, "newlin": 5, "fieldmap": 5, "field_nam": 5, "field_typ": 5, "callabl": 5, "mani": 5, "svendor": 5, "subsytem_vendor": 5, "tupl": 5, "repeat": 5}, "objects": {"pylspci": [[1, 0, 0, "-", "command"], [3, 0, 0, "-", "device"], [3, 0, 0, "-", "fields"], [1, 0, 0, "-", "filters"]], "pylspci.command": [[1, 1, 1, "", "CommandBuilder"], [1, 1, 1, "", "IDResolveOption"], [1, 4, 1, "", "list_access_methods"], [1, 4, 1, "", "list_pcilib_params"], [1, 4, 1, "", "list_pcilib_params_raw"], [1, 4, 1, "", "lspci"]], "pylspci.command.CommandBuilder": [[1, 2, 1, "", "__iter__"], [1, 2, 1, "", "device_filter"], [1, 2, 1, "", "from_file"], [1, 2, 1, "", "hide_single_domain"], [1, 2, 1, "", "include_bridge_paths"], [1, 2, 1, "", "include_kernel_drivers"], [1, 2, 1, "", "list_access_methods"], [1, 2, 1, "", "list_pcilib_params"], [1, 2, 1, "", "slot_filter"], [1, 2, 1, "", "use_access_method"], [1, 2, 1, "", "use_pciids"], [1, 2, 1, "", "use_pcimap"], [1, 2, 1, "", "verbose"], [1, 2, 1, "", "with_default_parser"], [1, 2, 1, "", "with_ids"], [1, 2, 1, "", "with_names"], [1, 2, 1, "", "with_parser"], [1, 2, 1, "", "with_pcilib_params"]], "pylspci.command.IDResolveOption": [[1, 3, 1, "", "Both"], [1, 3, 1, "", "IDOnly"], [1, 3, 1, "", "NameOnly"]], "pylspci.device": [[3, 1, 1, "", "Device"]], "pylspci.device.Device": [[3, 2, 1, "", "as_dict"], [3, 3, 1, "", "cls"], [3, 3, 1, "", "device"], [3, 3, 1, "", "driver"], [3, 3, 1, "", "iommu_group"], [3, 3, 1, "", "kernel_modules"], [3, 3, 1, "", "numa_node"], [3, 3, 1, "", "physical_slot"], [3, 3, 1, "", "progif"], [3, 3, 1, "", "revision"], [3, 3, 1, "", "slot"], [3, 3, 1, "", "subsystem_device"], [3, 3, 1, "", "subsystem_vendor"], [3, 3, 1, "", "vendor"]], "pylspci.fields": [[3, 1, 1, "", "NameWithID"], [3, 1, 1, "", "PCIAccessParameter"], [3, 1, 1, "", "Slot"]], "pylspci.fields.NameWithID": [[3, 2, 1, "", "as_dict"], [3, 3, 1, "", "id"], [3, 3, 1, "", "name"]], "pylspci.fields.PCIAccessParameter": [[3, 2, 1, "", "as_dict"], [3, 3, 1, "", "default"], [3, 3, 1, "", "description"], [3, 3, 1, "", "name"]], "pylspci.fields.Slot": [[3, 2, 1, "", "as_dict"], [3, 3, 1, "", "bus"], [3, 3, 1, "", "device"], [3, 3, 1, "", "domain"], [3, 3, 1, "", "function"], [3, 3, 1, "", "parent"]], "pylspci.filters": [[1, 1, 1, "", "DeviceFilter"], [1, 1, 1, "", "Filter"], [1, 1, 1, "", "SlotFilter"]], "pylspci.filters.DeviceFilter": [[1, 3, 1, "", "cls"], [1, 3, 1, "", "device"], [1, 3, 1, "", "vendor"]], "pylspci.filters.Filter": [[1, 2, 1, "", "parse"]], "pylspci.filters.SlotFilter": [[1, 3, 1, "", "bus"], [1, 3, 1, "", "device"], [1, 3, 1, "", "domain"], [1, 3, 1, "", "function"]], "pylspci.parsers": [[5, 0, 0, "-", "base"], [5, 0, 0, "-", "simple"], [5, 0, 0, "-", "verbose"]], "pylspci.parsers.base": [[5, 1, 1, "", "Parser"]], "pylspci.parsers.base.Parser": [[5, 3, 1, "", "default_lspci_args"], [5, 2, 1, "", "parse"], [5, 2, 1, "", "run"]], "pylspci.parsers.simple": [[5, 1, 1, "", "SimpleParser"]], "pylspci.parsers.simple.SimpleParser": [[5, 2, 1, "", "parse"], [5, 2, 1, "", "parse_line"], [5, 2, 1, "", "run"]], "pylspci.parsers.verbose": [[5, 1, 1, "", "FieldMapping"], [5, 1, 1, "", "VerboseParser"]], "pylspci.parsers.verbose.FieldMapping": [[5, 3, 1, "", "field_name"], [5, 3, 1, "", "field_type"], [5, 3, 1, "", "many"]], "pylspci.parsers.verbose.VerboseParser": [[5, 3, 1, "", "default_lspci_args"], [5, 2, 1, "", "parse"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "function", "Python function"]}, "titleterms": {"command": [0, 1, 4], "line": [0, 4], "interfac": [0, 4], "option": 0, "filter": 0, "devic": [0, 1, 3], "data": [0, 3], "output": 0, "mode": 0, "pci": 0, "access": 0, "api": 1, "builder": 1, "select": 1, "contribut": 2, "bug": 2, "suggest": 2, "develop": 2, "setup": 2, "unit": 2, "test": 2, "coverag": 2, "lint": 2, "type": 2, "check": 2, "document": 2, "pars": [3, 4], "The": 3, "field": 3, "python": 4, "lspci": 4, "parser": [4, 5], "custom": 4, "argument": 4, "learn": 4, "more": 4, "low": 5, "level": 5, "class": 5, "implement": 5, "detail": 5}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 56}})