API Shortcuts - pysourceinfo ============================ pysourceinfo.PySourceInfo ^^^^^^^^^^^^^^^^^^^^^^^^^ Runtime Type Information for Python sources. `[docs] `_ * Generic Analysis of the the path string only. +---------------------------------+-------------------------------------------------+ | [docs] | [source] | +=================================+=================================================+ | `getPythonPathFromSysPath`_ | `PySourceInfo.getPythonPathFromSysPath`_ | +---------------------------------+-------------------------------------------------+ | `getPythonPathRel`_ | `PySourceInfo.getPythonPathRel`_ | +---------------------------------+-------------------------------------------------+ .. _getPythonPathFromSysPath: pysourceinfo.html#pysourceinfo.PySourceInfo.getPythonPathFromSysPath .. _PySourceInfo.getPythonPathFromSysPath: _modules/pysourceinfo/PySourceInfo.html#getPythonPathFromSysPath .. _getPythonPathRel: pysourceinfo.html#pysourceinfo.PySourceInfo.getPythonPathRel .. _PySourceInfo.getPythonPathRel: _modules/pysourceinfo/PySourceInfo.html#getPythonPathRel * Callstack - Source References Addressed with the common parameter *spos >=0* for stack positions. *Priority on 'inspect'*: .. index:: single: options; functions single: options; methods .. _CallerFunctionsandMethods: * Caller - Functions and Methods: +--------------------------------------------+---------------------------------------------------------+ | [docs] | [source] | +============================================+=========================================================+ | `getCallerFunc`_ | `PySourceInfo.getCallerFunc`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerFuncName`_ | `PySourceInfo.getCallerFuncName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerLinenumber`_ | `PySourceInfo.getCallerLinenumber`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerName`_ | `PySourceInfo.getCallerName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerNameOID`_ | `PySourceInfo.getCallerNameOID`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerNamespaceGlobal`_ | `PySourceInfo.getCallerNamespaceGlobal`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerNamespaceLocal`_ | `PySourceInfo.getCallerNamespaceLocal`_ | +--------------------------------------------+---------------------------------------------------------+ . .. index:: single: options; modules single: options; files .. _CallerModulesFiles: * Modules - Files: +--------------------------------------------+---------------------------------------------------------+ | [docs] | [source] | +============================================+=========================================================+ | `getCallerFileName`_ | `PySourceInfo.getCallerFileName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerFilePathName`_ | `PySourceInfo.getCallerFilePathName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerLinenumber`_ | `PySourceInfo.getCallerLinenumber`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerModuleFilePathName`_ | `PySourceInfo.getCallerModuleFilePathName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerModuleName`_ | `PySourceInfo.getCallerModuleName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerModulePathName`_ | `PySourceInfo.getCallerModulePathName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerModulePythonPath`_ | `PySourceInfo.getCallerModulePythonPath`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerPathName`_ | `PySourceInfo.getCallerPathName`_ | +--------------------------------------------+---------------------------------------------------------+ . .. index:: single: options; Packages single: options; directories single: options; files .. _CallerPackagesFilesandorDirectories: * Packages - Files and/or Directories: +--------------------------------------------+---------------------------------------------------------+ | [docs] | [source] | +============================================+=========================================================+ | `getCallerPackageFilePathName`_ | `PySourceInfo.getCallerPackageFilePathName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerPackageName`_ | `PySourceInfo.getCallerPackageName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerPackagePathName`_ | `PySourceInfo.getCallerPackagePathName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerPackagePythonPath`_ | `PySourceInfo.getCallerPackagePythonPath`_ | +--------------------------------------------+---------------------------------------------------------+ . *Priority on 'sys.path'*: .. index:: single: options; Packages single: options; directories single: options; files .. _CallerPackagesFilesandorDirectoriesSysPath: * Packages - Files and/or Directories: +--------------------------------------------+---------------------------------------------------------+ | [docs] | [source] | +============================================+=========================================================+ | `getCallerSysPathPackageName`_ | `PySourceInfo.getCallerSysPathPackageName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerSysPathPackageSysPathName`_ | `PySourceInfo.getCallerSysPathPackageSysPathName`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerSysPathPackageSysPathNameRel`_ | `PySourceInfo.getCallerSysPathPackageSysPathNameRel`_ | +--------------------------------------------+---------------------------------------------------------+ | `getCallerSysPathPackagePythonPath`_ | `PySourceInfo.getCallerSysPathPackagePythonPath`_ | +--------------------------------------------+---------------------------------------------------------+ .. _getCallerFileName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerFileName .. _PySourceInfo.getCallerFileName: _modules/pysourceinfo/PySourceInfo.html#getCallerFileName .. _getCallerFilePathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerFilePathName .. _PySourceInfo.getCallerFilePathName: _modules/pysourceinfo/PySourceInfo.html#getCallerFilePathName .. _getCallerFuncName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerFuncName .. _PySourceInfo.getCallerFuncName: _modules/pysourceinfo/PySourceInfo.html#getCallerFuncName .. _getCallerFunc: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerFunc .. _PySourceInfo.getCallerFunc: _modules/pysourceinfo/PySourceInfo.html#getCallerFunc .. _getCallerLinenumber: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerLinenumber .. _PySourceInfo.getCallerLinenumber: _modules/pysourceinfo/PySourceInfo.html#getCallerLinenumber .. _getCallerModuleFilePathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerModuleFilePathName .. _PySourceInfo.getCallerModuleFilePathName: _modules/pysourceinfo/PySourceInfo.html#getCallerModuleFilePathName .. _getCallerModuleName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerModuleName .. _PySourceInfo.getCallerModuleName: _modules/pysourceinfo/PySourceInfo.html#getCallerModuleName .. _getCallerModulePathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerModulePathName .. _PySourceInfo.getCallerModulePathName: _modules/pysourceinfo/PySourceInfo.html#getCallerModulePathName .. _getCallerModulePythonPath: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerModulePythonPath .. _PySourceInfo.getCallerModulePythonPath: _modules/pysourceinfo/PySourceInfo.html#getCallerModulePythonPath .. _getCallerName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerName .. _PySourceInfo.getCallerName: _modules/pysourceinfo/PySourceInfo.html#getCallerName .. _getCallerNameOID: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerNameOID .. _PySourceInfo.getCallerNameOID: _modules/pysourceinfo/PySourceInfo.html#getCallerNameOID .. _getCallerNamespaceGlobal: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerNamespaceGlobal .. _PySourceInfo.getCallerNamespaceGlobal: _modules/pysourceinfo/PySourceInfo.html#getCallerNamespaceGlobal .. _getCallerNamespaceLocal: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerNamespaceLocal .. _PySourceInfo.getCallerNamespaceLocal: _modules/pysourceinfo/PySourceInfo.html#getCallerNamespaceLocal .. _getCallerPackageFilePathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerPackageFilePathName .. _PySourceInfo.getCallerPackageFilePathName: _modules/pysourceinfo/PySourceInfo.html#getCallerPackageFilePathName .. _getCallerPackageName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerPackageName .. _PySourceInfo.getCallerPackageName: _modules/pysourceinfo/PySourceInfo.html#getCallerPackageName .. _getCallerPackagePathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerPackagePathName .. _PySourceInfo.getCallerPackagePathName: _modules/pysourceinfo/PySourceInfo.html#getCallerPackagePathName .. _getCallerPackagePythonPath: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerPackagePythonPath .. _PySourceInfo.getCallerPackagePythonPath: _modules/pysourceinfo/PySourceInfo.html#getCallerPackagePythonPath .. _getCallerPathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerPathName .. _PySourceInfo.getCallerPathName: _modules/pysourceinfo/PySourceInfo.html#getCallerPathName .. _getCallerSysPathPackageName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerSysPathPackageName .. _PySourceInfo.getCallerSysPathPackageName: _modules/pysourceinfo/PySourceInfo.html#getCallerSysPathPackageName .. _getCallerSysPathPackageSysPathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerSysPathPackageSysPathName .. _PySourceInfo.getCallerSysPathPackageSysPathName: _modules/pysourceinfo/PySourceInfo.html#getCallerSysPathPackageSysPathName .. _getCallerSysPathPackageSysPathNameRel: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerSysPathPackageSysPathNameRel .. _PySourceInfo.getCallerSysPathPackageSysPathNameRel: _modules/pysourceinfo/PySourceInfo.html#getCallerSysPathPackageSysPathNameRel .. _getCallerSysPathPackagePythonPath: pysourceinfo.html#pysourceinfo.PySourceInfo.getCallerSysPathPackagePythonPath .. _PySourceInfo.getCallerSysPathPackagePythonPath: _modules/pysourceinfo/PySourceInfo.html#getCallerSysPathPackagePythonPath .. * Callstack - Module References Addressed with the common parameter *spos >=0* for stack positions. +---------------------------------+-------------------------------------------------+ | [docs] | [source] | +=================================+=================================================+ | ... | ... | +---------------------------------+-------------------------------------------------+ * Lists, and selective search for processing Iterators may not work properly in any case because subcalls may change the stack. Thus providing a snapshots as lists. +---------------------------------+-------------------------------------------------+ | [docs] | [source] | +=================================+=================================================+ | `getStackFuncList`_ | `PySourceInfo.getStackFuncList`_ | +---------------------------------+-------------------------------------------------+ | `getStackFuncMap`_ | `PySourceInfo.getStackFuncMap`_ | +---------------------------------+-------------------------------------------------+ | `getStackFuncNameList`_ | `PySourceInfo.getStackFuncNameList`_ | +---------------------------------+-------------------------------------------------+ | `getStackFuncNameMap`_ | `PySourceInfo.getStackFuncNameMap`_ | +---------------------------------+-------------------------------------------------+ | `getStackLen`_ | `PySourceInfo.getStackLen`_ | +---------------------------------+-------------------------------------------------+ | `getStackSposForFunc`_ | `PySourceInfo.getStackSposForFunc`_ | +---------------------------------+-------------------------------------------------+ | `getStackSposForFuncName`_ | `PySourceInfo.getStackSposForFuncName`_ | +---------------------------------+-------------------------------------------------+ .. _getStackFuncList: pysourceinfo.html#pysourceinfo.PySourceInfo.getStackFuncList .. _PySourceInfo.getStackFuncList: _modules/pysourceinfo/PySourceInfo.html#getStackFuncList .. _getStackFuncNameList: pysourceinfo.html#pysourceinfo.PySourceInfo.getStackFuncNameList .. _PySourceInfo.getStackFuncNameList: _modules/pysourceinfo/PySourceInfo.html#getStackFuncNameList .. _getStackFuncMap: pysourceinfo.html#pysourceinfo.PySourceInfo.getStackFuncMap .. _PySourceInfo.getStackFuncMap: _modules/pysourceinfo/PySourceInfo.html#getStackFuncMap .. _getStackFuncNameMap: pysourceinfo.html#pysourceinfo.PySourceInfo.getStackFuncNameMap .. _PySourceInfo.getStackFuncNameMap: _modules/pysourceinfo/PySourceInfo.html#getStackFuncNameMap .. _getStackLen: pysourceinfo.html#pysourceinfo.PySourceInfo.getStackLen .. _PySourceInfo.getStackLen: _modules/pysourceinfo/PySourceInfo.html#getStackLen .. _getStackSposForFunc: pysourceinfo.html#pysourceinfo.PySourceInfo.getStackSposForFunc .. _PySourceInfo.getStackSposForFunc: _modules/pysourceinfo/PySourceInfo.html#getStackSposForFunc .. _getStackSposForFuncName: pysourceinfo.html#pysourceinfo.PySourceInfo.getStackSposForFuncName .. _PySourceInfo.getStackSposForFuncName: _modules/pysourceinfo/PySourceInfo.html#getStackSposForFuncName * Static runtime components Addressed with the common parameter *mod* for memory address. +---------------------------------+-------------------------------------------------+ | [docs] | [source] | +=================================+=================================================+ | `getModuleFilePathName`_ | `PySourceInfo.getModuleFilePathName`_ | +---------------------------------+-------------------------------------------------+ | `getModulePathName`_ | `PySourceInfo.getModulePathName`_ | +---------------------------------+-------------------------------------------------+ | `getModuleSourceFilePathName`_ | `PySourceInfo.getModuleSourceFilePathName`_ | +---------------------------------+-------------------------------------------------+ .. _getModuleFilePathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getModuleFilePathName .. _PySourceInfo.getModuleFilePathName: _modules/pysourceinfo/PySourceInfo.html#getModuleFilePathName .. _getModulePathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getModulePathName .. _PySourceInfo.getModulePathName: _modules/pysourceinfo/PySourceInfo.html#getModulePathName .. _getModuleSourceFilePathName: pysourceinfo.html#pysourceinfo.PySourceInfo.getModuleSourceFilePathName .. _PySourceInfo.getModuleSourceFilePathName: _modules/pysourceinfo/PySourceInfo.html#getModuleSourceFilePathName