Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1"""
2@file
3@brief Helpers for module :epkg:`*py:os`.
4"""
5import os
8def get_machine():
9 """
10 Returns the machine name.
12 @return machine name
14 The method assumes environment variable ``COMPUTERNAME``,
15 ``HOSTNAME`` or ``NAME`` is available.
16 Otherwise, you should use module ``platform``.
17 """
18 name = os.environ.get("COMPUTERNAME",
19 os.environ.get("HOSTNAME",
20 os.environ.get("NAME",
21 os.environ.get("TRAVIS_OS_NAME", None))))
22 if name is None:
23 raise ValueError("Unable to find machine name in {0}".format(
24 ",".join(sorted(os.environ.keys()))))
25 return name
28def get_user():
29 """
30 Returns the user name.
32 @return user name
34 The method assumes environment variable ``USERNAME`` or ``USER``
35 is available.
36 """
37 name = os.environ.get("USERNAME", os.environ.get(
38 "USER", os.environ.get("CIRCLE_USERNAME", None)))
39 if name is None:
40 raise ValueError( # pragma: no cover
41 "Unable to find user name in {0}".format(
42 ",".join(sorted(os.environ.keys()))))
43 return name