# No shebang line, this module is meant to be imported
#
# Copyright 2015 Ambient Entertainment GmbH & Co. KG
# Copyright 2015 Oliver Palmer
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Disks
-----
Contains information about the local disks.
"""
from collections import namedtuple
import psutil
from pyfarm.agent.logger import getLogger
DiskInfo = namedtuple("DiskInfo", ("mountpoint", "free", "size"))
logger = getLogger("agent.disks")
[docs]def disks(as_dict=False):
"""
Returns a list of disks in the system, in the form of :class:`DiskInfo`
objects.
:param bool as_dict:
If True then return a dictionary value instead of :class:`DiskInfo`
instances. This is mainly used by the agent to eliminate an extra
loop for translation.
"""
out = []
for partition in psutil.disk_partitions():
try:
usage = psutil.disk_usage(partition.mountpoint)
# Not all disks can return disk information. A partition
# that is mounted but does not have a file system, cdrom
# drives on Windows for example, wouldn't have any usage
# data to return.
except OSError:
continue
if not as_dict:
info = DiskInfo(
mountpoint=partition.mountpoint,
free=usage.free,
size=usage.total
)
else:
info = {
"mountpoint": partition.mountpoint,
"free": usage.free,
"size": usage.total
}
out.append(info)
return out