Datasets:

sia-precision-education

/

sia_pile_sample

like 0

[ "Spawn", "the", "ToolTip", ".", "This", "simply", "makes", "the", "ToolTip", "eligible", "for", "display", ".", "Usually", "this", "is", "caused", "by", "entering", "the", "widget", "Arguments", ":", "event", ":", "The", "event", "that", "called", "this", "funciton" ]

[ "def", "spawn", "(", "self", ",", "event", "=", "None", ")", ":", "self", ".", "visible", "=", "1", "# The after function takes a time argument in miliseconds", "self", ".", "after", "(", "int", "(", "ToolTip", ".", "ShowTipDelay", "*", "1000", ")", ",", "self", ".", "show", ")" ]

[ "Displays", "the", "ToolTip", "if", "the", "time", "delay", "has", "been", "long", "enough" ]

[ "def", "show", "(", "self", ")", ":", "if", "ToolTip", ".", "ShowToolTips", "is", "False", ":", "return", "text", "=", "self", ".", "msgVar", ".", "get", "(", ")", "if", "ToolTip", ".", "ShowTipNumber", "is", "True", "and", "self", ".", "TipID", "is", "not", "None", ":", "# check if text is not there, if so add it", "if", "self", ".", "TipNumText", "not", "in", "text", ":", "self", ".", "msgVar", ".", "set", "(", "self", ".", "TipNumText", "+", "text", ")", "else", ":", "text", ".", "replace", "(", "self", ".", "TipNumText", ",", "\"\"", ")", "self", ".", "msgVar", ".", "set", "(", "text", ")", "if", "self", ".", "visible", "==", "1", "and", "time", "(", ")", "-", "self", ".", "lastMotion", ">", "ToolTip", ".", "ShowTipDelay", ":", "self", ".", "visible", "=", "2", "if", "self", ".", "visible", "==", "2", ":", "self", ".", "deiconify", "(", ")" ]

[ "Processes", "motion", "within", "the", "widget", ".", "Arguments", ":", "event", ":", "The", "event", "that", "called", "this", "function" ]

[ "def", "move", "(", "self", ",", "event", ")", ":", "self", ".", "lastMotion", "=", "time", "(", ")", "# If the follow flag is not set, motion within the widget will", "# make the ToolTip dissapear", "if", "self", ".", "follow", "==", "False", ":", "self", ".", "withdraw", "(", ")", "self", ".", "visible", "=", "1", "# Offset the ToolTip 10x10 pixels southeast of the pointer", "self", ".", "geometry", "(", "'+%i+%i'", "%", "(", "event", ".", "x_root", "+", "10", ",", "event", ".", "y_root", "+", "10", ")", ")", "# Try to call the message function. Will not change the message", "# if the message function is None or the message function fails", "try", ":", "self", ".", "msgVar", ".", "set", "(", "self", ".", "msgFunc", "(", ")", ")", "except", ":", "pass", "self", ".", "after", "(", "int", "(", "ToolTip", ".", "ShowTipDelay", "*", "1000", ")", ",", "self", ".", "show", ")" ]

[ "Hides", "the", "ToolTip", ".", "Usually", "this", "is", "caused", "by", "leaving", "the", "widget", "Arguments", ":", "event", ":", "The", "event", "that", "called", "this", "function" ]

[ "def", "hide", "(", "self", ",", "event", "=", "None", ")", ":", "self", ".", "visible", "=", "0", "self", ".", "withdraw", "(", ")" ]

[ "Can", "t", "seem", "to", "get", "a", "foucs", "highlight", "around", "some", "of", "the", "controls", ".", "So", "I", "m", "using", "color", "changes", "to", "show", "focus", "/", "tab", "stops", ".", "Also", "the", "Scale", "does", "not", "seem", "to", "get", "focus", "by", "clicking", "on", "it", "Need", "to", "force", "focus", "when", "the", "user", "clicks", "on", "it" ]

[ "def", "SetControlMapping", "(", "self", ")", ":", "#Style().configure('.', font=('Helvetica', 12)) # all", "Style", "(", ")", ".", "configure", "(", "'RedMessage.TLabel'", ",", "font", "=", "(", "'Arial'", ",", "10", ",", "\"italic\"", ")", ",", "foreground", "=", "'red'", ")", "# These dont work since they're overriden by the map later on... ???", "Style", "(", ")", ".", "configure", "(", "'Error.TEntry'", ",", "background", "=", "'red'", ",", "foreground", "=", "'white'", ")", "Style", "(", ")", ".", "configure", "(", "'OK.TEntry'", ",", "background", "=", "'white'", ",", "foreground", "=", "'black'", ")", "Style", "(", ")", ".", "configure", "(", "'DataLabel.TLabel'", ",", "foreground", "=", "'blue'", ",", "font", "=", "(", "'Arial'", ",", "10", ")", ")", "Style", "(", ")", ".", "configure", "(", "'StatusBar.TLabel'", ",", "background", "=", "self", ".", "FocusColor", ",", "relief", "=", "SUNKEN", ")", "Style", "(", ")", ".", "configure", "(", "'TMenu'", ",", "background", "=", "'white'", ",", "activeforeground", "=", "'lightblue'", ")", "Style", "(", ")", ".", "map", "(", "'TPanedwindow'", ",", "background", "=", "[", "(", "'!active'", ",", "'#f0f0ff'", ")", ",", "]", ",", ")", "Style", "(", ")", ".", "map", "(", "'TCombobox'", ",", "fieldbackground", "=", "[", "(", "'focus'", ",", "'!disabled'", ",", "self", ".", "FocusColor", ")", ",", "(", "'!focus'", ",", "'active'", ",", "'!disabled'", ",", "self", ".", "NoFocusMouseOverColor", ")", ",", "(", "'!focus'", ",", "'!active'", ",", "'!disabled'", ",", "self", ".", "NoFocusNoMouseOverColor", ")", ",", "#('disabled','lightgray'), # Use foreground", "]", ",", "foreground", "=", "[", "(", "'disabled'", ",", "'gray'", ")", ",", "(", "'!disabled'", ",", "'black'", ")", "]", ",", "selectbackground", "=", "[", "(", "'focus'", ",", "'!disabled'", ",", "self", ".", "FocusColor", ")", ",", "(", "'!focus'", ",", "'active'", ",", "'!disabled'", ",", "self", ".", "NoFocusMouseOverColor", ")", ",", "(", "'!focus'", ",", "'!active'", ",", "'!disabled'", ",", "self", ".", "NoFocusNoMouseOverColor", ")", ",", "#('disabled','lightgray'),", "]", ",", "selectforeground", "=", "[", "(", "'!focus'", ",", "'black'", ")", ",", "(", "'readonly'", ",", "'black'", ")", ",", "(", "'focus'", ",", "'black'", ")", ",", "(", "'disabled'", ",", "'black'", ")", ",", "(", "'!disabled'", ",", "'black'", ")", "]", ",", ")", "# close map", "Style", "(", ")", ".", "map", "(", "'TEntry'", ",", "# This one is just for 'look and feel'", "fieldbackground", "=", "[", "(", "'focus'", ",", "'!disabled'", ",", "'!invalid'", ",", "self", ".", "FocusColor", ")", ",", "(", "'!focus'", ",", "'active'", ",", "'!disabled'", ",", "'!invalid'", ",", "self", ".", "NoFocusMouseOverColor", ")", ",", "(", "'!focus'", ",", "'!active'", ",", "'!disabled'", ",", "'!invalid'", ",", "self", ".", "NoFocusNoMouseOverColor", ")", ",", "(", "'invalid'", ",", "'#FF0000'", ")", "#('disabled','lightgray'),", "]", ",", "foreground", "=", "[", "(", "'disabled'", ",", "'!invalid'", ",", "'gray'", ")", ",", "(", "'!disabled'", ",", "'!invalid'", ",", "'black'", ")", "#('invalid', self.NoFocusNoMouseOverColor)", "]", ",", "#background = [", "#('focus','!disabled',self.FocusColor),", "#('!focus','active','!disabled',self.NoFocusMouseOverColor'),", "#('!focus','!active','!disabled',self.NoFocusNoMouseOverColor),", "##('disabled','lightgray'),", "#],", "#selectbackground = [", "#('focus','!disabled',self.FocusColor),", "#('!focus','active','!disabled',self.NoFocusMouseOverColor),", "#('!focus','!active','!disabled',self.NoFocusNoMouseOverColor).", "##('disabled','lightgray'),", "#],", "selectforeground", "=", "[", "(", "'!focus'", ",", "'black'", ")", ",", "(", "'focus'", ",", "'white'", ")", ",", "]", ",", ")", "# close map", "#Style().map('TMenubutton',# This one is just for 'look and feel'", "#fieldbackground = [", "#('focus','!disabled',self.FocusColor),", "#('!focus','active','!disabled',self.NoFocusMouseOverColor),", "#('!focus','!active','!disabled',self.NoFocusNoMouseOverColor),", "##('disabled','lightgray'),", "#],", "#foreground = [", "#('disabled','gray'),", "#('!disabled', 'black')", "#],", "#background = [", "#('focus','!disabled',self.FocusColor),", "#('!focus','active','!disabled',self.NoFocusMouseOverColor),", "#('!focus','!active','!disabled',self.NoFocusNoMouseOverColor),", "##('disabled','lightgray'),", "#],", "#selectbackground = [", "#('focus','!disabled',self.FocusColor),", "#('!focus','active','!disabled',self.NoFocusMouseOverColor),", "#('!focus','!active','!disabled',self.NoFocusNoMouseOverColor),", "##('disabled','lightgray'),", "#],", "#selectforeground = [", "#('!focus','black'),", "#('focus','white'),", "#],", "#) # close map", "Style", "(", ")", ".", "map", "(", "\"Horizontal.TScale\"", ",", "troughcolor", "=", "[", "(", "'focus'", ",", "'!disabled'", ",", "self", ".", "FocusColor", ")", ",", "(", "'!focus'", ",", "'active'", ",", "'!disabled'", ",", "self", ".", "NoFocusMouseOverColor", ")", ",", "(", "'!focus'", ",", "'!active'", ",", "'!disabled'", ",", "self", ".", "NoFocusNoMouseOverColor", ")", ",", "(", "'disabled'", ",", "'lightgray'", ")", ",", "]", ",", ")", "# close map", "Style", "(", ")", ".", "map", "(", "\"Vertical.TScale\"", ",", "troughcolor", "=", "[", "(", "'focus'", ",", "'!disabled'", ",", "self", ".", "FocusColor", ")", ",", "(", "'!focus'", ",", "'active'", ",", "'!disabled'", ",", "self", ".", "NoFocusMouseOverColor", ")", ",", "(", "'!focus'", ",", "'!active'", ",", "'!disabled'", ",", "self", ".", "NoFocusNoMouseOverColor", ")", ",", "(", "'disabled'", ",", "'lightgray'", ")", ",", "]", ",", ")", "# close map", "Style", "(", ")", ".", "map", "(", "\"TMenu\"", ",", "background", "=", "[", "(", "'focus'", ",", "'!disabled'", ",", "self", ".", "FocusColor", ")", ",", "(", "'!focus'", ",", "'active'", ",", "'!disabled'", ",", "self", ".", "NoFocusMouseOverColor", ")", ",", "(", "'!focus'", ",", "'!active'", ",", "'!disabled'", ",", "self", ".", "NoFocusNoMouseOverColor", ")", ",", "(", "'disabled'", ",", "'lightgray'", ")", ",", "]", ",", ")" ]

[ "Implement", "Record", "Sequence" ]

[ "def", "LoadImageFromStream", "(", "self", ",", "zoom", ")", ":", "if", "self", ".", "photo", ":", "del", "self", ".", "photo", "self", ".", "pictureStream", ".", "seek", "(", "0", ")", "self", ".", "CurrentImage", "=", "PIL", ".", "Image", ".", "open", "(", "self", ".", "pictureStream", ")", "# https://pillow.readthedocs.io/en/3.1.x/reference/Image.html#the-image-class", "self", ".", "RawEXIFData", "=", "None", "if", "PreferencesDialog", ".", "DefaultPhotoFormat", "==", "'jpeg'", ":", "self", ".", "RawEXIFData", "=", "self", ".", "CurrentImage", ".", "info", "[", "'exif'", "]", "# Works!!!!", "#print ( self.RawEXIFData )", "self", ".", "CameraUtils", ".", "AddEXIFTags", "(", "self", ".", "CurrentImage", ")", "self", ".", "ShowHideImageAttributesPane", "(", "self", ".", "viewImageAttributesPane", ".", "get", "(", ")", ")", "# resize what's displayed if user used Ctrl+mousewheel", "size", "=", "self", ".", "CurrentImage", ".", "size", "if", "size", "[", "0", "]", "<=", "1024", "and", "size", "[", "1", "]", "<=", "768", ":", "# hold max zoom level", "width", "=", "int", "(", "zoom", "*", "size", "[", "0", "]", ")", "height", "=", "int", "(", "zoom", "*", "size", "[", "1", "]", ")", "if", "width", "<=", "1024", "and", "height", "<=", "768", ":", "self", ".", "CurrentImage", "=", "self", ".", "CurrentImage", ".", "resize", "(", "(", "width", ",", "height", ")", ",", "PIL", ".", "Image", ".", "ANTIALIAS", ")", "self", ".", "CurrentImageSize", "=", "self", ".", "CurrentImage", ".", "size", "# Convert to canvas compatible format and store on canvas", "self", ".", "photo", "=", "ImageTk", ".", "PhotoImage", "(", "self", ".", "CurrentImage", ")", "self", ".", "photoCanvas", ".", "delete", "(", "\"pic\"", ")", "self", ".", "photoCanvas", ".", "create_image", "(", "0", ",", "0", ",", "image", "=", "self", ".", "photo", ",", "anchor", "=", "'nw'", ",", "tags", "=", "(", "'pic'", ")", ")", "self", ".", "photoCanvas", ".", "config", "(", "scrollregion", "=", "self", ".", "photoCanvas", ".", "bbox", "(", "ALL", ")", ")", "self", ".", "photoCanvas", ".", "tag_raise", "(", "\"objs\"", ")", "# raise Z order of cursors to topmost" ]

[ "The", "Combobox", "is", "a", "problem", ".", "Could", "save", "last", "two", "entries", "...", "if", "Combobox", "Labelframe", "Tk", "...", "NO!", "this", "could", "be", "the", "Topwindow", "losing", "focus", "while", "the", "Combobox", "has", "the", "focus", ".", "The", "same", "effect", "Also", "the", "nesting", "may", "vary", "based", "on", "where", "the", "Combobox", "is", "in", "the", "hierarcy", ".", "What", "I", "really", "want", "is", "to", "capture", "the", "<B1", "-", "Motion", ">", "on", "the", "TopWindow", "titlebar", "-", "OR", "-", "get", "the", "widget", "ID", "to", "the", "Combobox", "Toplevel", "dropdown", "window", "." ]

[ "def", "LoseFocus", "(", "self", ",", "event", ")", ":", "if", "self", ".", "camera", ".", "preview", "and", "not", "self", ".", "AlwaysPreview", "and", "event", ".", "widget", ".", "winfo_class", "(", ")", ".", "lower", "(", ")", "==", "'tk'", "and", "self", ".", "root", ".", "attributes", "(", "\"-topmost\"", ")", "==", "0", ":", "# TopMost window hack", "if", "self", ".", "ShowOnScreen", ".", "get", "(", ")", "==", "False", ":", "self", ".", "camera", ".", "preview", ".", "alpha", "=", "0", "self", ".", "ImageCanvas", ".", "itemconfigure", "(", "'nopreview'", ",", "state", "=", "'normal'", ")" ]

[ "Configuration", "files", "in", "python", "There", "are", "several", "ways", "to", "do", "this", "depending", "on", "the", "file", "format", "required", ".", "ConfigParser", "[", ".", "ini", "format", "]", "Write", "a", "file", "like", "so", ":", "from", "ConfigParser", "import", "SafeConfigParser", "config", "=", "SafeConfigParser", "()", "config", ".", "read", "(", "config", ".", "ini", ")", "config", ".", "add_section", "(", "main", ")", "config", ".", "set", "(", "main", "key1", "value1", ")", "config", ".", "set", "(", "main", "key2", "value2", ")", "config", ".", "set", "(", "main", "key3", "value3", ")" ]

[ "def", "BuildPage", "(", "self", ")", ":", "# Setup default folder to save pictures and videos", "f", "=", "MyLabelFrame", "(", "self", ",", "'Set default directories'", ",", "0", ",", "0", ")", "self", ".", "iconCameraBig", "=", "PIL", ".", "Image", ".", "open", "(", "'Assets/camera-icon.png'", ")", "self", ".", "iconCameraBig", "=", "ImageTk", ".", "PhotoImage", "(", "self", ".", "iconCameraBig", ".", "resize", "(", "(", "22", ",", "22", ")", ",", "Image", ".", "ANTIALIAS", ")", ")", "self", ".", "iconVideoBig", "=", "PIL", ".", "Image", ".", "open", "(", "'Assets/video-icon-b.png'", ")", "self", ".", "iconVideoBig", "=", "ImageTk", ".", "PhotoImage", "(", "self", ".", "iconVideoBig", ".", "resize", "(", "(", "22", ",", "22", ")", ",", "Image", ".", "ANTIALIAS", ")", ")", "self", ".", "iconFiles", "=", "PIL", ".", "Image", ".", "open", "(", "'Assets/files.png'", ")", "self", ".", "iconFiles", "=", "ImageTk", ".", "PhotoImage", "(", "self", ".", "iconFiles", ".", "resize", "(", "(", "22", ",", "22", ")", ",", "Image", ".", "ANTIALIAS", ")", ")", "b", "=", "ttk", ".", "Button", "(", "f", ",", "text", "=", "\"Photos...\"", ",", "image", "=", "self", ".", "iconCameraBig", ",", "compound", "=", "'left'", ",", "command", "=", "self", ".", "SelectPhotoDirectory", ",", "width", "=", "7", ")", "b", ".", "grid", "(", "row", "=", "0", ",", "column", "=", "0", ",", "sticky", "=", "'W'", ",", "pady", "=", "(", "5", ",", "5", ")", ")", "ToolTip", "(", "b", ",", "6000", ")", "self", ".", "PhotoDirLabel", "=", "Label", "(", "f", ",", "foreground", "=", "'#0000FF'", ",", "text", "=", "PreferencesDialog", ".", "DefaultPhotoDir", ",", "anchor", "=", "W", ")", "self", ".", "PhotoDirLabel", ".", "grid", "(", "row", "=", "0", ",", "column", "=", "1", ",", "sticky", "=", "'EW'", ",", "padx", "=", "10", ")", "ToolTip", "(", "self", ".", "PhotoDirLabel", ",", "6001", ")", "b", "=", "ttk", ".", "Button", "(", "f", ",", "text", "=", "\"Videos...\"", ",", "image", "=", "self", ".", "iconVideoBig", ",", "compound", "=", "'left'", ",", "command", "=", "self", ".", "SelectVideoDirectory", ",", "width", "=", "7", ")", "b", ".", "grid", "(", "row", "=", "1", ",", "column", "=", "0", ",", "sticky", "=", "'W'", ")", "ToolTip", "(", "b", ",", "6002", ")", "self", ".", "VideoDirLabel", "=", "Label", "(", "f", ",", "foreground", "=", "'#0000FF'", ",", "text", "=", "PreferencesDialog", ".", "DefaultVideoDir", ",", "anchor", "=", "W", ")", "self", ".", "VideoDirLabel", ".", "grid", "(", "row", "=", "1", ",", "column", "=", "1", ",", "sticky", "=", "'EW'", ",", "padx", "=", "10", ")", "ToolTip", "(", "self", ".", "VideoDirLabel", ",", "6003", ")", "b", "=", "ttk", ".", "Button", "(", "f", ",", "text", "=", "\"Files...\"", ",", "image", "=", "self", ".", "iconFiles", ",", "compound", "=", "'left'", ",", "command", "=", "self", ".", "SelectFilesDirectory", ",", "width", "=", "7", ")", "b", ".", "grid", "(", "row", "=", "2", ",", "column", "=", "0", ",", "sticky", "=", "'W'", ",", "pady", "=", "(", "5", ",", "5", ")", ")", "ToolTip", "(", "b", ",", "6004", ")", "self", ".", "FilesDirLabel", "=", "Label", "(", "f", ",", "foreground", "=", "'#0000FF'", ",", "text", "=", "PreferencesDialog", ".", "DefaultFilesDir", ",", "anchor", "=", "W", ")", "self", ".", "FilesDirLabel", ".", "grid", "(", "row", "=", "2", ",", "column", "=", "1", ",", "sticky", "=", "'EW'", ",", "padx", "=", "10", ")", "ToolTip", "(", "self", ".", "FilesDirLabel", ",", "6005", ")", "f", "=", "MyLabelFrame", "(", "self", ",", "'Photo/Video capture formats'", ",", "1", ",", "0", ")", "ttk", ".", "Label", "(", "f", ",", "text", "=", "'Photo capture format'", ",", "padding", "=", "(", "5", ",", "5", ",", "5", ",", "5", ")", ")", ".", "grid", "(", "row", "=", "0", ",", "column", "=", "0", ",", "sticky", "=", "'W'", ")", "self", ".", "photoCaptureFormatCombo", "=", "Combobox", "(", "f", ",", "height", "=", "15", ",", "width", "=", "8", ",", "state", "=", "'readonly'", ")", "#,width=15)", "self", ".", "photoCaptureFormatCombo", ".", "grid", "(", "row", "=", "0", ",", "column", "=", "1", ",", "sticky", "=", "'EW'", ")", "self", ".", "photoFormats", "=", "[", "'jpeg'", ",", "'png'", ",", "'bmp'", ",", "'gif'", ",", "'yuv'", ",", "'rgb'", ",", "'rgba'", ",", "'bgr'", ",", "'bgra'", ",", "'raw'", "]", "self", ".", "photoCaptureFormatCombo", "[", "'values'", "]", "=", "self", ".", "photoFormats", "self", ".", "photoCaptureFormatCombo", ".", "current", "(", "self", ".", "photoFormats", ".", "index", "(", "PreferencesDialog", ".", "DefaultPhotoFormat", ")", ")", "self", ".", "photoCaptureFormatCombo", ".", "bind", "(", "'<<ComboboxSelected>>'", ",", "self", ".", "photoCaptureFormatChanged", ")", "ToolTip", "(", "self", ".", "photoCaptureFormatCombo", ",", "msg", "=", "6010", ")", "self", ".", "ModFormatParams", "=", "ttk", ".", "Button", "(", "f", ",", "text", "=", "'Params...'", ",", "command", "=", "self", ".", "ModifyFormatParamPressed", ",", "underline", "=", "0", ",", "padding", "=", "(", "5", ",", "3", ",", "5", ",", "3", ")", ",", "width", "=", "8", ")", "self", ".", "ModFormatParams", ".", "grid", "(", "row", "=", "0", ",", "column", "=", "2", ",", "sticky", "=", "'W'", ",", "padx", "=", "5", ")", "ToolTip", "(", "self", ".", "ModFormatParams", ",", "msg", "=", "6011", ")", "ttk", ".", "Label", "(", "f", ",", "text", "=", "'Video capture format'", ",", "padding", "=", "(", "5", ",", "5", ",", "5", ",", "5", ")", ")", ".", "grid", "(", "row", "=", "1", ",", "column", "=", "0", ",", "sticky", "=", "'W'", ")", "self", ".", "VideoCaptureFormatCombo", "=", "Combobox", "(", "f", ",", "height", "=", "15", ",", "width", "=", "8", ",", "state", "=", "'readonly'", ")", "#,width=15)", "self", ".", "VideoCaptureFormatCombo", ".", "grid", "(", "row", "=", "1", ",", "column", "=", "1", ",", "sticky", "=", "'EW'", ")", "self", ".", "videoFormats", "=", "[", "'h264'", ",", "'mjpeg'", ",", "'yuv'", ",", "'rgb'", ",", "'rgba'", ",", "'bgr'", ",", "'bgra'", "]", "self", ".", "VideoCaptureFormatCombo", "[", "'values'", "]", "=", "self", ".", "videoFormats", "self", ".", "VideoCaptureFormatCombo", ".", "current", "(", "self", ".", "videoFormats", ".", "index", "(", "PreferencesDialog", ".", "DefaultVideoFormat", ")", ")", "self", ".", "VideoCaptureFormatCombo", ".", "bind", "(", "'<<ComboboxSelected>>'", ",", "self", ".", "VideoCaptureFormatChanged", ")", "ToolTip", "(", "self", ".", "VideoCaptureFormatCombo", ",", "6020", ")", "self", ".", "ModVideoFormatParams", "=", "ttk", ".", "Button", "(", "f", ",", "text", "=", "'Params...'", ",", "command", "=", "self", ".", "ModifyVideoFormatParamPressed", ",", "underline", "=", "0", ",", "padding", "=", "(", "5", ",", "3", ",", "5", ",", "3", ")", ",", "width", "=", "8", ")", "self", ".", "ModVideoFormatParams", ".", "grid", "(", "row", "=", "1", ",", "column", "=", "2", ",", "sticky", "=", "'W'", ",", "padx", "=", "5", ")", "ToolTip", "(", "self", ".", "ModVideoFormatParams", ",", "6021", ")", "# Save / Restore camera settings? This may be a bit to do", "f", "=", "MyLabelFrame", "(", "self", ",", "'Photo/Video naming'", ",", "2", ",", "0", ")", "Label", "(", "f", ",", "text", "=", "'Timestamp format:'", ")", ".", "grid", "(", "row", "=", "0", ",", "column", "=", "0", ",", "sticky", "=", "'W'", ")", "okCmd", "=", "(", "self", ".", "register", "(", "self", ".", "ValidateTimestamp", ")", ",", "'%P'", ")", "self", ".", "TimeStamp", "=", "MyStringVar", "(", "PreferencesDialog", ".", "DefaultTimestampFormat", ")", "e", "=", "Entry", "(", "f", ",", "width", "=", "20", ",", "validate", "=", "'all'", ",", "textvariable", "=", "self", ".", "TimeStamp", ")", "e", ".", "grid", "(", "row", "=", "0", ",", "column", "=", "1", ",", "sticky", "=", "'W'", ")", "ToolTip", "(", "e", ",", "6050", ")", "image", "=", "PIL", ".", "Image", ".", "open", "(", "'Assets/help.png'", ")", "self", ".", "helpimage", "=", "ImageTk", ".", "PhotoImage", "(", "image", ".", "resize", "(", "(", "16", ",", "16", ")", ")", ")", "b", "=", "ttk", ".", "Button", "(", "f", ",", "image", "=", "self", ".", "helpimage", ",", "width", "=", "10", ",", "command", "=", "self", ".", "FormatHelp", ",", "padding", "=", "(", "2", ",", "2", ",", "2", ",", "2", ")", ")", "b", ".", "grid", "(", "row", "=", "0", ",", "column", "=", "2", ",", "padx", "=", "5", ")", "ToolTip", "(", "b", ",", "6052", ")", "Label", "(", "f", ",", "text", "=", "'Sample timestamp:'", ")", ".", "grid", "(", "row", "=", "1", ",", "column", "=", "0", ",", "sticky", "=", "'W'", ")", "self", ".", "TimestampLabel", "=", "MyStringVar", "(", "datetime", ".", "datetime", ".", "now", "(", ")", ".", "strftime", "(", "PreferencesDialog", ".", "DefaultTimestampFormat", ")", ")", "self", ".", "tsl", "=", "Label", "(", "f", ",", "textvariable", "=", "self", ".", "TimestampLabel", ",", "foreground", "=", "'#0000FF'", ")", "self", ".", "tsl", ".", "grid", "(", "row", "=", "1", ",", "column", "=", "1", ",", "columnspan", "=", "2", ",", "sticky", "=", "'W'", ")", "ToolTip", "(", "self", ".", "tsl", ",", "6051", ")", "self", ".", "after", "(", "1000", ",", "self", ".", "UpdateTimestamp", ")", "self", ".", "PhotoTimestampVar", "=", "MyBooleanVar", "(", "PreferencesDialog", ".", "PhotoTimestamp", ")", "self", ".", "PhotoTimestamp", "=", "Checkbutton", "(", "f", ",", "text", "=", "'Include timestamp in photo name'", ",", "variable", "=", "self", ".", "PhotoTimestampVar", ",", "command", "=", "self", ".", "PhotoTimestampChecked", ")", "self", ".", "PhotoTimestamp", ".", "grid", "(", "row", "=", "2", ",", "column", "=", "0", ",", "columnspan", "=", "2", ",", "sticky", "=", "'W'", ")", "ToolTip", "(", "self", ".", "PhotoTimestamp", ",", "6060", ")", "self", ".", "VideoTimestampVar", "=", "MyBooleanVar", "(", "PreferencesDialog", ".", "VideoTimestamp", ")", "self", ".", "VideoTimestamp", "=", "Checkbutton", "(", "f", ",", "text", "=", "'Include timestamp in video name'", ",", "variable", "=", "self", ".", "VideoTimestampVar", ",", "command", "=", "self", ".", "VideoTimestampChecked", ")", "self", ".", "VideoTimestamp", ".", "grid", "(", "row", "=", "3", ",", "column", "=", "0", ",", "columnspan", "=", "2", ",", "sticky", "=", "'W'", ")", "ToolTip", "(", "self", ".", "VideoTimestamp", ",", "6061", ")", "e", ".", "config", "(", "validatecommand", "=", "okCmd", ")", "self", ".", "photoCaptureFormatChanged", "(", "None", ")", "self", ".", "VideoCaptureFormatChanged", "(", "None", ")" ]

[ "Returns", "the", "first", "matching", "line", "in", "a", "list", "of", "lines", ".", "See", "match", "()" ]

[ "def", "matching_line", "(", "lines", ",", "keyword", ")", ":", "for", "line", "in", "lines", ":", "matching", "=", "match", "(", "line", ",", "keyword", ")", "if", "matching", "!=", "None", ":", "return", "matching", "return", "None" ]

[ "If", "the", "first", "part", "of", "line", "(", "modulo", "blanks", ")", "matches", "keyword", "returns", "the", "end", "of", "that", "line", ".", "Otherwise", "returns", "None" ]

[ "def", "match", "(", "line", ",", "keyword", ")", ":", "line", "=", "line", ".", "lstrip", "(", ")", "length", "=", "len", "(", "keyword", ")", "if", "line", "[", ":", "length", "]", "==", "keyword", ":", "return", "line", "[", "length", ":", "]", "else", ":", "return", "None" ]

[ "Applies", "the", "rules", "to", "the", "bunch", "of", "text", "describing", "a", "cell", "and", "returns", "the", "corresponding", "dictionary" ]

[ "def", "parse_cell", "(", "cell", ")", ":", "parsed_cell", "=", "{", "}", "for", "key", "in", "rules", ":", "rule", "=", "rules", "[", "key", "]", "parsed_cell", ".", "update", "(", "{", "key", ":", "rule", "(", "cell", ")", "}", ")", "return", "parsed_cell" ]

[ "Starts", "an", "application", "." ]

[ "def", "start_app", "(", "host", ",", "app_id", ",", "data", "=", "None", ")", ":", "if", "data", "is", "None", ":", "data", "=", "{", "\"\"", ":", "\"\"", "}", "CC_SESSION", ".", "post", "(", "_craft_app_url", "(", "host", ",", "app_id", ")", ",", "data", "=", "data", ")" ]

[ "Quits", "specified", "application", "if", "it", "is", "running", ".", "If", "no", "app_id", "specified", "will", "quit", "current", "running", "app", "." ]

[ "def", "quit_app", "(", "host", ",", "app_id", "=", "None", ")", ":", "if", "not", "app_id", ":", "status", "=", "get_app_status", "(", "host", ")", "if", "status", ":", "app_id", "=", "status", ".", "app_id", "if", "app_id", ":", "CC_SESSION", ".", "delete", "(", "_craft_app_url", "(", "host", ",", "app_id", ")", ")" ]

[ "Reboots", "the", "chromecast", "." ]

[ "def", "reboot", "(", "host", ")", ":", "CC_SESSION", ".", "post", "(", "FORMAT_BASE_URL", ".", "format", "(", "host", ")", "+", "\"/setup/reboot\"", ",", "data", "=", "'{\"params\":\"now\"}'", ")" ]

[ "Returns", "the", "device", "status", "as", "a", "named", "tuple", "." ]

[ "def", "get_device_status", "(", "host", ")", ":", "try", ":", "req", "=", "CC_SESSION", ".", "get", "(", "FORMAT_BASE_URL", ".", "format", "(", "host", ")", "+", "\"/ssdp/device-desc.xml\"", ")", "status_el", "=", "ET", ".", "fromstring", "(", "req", ".", "text", ".", "encode", "(", "\"UTF-8\"", ")", ")", "device_info_el", "=", "status_el", ".", "find", "(", "XML_NS_UPNP_DEVICE", "+", "\"device\"", ")", "api_version_el", "=", "status_el", ".", "find", "(", "XML_NS_UPNP_DEVICE", "+", "\"specVersion\"", ")", "friendly_name", "=", "_read_xml_element", "(", "device_info_el", ",", "XML_NS_UPNP_DEVICE", ",", "\"friendlyName\"", ",", "\"Unknown Chromecast\"", ")", "model_name", "=", "_read_xml_element", "(", "device_info_el", ",", "XML_NS_UPNP_DEVICE", ",", "\"modelName\"", ",", "\"Unknown model name\"", ")", "manufacturer", "=", "_read_xml_element", "(", "device_info_el", ",", "XML_NS_UPNP_DEVICE", ",", "\"manufacturer\"", ",", "\"Unknown manufacturer\"", ")", "api_version", "=", "(", "int", "(", "_read_xml_element", "(", "api_version_el", ",", "XML_NS_UPNP_DEVICE", ",", "\"major\"", ",", "-", "1", ")", ")", ",", "int", "(", "_read_xml_element", "(", "api_version_el", ",", "XML_NS_UPNP_DEVICE", ",", "\"minor\"", ",", "-", "1", ")", ")", ")", "return", "DeviceStatus", "(", "friendly_name", ",", "model_name", ",", "manufacturer", ",", "api_version", ")", "except", "(", "requests", ".", "exceptions", ".", "RequestException", ",", "ET", ".", "ParseError", ")", ":", "return", "None" ]

[ "Returns", "the", "status", "of", "the", "specified", "app", "or", "else", "the", "current", "running", "app", "." ]

[ "def", "get_app_status", "(", "host", ",", "app_id", "=", "None", ")", ":", "# /apps/ will redirect to the active app", "url", "=", "(", "FORMAT_APP_PATH", ".", "format", "(", "host", ",", "app_id", ")", "if", "app_id", "else", "FORMAT_BASE_URL", ".", "format", "(", "host", ")", "+", "\"/apps/\"", ")", "try", ":", "req", "=", "CC_SESSION", ".", "get", "(", "url", ")", "if", "req", ".", "status_code", "==", "204", ":", "return", "None", "status_el", "=", "ET", ".", "fromstring", "(", "req", ".", "text", ".", "encode", "(", "\"UTF-8\"", ")", ")", "options", "=", "status_el", ".", "find", "(", "XML_NS_DIAL", "+", "\"options\"", ")", ".", "attrib", "app_id", "=", "_read_xml_element", "(", "status_el", ",", "XML_NS_DIAL", ",", "\"name\"", ",", "\"Unknown application\"", ")", "state", "=", "_read_xml_element", "(", "status_el", ",", "XML_NS_DIAL", ",", "\"state\"", ",", "\"unknown\"", ")", "service_el", "=", "status_el", ".", "find", "(", "XML_NS_CAST", "+", "\"servicedata\"", ")", "if", "service_el", "is", "not", "None", ":", "service_url", "=", "_read_xml_element", "(", "service_el", ",", "XML_NS_CAST", ",", "\"connectionSvcURL\"", ",", "None", ")", "protocols_el", "=", "service_el", ".", "find", "(", "XML_NS_CAST", "+", "\"protocols\"", ")", "if", "protocols_el", "is", "not", "None", ":", "protocols", "=", "[", "el", ".", "text", "for", "el", "in", "protocols_el", "]", "else", ":", "protocols", "=", "[", "]", "else", ":", "service_url", "=", "None", "protocols", "=", "[", "]", "activity_el", "=", "status_el", ".", "find", "(", "XML_NS_CAST", "+", "\"activity-status\"", ")", "if", "activity_el", "is", "not", "None", ":", "description", "=", "_read_xml_element", "(", "activity_el", ",", "XML_NS_CAST", ",", "\"description\"", ",", "app_id", ")", "else", ":", "description", "=", "app_id", "return", "AppStatus", "(", "app_id", ",", "description", ",", "state", ",", "options", ",", "service_url", ",", "protocols", ")", "except", "(", "requests", ".", "exceptions", ".", "RequestException", ",", "ET", ".", "ParseError", ")", ":", "return", "None" ]

[ "Helper", "method", "to", "create", "a", "ChromeCast", "url", "given", "a", "host", "and", "an", "optional", "app_id", "." ]

[ "def", "_craft_app_url", "(", "host", ",", "app_id", "=", "None", ")", ":", "return", "(", "FORMAT_APP_PATH", ".", "format", "(", "host", ",", "app_id", ")", "if", "app_id", "else", "FORMAT_BASE_URL", ".", "format", "(", "host", ")", ")" ]

[ "Helper", "method", "to", "read", "text", "from", "an", "element", "." ]

[ "def", "_read_xml_element", "(", "element", ",", "xml_ns", ",", "tag_name", ",", "default", "=", "\"\"", ")", ":", "try", ":", "return", "element", ".", "find", "(", "xml_ns", "+", "tag_name", ")", ".", "text", "except", "AttributeError", ":", "return", "default" ]

[ "Sends", "a", "message", "over", "the", "network", "to", "discover", "Chromecasts", "and", "returns", "a", "list", "of", "found", "IP", "addresses", "." ]

[ "def", "discover_chromecasts", "(", "max_devices", "=", "None", ",", "timeout", "=", "DISCOVER_TIMEOUT", ")", ":", "ips", "=", "[", "]", "calc_now", "=", "dt", ".", "datetime", ".", "now", "start", "=", "calc_now", "(", ")", "try", ":", "sock", "=", "socket", ".", "socket", "(", "socket", ".", "AF_INET", ",", "socket", ".", "SOCK_DGRAM", ")", "sock", ".", "sendto", "(", "SSDP_REQUEST", ".", "encode", "(", "\"ascii\"", ")", ",", "(", "SSDP_ADDR", ",", "SSDP_PORT", ")", ")", "sock", ".", "setblocking", "(", "0", ")", "while", "True", ":", "time_diff", "=", "calc_now", "(", ")", "-", "start", "seconds_left", "=", "timeout", "-", "time_diff", ".", "seconds", "if", "seconds_left", "<=", "0", ":", "return", "ips", "ready", "=", "select", ".", "select", "(", "[", "sock", "]", ",", "[", "]", ",", "[", "]", ",", "seconds_left", ")", "[", "0", "]", "if", "ready", ":", "response", "=", "sock", ".", "recv", "(", "1024", ")", ".", "decode", "(", "\"ascii\"", ")", "found_ip", "=", "found_st", "=", "None", "headers", "=", "response", ".", "split", "(", "\"\\r\\n\\r\\n\"", ",", "1", ")", "[", "0", "]", "for", "header", "in", "headers", ".", "split", "(", "\"\\r\\n\"", ")", ":", "parts", "=", "header", ".", "split", "(", "\": \"", ",", "1", ")", "# Headers start with something like 'HTTP/1.1 200 OK'", "# We cannot split that up in key-value pair, so skip", "if", "len", "(", "parts", ")", "!=", "2", ":", "continue", "key", ",", "value", "=", "parts", "if", "key", "==", "\"LOCATION\"", ":", "url", "=", "urlparse", ".", "urlparse", "(", "value", ")", "found_ip", "=", "url", ".", "hostname", "elif", "key", "==", "\"ST\"", ":", "found_st", "=", "value", "if", "found_st", "==", "SSDP_ST", "and", "found_ip", ":", "ips", ".", "append", "(", "found_ip", ")", "if", "max_devices", "and", "len", "(", "ips", ")", "==", "max_devices", ":", "return", "ips", "except", "socket", ".", "error", ":", "logging", ".", "getLogger", "(", "__name__", ")", ".", "exception", "(", "\"Socket error while discovering Chromecasts\"", ")", "finally", ":", "sock", ".", "close", "(", ")", "return", "ips" ]

[ "Returns", "all", "possible", "app", "ids", "." ]

[ "def", "get_possible_app_ids", "(", ")", ":", "try", ":", "req", "=", "requests", ".", "get", "(", "\"https://clients3.google.com/cast/chromecast/device/baseconfig\"", ")", "data", "=", "json", ".", "loads", "(", "req", ".", "text", "[", "4", ":", "]", ")", "return", "[", "app", "[", "'app_id'", "]", "for", "app", "in", "data", "[", "'applications'", "]", "]", "+", "data", "[", "\"enabled_app_ids\"", "]", "except", "ValueError", ":", "# If json fails to parse", "return", "[", "]" ]

[ "Get", "specific", "configuration", "for", "app_id", "." ]

[ "def", "get_app_config", "(", "app_id", ")", ":", "try", ":", "req", "=", "requests", ".", "get", "(", "(", "\"https://clients3.google.com/\"", "\"cast/chromecast/device/app?a={}\"", ")", ".", "format", "(", "app_id", ")", ")", "return", "json", ".", "loads", "(", "req", ".", "text", "[", "4", ":", "]", ")", "if", "req", ".", "status_code", "==", "200", "else", "{", "}", "except", "ValueError", ":", "# If json fails to parse", "return", "{", "}" ]

[ "Creates", "and", "returns", "a", "RAMP", "client", "based", "on", "the", "supplied", "app", "status", ".", "Will", "return", "None", "if", "RAMP", "client", "is", "not", "supported", ".", "Will", "raise", "ValueError", "if", "unable", "to", "retrieve", "the", "websocket", "url", "." ]

[ "def", "create_websocket_client", "(", "app_status", ")", ":", "# Check if current app has no service url or no protocols.", "if", "not", "app_status", ".", "service_url", "or", "not", "app_status", ".", "service_protocols", ":", "return", "None", "req", "=", "requests", ".", "post", "(", "app_status", ".", "service_url", ",", "data", "=", "\"{}\"", ".", "encode", "(", "\"ascii\"", ")", ",", "headers", "=", "{", "\"Content-Type\"", ":", "\"application/json\"", "}", ")", "if", "req", ".", "status_code", "!=", "200", ":", "raise", "error", ".", "ConnectionError", "(", "\"Could not retrieve websocket url ({}).\"", ".", "format", "(", "req", ".", "status_code", ")", ")", "conn_data", "=", "json", ".", "loads", "(", "req", ".", "text", ")", "client", "=", "ChromecastWebSocketClient", "(", "conn_data", "[", "'URL'", "]", ",", "app_status", ".", "service_protocols", ")", "client", ".", "connect", "(", ")", "atexit", ".", "register", "(", "_clean_open_clients", ")", "return", "client" ]

[ "Called", "on", "exit", "of", "Python", "to", "close", "open", "clients", "." ]

[ "def", "_clean_open_clients", "(", ")", ":", "for", "client_weakref", "in", "list", "(", "_OPEN_CLIENTS", ")", ":", "client", "=", "client_weakref", "(", ")", "if", "client", "and", "not", "client", ".", "terminated", ":", "client", ".", "close_connection", "(", ")" ]

[ "When", "connection", "is", "opened", "initiate", "the", "protocol", "handlers", "." ]

[ "def", "opened", "(", "self", ")", ":", "_OPEN_CLIENTS", ".", "append", "(", "self", ".", "_weakref", ")", "self", ".", "handlers", "[", "PROTOCOL_COMMAND", "]", "=", "CommandSubprotocol", "(", "self", ")", "_known_prot", "=", "KNOWN_PROTOCOLS", "# Instantiate supported subprotocols.", "for", "protocol", "in", "self", ".", "supported_protocols", ":", "handler", "=", "_known_prot", ".", "get", "(", "protocol", ")", "if", "handler", ":", "self", ".", "handlers", "[", "protocol", "]", "=", "handler", "(", "self", ")", "else", ":", "self", ".", "logger", ".", "warning", "(", "\"Unsupported protocol: {}\"", ".", "format", "(", "protocol", ")", ")" ]

[ "Clear", "protocol", "handlers", "when", "connection", "is", "lost", "." ]

[ "def", "closed", "(", "self", ",", "code", ",", "reason", "=", "None", ")", ":", "# Clear reference to client", "_OPEN_CLIENTS", ".", "remove", "(", "self", ".", "_weakref", ")", "for", "handler", "in", "self", ".", "handlers", ".", "values", "(", ")", ":", "handler", ".", "client", "=", "None", "self", ".", "handlers", ".", "clear", "(", ")" ]

[ "When", "a", "new", "message", "is", "received", "." ]

[ "def", "received_message", "(", "self", ",", "message", ")", ":", "# We do not support binary message", "if", "message", ".", "is_binary", ":", "return", "False", "try", ":", "protocol", ",", "data", "=", "json", ".", "loads", "(", "message", ".", "data", ".", "decode", "(", "'utf8'", ")", ")", "except", "ValueError", ":", "# If error while parsing JSON", "# if unpack error: more then 2 items in the list", "logging", ".", "getLogger", "(", "__name__", ")", ".", "exception", "(", "\"Error parsing incoming message: {}\"", ".", "format", "(", "message", ".", "data", ".", "decode", "(", "\"utf8\"", ")", ")", ")", "return", "if", "_DEBUG", ":", "logging", ".", "getLogger", "(", "__name__", ")", ".", "info", "(", "\"Receiving {}\"", ".", "format", "(", "data", ")", ")", "handler", "=", "self", ".", "handlers", ".", "get", "(", "protocol", ")", "if", "handler", ":", "handler", ".", "_receive_protocol", "(", "data", ")", "# pylint: disable=protected-access", "else", ":", "logging", ".", "getLogger", "(", "__name__", ")", ".", "warning", "(", "\"Unknown protocol received: {}, {}\"", ".", "format", "(", "protocol", ",", "data", ")", ")" ]

[ "Default", "handler", "for", "sending", "messages", "as", "subprotocol", "." ]

[ "def", "_send_protocol", "(", "self", ",", "data", ")", ":", "if", "_DEBUG", ":", "self", ".", "logger", ".", "info", "(", "\"Sending {}\"", ".", "format", "(", "data", ")", ")", "if", "not", "self", ".", "client", ":", "raise", "error", ".", "ConnectionError", "(", "\"Not connected to Chromecast\"", ")", "try", ":", "self", ".", "client", ".", "send", "(", "json", ".", "dumps", "(", "[", "self", ".", "protocol", ",", "data", "]", ")", ".", "encode", "(", "\"utf8\"", ")", ")", "except", "socket", ".", "error", ":", "# if an error occured sending data over the socket", "raise", "error", ".", "ConnectionError", "(", "\"Error communicating with Chromecast\"", ")" ]

[ "Default", "handler", "for", "receiving", "messages", "as", "subprotocol", "." ]

[ "def", "_receive_protocol", "(", "self", ",", "data", ")", ":", "self", ".", "logger", ".", "warning", "(", "\"Unhandled {} message: {}\"", ".", "format", "(", "self", ".", "protocol", ",", "data", ")", ")" ]

[ "Returns", "if", "this", "subprotocol", "is", "active", "." ]

[ "def", "is_active", "(", "self", ")", ":", "return", "not", "self", ".", "client", ".", "terminated" ]

[ "Handles", "an", "incoming", "COMMAND", "message", "." ]

[ "def", "_receive_protocol", "(", "self", ",", "data", ")", ":", "if", "data", "[", "COMMAND_ATTR_TYPE", "]", "==", "COMMAND_TYPE_PING", ":", "self", ".", "_send_protocol", "(", "{", "COMMAND_ATTR_TYPE", ":", "COMMAND_TYPE_PONG", "}", ")", "else", ":", "BaseSubprotocol", ".", "_receive_protocol", "(", "self", ",", "data", ")" ]

[ "Handles", "an", "incoming", "Ramp", "message", "." ]

[ "def", "_receive_protocol", "(", "self", ",", "data", ")", ":", "message_type", "=", "data", "[", "RAMP_ATTR_TYPE", "]", "if", "message_type", "==", "RAMP_TYPE_STATUS", ":", "self", ".", "_update_status", "(", "data", "[", "RAMP_ATTR_STATUS", "]", ")", "elif", "message_type", "==", "RAMP_TYPE_RESPONSE", ":", "# Match it with the command that we send", "try", ":", "cmd_type", ",", "cmd_event", "=", "self", ".", "commands", ".", "pop", "(", "data", "[", "RAMP_ATTR_CMD_ID", "]", ")", "except", "KeyError", ":", "# If CMD_ID did not exist or we do not recognize command", "return", "# Handle response, currently no response handlers", "if", "cmd_type", "in", "(", "RAMP_TYPE_PLAY", ",", "RAMP_TYPE_VOLUME", ",", "RAMP_TYPE_INFO", ")", ":", "self", ".", "_update_status", "(", "data", "[", "RAMP_ATTR_STATUS", "]", ")", "else", ":", "self", ".", "logger", ".", "warning", "(", "\"Unhandled response for command {}: {}\"", ".", "format", "(", "cmd_type", ",", "data", ")", ")", "# Alert code that is waiting for this command to get response", "if", "cmd_event", ":", "cmd_event", ".", "set", "(", ")", "else", ":", "BaseSubprotocol", ".", "_receive_protocol", "(", "self", ",", "data", ")" ]

[ "Sends", "a", "RAMP", "message", ".", "Set", "blocking", "=", "True", "to", "wait", "till", "the", "Chromecast", "sends", "a", "response", "to", "the", "command", "." ]

[ "def", "_send_ramp", "(", "self", ",", "data", ",", "blocking", "=", "False", ")", ":", "data", "[", "RAMP_ATTR_CMD_ID", "]", "=", "self", ".", "command_id", "event", "=", "threading", ".", "Event", "(", ")", "if", "blocking", "else", "None", "# Save type to match later with response", "self", ".", "commands", "[", "self", ".", "command_id", "]", "=", "(", "data", "[", "RAMP_ATTR_TYPE", "]", ",", "event", ")", "self", ".", "_send_protocol", "(", "data", ")", "self", ".", "command_id", "+=", "1", "if", "blocking", ":", "event", ".", "wait", "(", ")" ]

[ "Property", "that", "represents", "if", "content", "is", "being", "played", "." ]

[ "def", "is_playing", "(", "self", ")", ":", "return", "self", ".", "is_active", "and", "self", ".", "state", "==", "RAMP_STATE_PLAYING" ]

[ "Send", "the", "PLAY", "-", "command", "to", "the", "RAMP", "-", "target", "." ]

[ "def", "play", "(", "self", ")", ":", "self", ".", "_send_ramp", "(", "{", "RAMP_ATTR_TYPE", ":", "RAMP_TYPE_PLAY", "}", ")" ]

[ "Send", "the", "PAUSE", "-", "command", "to", "the", "RAMP", "-", "target", "." ]

[ "def", "pause", "(", "self", ")", ":", "# The STOP command actually pauses the media", "self", ".", "_send_ramp", "(", "{", "RAMP_ATTR_TYPE", ":", "RAMP_TYPE_STOP", "}", ")" ]

[ "Plays", "if", "paused", "pauses", "if", "playing", "." ]

[ "def", "playpause", "(", "self", ")", ":", "if", "self", ".", "state", "==", "RAMP_STATE_PLAYING", ":", "self", ".", "pause", "(", ")", "else", ":", "self", ".", "play", "(", ")" ]

[ "Seek", "within", "the", "content", "played", "at", "RAMP", "-", "target", "." ]

[ "def", "seek", "(", "self", ",", "seconds", ")", ":", "self", ".", "_send_ramp", "(", "{", "RAMP_ATTR_TYPE", ":", "RAMP_TYPE_PLAY", ",", "RAMP_ATTR_POSITION", ":", "seconds", "}", ")" ]

[ "Rewinds", "current", "media", "item", "." ]

[ "def", "rewind", "(", "self", ")", ":", "self", ".", "seek", "(", "0", ")" ]

[ "Skip", "to", "the", "next", "content", "at", "the", "RAMP", "-", "target", "." ]

[ "def", "next", "(", "self", ")", ":", "if", "self", ".", "duration", "!=", "0", ":", "self", ".", "seek", "(", "self", ".", "duration", "-", ".1", ")" ]

[ "Set", "volume", "at", "the", "RAMP", "-", "target", "." ]

[ "def", "set_volume", "(", "self", ",", "volume", ")", ":", "# volume is double between 0 and 1", "self", ".", "_send_ramp", "(", "{", "RAMP_ATTR_TYPE", ":", "RAMP_TYPE_VOLUME", ",", "RAMP_ATTR_VOLUME", ":", "volume", "}", ")" ]

[ "Increases", "volume", "." ]

[ "def", "volume_up", "(", "self", ")", ":", "if", "self", ".", "volume", "<", "1", ":", "self", ".", "set_volume", "(", "min", "(", "self", ".", "volume", "+", ".1", ",", "1", ")", ")" ]

[ "Decreases", "volume", "." ]

[ "def", "volume_down", "(", "self", ")", ":", "if", "self", ".", "volume", ">", "0", ":", "self", ".", "set_volume", "(", "max", "(", "self", ".", "volume", "-", ".1", ",", "0", ")", ")" ]

[ "Refresh", "data", "at", "the", "RAMP", "-", "target", "." ]

[ "def", "refresh", "(", "self", ")", ":", "self", ".", "_send_ramp", "(", "{", "RAMP_ATTR_TYPE", ":", "RAMP_TYPE_INFO", "}", ")" ]

[ "Updates", "the", "RAMP", "status", "." ]

[ "def", "_update_status", "(", "self", ",", "status", ")", ":", "con_inf", "=", "status", ".", "get", "(", "RAMP_ATTR_CONTENT_INFO", ",", "{", "}", ")", "self", ".", "state", "=", "status", ".", "get", "(", "RAMP_STATUS_ATTR_STATE", ",", "0", ")", "self", ".", "volume", "=", "status", ".", "get", "(", "RAMP_STATUS_ATTR_VOLUME", ",", "1", ")", "self", ".", "muted", "=", "status", ".", "get", "(", "RAMP_STATUS_ATTR_MUTED", ",", "False", ")", "self", ".", "content_id", "=", "status", ".", "get", "(", "RAMP_STATUS_ATTR_CONTENT_ID", ")", "self", ".", "title", "=", "status", ".", "get", "(", "RAMP_STATUS_ATTR_TITLE", ")", "self", ".", "artist", "=", "con_inf", ".", "get", "(", "RAMP_STATUS_CONTENT_INFO_ATTR_ARTIST", ")", "self", ".", "album", "=", "con_inf", ".", "get", "(", "RAMP_STATUS_CONTENT_INFO_ATTR_ALBUM_TITLE", ")", "self", ".", "_current_time", "=", "status", ".", "get", "(", "RAMP_STATUS_ATTR_CURRENT_TIME", ",", "0", ")", "self", ".", "duration", "=", "status", ".", "get", "(", "RAMP_STATUS_ATTR_DURATION", ",", "0", ")", "self", ".", "image_url", "=", "status", ".", "get", "(", "RAMP_STATUS_ATTR_IMAGE_URL", ")", "self", ".", "time_progress", "=", "status", ".", "get", "(", "RAMP_ATTR_TIME_PROGRESS", ",", "False", ")", "self", ".", "last_updated", "=", "dt", ".", "datetime", ".", "now", "(", ")" ]

[ "Returns", "current", "time", "of", "the", "content", "." ]

[ "def", "current_time", "(", "self", ")", ":", "# If time is progressing we have to calculate the current time based on", "# time the status was retrieved and the then current time.", "if", "self", ".", "time_progress", ":", "timediff", "=", "dt", ".", "datetime", ".", "now", "(", ")", "-", "self", ".", "last_updated", "return", "min", "(", "self", ".", "_current_time", "+", "timediff", ".", "seconds", ",", "self", ".", "duration", ")", "else", ":", "return", "self", ".", "_current_time" ]

[ "Starts", "the", "YouTube", "app", "if", "it", "is", "not", "running", "and", "plays", "specified", "video", "." ]

[ "def", "play_youtube_video", "(", "video_id", ",", "host", "=", "None", ")", ":", "if", "not", "host", ":", "host", "=", "_auto_select_chromecast", "(", ")", "start_app", "(", "host", ",", "APP_ID", "[", "\"YOUTUBE\"", "]", ",", "{", "\"v\"", ":", "video_id", "}", ")" ]

[ "Starts", "the", "YouTube", "app", "if", "it", "is", "not", "running", "and", "plays", "specified", "playlist", "." ]

[ "def", "play_youtube_playlist", "(", "playlist_id", ",", "host", "=", "None", ")", ":", "if", "not", "host", ":", "host", "=", "_auto_select_chromecast", "(", ")", "start_app", "(", "host", ",", "APP_ID", "[", "\"YOUTUBE\"", "]", ",", "{", "\"listType\"", ":", "\"playlist\"", ",", "\"list\"", ":", "playlist_id", "}", ")" ]

[ "Discovers", "local", "Chromecasts", "and", "returns", "first", "one", "found", ".", "Raises", "exception", "if", "none", "can", "be", "found", "." ]

[ "def", "_auto_select_chromecast", "(", ")", ":", "ips", "=", "discover_chromecasts", "(", "1", ")", "if", "ips", ":", "return", "ips", "[", "0", "]", "else", ":", "raise", "NoChromecastFoundError", "(", "\"Unable to detect Chromecast\"", ")" ]

[ "Returns", "the", "current", "app_id", "." ]

[ "def", "app_id", "(", "self", ")", ":", "return", "self", ".", "app", ".", "app_id", "if", "self", ".", "app", "else", "None" ]

[ "Returns", "the", "name", "of", "the", "current", "running", "app", "." ]

[ "def", "app_description", "(", "self", ")", ":", "return", "self", ".", "app", ".", "description", "if", "self", ".", "app", "else", "None" ]

[ "Returns", "the", "current", "RAMP", "content", "info", "and", "controls", "." ]

[ "def", "get_protocol", "(", "self", ",", "protocol", ")", ":", "if", "self", ".", "websocket_client", ":", "return", "self", ".", "websocket_client", ".", "handlers", ".", "get", "(", "protocol", ")", "else", ":", "return", "None" ]

[ "Queries", "the", "Chromecast", "for", "the", "current", "status", ".", "Starts", "a", "websocket", "client", "if", "possible", "." ]

[ "def", "refresh", "(", "self", ")", ":", "self", ".", "logger", ".", "info", "(", "\"Refreshing app status\"", ")", "# If we are refreshing but a refresh was planned, cancel that one", "with", "self", ".", "_refresh_lock", ":", "if", "self", ".", "_refresh_timer", ":", "self", ".", "_refresh_timer", ".", "cancel", "(", ")", "self", ".", "_refresh_timer", "=", "None", "cur_app", "=", "self", ".", "app", "cur_ws", "=", "self", ".", "websocket_client", "self", ".", "app", "=", "app", "=", "get_app_status", "(", "self", ".", "host", ")", "# If no previous app and no new app there is nothing to do", "if", "not", "cur_app", "and", "not", "app", ":", "is_diff_app", "=", "False", "else", ":", "is_diff_app", "=", "(", "not", "cur_app", "and", "app", "or", "cur_app", "and", "not", "app", "or", "cur_app", ".", "app_id", "!=", "app", ".", "app_id", ")", "# Clean up websocket if:", "# - there is a different app and a connection exists", "# - if it is the same app but the connection is terminated", "if", "cur_ws", "and", "(", "is_diff_app", "or", "cur_ws", ".", "terminated", ")", ":", "if", "not", "cur_ws", ".", "terminated", ":", "cur_ws", ".", "close_connection", "(", ")", "self", ".", "websocket_client", "=", "cur_ws", "=", "None", "# Create a new websocket client if there is no connection", "if", "not", "cur_ws", "and", "app", ":", "try", ":", "# If the current app is not capable of a websocket client", "# This method will return None so nothing is lost", "self", ".", "websocket_client", "=", "cur_ws", "=", "create_websocket_client", "(", "app", ")", "except", "ConnectionError", ":", "pass", "# Ramp service does not always immediately show up in the app", "# status. If we do not have a websocket client but the app is", "# known to be RAMP controllable, then plan refresh.", "if", "not", "cur_ws", "and", "app", ".", "app_id", "in", "RAMP_ENABLED", ":", "self", ".", "_delayed_refresh", "(", ")" ]

[ "Start", "an", "app", "on", "the", "Chromecast", "." ]

[ "def", "start_app", "(", "self", ",", "app_id", ",", "data", "=", "None", ")", ":", "self", ".", "logger", ".", "info", "(", "\"Starting app {}\"", ".", "format", "(", "app_id", ")", ")", "# data parameter has to contain atleast 1 key", "# or else some apps won't show", "start_app", "(", "self", ".", "host", ",", "app_id", ",", "data", ")", "self", ".", "_delayed_refresh", "(", ")" ]

[ "Tells", "the", "Chromecast", "to", "quit", "current", "app_id", "." ]

[ "def", "quit_app", "(", "self", ")", ":", "self", ".", "logger", ".", "info", "(", "\"Quiting current app\"", ")", "quit_app", "(", "self", ".", "host", ")", "self", ".", "_delayed_refresh", "(", ")" ]

[ "Give", "the", "ChromeCast", "time", "to", "start", "the", "app", "then", "refresh", "app", "." ]

[ "def", "_delayed_refresh", "(", "self", ")", ":", "with", "self", ".", "_refresh_lock", ":", "if", "self", ".", "_refresh_timer", ":", "self", ".", "_refresh_timer", ".", "cancel", "(", ")", "self", ".", "_refresh_timer", "=", "threading", ".", "Timer", "(", "5", ",", "self", ".", "refresh", ")", "self", ".", "_refresh_timer", ".", "start", "(", ")" ]

[ "Parse", "timestamp", "from", "log", "line" ]

[ "def", "_get_time", "(", "log", ")", ":", "tstamp", "=", "log", "[", ":", "19", "]", "return", "datetime", ".", "strptime", "(", "tstamp", ",", "\"%Y-%m-%d %H:%M:%S\"", ")" ]

[ "Parse", "logs", "in", "the", "format", "from", "monitor", ".", "py" ]

[ "def", "_parse", "(", "log", ",", "start_time", ")", ":", "log_time", "=", "_get_time", "(", "log", ")", "info", "=", "{", "'date'", ":", "log_time", ",", "'time'", ":", "(", "log_time", "-", "start_time", ")", ".", "total_seconds", "(", ")", "}", "for", "entry", "in", "log", "[", "19", ":", "-", "1", "]", ".", "split", "(", "\";\"", ")", ":", "key", ",", "val", "=", "entry", ".", "split", "(", "\"=\"", ")", "key", "=", "key", ".", "strip", "(", ")", "val", "=", "val", ".", "strip", "(", ")", "if", "(", "key", "==", "\"Lock\"", ")", ":", "val", "=", "\"Locked\"", "if", "val", "==", "\"True\"", "else", "\"Unlocked\"", "# categorial plot", "elif", "(", "key", "==", "\"Level\"", "or", "key", "==", "\"SNR\"", ")", ":", "unit", "=", "re", ".", "sub", "(", "'[0-9.-]'", ",", "''", ",", "val", ")", "val", "=", "val", ".", "replace", "(", "unit", ",", "''", ")", "# The logs from the S400 could return NaN, in which case \"val\" is", "# empty here. Skip these values.", "if", "(", "val", "==", "''", ")", ":", "continue", "val", "=", "float", "(", "val", ")", "elif", "(", "key", "==", "\"BER\"", "or", "key", "==", "\"Packet Errors\"", ")", ":", "val", "=", "float", "(", "val", ")", "else", ":", "raise", "ValueError", "(", "\"Unknown key\"", ")", "info", "[", "key", "]", "=", "val", "return", "info" ]

[ "Plot", "all", "results", "from", "list", "of", "dictionaries" ]

[ "def", "_plot", "(", "ds", ",", "ds_name", ")", ":", "keys", "=", "set", "(", ")", "for", "elem", "in", "ds", ":", "keys", ".", "update", "(", "list", "(", "ds", "[", "0", "]", ".", "keys", "(", ")", ")", ")", "keys", ".", "remove", "(", "\"time\"", ")", "keys", ".", "remove", "(", "\"date\"", ")", "formatter", "=", "DateFormatter", "(", "'%m/%d %H:%M'", ")", "path", "=", "os", ".", "path", ".", "join", "(", "\"figs\"", ",", "ds_name", ")", "if", "not", "os", ".", "path", ".", "isdir", "(", "path", ")", ":", "os", ".", "makedirs", "(", "path", ")", "for", "key", "in", "keys", ":", "logger", ".", "info", "(", "\"Plotting {}\"", ".", "format", "(", "key", ")", ")", "x", "=", "[", "r", "[", "key", "]", "for", "r", "in", "ds", "if", "key", "in", "r", "]", "t", "=", "[", "r", "[", "\"date\"", "]", "for", "r", "in", "ds", "if", "key", "in", "r", "]", "# Add unit to y-label", "if", "(", "key", "==", "\"SNR\"", ")", ":", "ylabel", "=", "\"SNR (dB)\"", "elif", "(", "key", "==", "\"Level\"", ")", ":", "ylabel", "=", "\"Signal Level\"", "# NOTE: the SDR logs positive signal levels rather than dBm.", "if", "(", "all", "(", "[", "val", "<", "0", "for", "val", "in", "x", "]", ")", ")", ":", "ylabel", "+=", "\" (dBm)\"", "else", ":", "ylabel", "=", "key", "fig", ",", "ax", "=", "plt", ".", "subplots", "(", ")", "plt", ".", "plot_date", "(", "t", ",", "x", ",", "ms", "=", "2", ")", "plt", ".", "ylabel", "(", "ylabel", ")", "plt", ".", "xlabel", "(", "\"Time (UTC)\"", ")", "# Plot BER in log scale as it is not zero throughout the acquisition", "if", "(", "key", "==", "\"BER\"", "and", "any", "(", "[", "val", ">", "0", "for", "val", "in", "x", "]", ")", ")", ":", "ax", ".", "set_yscale", "(", "'log'", ")", "ax", ".", "xaxis", ".", "set_major_formatter", "(", "formatter", ")", "ax", ".", "xaxis", ".", "set_tick_params", "(", "rotation", "=", "30", ",", "labelsize", "=", "10", ")", "plt", ".", "tight_layout", "(", ")", "savepath", "=", "os", ".", "path", ".", "join", "(", "path", ",", "key", ".", "replace", "(", "\"/\"", ",", "\"_\"", ")", ".", "lower", "(", ")", "+", "\".png\"", ")", "plt", ".", "savefig", "(", "savepath", ",", "dpi", "=", "300", ")", "plt", ".", "close", "(", ")" ]

[ "Parse", "and", "plot", "receiver", "metrics" ]

[ "def", "_analyze", "(", "logs", ",", "ds_name", ")", ":", "start_time", "=", "_get_time", "(", "logs", "[", "0", "]", ")", "ds", "=", "list", "(", ")", "for", "log", "in", "logs", ":", "logger", ".", "debug", "(", "log", ")", "res", "=", "_parse", "(", "log", ",", "start_time", ")", "logger", ".", "debug", "(", "res", ")", "if", "(", "res", "is", "not", "None", ")", ":", "ds", ".", "append", "(", "res", ")", "_plot", "(", "ds", ",", "ds_name", ")" ]

[ "Convert", "footnotes", "from", "github", "-", "flavored", "markdown", "into", "extended", "markdown" ]

[ "def", "convert_footnotes", "(", "text", ",", "doc", ")", ":", "lines", "=", "text", ".", "splitlines", "(", ")", "footnote", "=", "None", "for", "i", ",", "line", "in", "enumerate", "(", "lines", ")", ":", "if", "\"<sup>\"", "in", "line", ":", "footnote", "=", "re", ".", "search", "(", "r\"^(.*?)\"", ",", "line", ")", ".", "group", "(", "1", ")", "if", "doc", "not", "in", "footnote_map", ":", "footnote_map", "[", "doc", "]", "=", "{", "}", "# Assign a global footnote number", "if", "footnote", "in", "footnote_map", "[", "doc", "]", ":", "i_footnote", "=", "footnote_map", "[", "doc", "]", "[", "footnote", "]", "[", "'idx'", "]", "else", ":", "i_footnote", "=", "sum", "(", "[", "len", "(", "x", ")", "for", "x", "in", "footnote_map", ".", "values", "(", ")", "]", ")", "+", "1", "footnote_map", "[", "doc", "]", "[", "footnote", "]", "=", "{", "'idx'", ":", "i_footnote", ",", "'ref_missing'", ":", "True", "}", "if", "footnote_map", "[", "doc", "]", "[", "footnote", "]", "[", "'ref_missing'", "]", ":", "# Footnote reference (without colon)", "lines", "[", "i", "]", "=", "line", ".", "replace", "(", "\"^{\"", "+", "footnote", "+", "\"}\"", ",", "\"[^{}]\"", ".", "format", "(", "i_footnote", ")", ")", "footnote_map", "[", "doc", "]", "[", "footnote", "]", "[", "'ref_missing'", "]", "=", "False", "else", ":", "# Footnote definition (with colon)", "lines", "[", "i", "]", "=", "line", ".", "replace", "(", "\"^{\"", "+", "footnote", "+", "\"}\"", ",", "\"[^{}]:\"", ".", "format", "(", "i_footnote", ")", ")", "return", "\"\\n\"", ".", "join", "(", "lines", ")" ]

[ "Remove", "the", "YAML", "front", "matter", "of", "a", "Markdown", "document" ]

[ "def", "remove_yaml_front_matter", "(", "text", ")", ":", "if", "text", "[", "0", ":", "4", "]", "==", "\"---\\n\"", ":", "# Find where the front matter ends", "lines", "=", "text", ".", "splitlines", "(", ")", "i_end", "=", "1", "while", "(", "i_end", "<", "10", ")", ":", "# front matter should use less than 10 lines", "if", "lines", "[", "i_end", "]", "==", "\"---\"", ":", "break", "i_end", "+=", "1", "assert", "(", "i_end", "<", "10", ")", ",", "\"Failed to find YAML front matter closure\"", "# Remove also the extra line break after the front matter", "if", "(", "lines", "[", "i_end", "+", "1", "]", "==", "\"\"", ")", ":", "i_end", "+=", "1", "text", "=", "\"\\n\"", ".", "join", "(", "lines", "[", "(", "i_end", "+", "1", ")", ":", "]", ")", "return", "text" ]

[ "Change", "document", "links", "to", "anchor", "links", "on", "the", "concatenated", "text" ]

[ "def", "fix_links", "(", "concat_text", ",", "docs", ",", "title_map", ",", "absent_docs", ")", ":", "# Replace all document links with the corresponding anchor link", "for", "doc", "in", "docs", ":", "# Convert title to the corresponding markdown anchor link", "anchor_link", "=", "title_map", "[", "doc", "]", ".", "lower", "(", ")", ".", "replace", "(", "\" \"", ",", "\"-\"", ")", "# Replace direct links", "original_link", "=", "\"({})\"", ".", "format", "(", "doc", ")", "new_link", "=", "\"(#{})\"", ".", "format", "(", "anchor_link", ")", "concat_text", "=", "concat_text", ".", "replace", "(", "original_link", ",", "new_link", ")", "# Fix links pointing to a particular subsection", "concat_text", "=", "concat_text", ".", "replace", "(", "\"({}#\"", ".", "format", "(", "doc", ")", ",", "\"(#\"", ")", "# Replace links to absent docs", "lines", "=", "concat_text", ".", "splitlines", "(", ")", "for", "doc", "in", "absent_docs", ":", "original_link", "=", "\"({})\"", ".", "format", "(", "doc", ")", "for", "i", ",", "line", "in", "enumerate", "(", "lines", ")", ":", "if", "original_link", "in", "line", ":", "match", "=", "re", ".", "search", "(", "r\"\\[(.*?)\\]\\(\"", "+", "doc", "+", "r\"\\)\"", ",", "line", ")", "lines", "[", "i", "]", "=", "line", ".", "replace", "(", "match", ".", "group", "(", "0", ")", ",", "match", ".", "group", "(", "1", ")", ")", "return", "\"\\n\"", ".", "join", "(", "lines", ")" ]

[ "Get", "iptables", "rules", "that", "are", "specifically", "applied", "to", "a", "target", "interface" ]

[ "def", "_get_iptables_rules", "(", "net_if", ")", ":", "# Unfortunately, root privileges are required to read the current firewall", "# rules. Hence, we can't read the current rules without eventually asking", "# the root password in dry-run mode. As a workaround, return an empty list", "# as if the rule was not set yet.", "if", "(", "runner", ".", "dry", ")", ":", "return", "[", "]", "# Get rules", "cmd", "=", "[", "\"iptables\"", ",", "\"-L\"", ",", "\"-v\"", ",", "\"--line-numbers\"", "]", "res", "=", "runner", ".", "run", "(", "cmd", ",", "root", "=", "True", ",", "capture_output", "=", "True", ")", ".", "stdout", "# Parse", "header1", "=", "\"\"", "header2", "=", "\"\"", "rules", "=", "list", "(", ")", "for", "line", "in", "res", ".", "splitlines", "(", ")", ":", "if", "(", "\"Chain INPUT\"", "in", "line", ".", "decode", "(", ")", ")", ":", "header1", "=", "line", ".", "decode", "(", ")", "if", "(", "\"destination\"", "in", "line", ".", "decode", "(", ")", ")", ":", "header2", "=", "line", ".", "decode", "(", ")", "if", "(", "net_if", "in", "line", ".", "decode", "(", ")", ")", ":", "rules", ".", "append", "(", "{", "'rule'", ":", "line", ".", "decode", "(", ")", ".", "split", "(", ")", ",", "'header1'", ":", "header1", ",", "'header2'", ":", "header2", "}", ")", "return", "rules" ]

[ "Check", "if", "an", "iptables", "rule", "for", "IGMP", "is", "already", "configured" ]

[ "def", "_is_iptables_igmp_rule_set", "(", "net_if", ",", "cmd", ")", ":", "assert", "(", "cmd", "[", "0", "]", "!=", "\"sudo\"", ")", "for", "rule", "in", "_get_iptables_rules", "(", "net_if", ")", ":", "if", "(", "rule", "[", "'rule'", "]", "[", "3", "]", "==", "\"ACCEPT\"", "and", "rule", "[", "'rule'", "]", "[", "6", "]", "==", "cmd", "[", "6", "]", "and", "rule", "[", "'rule'", "]", "[", "4", "]", "==", "\"igmp\"", ")", ":", "print", "(", "\"\\nFirewall rule for IGMP already configured\\n\"", ")", "print", "(", "rule", "[", "'header1'", "]", ")", "print", "(", "rule", "[", "'header2'", "]", ")", "print", "(", "\" \"", ".", "join", "(", "rule", "[", "'rule'", "]", ")", ")", "print", "(", "\"\\nSkipping...\"", ")", "return", "True", "return", "False" ]

[ "Check", "if", "an", "iptables", "rule", "for", "UDP", "is", "already", "configured" ]

[ "def", "_is_iptables_udp_rule_set", "(", "net_if", ",", "cmd", ")", ":", "assert", "(", "cmd", "[", "0", "]", "!=", "\"sudo\"", ")", "for", "rule", "in", "_get_iptables_rules", "(", "net_if", ")", ":", "if", "(", "rule", "[", "'rule'", "]", "[", "3", "]", "==", "\"ACCEPT\"", "and", "rule", "[", "'rule'", "]", "[", "6", "]", "==", "cmd", "[", "6", "]", "and", "rule", "[", "'rule'", "]", "[", "4", "]", "==", "\"udp\"", "and", "rule", "[", "'rule'", "]", "[", "12", "]", "==", "cmd", "[", "10", "]", ")", ":", "print", "(", "\"\\nFirewall rule already configured\\n\"", ")", "print", "(", "rule", "[", "'header1'", "]", ")", "print", "(", "rule", "[", "'header2'", "]", ")", "print", "(", "\" \"", ".", "join", "(", "rule", "[", "'rule'", "]", ")", ")", "print", "(", "\"\\nSkipping...\"", ")", "return", "True", "return", "False" ]

[ "Add", "iptables", "rule" ]

[ "def", "_add_iptables_rule", "(", "net_if", ",", "cmd", ")", ":", "assert", "(", "cmd", "[", "0", "]", "!=", "\"sudo\"", ")", "# Set up the iptables rules", "runner", ".", "run", "(", "cmd", ",", "root", "=", "True", ")", "for", "rule", "in", "_get_iptables_rules", "(", "net_if", ")", ":", "print_rule", "=", "False", "if", "(", "rule", "[", "'rule'", "]", "[", "3", "]", "==", "\"ACCEPT\"", "and", "rule", "[", "'rule'", "]", "[", "6", "]", "==", "cmd", "[", "6", "]", "and", "rule", "[", "'rule'", "]", "[", "4", "]", "==", "cmd", "[", "4", "]", ")", ":", "if", "(", "cmd", "[", "4", "]", "==", "\"igmp\"", ")", ":", "print_rule", "=", "True", "elif", "(", "cmd", "[", "4", "]", "==", "\"udp\"", "and", "rule", "[", "'rule'", "]", "[", "12", "]", "==", "cmd", "[", "10", "]", ")", ":", "print_rule", "=", "True", "if", "(", "print_rule", ")", ":", "print", "(", "\"Added iptables rule:\\n\"", ")", "print", "(", "rule", "[", "'header1'", "]", ")", "print", "(", "rule", "[", "'header2'", "]", ")", "print", "(", "\" \"", ".", "join", "(", "rule", "[", "'rule'", "]", ")", "+", "\"\\n\"", ")" ]

[ "Configure", "iptables", "rules", "to", "accept", "blocksat", "traffic", "on", "a", "DVB", "-", "S2", "interface" ]

[ "def", "_configure_iptables", "(", "net_if", ",", "ports", ",", "igmp", "=", "False", ",", "prompt", "=", "True", ")", ":", "cmd", "=", "[", "\"iptables\"", ",", "\"-I\"", ",", "\"INPUT\"", ",", "\"-p\"", ",", "\"udp\"", ",", "\"-i\"", ",", "net_if", ",", "\"--match\"", ",", "\"multiport\"", ",", "\"--dports\"", ",", "\",\"", ".", "join", "(", "ports", ")", ",", "\"-j\"", ",", "\"ACCEPT\"", ",", "]", "util", ".", "fill_print", "(", "\"A firewall rule is required to accept Blocksat traffic arriving \"", "+", "\"through interface {} towards UDP ports {}.\"", ".", "format", "(", "net_if", ",", "\",\"", ".", "join", "(", "ports", ")", ")", ")", "if", "(", "runner", ".", "dry", ")", ":", "util", ".", "fill_print", "(", "\"The following command would be executed:\"", ")", "if", "(", "not", "_is_iptables_udp_rule_set", "(", "net_if", ",", "cmd", ")", ")", ":", "if", "(", "runner", ".", "dry", "or", "(", "not", "prompt", ")", "or", "util", ".", "ask_yes_or_no", "(", "\"Add the corresponding ACCEPT firewall rule?\"", ")", ")", ":", "_add_iptables_rule", "(", "net_if", ",", "cmd", ")", "else", ":", "print", "(", "\"\\nFirewall configuration cancelled\"", ")", "# We're done, unless we also need to configure an IGMP rule", "if", "(", "not", "igmp", ")", ":", "return", "# IGMP rule supports standalone DVB receivers. The host in this case will", "# need to periodically send IGMP membership reports in order for upstream", "# switches between itself and the DVB receiver to continue delivering the", "# multicast-addressed traffic. This overcomes the scenario where group", "# membership timeouts are implemented by the intermediate switches.", "cmd", "=", "[", "\"iptables\"", ",", "\"-I\"", ",", "\"INPUT\"", ",", "\"-p\"", ",", "\"igmp\"", ",", "\"-i\"", ",", "net_if", ",", "\"-j\"", ",", "\"ACCEPT\"", ",", "]", "print", "(", ")", "util", ".", "fill_print", "(", "\"A firewall rule is required to accept IGMP queries arriving from the \"", "\"standalone DVB-S2 receiver on interface {}.\"", ".", "format", "(", "net_if", ")", ")", "if", "(", "runner", ".", "dry", ")", ":", "util", ".", "fill_print", "(", "\"The following command would be executed:\"", ")", "if", "(", "not", "_is_iptables_igmp_rule_set", "(", "net_if", ",", "cmd", ")", ")", ":", "if", "(", "runner", ".", "dry", "or", "(", "not", "prompt", ")", "or", "util", ".", "ask_yes_or_no", "(", "\"Add the corresponding ACCEPT firewall rule?\"", ")", ")", ":", "_add_iptables_rule", "(", "net_if", ",", "cmd", ")", "else", ":", "print", "(", "\"\\nIGMP firewall rule cancelled\"", ")" ]

[ "Check", "if", "the", "firewall", "is", "based", "on", "firewalld" ]

[ "def", "is_firewalld", "(", ")", ":", "if", "(", "which", "(", "'firewall-cmd'", ")", "is", "None", ")", ":", "return", "False", "if", "(", "which", "(", "'systemctl'", ")", "is", "None", ")", ":", "# Can't check whether firewalld is running", "return", "False", "# Run the following commands even in dry-run mode", "res1", "=", "runner", ".", "run", "(", "[", "'systemctl'", ",", "'is-active'", ",", "'--quiet'", ",", "'firewalld'", "]", ",", "nodry", "=", "True", ",", "nocheck", "=", "True", ")", "res2", "=", "runner", ".", "run", "(", "[", "'systemctl'", ",", "'is-active'", ",", "'--quiet'", ",", "'iptables'", "]", ",", "nodry", "=", "True", ",", "nocheck", "=", "True", ")", "# If running (active), 'is-active' returns 0", "if", "(", "res1", ".", "returncode", "==", "0", "and", "res2", ".", "returncode", "==", "0", ")", ":", "raise", "ValueError", "(", "\"Failed to detect firewall system (firewalld or iptables)\"", ")", "return", "(", "res1", ".", "returncode", "==", "0", ")" ]

[ "Configure", "firewalld", "for", "blocksat", "and", "IGMP", "traffic" ]

[ "def", "_configure_firewalld", "(", "net_if", ",", "ports", ",", "src_ip", ",", "igmp", ",", "prompt", ")", ":", "if", "len", "(", "ports", ")", ">", "1", ":", "portrange", "=", "\"{}-{}\"", ".", "format", "(", "min", "(", "ports", ")", ",", "max", "(", "ports", ")", ")", "else", ":", "portrange", "=", "ports", "util", ".", "fill_print", "(", "\"- Configure the firewall to accept Blocksat traffic arriving \"", "+", "\"from {} towards address {} on UDP ports {}:\\n\"", ".", "format", "(", "src_ip", ",", "defs", ".", "mcast_ip", ",", "portrange", ")", ")", "if", "(", "not", "runner", ".", "dry", "and", "prompt", ")", ":", "if", "(", "not", "util", ".", "ask_yes_or_no", "(", "\"Add firewalld rule?\"", ")", ")", ":", "print", "(", "\"\\nFirewall configuration cancelled\"", ")", "return", "rich_rule", "=", "(", "\"rule \"", "\"family=ipv4 \"", "\"source address={} \"", "\"destination address={}/32 \"", "\"port port={} protocol=udp accept\"", ".", "format", "(", "src_ip", ",", "defs", ".", "mcast_ip", ",", "portrange", ")", ")", "runner", ".", "run", "(", "[", "'firewall-cmd'", ",", "'--add-rich-rule'", ",", "\"{}\"", ".", "format", "(", "rich_rule", ")", "]", ",", "root", "=", "True", ")", "if", "(", "runner", ".", "dry", ")", ":", "print", "(", ")", "util", ".", "fill_print", "(", "\"NOTE: Add \\\"--permanent\\\" to make it persistent. In this case, \"", "\"remember to reload firewalld afterwards.\"", ")", "# We're done, unless we also need to configure an IGMP rule", "if", "(", "not", "igmp", ")", ":", "return", "util", ".", "fill_print", "(", "\"- Allow IGMP packets. This is necessary when using a standalone \"", "\"DVB-S2 receiver connected through a switch:\\n\"", ")", "if", "(", "not", "runner", ".", "dry", "and", "prompt", ")", ":", "if", "(", "not", "util", ".", "ask_yes_or_no", "(", "\"Enable IGMP on the firewall?\"", ")", ")", ":", "print", "(", "\"\\nFirewall configuration cancelled\"", ")", "return", "runner", ".", "run", "(", "[", "'firewall-cmd'", ",", "'--add-protocol=igmp'", "]", ",", "root", "=", "True", ")", "print", "(", ")" ]

[ "Configure", "firewallrules", "to", "accept", "blocksat", "traffic", "via", "DVB", "interface" ]

[ "def", "configure", "(", "net_ifs", ",", "ports", ",", "src_ip", ",", "igmp", "=", "False", ",", "prompt", "=", "True", ",", "dry", "=", "False", ")", ":", "assert", "(", "isinstance", "(", "net_ifs", ",", "list", ")", ")", "runner", ".", "set_dry", "(", "dry", ")", "util", ".", "print_header", "(", "\"Firewall Rules\"", ")", "for", "i", ",", "net_if", "in", "enumerate", "(", "net_ifs", ")", ":", "if", "(", "is_firewalld", "(", ")", ")", ":", "_configure_firewalld", "(", "net_if", ",", "ports", ",", "src_ip", ",", "igmp", ",", "prompt", ")", "else", ":", "_configure_iptables", "(", "net_if", ",", "ports", ",", "igmp", ",", "prompt", ")", "if", "(", "i", "<", "len", "(", "net_ifs", ")", "-", "1", ")", ":", "print", "(", "\"\"", ")" ]

[ "Parser", "for", "firewall", "command" ]

[ "def", "subparser", "(", "subparsers", ")", ":", "p", "=", "subparsers", ".", "add_parser", "(", "'firewall'", ",", "description", "=", "\"Set firewall rules\"", ",", "help", "=", "'Set firewall rules'", ",", "formatter_class", "=", "ArgumentDefaultsHelpFormatter", ")", "p", ".", "add_argument", "(", "'-i'", ",", "'--interface'", ",", "required", "=", "True", ",", "help", "=", "'Network interface'", ")", "p", ".", "add_argument", "(", "'--standalone'", ",", "default", "=", "False", ",", "action", "=", "'store_true'", ",", "help", "=", "'Apply configurations for a standalone DVB-S2 receiver'", ")", "p", ".", "add_argument", "(", "'-y'", ",", "'--yes'", ",", "default", "=", "False", ",", "action", "=", "'store_true'", ",", "help", "=", "\"Default to answering Yes to configuration prompts\"", ")", "p", ".", "add_argument", "(", "\"--dry-run\"", ",", "action", "=", "'store_true'", ",", "default", "=", "False", ",", "help", "=", "\"Print all commands but do not execute them\"", ")", "p", ".", "set_defaults", "(", "func", "=", "firewall_subcommand", ")", "return", "p" ]

[ "Call", "function", "that", "sets", "firewall", "rules" ]

[ "def", "firewall_subcommand", "(", "args", ")", ":", "user_info", "=", "config", ".", "read_cfg_file", "(", "args", ".", "cfg", ",", "args", ".", "cfg_dir", ")", "if", "(", "user_info", "is", "None", ")", ":", "return", "configure", "(", "[", "args", ".", "interface", "]", ",", "defs", ".", "src_ports", ",", "user_info", "[", "'sat'", "]", "[", "'ip'", "]", ",", "igmp", "=", "args", ".", "standalone", ",", "prompt", "=", "(", "not", "args", ".", "yes", ")", ",", "dry", "=", "args", ".", "dry_run", ")" ]

[ "Check", "if", "the", "CLI", "has", "updates", "available", "via", "pip" ]

[ "def", "_check_pip_updates", "(", "cfg_dir", ",", "cli_version", ")", ":", "logger", ".", "debug", "(", "\"Checking blocksat-cli updates\"", ")", "# Save the new pip verification timestamp on the cache file", "update_cache", "=", "UpdateCache", "(", "cfg_dir", ")", "update_cache", ".", "save", "(", ")", "# Is blocksat-cli installed?", "res", "=", "subprocess", ".", "run", "(", "[", "\"pip3\"", ",", "\"show\"", ",", "\"blocksat-cli\"", "]", ",", "stdout", "=", "subprocess", ".", "DEVNULL", ",", "stderr", "=", "subprocess", ".", "DEVNULL", ")", "found", "=", "(", "res", ".", "returncode", "==", "0", ")", "# If the CLI was not installed via pip, don't check updates", "if", "(", "not", "found", ")", ":", "logger", ".", "debug", "(", "\"Could not find blocksat-cli installed via pip3\"", ")", "return", "# Is the CLI outdated?", "try", ":", "outdated_list", "=", "json", ".", "loads", "(", "subprocess", ".", "check_output", "(", "[", "\"pip3\"", ",", "\"list\"", ",", "\"--outdated\"", ",", "\"--format\"", ",", "\"json\"", "]", ",", "stderr", "=", "subprocess", ".", "DEVNULL", ")", ".", "decode", "(", ")", ")", "except", "subprocess", ".", "CalledProcessError", ":", "# Don't break if the command fails. It could be a problem on pip. For", "# example, there is a bug in which pip throws a TypeError on the \"list", "# --outdated\" command saying: '>' not supported between instances of", "# 'Version' and 'Version'", "logger", ".", "warning", "(", "\"Failed to check blocksat-cli updates.\"", ")", "return", "cli_outdated", "=", "False", "for", "package", "in", "outdated_list", ":", "if", "(", "package", "[", "'name'", "]", "==", "\"blocksat-cli\"", ")", ":", "cli_outdated", "=", "True", "# Save the available update on the cache file", "update_cache", ".", "save", "(", "(", "package", "[", "'version'", "]", ",", "package", "[", "'latest_version'", "]", ")", ")", "logger", ".", "debug", "(", "\"Update available for blocksat-cli\"", ")", "if", "(", "not", "cli_outdated", ")", ":", "logger", ".", "debug", "(", "\"blocksat-cli is up-to-date\"", ")", "# Clear a potential update flag on the cache file", "update_cache", ".", "save", "(", ")" ]

[ "Check", "if", "the", "CLI", "has", "updates", "available" ]

[ "def", "check_cli_updates", "(", "args", ",", "cli_version", ")", ":", "# If pip is not available, assume the CLI was not installed via pip", "if", "(", "not", "which", "(", "\"pip3\"", ")", ")", ":", "logger", ".", "debug", "(", "\"pip3 unavailable\"", ")", "return", "# Create the configuration directory if it does not exist", "if", "not", "os", ".", "path", ".", "exists", "(", "args", ".", "cfg_dir", ")", ":", "os", ".", "makedirs", "(", "args", ".", "cfg_dir", ",", "exist_ok", "=", "True", ")", "# Check the update cache file first", "update_cache", "=", "UpdateCache", "(", "args", ".", "cfg_dir", ")", "# If the cache file says there is an update available, check whether the", "# current version is already the updated one. If not, recommend the update.", "if", "(", "update_cache", ".", "has_update", "(", ")", ")", ":", "if", "(", "update_cache", ".", "new_version", "(", ")", ">", "StrictVersion", "(", "cli_version", ")", ")", ":", "# Not updated yet. Recommend it.", "update_cache", ".", "recommend_update", "(", ")", "else", ":", "# Already updated. Clear the update flag.", "update_cache", ".", "save", "(", ")", "return", "# If the last update verification was still recent (less than a day ago),", "# do not check pip. Avoid the unnecessary spawning of the pip-checking", "# thread.", "if", "(", "update_cache", ".", "data", ")", ":", "time_since_last_check", "=", "(", "datetime", ".", "now", "(", ")", "-", "update_cache", ".", "last_check", "(", ")", ")", "if", "(", "time_since_last_check", "<", "timedelta", "(", "days", "=", "1", ")", ")", ":", "logger", ".", "debug", "(", "\"Last update check was less than a day ago: {}\"", ".", "format", "(", "str", "(", "time_since_last_check", ")", ")", ")", "return", "# Check pip updates on a thread. This verification can be slow, so it is", "# better not to block.", "t", "=", "threading", ".", "Thread", "(", "target", "=", "_check_pip_updates", ",", "args", "=", "(", "args", ".", "cfg_dir", ",", "cli_version", ")", ")", "t", ".", "start", "(", ")" ]

[ "UpdateCache", "constructor" ]

[ "def", "__init__", "(", "self", ",", "cfg_dir", ")", ":", "super", "(", ")", ".", "__init__", "(", "cfg_dir", ",", "filename", "=", "\".update\"", ")" ]

[ "Return", "the", "datetime", "corresponding", "to", "the", "last", "update", "verification" ]

[ "def", "last_check", "(", "self", ")", ":", "return", "datetime", ".", "strptime", "(", "self", ".", "data", "[", "'last_check'", "]", ",", "'%Y-%m-%d %H:%M:%S.%f'", ")" ]

[ "Save", "information", "into", "the", "update", "cache", "file" ]

[ "def", "save", "(", "self", ",", "cli_update", "=", "None", ")", ":", "self", ".", "data", "[", "'last_check'", "]", "=", "datetime", ".", "now", "(", ")", ".", "strftime", "(", "'%Y-%m-%d %H:%M:%S.%f'", ")", "self", ".", "data", "[", "'cli_update'", "]", "=", "cli_update", "super", "(", ")", ".", "save", "(", ")" ]

[ "Returns", "whether", "there", "is", "an", "update", "available", "for", "the", "CLI" ]

[ "def", "has_update", "(", "self", ")", ":", "return", "'cli_update'", "in", "self", ".", "data", "and", "self", ".", "data", "[", "'cli_update'", "]", "is", "not", "None" ]

[ "Get", "the", "new", "version", "available", "for", "an", "update" ]

[ "def", "new_version", "(", "self", ")", ":", "return", "StrictVersion", "(", "self", ".", "data", "[", "'cli_update'", "]", "[", "1", "]", ")" ]

[ "Print", "information", "regarding", "the", "recommended", "update" ]

[ "def", "recommend_update", "(", "self", ")", ":", "if", "(", "self", ".", "data", "[", "'cli_update'", "]", "is", "None", ")", ":", "return", "print", "(", "\"\\nUpdate available for blocksat-cli\"", ")", "print", "(", "\"Current version: {}.\\nLatest version: {}.\"", ".", "format", "(", "self", ".", "data", "[", "'cli_update'", "]", "[", "0", "]", ",", "self", ".", "data", "[", "'cli_update'", "]", "[", "1", "]", ")", ")", "print", "(", "\"Please run:\\n\\n pip3 install blocksat-cli --upgrade\\n\\n\"", ")" ]

[ "Cache", "constructor" ]

[ "def", "__init__", "(", "self", ",", "cfg_dir", ",", "filename", "=", "\".cache\"", ")", ":", "self", ".", "path", "=", "os", ".", "path", ".", "join", "(", "cfg_dir", ",", "filename", ")", "self", ".", "data", "=", "{", "}", "self", ".", "load", "(", ")" ]

[ "Load", "data", "from", "the", "cache", "file" ]

[ "def", "load", "(", "self", ")", ":", "if", "(", "not", "os", ".", "path", ".", "exists", "(", "self", ".", "path", ")", ")", ":", "return", "try", ":", "with", "open", "(", "self", ".", "path", ",", "'r'", ")", "as", "fd", ":", "self", ".", "data", "=", "json", ".", "load", "(", "fd", ")", "except", "json", ".", "decoder", ".", "JSONDecodeError", ":", "return" ]

[ "Save", "data", "into", "the", "cache", "file" ]

[ "def", "save", "(", "self", ")", ":", "with", "open", "(", "self", ".", "path", ",", "'w'", ")", "as", "fd", ":", "json", ".", "dump", "(", "self", ".", "data", ",", "fd", ")" ]

[ "Get", "using", "dot", "notation" ]

[ "def", "get", "(", "self", ",", "field", ")", ":", "nested_keys", "=", "field", ".", "split", "(", "'.'", ")", "tmp", "=", "self", ".", "data", "for", "i", ",", "key", "in", "enumerate", "(", "nested_keys", ")", ":", "if", "key", "not", "in", "tmp", ":", "return", "None", "if", "i", "==", "len", "(", "nested_keys", ")", "-", "1", ":", "return", "tmp", "[", "key", "]", "tmp", "=", "tmp", "[", "key", "]" ]

[ "Set", "using", "dot", "notation" ]

[ "def", "set", "(", "self", ",", "field", ",", "val", ",", "overwrite", "=", "True", ")", ":", "nested_keys", "=", "field", ".", "split", "(", "'.'", ")", "tmp", "=", "self", ".", "data", "for", "i", ",", "key", "in", "enumerate", "(", "nested_keys", ")", ":", "if", "key", "not", "in", "tmp", ":", "tmp", "[", "key", "]", "=", "{", "}", "if", "i", "==", "len", "(", "nested_keys", ")", "-", "1", ":", "if", "(", "key", "in", "tmp", "and", "not", "overwrite", ")", ":", "return", "tmp", "[", "key", "]", "=", "val", "tmp", "=", "tmp", "[", "key", "]" ]

[ "Ask", "for", "user", "input", "of", "a", "specific", "type" ]

[ "def", "typed_input", "(", "msg", ",", "hint", "=", "None", ",", "in_type", "=", "int", ",", "default", "=", "None", ")", ":", "res", "=", "None", "while", "(", "res", "is", "None", ")", ":", "try", ":", "if", "(", "default", "is", "not", "None", ")", ":", "assert", "(", "isinstance", "(", "default", ",", "in_type", ")", ")", "input_val", "=", "_input", "(", "msg", "+", "\": [{}] \"", ".", "format", "(", "default", ")", ")", "or", "default", "else", ":", "input_val", "=", "_input", "(", "msg", "+", "\": \"", ")", "res", "=", "in_type", "(", "input_val", ")", "except", "ValueError", ":", "if", "(", "hint", "is", "None", ")", ":", "if", "(", "in_type", "==", "int", ")", ":", "print", "(", "\"Please enter an integer number\"", ")", "elif", "(", "in_type", "==", "float", ")", ":", "print", "(", "\"Please enter a number\"", ")", "elif", "(", "in_type", "==", "IPv4Address", ")", ":", "print", "(", "\"Please enter a valid IPv4 address\"", ")", "else", ":", "type_str", "=", "in_type", ".", "__name__", "print", "(", "\"Please enter a {}\"", ".", "format", "(", "type_str", ")", ")", "else", ":", "print", "(", "hint", ")", "assert", "(", "res", "is", "not", "None", ")", "assert", "(", "isinstance", "(", "res", ",", "in_type", ")", ")", "return", "res" ]

[ "Ask", "for", "a", "non", "-", "null", "string", "input", "with", "an", "optional", "default", "value" ]

[ "def", "string_input", "(", "msg", ",", "default", "=", "None", ")", ":", "res", "=", "\"\"", "while", "(", "len", "(", "res", ")", "==", "0", ")", ":", "if", "(", "default", "is", "not", "None", ")", ":", "assert", "(", "isinstance", "(", "default", ",", "str", ")", ")", "res", "=", "_input", "(", "msg", "+", "\": [{}] \"", ".", "format", "(", "default", ")", ")", "or", "default", "else", ":", "res", "=", "_input", "(", "msg", "+", "\": \"", ")", "return", "res" ]

[ "Yes", "or", "no", "question" ]

[ "def", "ask_yes_or_no", "(", "msg", ",", "default", "=", "\"y\"", ",", "help_msg", "=", "None", ")", ":", "response", "=", "None", "if", "(", "default", "==", "\"y\"", ")", ":", "options", "=", "\"[Y/n]\"", "else", ":", "options", "=", "\"[N/y]\"", "while", "response", "not", "in", "{", "\"y\"", ",", "\"n\"", "}", ":", "if", "(", "help_msg", "is", "None", ")", ":", "question", "=", "msg", "+", "\" \"", "+", "options", "+", "\" \"", "raw_resp", "=", "_input", "(", "question", ")", "or", "default", "else", ":", "print", "(", "textwrap", ".", "fill", "(", "msg", ")", ")", "print", "(", ")", "print", "(", "textwrap", ".", "fill", "(", "help_msg", ")", ")", "print", "(", ")", "raw_resp", "=", "_input", "(", "\"Answer \"", "+", "options", "+", "\" \"", ")", "or", "default", "response", "=", "raw_resp", ".", "lower", "(", ")", "if", "(", "response", "not", "in", "[", "\"y\"", ",", "\"n\"", "]", ")", ":", "print", "(", "\"Please enter \\\"y\\\" or \\\"n\\\"\"", ")", "return", "(", "response", "==", "\"y\"", ")" ]

[ "Multiple", "choice", "question" ]

[ "def", "ask_multiple_choice", "(", "vec", ",", "msg", ",", "label", ",", "to_str", ",", "help_msg", "=", "None", ",", "none_option", "=", "False", ",", "none_str", "=", "\"None of the above\"", ")", ":", "if", "(", "none_option", ")", ":", "assert", "(", "len", "(", "vec", ")", ">", "0", ")", "else", ":", "assert", "(", "len", "(", "vec", ")", ">", "1", ")", "print", "(", "msg", ")", "for", "i_elem", ",", "elem", "in", "enumerate", "(", "vec", ")", ":", "elem_str", "=", "to_str", "(", "elem", ")", "print", "(", "\"[%2u] %s\"", "%", "(", "i_elem", ",", "elem_str", ")", ")", "if", "(", "none_option", ")", ":", "print", "(", "\"[%2u] %s\"", "%", "(", "len", "(", "vec", ")", ",", "none_str", ")", ")", "if", "(", "help_msg", "is", "not", "None", ")", ":", "print", "(", ")", "print", "(", "help_msg", ")", "resp", "=", "None", "while", "(", "not", "isinstance", "(", "resp", ",", "int", ")", ")", ":", "try", ":", "resp", "=", "int", "(", "_input", "(", "\"\\n%s number: \"", "%", "(", "label", ")", ")", ")", "except", "ValueError", ":", "print", "(", "\"Please choose a number\"", ")", "continue", "max_resp", "=", "len", "(", "vec", ")", "+", "1", "if", "none_option", "else", "len", "(", "vec", ")", "if", "(", "resp", ">=", "max_resp", ")", ":", "print", "(", "\"Please choose number from 0 to %u\"", "%", "(", "max_resp", "-", "1", ")", ")", "resp", "=", "None", "continue", "if", "(", "none_option", "and", "resp", "==", "len", "(", "vec", ")", ")", ":", "choice", "=", "None", "print", "(", "none_str", ")", "else", ":", "choice", "=", "copy", ".", "deepcopy", "(", "vec", "[", "resp", "]", ")", "# NOTE: deep copy to prevent the caller from changing the original", "# element.", "print", "(", "to_str", "(", "choice", ")", ")", "print", "(", ")", "return", "choice" ]

[ "Print", "section", "header" ]

[ "def", "print_header", "(", "header", ",", "target_len", "=", "80", ")", ":", "prefix", "=", "\"\"", "suffix", "=", "\"\"", "header_len", "=", "len", "(", "header", ")", "+", "2", "remaining", "=", "target_len", "-", "header_len", "prefix_len", "=", "int", "(", "remaining", "/", "2", ")", "suffix_len", "=", "int", "(", "remaining", "/", "2", ")", "if", "(", "remaining", "%", "1", "==", "1", ")", ":", "prefix_len", "+=", "1", "for", "i", "in", "range", "(", "0", ",", "prefix_len", ")", ":", "prefix", "+=", "\"-\"", "for", "i", "in", "range", "(", "0", ",", "suffix_len", ")", ":", "suffix", "+=", "\"-\"", "print", "(", "\"\\n\"", "+", "prefix", "+", "\" \"", "+", "header", "+", "\" \"", "+", "suffix", ")" ]

[ "Print", "sub", "-", "section", "header" ]

[ "def", "print_sub_header", "(", "header", ",", "target_len", "=", "60", ")", ":", "print_header", "(", "header", ",", "target_len", "=", "target_len", ")" ]

[ "Get", "the", "user", "s", "home", "directory", "even", "if", "running", "with", "sudo" ]

[ "def", "get_home_dir", "(", ")", ":", "sudo_user", "=", "os", ".", "environ", ".", "get", "(", "'SUDO_USER'", ")", "user", "=", "sudo_user", "if", "sudo_user", "is", "not", "None", "else", "\"\"", "return", "os", ".", "path", ".", "expanduser", "(", "\"~\"", "+", "user", ")" ]

[ "Print", "progress", "on", "urlretrieve", "s", "reporthook" ]

[ "def", "_print_urlretrieve_progress", "(", "block_num", ",", "block_size", ",", "total_size", ")", ":", "downloaded", "=", "block_num", "*", "block_size", "progress", "=", "100", "*", "downloaded", "/", "total_size", "if", "(", "total_size", ">", "0", ")", ":", "print", "(", "\"Download progress: {:4.1f}%\"", ".", "format", "(", "progress", ")", ",", "end", "=", "'\\r'", ")", "if", "(", "progress", ">=", "100", ")", ":", "print", "(", "\"\"", ")" ]

[ "Download", "file", "from", "a", "given", "URL" ]

[ "def", "download_file", "(", "url", ",", "destdir", ",", "dry_run", ",", "logger", "=", "None", ")", ":", "filename", "=", "url", ".", "split", "(", "'/'", ")", "[", "-", "1", "]", "local_path", "=", "os", ".", "path", ".", "join", "(", "destdir", ",", "filename", ")", "if", "(", "dry_run", ")", ":", "print", "(", "\"Download: {}\"", ".", "format", "(", "url", ")", ")", "print", "(", "\"Save at: {}\"", ".", "format", "(", "destdir", ")", ")", "return", "if", "(", "logger", "is", "not", "None", ")", ":", "logger", ".", "debug", "(", "\"Download {} and save at {}\"", ".", "format", "(", "url", ",", "destdir", ")", ")", "try", ":", "urlretrieve", "(", "url", ",", "local_path", ",", "_print_urlretrieve_progress", ")", "except", "HTTPError", "as", "e", ":", "logger", ".", "error", "(", "str", "(", "e", ")", ")", "return", "return", "local_path" ]

[ "Generate", "string", "for", "command" ]

[ "def", "_get_cmd_str", "(", "self", ",", "orig_cmd", ")", ":", "quoted_cmd", "=", "orig_cmd", ".", "copy", "(", ")", "for", "i", ",", "elem", "in", "enumerate", "(", "quoted_cmd", ")", ":", "if", "(", "\" \"", "in", "elem", ")", ":", "quoted_cmd", "[", "i", "]", "=", "\"\\'{}\\'\"", ".", "format", "(", "elem", ")", "return", "\"> \"", "+", "\" \"", ".", "join", "(", "quoted_cmd", ")" ]

[ "Create", "file", "with", "given", "content", "on", "a", "specified", "path" ]

[ "def", "create_file", "(", "self", ",", "content", ",", "path", ",", "*", "*", "kwargs", ")", ":", "if", "(", "self", ".", "dry", ")", ":", "# In dry-run mode, run an equivalent echo command.", "cmd", "=", "[", "\"echo\"", ",", "\"-e\"", ",", "repr", "(", "content", ")", ",", "\">\"", ",", "path", "]", "else", ":", "tmp_file", "=", "tempfile", ".", "NamedTemporaryFile", "(", "mode", "=", "\"w\"", ",", "delete", "=", "False", ")", "with", "tmp_file", "as", "fd", ":", "fd", ".", "write", "(", "content", ")", "cmd", "=", "[", "\"mv\"", ",", "tmp_file", ".", "name", ",", "path", "]", "self", ".", "run", "(", "cmd", ",", "*", "*", "kwargs", ")", "if", "(", "not", "self", ".", "dry", ")", ":", "self", ".", "logger", ".", "info", "(", "\"Created file {}\"", ".", "format", "(", "path", ")", ")" ]

[ "Create", "unnamed", "pipe" ]

[ "def", "__init__", "(", "self", ")", ":", "r_fd", ",", "w_fd", "=", "os", ".", "pipe", "(", ")", "self", ".", "r_fd", "=", "r_fd", "# read file descriptor", "self", ".", "r_fo", "=", "os", ".", "fdopen", "(", "r_fd", ",", "\"r\"", ")", "# read file object", "self", ".", "w_fd", "=", "w_fd", "# write file descriptor", "self", ".", "w_fo", "=", "os", ".", "fdopen", "(", "w_fd", ",", "\"w\"", ")" ]

[ "Close", "pipe" ]

[ "def", "__del__", "(", "self", ")", ":", "self", ".", "r_fo", ".", "close", "(", ")", "self", ".", "w_fo", ".", "close", "(", ")" ]

[ "Read", "line", "from", "pipe", "file" ]

[ "def", "readline", "(", "self", ")", ":", "return", "self", ".", "r_fo", ".", "readline", "(", ")" ]

[ "Write", "data", "to", "pipe", "file" ]

[ "def", "write", "(", "self", ",", "data", ")", ":", "self", ".", "w_fo", ".", "write", "(", "data", ")" ]