{ } Raw JSON

bundles / astropy latest / astropy / utils / data / get_free_space_in_dir

function

astropy.utils.data:get_free_space_in_dir

source: /astropy/utils/data.py :1074

Signature

def   get_free_space_in_dir ( path unit = False )

Summary

Given a path to a directory, returns the amount of free space on that filesystem.

Parameters

path : str

The path to a directory.

unit : bool or `~astropy.units.Unit`

Return the amount of free space as Quantity in the given unit, if provided. Default is False for backward-compatibility.

Returns

free_space : int or `~astropy.units.Quantity`

The amount of free space on the partition that the directory is on. If unit=False, it is returned as plain integer (in bytes).

Aliases

  • astropy.utils.data.get_free_space_in_dir