sources::utils Namespace Reference

fail if argument is provided with deprecation warning

fail if argument provided is a parent of the specified directory

An argument parser that verifies that a string passed in corresponds
to a file

validate that an argument passed in (as string) is a member of the list
of possible arguments after converting it's case.

An argument parser combinator that takes in an argument parser and
creates a new parser that accepts a comma separated list of the same thing.

An argument parser that verifies that a string passed in is either
absolute path or a file name (expanded to
mbed-os/tools/profiles/<fname>.json) of a existing file

Abort with an error that was generated by the arguments to a CLI program

Positional arguments:
parser - the ArgumentParser object that parsed the command line
message - what went wrong

Function checks for Python modules which should be "importable"
    before test suite can be used.
    @return returns True if all modules are installed already

A wrapper to run a command as a blocking job

render a list of strings as a in a bunch of columns

Positional arguments:
strings - the strings to columnate

Keyword arguments;
separator - the separation between the columns
chars - the maximum with of a row

Standard task runner used for compiling

Positional argumets:
job - a dict containing a list of commands and the remaining arguments
      to run_cmd

Create your own pseudo-enums

Keyword arguments:
* - a member of the Enum you are creating and it's value

Implement the behaviour of "shutil.copy(src, dst)" without copying the
permissions (this was causing errors with directories mounted with samba)

Positional arguments:
src - the source of the copy operation
dst - the destination of the copy operation

A function that does rm -rf

Positional arguments:
directory - the directory to remove

Utility function: traverse a dictionary and change all the strings in
the dictionary to ASCII from Unicode. Useful when reading ASCII JSON data,
because the JSON decoder always returns Unicode string. Based on
http://stackoverflow.com/a/13105359

Positional arguments:
dictionary - The dict that contains some Unicode that should be ASCII

Fatal error, abort hard

Positional arguments:
msg - the message to print before crashing

Returns the absolute path to a command.
    None is returned if no absolute path was found.

Positional arguhments:
command - the command to find the path of

When called inside a function, it returns the name
of the caller of that function.

Keyword arguments:
steps - the number of steps up the stack the calling function is

Given a path, return the number of directory levels present.
    This roughly translates to the number of path separators (os.sep) + 1.
    Ex. Given "path/to/dir", this would return 3
    Special cases: "." and "/" return 0

Positional arguments:
path - the path to calculate the depth of

Verify that a command exists and is executable

Positional arguments:
command - the command to check

A simple check to verify that a path to an executable exists

Positional arguments:
path - the executable

Read a JSON file and return its Python representation, transforming all
the strings from Unicode to ASCII. The order of keys in the JSON file is
preserved.

Positional arguments:
fname - the name of the file to parse

a wrapped makedirs that only tries to create a directory if it does not
exist already

Positional arguments:
path - the path to maybe create

Breaks a string up into smaller pieces before print them

This is a limitation within Windows, as detailed here:
https://bugs.python.org/issue11395

Positional arguments:
large_string - the large string to print

Relative path calculation that optionaly always starts with a dot

Positional arguments:
path - the path to make relative
base - what to make the path relative to

Keyword arguments:
dot - if True, the path will always start with a './'

Run a command in the forground

Positional arguments:
command - the command to run

Keyword arguments:
work_dir - the working directory to run the command in
chroot - the chroot to run the command in
redirect - redirect the stderr to a pipe to be used later

A version of run command that checks if the command exists befor running

Positional arguments:
command - the command line you are trying to invoke

spilt a file name into it's directory name, base name, and extension

Positional arguments:
path - the file name to split