IPython Documentation

Table Of Contents

Previous topic

Module: utils.submodule

Next topic

Module: utils.syspathcontext

This Page


This documentation is for an old version of IPython. You can find docs for newer versions here.

Module: utils.sysinfo

Utilities for getting information about IPython and the system it’s running in.

4 Functions


Get short form of commit hash given directory pkg_path

We get the commit hash from (in order of preference):

  • IPython.utils._sysinfo.commit
  • git output, if we are in a git repository

If these fail, we return a not-found placeholder tuple


pkg_path : str

directory containing package only used for getting commit from active repo


hash_from : str

Where we got the hash from - description

hash_str : str

short form of hash


Return dict describing the context of this package


pkg_path : str

path containing __init__.py for package


context : dict

with named parameters of interest


Return useful information about IPython and the system, as a string.


Return the effective number of CPUs in the system as an integer.

This cross-platform function makes an attempt at finding the total number of available CPUs in the system, as returned by various underlying system and python calls.

If it can’t find a sensible answer, it returns 1 (though an error may make it return a large positive number that’s actually incorrect).