Datasets:

---

CM

/

codexglue_code2text_python

like 8

[ "def", "get_create_options", "(", "self", ")", ":", "package", "=", "self", ".", "_get_package", "(", ")", "# Locations", "locations", "=", "[", "]", "for", "region", "in", "package", "[", "'regions'", "]", ":", "locations", ".", "append", "(", "{", "'name'", ":", "region", "[", "'location'", "]", "[", "'location'", "]", "[", "'longName'", "]", ",", "'key'", ":", "region", "[", "'location'", "]", "[", "'location'", "]", "[", "'name'", "]", ",", "}", ")", "# Sizes", "sizes", "=", "[", "]", "for", "preset", "in", "package", "[", "'activePresets'", "]", "+", "package", "[", "'accountRestrictedActivePresets'", "]", ":", "sizes", ".", "append", "(", "{", "'name'", ":", "preset", "[", "'description'", "]", ",", "'key'", ":", "preset", "[", "'keyName'", "]", "}", ")", "# Operating systems", "operating_systems", "=", "[", "]", "for", "item", "in", "package", "[", "'items'", "]", ":", "if", "item", "[", "'itemCategory'", "]", "[", "'categoryCode'", "]", "==", "'os'", ":", "operating_systems", ".", "append", "(", "{", "'name'", ":", "item", "[", "'softwareDescription'", "]", "[", "'longDescription'", "]", ",", "'key'", ":", "item", "[", "'softwareDescription'", "]", "[", "'referenceCode'", "]", ",", "}", ")", "# Port speeds", "port_speeds", "=", "[", "]", "for", "item", "in", "package", "[", "'items'", "]", ":", "if", "all", "(", "[", "item", "[", "'itemCategory'", "]", "[", "'categoryCode'", "]", "==", "'port_speed'", ",", "# Hide private options", "not", "_is_private_port_speed_item", "(", "item", ")", ",", "# Hide unbonded options", "_is_bonded", "(", "item", ")", "]", ")", ":", "port_speeds", ".", "append", "(", "{", "'name'", ":", "item", "[", "'description'", "]", ",", "'key'", ":", "item", "[", "'capacity'", "]", ",", "}", ")", "# Extras", "extras", "=", "[", "]", "for", "item", "in", "package", "[", "'items'", "]", ":", "if", "item", "[", "'itemCategory'", "]", "[", "'categoryCode'", "]", "in", "EXTRA_CATEGORIES", ":", "extras", ".", "append", "(", "{", "'name'", ":", "item", "[", "'description'", "]", ",", "'key'", ":", "item", "[", "'keyName'", "]", "}", ")", "return", "{", "'locations'", ":", "locations", ",", "'sizes'", ":", "sizes", ",", "'operating_systems'", ":", "operating_systems", ",", "'port_speeds'", ":", "port_speeds", ",", "'extras'", ":", "extras", ",", "}" ]

[ "Returns", "valid", "options", "for", "ordering", "hardware", "." ]

[ "def", "_get_package", "(", "self", ")", ":", "mask", "=", "'''\n items[\n keyName,\n capacity,\n description,\n attributes[id,attributeTypeKeyName],\n itemCategory[id,categoryCode],\n softwareDescription[id,referenceCode,longDescription],\n prices\n ],\n activePresets,\n accountRestrictedActivePresets,\n regions[location[location[priceGroups]]]\n '''", "package_keyname", "=", "'BARE_METAL_SERVER'", "package", "=", "self", ".", "ordering_manager", ".", "get_package_by_key", "(", "package_keyname", ",", "mask", "=", "mask", ")", "return", "package" ]

[ "Get", "the", "package", "related", "to", "simple", "hardware", "ordering", "." ]

[ "def", "_generate_create_dict", "(", "self", ",", "size", "=", "None", ",", "hostname", "=", "None", ",", "domain", "=", "None", ",", "location", "=", "None", ",", "os", "=", "None", ",", "port_speed", "=", "None", ",", "ssh_keys", "=", "None", ",", "post_uri", "=", "None", ",", "hourly", "=", "True", ",", "no_public", "=", "False", ",", "extras", "=", "None", ")", ":", "extras", "=", "extras", "or", "[", "]", "package", "=", "self", ".", "_get_package", "(", ")", "location", "=", "_get_location", "(", "package", ",", "location", ")", "prices", "=", "[", "]", "for", "category", "in", "[", "'pri_ip_addresses'", ",", "'vpn_management'", ",", "'remote_management'", "]", ":", "prices", ".", "append", "(", "_get_default_price_id", "(", "package", "[", "'items'", "]", ",", "option", "=", "category", ",", "hourly", "=", "hourly", ",", "location", "=", "location", ")", ")", "prices", ".", "append", "(", "_get_os_price_id", "(", "package", "[", "'items'", "]", ",", "os", ",", "location", "=", "location", ")", ")", "prices", ".", "append", "(", "_get_bandwidth_price_id", "(", "package", "[", "'items'", "]", ",", "hourly", "=", "hourly", ",", "no_public", "=", "no_public", ",", "location", "=", "location", ")", ")", "prices", ".", "append", "(", "_get_port_speed_price_id", "(", "package", "[", "'items'", "]", ",", "port_speed", ",", "no_public", ",", "location", "=", "location", ")", ")", "for", "extra", "in", "extras", ":", "prices", ".", "append", "(", "_get_extra_price_id", "(", "package", "[", "'items'", "]", ",", "extra", ",", "hourly", ",", "location", "=", "location", ")", ")", "hardware", "=", "{", "'hostname'", ":", "hostname", ",", "'domain'", ":", "domain", ",", "}", "order", "=", "{", "'hardware'", ":", "[", "hardware", "]", ",", "'location'", ":", "location", "[", "'keyname'", "]", ",", "'prices'", ":", "[", "{", "'id'", ":", "price", "}", "for", "price", "in", "prices", "]", ",", "'packageId'", ":", "package", "[", "'id'", "]", ",", "'presetId'", ":", "_get_preset_id", "(", "package", ",", "size", ")", ",", "'useHourlyPricing'", ":", "hourly", ",", "}", "if", "post_uri", ":", "order", "[", "'provisionScripts'", "]", "=", "[", "post_uri", "]", "if", "ssh_keys", ":", "order", "[", "'sshKeys'", "]", "=", "[", "{", "'sshKeyIds'", ":", "ssh_keys", "}", "]", "return", "order" ]

[ "Translates", "arguments", "into", "a", "dictionary", "for", "creating", "a", "server", "." ]

[ "def", "_get_ids_from_hostname", "(", "self", ",", "hostname", ")", ":", "results", "=", "self", ".", "list_hardware", "(", "hostname", "=", "hostname", ",", "mask", "=", "\"id\"", ")", "return", "[", "result", "[", "'id'", "]", "for", "result", "in", "results", "]" ]

[ "Returns", "list", "of", "matching", "hardware", "IDs", "for", "a", "given", "hostname", "." ]

[ "def", "_get_ids_from_ip", "(", "self", ",", "ip", ")", ":", "# pylint: disable=inconsistent-return-statements", "try", ":", "# Does it look like an ip address?", "socket", ".", "inet_aton", "(", "ip", ")", "except", "socket", ".", "error", ":", "return", "[", "]", "# Find the server via ip address. First try public ip, then private", "results", "=", "self", ".", "list_hardware", "(", "public_ip", "=", "ip", ",", "mask", "=", "\"id\"", ")", "if", "results", ":", "return", "[", "result", "[", "'id'", "]", "for", "result", "in", "results", "]", "results", "=", "self", ".", "list_hardware", "(", "private_ip", "=", "ip", ",", "mask", "=", "\"id\"", ")", "if", "results", ":", "return", "[", "result", "[", "'id'", "]", "for", "result", "in", "results", "]" ]

[ "Returns", "list", "of", "matching", "hardware", "IDs", "for", "a", "given", "ip", "address", "." ]

[ "def", "edit", "(", "self", ",", "hardware_id", ",", "userdata", "=", "None", ",", "hostname", "=", "None", ",", "domain", "=", "None", ",", "notes", "=", "None", ",", "tags", "=", "None", ")", ":", "obj", "=", "{", "}", "if", "userdata", ":", "self", ".", "hardware", ".", "setUserMetadata", "(", "[", "userdata", "]", ",", "id", "=", "hardware_id", ")", "if", "tags", "is", "not", "None", ":", "self", ".", "hardware", ".", "setTags", "(", "tags", ",", "id", "=", "hardware_id", ")", "if", "hostname", ":", "obj", "[", "'hostname'", "]", "=", "hostname", "if", "domain", ":", "obj", "[", "'domain'", "]", "=", "domain", "if", "notes", ":", "obj", "[", "'notes'", "]", "=", "notes", "if", "not", "obj", ":", "return", "True", "return", "self", ".", "hardware", ".", "editObject", "(", "obj", ",", "id", "=", "hardware_id", ")" ]

[ "Edit", "hostname", "domain", "name", "notes", "user", "data", "of", "the", "hardware", "." ]

[ "def", "update_firmware", "(", "self", ",", "hardware_id", ",", "ipmi", "=", "True", ",", "raid_controller", "=", "True", ",", "bios", "=", "True", ",", "hard_drive", "=", "True", ")", ":", "return", "self", ".", "hardware", ".", "createFirmwareUpdateTransaction", "(", "bool", "(", "ipmi", ")", ",", "bool", "(", "raid_controller", ")", ",", "bool", "(", "bios", ")", ",", "bool", "(", "hard_drive", ")", ",", "id", "=", "hardware_id", ")" ]

[ "Update", "hardware", "firmware", "." ]

[ "def", "reflash_firmware", "(", "self", ",", "hardware_id", ",", "ipmi", "=", "True", ",", "raid_controller", "=", "True", ",", "bios", "=", "True", ")", ":", "return", "self", ".", "hardware", ".", "createFirmwareReflashTransaction", "(", "bool", "(", "ipmi", ")", ",", "bool", "(", "raid_controller", ")", ",", "bool", "(", "bios", ")", ",", "id", "=", "hardware_id", ")" ]

[ "Reflash", "hardware", "firmware", "." ]

[ "def", "wait_for_ready", "(", "self", ",", "instance_id", ",", "limit", "=", "14400", ",", "delay", "=", "10", ",", "pending", "=", "False", ")", ":", "now", "=", "time", ".", "time", "(", ")", "until", "=", "now", "+", "limit", "mask", "=", "\"mask[id, lastOperatingSystemReload[id], activeTransaction, provisionDate]\"", "instance", "=", "self", ".", "get_hardware", "(", "instance_id", ",", "mask", "=", "mask", ")", "while", "now", "<=", "until", ":", "if", "utils", ".", "is_ready", "(", "instance", ",", "pending", ")", ":", "return", "True", "transaction", "=", "utils", ".", "lookup", "(", "instance", ",", "'activeTransaction'", ",", "'transactionStatus'", ",", "'friendlyName'", ")", "snooze", "=", "min", "(", "delay", ",", "until", "-", "now", ")", "LOGGER", ".", "info", "(", "\"%s - %d not ready. Auto retry in %ds\"", ",", "transaction", ",", "instance_id", ",", "snooze", ")", "time", ".", "sleep", "(", "snooze", ")", "instance", "=", "self", ".", "get_hardware", "(", "instance_id", ",", "mask", "=", "mask", ")", "now", "=", "time", ".", "time", "(", ")", "LOGGER", ".", "info", "(", "\"Waiting for %d expired.\"", ",", "instance_id", ")", "return", "False" ]

[ "Determine", "if", "a", "Server", "is", "ready", "." ]

[ "def", "cli", "(", "env", ",", "identifier", ",", "immediate", ",", "comment", ",", "reason", ")", ":", "mgr", "=", "SoftLayer", ".", "HardwareManager", "(", "env", ".", "client", ")", "hw_id", "=", "helpers", ".", "resolve_id", "(", "mgr", ".", "resolve_ids", ",", "identifier", ",", "'hardware'", ")", "if", "not", "(", "env", ".", "skip_confirmations", "or", "formatting", ".", "no_going_back", "(", "hw_id", ")", ")", ":", "raise", "exceptions", ".", "CLIAbort", "(", "'Aborted'", ")", "mgr", ".", "cancel_hardware", "(", "hw_id", ",", "reason", ",", "comment", ",", "immediate", ")" ]

[ "Cancel", "a", "dedicated", "server", "." ]

[ "def", "cli", "(", "env", ",", "identifier", ",", "postinstall", ",", "key", ",", "image", ")", ":", "vsi", "=", "SoftLayer", ".", "VSManager", "(", "env", ".", "client", ")", "vs_id", "=", "helpers", ".", "resolve_id", "(", "vsi", ".", "resolve_ids", ",", "identifier", ",", "'VS'", ")", "keys", "=", "[", "]", "if", "key", ":", "for", "single_key", "in", "key", ":", "resolver", "=", "SoftLayer", ".", "SshKeyManager", "(", "env", ".", "client", ")", ".", "resolve_ids", "key_id", "=", "helpers", ".", "resolve_id", "(", "resolver", ",", "single_key", ",", "'SshKey'", ")", "keys", ".", "append", "(", "key_id", ")", "if", "not", "(", "env", ".", "skip_confirmations", "or", "formatting", ".", "no_going_back", "(", "vs_id", ")", ")", ":", "raise", "exceptions", ".", "CLIAbort", "(", "'Aborted'", ")", "vsi", ".", "reload_instance", "(", "vs_id", ",", "post_uri", "=", "postinstall", ",", "ssh_keys", "=", "keys", ",", "image_id", "=", "image", ")" ]

[ "Reload", "operating", "system", "on", "a", "virtual", "server", "." ]

[ "def", "cli", "(", "env", ",", "identifier", ",", "columns", ")", ":", "manager", "=", "CapacityManager", "(", "env", ".", "client", ")", "mask", "=", "\"\"\"mask[instances[id,createDate,guestId,billingItem[id, description, recurringFee, category[name]],\n guest[modifyDate,id, primaryBackendIpAddress, primaryIpAddress,domain, hostname]]]\"\"\"", "result", "=", "manager", ".", "get_object", "(", "identifier", ",", "mask", ")", "try", ":", "flavor", "=", "result", "[", "'instances'", "]", "[", "0", "]", "[", "'billingItem'", "]", "[", "'description'", "]", "except", "KeyError", ":", "flavor", "=", "\"Pending Approval...\"", "table", "=", "formatting", ".", "Table", "(", "columns", ".", "columns", ",", "title", "=", "\"%s - %s\"", "%", "(", "result", ".", "get", "(", "'name'", ")", ",", "flavor", ")", ")", "# RCI = Reserved Capacity Instance", "for", "rci", "in", "result", "[", "'instances'", "]", ":", "guest", "=", "rci", ".", "get", "(", "'guest'", ",", "None", ")", "if", "guest", "is", "not", "None", ":", "table", ".", "add_row", "(", "[", "value", "or", "formatting", ".", "blank", "(", ")", "for", "value", "in", "columns", ".", "row", "(", "guest", ")", "]", ")", "else", ":", "table", ".", "add_row", "(", "[", "'-'", "for", "value", "in", "columns", ".", "columns", "]", ")", "env", ".", "fout", "(", "table", ")" ]

[ "Reserved", "Capacity", "Group", "details", ".", "Will", "show", "which", "guests", "are", "assigned", "to", "a", "reservation", "." ]

[ "def", "get_client_settings_args", "(", "*", "*", "kwargs", ")", ":", "timeout", "=", "kwargs", ".", "get", "(", "'timeout'", ")", "if", "timeout", "is", "not", "None", ":", "timeout", "=", "float", "(", "timeout", ")", "return", "{", "'endpoint_url'", ":", "kwargs", ".", "get", "(", "'endpoint_url'", ")", ",", "'timeout'", ":", "timeout", ",", "'proxy'", ":", "kwargs", ".", "get", "(", "'proxy'", ")", ",", "'username'", ":", "kwargs", ".", "get", "(", "'username'", ")", ",", "'api_key'", ":", "kwargs", ".", "get", "(", "'api_key'", ")", ",", "}" ]

[ "Retrieve", "client", "settings", "from", "user", "-", "supplied", "arguments", "." ]

[ "def", "get_client_settings_env", "(", "*", "*", "_", ")", ":", "return", "{", "'proxy'", ":", "os", ".", "environ", ".", "get", "(", "'https_proxy'", ")", ",", "'username'", ":", "os", ".", "environ", ".", "get", "(", "'SL_USERNAME'", ")", ",", "'api_key'", ":", "os", ".", "environ", ".", "get", "(", "'SL_API_KEY'", ")", ",", "}" ]

[ "Retrieve", "client", "settings", "from", "environment", "settings", "." ]

[ "def", "get_client_settings_config_file", "(", "*", "*", "kwargs", ")", ":", "# pylint: disable=inconsistent-return-statements", "config_files", "=", "[", "'/etc/softlayer.conf'", ",", "'~/.softlayer'", "]", "if", "kwargs", ".", "get", "(", "'config_file'", ")", ":", "config_files", ".", "append", "(", "kwargs", ".", "get", "(", "'config_file'", ")", ")", "config_files", "=", "[", "os", ".", "path", ".", "expanduser", "(", "f", ")", "for", "f", "in", "config_files", "]", "config", "=", "utils", ".", "configparser", ".", "RawConfigParser", "(", "{", "'username'", ":", "''", ",", "'api_key'", ":", "''", ",", "'endpoint_url'", ":", "''", ",", "'timeout'", ":", "'0'", ",", "'proxy'", ":", "''", ",", "}", ")", "config", ".", "read", "(", "config_files", ")", "if", "config", ".", "has_section", "(", "'softlayer'", ")", ":", "return", "{", "'endpoint_url'", ":", "config", ".", "get", "(", "'softlayer'", ",", "'endpoint_url'", ")", ",", "'timeout'", ":", "config", ".", "getfloat", "(", "'softlayer'", ",", "'timeout'", ")", ",", "'proxy'", ":", "config", ".", "get", "(", "'softlayer'", ",", "'proxy'", ")", ",", "'username'", ":", "config", ".", "get", "(", "'softlayer'", ",", "'username'", ")", ",", "'api_key'", ":", "config", ".", "get", "(", "'softlayer'", ",", "'api_key'", ")", ",", "}" ]

[ "Retrieve", "client", "settings", "from", "the", "possible", "config", "file", "locations", "." ]

[ "def", "get_client_settings", "(", "*", "*", "kwargs", ")", ":", "all_settings", "=", "{", "}", "for", "setting_method", "in", "SETTING_RESOLVERS", ":", "settings", "=", "setting_method", "(", "*", "*", "kwargs", ")", "if", "settings", ":", "settings", ".", "update", "(", "(", "k", ",", "v", ")", "for", "k", ",", "v", "in", "all_settings", ".", "items", "(", ")", "if", "v", ")", "all_settings", "=", "settings", "return", "all_settings" ]

[ "Parse", "client", "settings", "." ]

[ "def", "cli", "(", "env", ",", "package_keyname", ",", "required", ")", ":", "client", "=", "env", ".", "client", "manager", "=", "ordering", ".", "OrderingManager", "(", "client", ")", "table", "=", "formatting", ".", "Table", "(", "COLUMNS", ")", "categories", "=", "manager", ".", "list_categories", "(", "package_keyname", ")", "if", "required", ":", "categories", "=", "[", "cat", "for", "cat", "in", "categories", "if", "cat", "[", "'isRequired'", "]", "]", "for", "cat", "in", "categories", ":", "table", ".", "add_row", "(", "[", "cat", "[", "'itemCategory'", "]", "[", "'name'", "]", ",", "cat", "[", "'itemCategory'", "]", "[", "'categoryCode'", "]", ",", "'Y'", "if", "cat", "[", "'isRequired'", "]", "else", "'N'", "]", ")", "env", ".", "fout", "(", "table", ")" ]

[ "List", "the", "categories", "of", "a", "package", "." ]

[ "def", "list_certs", "(", "self", ",", "method", "=", "'all'", ")", ":", "ssl", "=", "self", ".", "client", "[", "'Account'", "]", "methods", "=", "{", "'all'", ":", "'getSecurityCertificates'", ",", "'expired'", ":", "'getExpiredSecurityCertificates'", ",", "'valid'", ":", "'getValidSecurityCertificates'", "}", "mask", "=", "\"mask[id, commonName, validityDays, notes]\"", "func", "=", "getattr", "(", "ssl", ",", "methods", "[", "method", "]", ")", "return", "func", "(", "mask", "=", "mask", ")" ]

[ "List", "all", "certificates", "." ]

[ "def", "cli", "(", "env", ")", ":", "manager", "=", "SoftLayer", ".", "DNSManager", "(", "env", ".", "client", ")", "zones", "=", "manager", ".", "list_zones", "(", ")", "table", "=", "formatting", ".", "Table", "(", "[", "'id'", ",", "'zone'", ",", "'serial'", ",", "'updated'", "]", ")", "table", ".", "align", "[", "'serial'", "]", "=", "'c'", "table", ".", "align", "[", "'updated'", "]", "=", "'c'", "for", "zone", "in", "zones", ":", "table", ".", "add_row", "(", "[", "zone", "[", "'id'", "]", ",", "zone", "[", "'name'", "]", ",", "zone", "[", "'serial'", "]", ",", "zone", "[", "'updateDate'", "]", ",", "]", ")", "env", ".", "fout", "(", "table", ")" ]

[ "List", "all", "zones", "." ]

[ "def", "list_file_volumes", "(", "self", ",", "datacenter", "=", "None", ",", "username", "=", "None", ",", "storage_type", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "'mask'", "not", "in", "kwargs", ":", "items", "=", "[", "'id'", ",", "'username'", ",", "'capacityGb'", ",", "'bytesUsed'", ",", "'serviceResource.datacenter[name]'", ",", "'serviceResourceBackendIpAddress'", ",", "'activeTransactionCount'", ",", "'fileNetworkMountAddress'", ",", "'replicationPartnerCount'", "]", "kwargs", "[", "'mask'", "]", "=", "','", ".", "join", "(", "items", ")", "_filter", "=", "utils", ".", "NestedDict", "(", "kwargs", ".", "get", "(", "'filter'", ")", "or", "{", "}", ")", "_filter", "[", "'nasNetworkStorage'", "]", "[", "'serviceResource'", "]", "[", "'type'", "]", "[", "'type'", "]", "=", "(", "utils", ".", "query_filter", "(", "'!~ NAS'", ")", ")", "_filter", "[", "'nasNetworkStorage'", "]", "[", "'storageType'", "]", "[", "'keyName'", "]", "=", "(", "utils", ".", "query_filter", "(", "'*FILE_STORAGE*'", ")", ")", "if", "storage_type", ":", "_filter", "[", "'nasNetworkStorage'", "]", "[", "'storageType'", "]", "[", "'keyName'", "]", "=", "(", "utils", ".", "query_filter", "(", "'%s_FILE_STORAGE*'", "%", "storage_type", ".", "upper", "(", ")", ")", ")", "if", "datacenter", ":", "_filter", "[", "'nasNetworkStorage'", "]", "[", "'serviceResource'", "]", "[", "'datacenter'", "]", "[", "'name'", "]", "=", "(", "utils", ".", "query_filter", "(", "datacenter", ")", ")", "if", "username", ":", "_filter", "[", "'nasNetworkStorage'", "]", "[", "'username'", "]", "=", "(", "utils", ".", "query_filter", "(", "username", ")", ")", "kwargs", "[", "'filter'", "]", "=", "_filter", ".", "to_dict", "(", ")", "return", "self", ".", "client", ".", "call", "(", "'Account'", ",", "'getNasNetworkStorage'", ",", "*", "*", "kwargs", ")" ]

[ "Returns", "a", "list", "of", "file", "volumes", "." ]

[ "def", "get_file_volume_details", "(", "self", ",", "volume_id", ",", "*", "*", "kwargs", ")", ":", "if", "'mask'", "not", "in", "kwargs", ":", "items", "=", "[", "'id'", ",", "'username'", ",", "'password'", ",", "'capacityGb'", ",", "'bytesUsed'", ",", "'snapshotCapacityGb'", ",", "'parentVolume.snapshotSizeBytes'", ",", "'storageType.keyName'", ",", "'serviceResource.datacenter[name]'", ",", "'serviceResourceBackendIpAddress'", ",", "'fileNetworkMountAddress'", ",", "'storageTierLevel'", ",", "'provisionedIops'", ",", "'lunId'", ",", "'originalVolumeName'", ",", "'originalSnapshotName'", ",", "'originalVolumeSize'", ",", "'activeTransactionCount'", ",", "'activeTransactions.transactionStatus[friendlyName]'", ",", "'replicationPartnerCount'", ",", "'replicationStatus'", ",", "'replicationPartners[id,username,'", "'serviceResourceBackendIpAddress,'", "'serviceResource[datacenter[name]],'", "'replicationSchedule[type[keyname]]]'", ",", "]", "kwargs", "[", "'mask'", "]", "=", "','", ".", "join", "(", "items", ")", "return", "self", ".", "client", ".", "call", "(", "'Network_Storage'", ",", "'getObject'", ",", "id", "=", "volume_id", ",", "*", "*", "kwargs", ")" ]

[ "Returns", "details", "about", "the", "specified", "volume", "." ]

[ "def", "order_replicant_volume", "(", "self", ",", "volume_id", ",", "snapshot_schedule", ",", "location", ",", "tier", "=", "None", ")", ":", "file_mask", "=", "'billingItem[activeChildren,hourlyFlag],'", "'storageTierLevel,osType,staasVersion,'", "'hasEncryptionAtRest,snapshotCapacityGb,schedules,'", "'intervalSchedule,hourlySchedule,dailySchedule,'", "'weeklySchedule,storageType[keyName],provisionedIops'", "file_volume", "=", "self", ".", "get_file_volume_details", "(", "volume_id", ",", "mask", "=", "file_mask", ")", "order", "=", "storage_utils", ".", "prepare_replicant_order_object", "(", "self", ",", "snapshot_schedule", ",", "location", ",", "tier", ",", "file_volume", ",", "'file'", ")", "return", "self", ".", "client", ".", "call", "(", "'Product_Order'", ",", "'placeOrder'", ",", "order", ")" ]

[ "Places", "an", "order", "for", "a", "replicant", "file", "volume", "." ]

[ "def", "order_duplicate_volume", "(", "self", ",", "origin_volume_id", ",", "origin_snapshot_id", "=", "None", ",", "duplicate_size", "=", "None", ",", "duplicate_iops", "=", "None", ",", "duplicate_tier_level", "=", "None", ",", "duplicate_snapshot_size", "=", "None", ",", "hourly_billing_flag", "=", "False", ")", ":", "file_mask", "=", "'id,billingItem[location,hourlyFlag],snapshotCapacityGb,'", "'storageType[keyName],capacityGb,originalVolumeSize,'", "'provisionedIops,storageTierLevel,'", "'staasVersion,hasEncryptionAtRest'", "origin_volume", "=", "self", ".", "get_file_volume_details", "(", "origin_volume_id", ",", "mask", "=", "file_mask", ")", "order", "=", "storage_utils", ".", "prepare_duplicate_order_object", "(", "self", ",", "origin_volume", ",", "duplicate_iops", ",", "duplicate_tier_level", ",", "duplicate_size", ",", "duplicate_snapshot_size", ",", "'file'", ",", "hourly_billing_flag", ")", "if", "origin_snapshot_id", "is", "not", "None", ":", "order", "[", "'duplicateOriginSnapshotId'", "]", "=", "origin_snapshot_id", "return", "self", ".", "client", ".", "call", "(", "'Product_Order'", ",", "'placeOrder'", ",", "order", ")" ]

[ "Places", "an", "order", "for", "a", "duplicate", "file", "volume", "." ]

[ "def", "order_modified_volume", "(", "self", ",", "volume_id", ",", "new_size", "=", "None", ",", "new_iops", "=", "None", ",", "new_tier_level", "=", "None", ")", ":", "mask_items", "=", "[", "'id'", ",", "'billingItem'", ",", "'storageType[keyName]'", ",", "'capacityGb'", ",", "'provisionedIops'", ",", "'storageTierLevel'", ",", "'staasVersion'", ",", "'hasEncryptionAtRest'", ",", "]", "file_mask", "=", "','", ".", "join", "(", "mask_items", ")", "volume", "=", "self", ".", "get_file_volume_details", "(", "volume_id", ",", "mask", "=", "file_mask", ")", "order", "=", "storage_utils", ".", "prepare_modify_order_object", "(", "self", ",", "volume", ",", "new_iops", ",", "new_tier_level", ",", "new_size", ")", "return", "self", ".", "client", ".", "call", "(", "'Product_Order'", ",", "'placeOrder'", ",", "order", ")" ]

[ "Places", "an", "order", "for", "modifying", "an", "existing", "file", "volume", "." ]

[ "def", "order_snapshot_space", "(", "self", ",", "volume_id", ",", "capacity", ",", "tier", ",", "upgrade", ",", "*", "*", "kwargs", ")", ":", "file_mask", "=", "'id,billingItem[location,hourlyFlag],'", "'storageType[keyName],storageTierLevel,provisionedIops,'", "'staasVersion,hasEncryptionAtRest'", "file_volume", "=", "self", ".", "get_file_volume_details", "(", "volume_id", ",", "mask", "=", "file_mask", ",", "*", "*", "kwargs", ")", "order", "=", "storage_utils", ".", "prepare_snapshot_order_object", "(", "self", ",", "file_volume", ",", "capacity", ",", "tier", ",", "upgrade", ")", "return", "self", ".", "client", ".", "call", "(", "'Product_Order'", ",", "'placeOrder'", ",", "order", ")" ]

[ "Orders", "snapshot", "space", "for", "the", "given", "file", "volume", "." ]

[ "def", "cli", "(", "env", ",", "zone", ")", ":", "manager", "=", "SoftLayer", ".", "DNSManager", "(", "env", ".", "client", ")", "zone_id", "=", "helpers", ".", "resolve_id", "(", "manager", ".", "resolve_ids", ",", "zone", ",", "name", "=", "'zone'", ")", "env", ".", "fout", "(", "manager", ".", "dump_zone", "(", "zone_id", ")", ")" ]

[ "Print", "zone", "in", "BIND", "format", "." ]

[ "def", "rescue", "(", "env", ",", "identifier", ")", ":", "vsi", "=", "SoftLayer", ".", "VSManager", "(", "env", ".", "client", ")", "vs_id", "=", "helpers", ".", "resolve_id", "(", "vsi", ".", "resolve_ids", ",", "identifier", ",", "'VS'", ")", "if", "not", "(", "env", ".", "skip_confirmations", "or", "formatting", ".", "confirm", "(", "\"This action will reboot this VSI. Continue?\"", ")", ")", ":", "raise", "exceptions", ".", "CLIAbort", "(", "'Aborted'", ")", "vsi", ".", "rescue", "(", "vs_id", ")" ]

[ "Reboot", "into", "a", "rescue", "image", "." ]

[ "def", "reboot", "(", "env", ",", "identifier", ",", "hard", ")", ":", "virtual_guest", "=", "env", ".", "client", "[", "'Virtual_Guest'", "]", "mgr", "=", "SoftLayer", ".", "HardwareManager", "(", "env", ".", "client", ")", "vs_id", "=", "helpers", ".", "resolve_id", "(", "mgr", ".", "resolve_ids", ",", "identifier", ",", "'VS'", ")", "if", "not", "(", "env", ".", "skip_confirmations", "or", "formatting", ".", "confirm", "(", "'This will reboot the VS with id %s. '", "'Continue?'", "%", "vs_id", ")", ")", ":", "raise", "exceptions", ".", "CLIAbort", "(", "'Aborted.'", ")", "if", "hard", "is", "True", ":", "virtual_guest", ".", "rebootHard", "(", "id", "=", "vs_id", ")", "elif", "hard", "is", "False", ":", "virtual_guest", ".", "rebootSoft", "(", "id", "=", "vs_id", ")", "else", ":", "virtual_guest", ".", "rebootDefault", "(", "id", "=", "vs_id", ")" ]

[ "Reboot", "an", "active", "virtual", "server", "." ]

[ "def", "power_off", "(", "env", ",", "identifier", ",", "hard", ")", ":", "virtual_guest", "=", "env", ".", "client", "[", "'Virtual_Guest'", "]", "vsi", "=", "SoftLayer", ".", "VSManager", "(", "env", ".", "client", ")", "vs_id", "=", "helpers", ".", "resolve_id", "(", "vsi", ".", "resolve_ids", ",", "identifier", ",", "'VS'", ")", "if", "not", "(", "env", ".", "skip_confirmations", "or", "formatting", ".", "confirm", "(", "'This will power off the VS with id %s. '", "'Continue?'", "%", "vs_id", ")", ")", ":", "raise", "exceptions", ".", "CLIAbort", "(", "'Aborted.'", ")", "if", "hard", ":", "virtual_guest", ".", "powerOff", "(", "id", "=", "vs_id", ")", "else", ":", "virtual_guest", ".", "powerOffSoft", "(", "id", "=", "vs_id", ")" ]

[ "Power", "off", "an", "active", "virtual", "server", "." ]

[ "def", "power_on", "(", "env", ",", "identifier", ")", ":", "vsi", "=", "SoftLayer", ".", "VSManager", "(", "env", ".", "client", ")", "vs_id", "=", "helpers", ".", "resolve_id", "(", "vsi", ".", "resolve_ids", ",", "identifier", ",", "'VS'", ")", "env", ".", "client", "[", "'Virtual_Guest'", "]", ".", "powerOn", "(", "id", "=", "vs_id", ")" ]

[ "Power", "on", "a", "virtual", "server", "." ]

[ "def", "pause", "(", "env", ",", "identifier", ")", ":", "vsi", "=", "SoftLayer", ".", "VSManager", "(", "env", ".", "client", ")", "vs_id", "=", "helpers", ".", "resolve_id", "(", "vsi", ".", "resolve_ids", ",", "identifier", ",", "'VS'", ")", "if", "not", "(", "env", ".", "skip_confirmations", "or", "formatting", ".", "confirm", "(", "'This will pause the VS with id %s. Continue?'", "%", "vs_id", ")", ")", ":", "raise", "exceptions", ".", "CLIAbort", "(", "'Aborted.'", ")", "env", ".", "client", "[", "'Virtual_Guest'", "]", ".", "pause", "(", "id", "=", "vs_id", ")" ]

[ "Pauses", "an", "active", "virtual", "server", "." ]

[ "def", "resume", "(", "env", ",", "identifier", ")", ":", "vsi", "=", "SoftLayer", ".", "VSManager", "(", "env", ".", "client", ")", "vs_id", "=", "helpers", ".", "resolve_id", "(", "vsi", ".", "resolve_ids", ",", "identifier", ",", "'VS'", ")", "env", ".", "client", "[", "'Virtual_Guest'", "]", ".", "resume", "(", "id", "=", "vs_id", ")" ]

[ "Resumes", "a", "paused", "virtual", "server", "." ]

[ "def", "cli", "(", "env", ")", ":", "manager", "=", "AccountManager", "(", "env", ".", "client", ")", "summary", "=", "manager", ".", "get_summary", "(", ")", "env", ".", "fout", "(", "get_snapshot_table", "(", "summary", ")", ")" ]

[ "Prints", "some", "various", "bits", "of", "information", "about", "an", "account" ]

[ "def", "get_snapshot_table", "(", "account", ")", ":", "table", "=", "formatting", ".", "KeyValueTable", "(", "[", "\"Name\"", ",", "\"Value\"", "]", ",", "title", "=", "\"Account Snapshot\"", ")", "table", ".", "align", "[", "'Name'", "]", "=", "'r'", "table", ".", "align", "[", "'Value'", "]", "=", "'l'", "table", ".", "add_row", "(", "[", "'Company Name'", ",", "account", ".", "get", "(", "'companyName'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Balance'", ",", "utils", ".", "lookup", "(", "account", ",", "'pendingInvoice'", ",", "'startingBalance'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Upcoming Invoice'", ",", "utils", ".", "lookup", "(", "account", ",", "'pendingInvoice'", ",", "'invoiceTotalAmount'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Image Templates'", ",", "account", ".", "get", "(", "'blockDeviceTemplateGroupCount'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Dedicated Hosts'", ",", "account", ".", "get", "(", "'dedicatedHostCount'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Hardware'", ",", "account", ".", "get", "(", "'hardwareCount'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Virtual Guests'", ",", "account", ".", "get", "(", "'virtualGuestCount'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Domains'", ",", "account", ".", "get", "(", "'domainCount'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Network Storage Volumes'", ",", "account", ".", "get", "(", "'networkStorageCount'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Open Tickets'", ",", "account", ".", "get", "(", "'openTicketCount'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Network Vlans'", ",", "account", ".", "get", "(", "'networkVlanCount'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Subnets'", ",", "account", ".", "get", "(", "'subnetCount'", ",", "'-'", ")", "]", ")", "table", ".", "add_row", "(", "[", "'Users'", ",", "account", ".", "get", "(", "'userCount'", ",", "'-'", ")", "]", ")", "return", "table" ]

[ "Generates", "a", "table", "for", "printing", "account", "summary", "data" ]

[ "def", "cli", "(", "env", ",", "prop", ")", ":", "try", ":", "if", "prop", "==", "'network'", ":", "env", ".", "fout", "(", "get_network", "(", ")", ")", "return", "meta_prop", "=", "META_MAPPING", ".", "get", "(", "prop", ")", "or", "prop", "env", ".", "fout", "(", "SoftLayer", ".", "MetadataManager", "(", ")", ".", "get", "(", "meta_prop", ")", ")", "except", "SoftLayer", ".", "TransportError", ":", "raise", "exceptions", ".", "CLIAbort", "(", "'Cannot connect to the backend service address. Make sure '", "'this command is being ran from a device on the backend '", "'network.'", ")" ]

[ "Find", "details", "about", "this", "machine", "." ]

[ "def", "get_network", "(", ")", ":", "meta", "=", "SoftLayer", ".", "MetadataManager", "(", ")", "network_tables", "=", "[", "]", "for", "network_func", "in", "[", "meta", ".", "public_network", ",", "meta", ".", "private_network", "]", ":", "network", "=", "network_func", "(", ")", "table", "=", "formatting", ".", "KeyValueTable", "(", "[", "'name'", ",", "'value'", "]", ")", "table", ".", "align", "[", "'name'", "]", "=", "'r'", "table", ".", "align", "[", "'value'", "]", "=", "'l'", "table", ".", "add_row", "(", "[", "'mac addresses'", ",", "formatting", ".", "listing", "(", "network", "[", "'mac_addresses'", "]", ",", "separator", "=", "','", ")", "]", ")", "table", ".", "add_row", "(", "[", "'router'", ",", "network", "[", "'router'", "]", "]", ")", "table", ".", "add_row", "(", "[", "'vlans'", ",", "formatting", ".", "listing", "(", "network", "[", "'vlans'", "]", ",", "separator", "=", "','", ")", "]", ")", "table", ".", "add_row", "(", "[", "'vlan ids'", ",", "formatting", ".", "listing", "(", "network", "[", "'vlan_ids'", "]", ",", "separator", "=", "','", ")", "]", ")", "network_tables", ".", "append", "(", "table", ")", "return", "network_tables" ]

[ "Returns", "a", "list", "of", "tables", "with", "public", "and", "private", "network", "details", "." ]

[ "def", "get_formatter", "(", "columns", ")", ":", "column_map", "=", "dict", "(", "(", "column", ".", "name", ",", "column", ")", "for", "column", "in", "columns", ")", "def", "validate", "(", "ctx", ",", "param", ",", "value", ")", ":", "\"\"\"Click validation function.\"\"\"", "if", "value", "==", "''", ":", "raise", "click", ".", "BadParameter", "(", "'At least one column is required.'", ")", "formatter", "=", "ColumnFormatter", "(", ")", "for", "column", "in", "[", "col", ".", "strip", "(", ")", "for", "col", "in", "value", ".", "split", "(", "','", ")", "]", ":", "if", "column", "in", "column_map", ":", "formatter", ".", "add_column", "(", "column_map", "[", "column", "]", ")", "else", ":", "formatter", ".", "add_column", "(", "Column", "(", "column", ",", "column", ".", "split", "(", "'.'", ")", ")", ")", "return", "formatter", "return", "validate" ]

[ "This", "function", "returns", "a", "callback", "to", "use", "with", "click", "options", "." ]

[ "def", "add_column", "(", "self", ",", "column", ")", ":", "self", ".", "columns", ".", "append", "(", "column", ".", "name", ")", "self", ".", "column_funcs", ".", "append", "(", "column", ".", "path", ")", "if", "column", ".", "mask", "is", "not", "None", ":", "self", ".", "mask_parts", ".", "add", "(", "column", ".", "mask", ")" ]

[ "Add", "a", "new", "column", "along", "with", "a", "formatting", "function", "." ]

[ "def", "row", "(", "self", ",", "data", ")", ":", "for", "column", "in", "self", ".", "column_funcs", ":", "if", "callable", "(", "column", ")", ":", "yield", "column", "(", "data", ")", "else", ":", "yield", "utils", ".", "lookup", "(", "data", ",", "*", "column", ")" ]

[ "Return", "a", "formatted", "row", "for", "the", "given", "data", "." ]

[ "def", "cli", "(", "env", ",", "account_id", ",", "origin_id", ")", ":", "manager", "=", "SoftLayer", ".", "CDNManager", "(", "env", ".", "client", ")", "manager", ".", "remove_origin", "(", "account_id", ",", "origin_id", ")" ]

[ "Remove", "an", "origin", "pull", "mapping", "." ]

[ "def", "cli", "(", "env", ",", "sortby", ")", ":", "manager", "=", "SoftLayer", ".", "CDNManager", "(", "env", ".", "client", ")", "accounts", "=", "manager", ".", "list_accounts", "(", ")", "table", "=", "formatting", ".", "Table", "(", "[", "'id'", ",", "'account_name'", ",", "'type'", ",", "'created'", ",", "'notes'", "]", ")", "for", "account", "in", "accounts", ":", "table", ".", "add_row", "(", "[", "account", "[", "'id'", "]", ",", "account", "[", "'cdnAccountName'", "]", ",", "account", "[", "'cdnSolutionName'", "]", ",", "account", "[", "'createDate'", "]", ",", "account", ".", "get", "(", "'cdnAccountNote'", ",", "formatting", ".", "blank", "(", ")", ")", "]", ")", "table", ".", "sortby", "=", "sortby", "env", ".", "fout", "(", "table", ")" ]

[ "List", "all", "CDN", "accounts", "." ]

[ "def", "cli", "(", "env", ",", "volume_id", ",", "sortby", ",", "columns", ")", ":", "file_manager", "=", "SoftLayer", ".", "FileStorageManager", "(", "env", ".", "client", ")", "snapshots", "=", "file_manager", ".", "get_file_volume_snapshot_list", "(", "volume_id", ",", "mask", "=", "columns", ".", "mask", "(", ")", ")", "table", "=", "formatting", ".", "Table", "(", "columns", ".", "columns", ")", "table", ".", "sortby", "=", "sortby", "for", "snapshot", "in", "snapshots", ":", "table", ".", "add_row", "(", "[", "value", "or", "formatting", ".", "blank", "(", ")", "for", "value", "in", "columns", ".", "row", "(", "snapshot", ")", "]", ")", "env", ".", "fout", "(", "table", ")" ]

[ "List", "file", "storage", "snapshots", "." ]

[ "def", "list_instances", "(", "self", ",", "hourly", "=", "True", ",", "monthly", "=", "True", ",", "tags", "=", "None", ",", "cpus", "=", "None", ",", "memory", "=", "None", ",", "hostname", "=", "None", ",", "domain", "=", "None", ",", "local_disk", "=", "None", ",", "datacenter", "=", "None", ",", "nic_speed", "=", "None", ",", "public_ip", "=", "None", ",", "private_ip", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "'mask'", "not", "in", "kwargs", ":", "items", "=", "[", "'id'", ",", "'globalIdentifier'", ",", "'hostname'", ",", "'domain'", ",", "'fullyQualifiedDomainName'", ",", "'primaryBackendIpAddress'", ",", "'primaryIpAddress'", ",", "'lastKnownPowerState.name'", ",", "'powerState'", ",", "'maxCpu'", ",", "'maxMemory'", ",", "'datacenter'", ",", "'activeTransaction.transactionStatus[friendlyName,name]'", ",", "'status'", ",", "]", "kwargs", "[", "'mask'", "]", "=", "\"mask[%s]\"", "%", "','", ".", "join", "(", "items", ")", "call", "=", "'getVirtualGuests'", "if", "not", "all", "(", "[", "hourly", ",", "monthly", "]", ")", ":", "if", "hourly", ":", "call", "=", "'getHourlyVirtualGuests'", "elif", "monthly", ":", "call", "=", "'getMonthlyVirtualGuests'", "_filter", "=", "utils", ".", "NestedDict", "(", "kwargs", ".", "get", "(", "'filter'", ")", "or", "{", "}", ")", "if", "tags", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'tagReferences'", "]", "[", "'tag'", "]", "[", "'name'", "]", "=", "{", "'operation'", ":", "'in'", ",", "'options'", ":", "[", "{", "'name'", ":", "'data'", ",", "'value'", ":", "tags", "}", "]", ",", "}", "if", "cpus", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'maxCpu'", "]", "=", "utils", ".", "query_filter", "(", "cpus", ")", "if", "memory", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'maxMemory'", "]", "=", "utils", ".", "query_filter", "(", "memory", ")", "if", "hostname", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'hostname'", "]", "=", "utils", ".", "query_filter", "(", "hostname", ")", "if", "domain", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'domain'", "]", "=", "utils", ".", "query_filter", "(", "domain", ")", "if", "local_disk", "is", "not", "None", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'localDiskFlag'", "]", "=", "(", "utils", ".", "query_filter", "(", "bool", "(", "local_disk", ")", ")", ")", "if", "datacenter", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'datacenter'", "]", "[", "'name'", "]", "=", "(", "utils", ".", "query_filter", "(", "datacenter", ")", ")", "if", "nic_speed", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'networkComponents'", "]", "[", "'maxSpeed'", "]", "=", "(", "utils", ".", "query_filter", "(", "nic_speed", ")", ")", "if", "public_ip", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'primaryIpAddress'", "]", "=", "(", "utils", ".", "query_filter", "(", "public_ip", ")", ")", "if", "private_ip", ":", "_filter", "[", "'virtualGuests'", "]", "[", "'primaryBackendIpAddress'", "]", "=", "(", "utils", ".", "query_filter", "(", "private_ip", ")", ")", "kwargs", "[", "'filter'", "]", "=", "_filter", ".", "to_dict", "(", ")", "kwargs", "[", "'iter'", "]", "=", "True", "return", "self", ".", "client", ".", "call", "(", "'Account'", ",", "call", ",", "*", "*", "kwargs", ")" ]

[ "Retrieve", "a", "list", "of", "all", "virtual", "servers", "on", "the", "account", "." ]

[ "def", "get_instance", "(", "self", ",", "instance_id", ",", "*", "*", "kwargs", ")", ":", "if", "'mask'", "not", "in", "kwargs", ":", "kwargs", "[", "'mask'", "]", "=", "(", "'id,'", "'globalIdentifier,'", "'fullyQualifiedDomainName,'", "'hostname,'", "'domain,'", "'createDate,'", "'modifyDate,'", "'provisionDate,'", "'notes,'", "'dedicatedAccountHostOnlyFlag,'", "'privateNetworkOnlyFlag,'", "'primaryBackendIpAddress,'", "'primaryIpAddress,'", "'''networkComponents[id, status, speed, maxSpeed, name,\n macAddress, primaryIpAddress, port,\n primarySubnet[addressSpace],\n securityGroupBindings[\n securityGroup[id, name]]],'''", "'lastKnownPowerState.name,'", "'powerState,'", "'status,'", "'maxCpu,'", "'maxMemory,'", "'datacenter,'", "'activeTransaction[id, transactionStatus[friendlyName,name]],'", "'lastTransaction[transactionStatus],'", "'lastOperatingSystemReload.id,'", "'blockDevices,'", "'blockDeviceTemplateGroup[id, name, globalIdentifier],'", "'postInstallScriptUri,'", "'''operatingSystem[passwords[username,password],\n softwareLicense.softwareDescription[\n manufacturer,name,version,\n referenceCode]],'''", "'''softwareComponents[\n passwords[username,password,notes],\n softwareLicense[softwareDescription[\n manufacturer,name,version,\n referenceCode]]],'''", "'hourlyBillingFlag,'", "'userData,'", "'''billingItem[id,nextInvoiceTotalRecurringAmount,\n package[id,keyName],\n children[categoryCode,nextInvoiceTotalRecurringAmount],\n orderItem[id,\n order.userRecord[username],\n preset.keyName]],'''", "'tagReferences[id,tag[name,id]],'", "'networkVlans[id,vlanNumber,networkSpace],'", "'dedicatedHost.id,'", "'placementGroupId'", ")", "return", "self", ".", "guest", ".", "getObject", "(", "id", "=", "instance_id", ",", "*", "*", "kwargs", ")" ]

[ "Get", "details", "about", "a", "virtual", "server", "instance", "." ]

[ "def", "reload_instance", "(", "self", ",", "instance_id", ",", "post_uri", "=", "None", ",", "ssh_keys", "=", "None", ",", "image_id", "=", "None", ")", ":", "config", "=", "{", "}", "if", "post_uri", ":", "config", "[", "'customProvisionScriptUri'", "]", "=", "post_uri", "if", "ssh_keys", ":", "config", "[", "'sshKeyIds'", "]", "=", "[", "key_id", "for", "key_id", "in", "ssh_keys", "]", "if", "image_id", ":", "config", "[", "'imageTemplateId'", "]", "=", "image_id", "return", "self", ".", "client", ".", "call", "(", "'Virtual_Guest'", ",", "'reloadOperatingSystem'", ",", "'FORCE'", ",", "config", ",", "id", "=", "instance_id", ")" ]

[ "Perform", "an", "OS", "reload", "of", "an", "instance", "." ]

[ "def", "wait_for_transaction", "(", "self", ",", "instance_id", ",", "limit", ",", "delay", "=", "10", ")", ":", "return", "self", ".", "wait_for_ready", "(", "instance_id", ",", "limit", ",", "delay", "=", "delay", ",", "pending", "=", "True", ")" ]

[ "Waits", "on", "a", "VS", "transaction", "for", "the", "specified", "amount", "of", "time", "." ]

[ "def", "verify_create_instance", "(", "self", ",", "*", "*", "kwargs", ")", ":", "kwargs", ".", "pop", "(", "'tags'", ",", "None", ")", "create_options", "=", "self", ".", "_generate_create_dict", "(", "*", "*", "kwargs", ")", "return", "self", ".", "guest", ".", "generateOrderTemplate", "(", "create_options", ")" ]

[ "Verifies", "an", "instance", "creation", "command", "." ]

[ "def", "create_instance", "(", "self", ",", "*", "*", "kwargs", ")", ":", "tags", "=", "kwargs", ".", "pop", "(", "'tags'", ",", "None", ")", "inst", "=", "self", ".", "guest", ".", "createObject", "(", "self", ".", "_generate_create_dict", "(", "*", "*", "kwargs", ")", ")", "if", "tags", "is", "not", "None", ":", "self", ".", "set_tags", "(", "tags", ",", "guest_id", "=", "inst", "[", "'id'", "]", ")", "return", "inst" ]

[ "Creates", "a", "new", "virtual", "server", "instance", "." ]

[ "def", "set_tags", "(", "self", ",", "tags", ",", "guest_id", ")", ":", "self", ".", "guest", ".", "setTags", "(", "tags", ",", "id", "=", "guest_id", ")" ]

[ "Sets", "tags", "on", "a", "guest", "with", "a", "retry", "decorator" ]

[ "def", "create_instances", "(", "self", ",", "config_list", ")", ":", "tags", "=", "[", "conf", ".", "pop", "(", "'tags'", ",", "None", ")", "for", "conf", "in", "config_list", "]", "resp", "=", "self", ".", "guest", ".", "createObjects", "(", "[", "self", ".", "_generate_create_dict", "(", "*", "*", "kwargs", ")", "for", "kwargs", "in", "config_list", "]", ")", "for", "instance", ",", "tag", "in", "zip", "(", "resp", ",", "tags", ")", ":", "if", "tag", "is", "not", "None", ":", "self", ".", "set_tags", "(", "tag", ",", "guest_id", "=", "instance", "[", "'id'", "]", ")", "return", "resp" ]

[ "Creates", "multiple", "virtual", "server", "instances", "." ]

[ "def", "change_port_speed", "(", "self", ",", "instance_id", ",", "public", ",", "speed", ")", ":", "if", "public", ":", "return", "self", ".", "client", ".", "call", "(", "'Virtual_Guest'", ",", "'setPublicNetworkInterfaceSpeed'", ",", "speed", ",", "id", "=", "instance_id", ")", "else", ":", "return", "self", ".", "client", ".", "call", "(", "'Virtual_Guest'", ",", "'setPrivateNetworkInterfaceSpeed'", ",", "speed", ",", "id", "=", "instance_id", ")" ]

[ "Allows", "you", "to", "change", "the", "port", "speed", "of", "a", "virtual", "server", "s", "NICs", "." ]

[ "def", "_get_ids_from_hostname", "(", "self", ",", "hostname", ")", ":", "results", "=", "self", ".", "list_instances", "(", "hostname", "=", "hostname", ",", "mask", "=", "\"id\"", ")", "return", "[", "result", "[", "'id'", "]", "for", "result", "in", "results", "]" ]

[ "List", "VS", "ids", "which", "match", "the", "given", "hostname", "." ]

[ "def", "_get_ids_from_ip", "(", "self", ",", "ip_address", ")", ":", "# pylint: disable=inconsistent-return-statements", "try", ":", "# Does it look like an ip address?", "socket", ".", "inet_aton", "(", "ip_address", ")", "except", "socket", ".", "error", ":", "return", "[", "]", "# Find the VS via ip address. First try public ip, then private", "results", "=", "self", ".", "list_instances", "(", "public_ip", "=", "ip_address", ",", "mask", "=", "\"id\"", ")", "if", "results", ":", "return", "[", "result", "[", "'id'", "]", "for", "result", "in", "results", "]", "results", "=", "self", ".", "list_instances", "(", "private_ip", "=", "ip_address", ",", "mask", "=", "\"id\"", ")", "if", "results", ":", "return", "[", "result", "[", "'id'", "]", "for", "result", "in", "results", "]" ]

[ "List", "VS", "ids", "which", "match", "the", "given", "ip", "address", "." ]

[ "def", "upgrade", "(", "self", ",", "instance_id", ",", "cpus", "=", "None", ",", "memory", "=", "None", ",", "nic_speed", "=", "None", ",", "public", "=", "True", ",", "preset", "=", "None", ")", ":", "upgrade_prices", "=", "self", ".", "_get_upgrade_prices", "(", "instance_id", ")", "prices", "=", "[", "]", "data", "=", "{", "'nic_speed'", ":", "nic_speed", "}", "if", "cpus", "is", "not", "None", "and", "preset", "is", "not", "None", ":", "raise", "ValueError", "(", "\"Do not use cpu, private and memory if you are using flavors\"", ")", "data", "[", "'cpus'", "]", "=", "cpus", "if", "memory", "is", "not", "None", "and", "preset", "is", "not", "None", ":", "raise", "ValueError", "(", "\"Do not use memory, private or cpu if you are using flavors\"", ")", "data", "[", "'memory'", "]", "=", "memory", "maintenance_window", "=", "datetime", ".", "datetime", ".", "now", "(", "utils", ".", "UTC", "(", ")", ")", "order", "=", "{", "'complexType'", ":", "'SoftLayer_Container_Product_Order_Virtual_Guest_Upgrade'", ",", "'properties'", ":", "[", "{", "'name'", ":", "'MAINTENANCE_WINDOW'", ",", "'value'", ":", "maintenance_window", ".", "strftime", "(", "\"%Y-%m-%d %H:%M:%S%z\"", ")", "}", "]", ",", "'virtualGuests'", ":", "[", "{", "'id'", ":", "int", "(", "instance_id", ")", "}", "]", ",", "}", "for", "option", ",", "value", "in", "data", ".", "items", "(", ")", ":", "if", "not", "value", ":", "continue", "price_id", "=", "self", ".", "_get_price_id_for_upgrade_option", "(", "upgrade_prices", ",", "option", ",", "value", ",", "public", ")", "if", "not", "price_id", ":", "# Every option provided is expected to have a price", "raise", "exceptions", ".", "SoftLayerError", "(", "\"Unable to find %s option with value %s\"", "%", "(", "option", ",", "value", ")", ")", "prices", ".", "append", "(", "{", "'id'", ":", "price_id", "}", ")", "order", "[", "'prices'", "]", "=", "prices", "if", "preset", "is", "not", "None", ":", "vs_object", "=", "self", ".", "get_instance", "(", "instance_id", ")", "[", "'billingItem'", "]", "[", "'package'", "]", "order", "[", "'presetId'", "]", "=", "self", ".", "ordering_manager", ".", "get_preset_by_key", "(", "vs_object", "[", "'keyName'", "]", ",", "preset", ")", "[", "'id'", "]", "if", "prices", "or", "preset", ":", "self", ".", "client", "[", "'Product_Order'", "]", ".", "placeOrder", "(", "order", ")", "return", "True", "return", "False" ]

[ "Upgrades", "a", "VS", "instance", "." ]

[ "def", "_get_package_items", "(", "self", ")", ":", "warnings", ".", "warn", "(", "\"use _get_upgrade_prices() instead\"", ",", "DeprecationWarning", ")", "mask", "=", "[", "'description'", ",", "'capacity'", ",", "'units'", ",", "'prices[id,locationGroupId,categories[name,id,categoryCode]]'", "]", "mask", "=", "\"mask[%s]\"", "%", "','", ".", "join", "(", "mask", ")", "package_keyname", "=", "\"CLOUD_SERVER\"", "package", "=", "self", ".", "ordering_manager", ".", "get_package_by_key", "(", "package_keyname", ")", "package_service", "=", "self", ".", "client", "[", "'Product_Package'", "]", "return", "package_service", ".", "getItems", "(", "id", "=", "package", "[", "'id'", "]", ",", "mask", "=", "mask", ")" ]

[ "Following", "Method", "gets", "all", "the", "item", "ids", "related", "to", "VS", "." ]

[ "def", "_get_upgrade_prices", "(", "self", ",", "instance_id", ",", "include_downgrade_options", "=", "True", ")", ":", "mask", "=", "[", "'id'", ",", "'locationGroupId'", ",", "'categories[name,id,categoryCode]'", ",", "'item[description,capacity,units]'", "]", "mask", "=", "\"mask[%s]\"", "%", "','", ".", "join", "(", "mask", ")", "return", "self", ".", "guest", ".", "getUpgradeItemPrices", "(", "include_downgrade_options", ",", "id", "=", "instance_id", ",", "mask", "=", "mask", ")" ]

[ "Following", "Method", "gets", "all", "the", "price", "ids", "related", "to", "upgrading", "a", "VS", "." ]

[ "def", "_get_price_id_for_upgrade_option", "(", "self", ",", "upgrade_prices", ",", "option", ",", "value", ",", "public", "=", "True", ")", ":", "option_category", "=", "{", "'memory'", ":", "'ram'", ",", "'cpus'", ":", "'guest_core'", ",", "'nic_speed'", ":", "'port_speed'", "}", "category_code", "=", "option_category", ".", "get", "(", "option", ")", "for", "price", "in", "upgrade_prices", ":", "if", "price", ".", "get", "(", "'categories'", ")", "is", "None", "or", "price", ".", "get", "(", "'item'", ")", "is", "None", ":", "continue", "product", "=", "price", ".", "get", "(", "'item'", ")", "is_private", "=", "(", "product", ".", "get", "(", "'units'", ")", "==", "'PRIVATE_CORE'", "or", "product", ".", "get", "(", "'units'", ")", "==", "'DEDICATED_CORE'", ")", "for", "category", "in", "price", ".", "get", "(", "'categories'", ")", ":", "if", "not", "(", "category", ".", "get", "(", "'categoryCode'", ")", "==", "category_code", "and", "str", "(", "product", ".", "get", "(", "'capacity'", ")", ")", "==", "str", "(", "value", ")", ")", ":", "continue", "if", "option", "==", "'cpus'", ":", "# Public upgrade and public guest_core price", "if", "public", "and", "not", "is_private", ":", "return", "price", ".", "get", "(", "'id'", ")", "# Private upgrade and private guest_core price", "elif", "not", "public", "and", "is_private", ":", "return", "price", ".", "get", "(", "'id'", ")", "elif", "option", "==", "'nic_speed'", ":", "if", "'Public'", "in", "product", ".", "get", "(", "'description'", ")", ":", "return", "price", ".", "get", "(", "'id'", ")", "else", ":", "return", "price", ".", "get", "(", "'id'", ")" ]

[ "Find", "the", "price", "id", "for", "the", "option", "and", "value", "to", "upgrade", ".", "This" ]

[ "def", "_get_price_id_for_upgrade", "(", "self", ",", "package_items", ",", "option", ",", "value", ",", "public", "=", "True", ")", ":", "warnings", ".", "warn", "(", "\"use _get_price_id_for_upgrade_option() instead\"", ",", "DeprecationWarning", ")", "option_category", "=", "{", "'memory'", ":", "'ram'", ",", "'cpus'", ":", "'guest_core'", ",", "'nic_speed'", ":", "'port_speed'", "}", "category_code", "=", "option_category", "[", "option", "]", "for", "item", "in", "package_items", ":", "is_private", "=", "(", "item", ".", "get", "(", "'units'", ")", "==", "'PRIVATE_CORE'", ")", "for", "price", "in", "item", "[", "'prices'", "]", ":", "if", "'locationGroupId'", "in", "price", "and", "price", "[", "'locationGroupId'", "]", ":", "# Skip location based prices", "continue", "if", "'categories'", "not", "in", "price", ":", "continue", "categories", "=", "price", "[", "'categories'", "]", "for", "category", "in", "categories", ":", "if", "not", "(", "category", "[", "'categoryCode'", "]", "==", "category_code", "and", "str", "(", "item", "[", "'capacity'", "]", ")", "==", "str", "(", "value", ")", ")", ":", "continue", "if", "option", "==", "'cpus'", ":", "if", "public", "and", "not", "is_private", ":", "return", "price", "[", "'id'", "]", "elif", "not", "public", "and", "is_private", ":", "return", "price", "[", "'id'", "]", "elif", "option", "==", "'nic_speed'", ":", "if", "'Public'", "in", "item", "[", "'description'", "]", ":", "return", "price", "[", "'id'", "]", "else", ":", "return", "price", "[", "'id'", "]" ]

[ "Find", "the", "price", "id", "for", "the", "option", "and", "value", "to", "upgrade", "." ]

[ "def", "interface_list", "(", "env", ",", "securitygroup_id", ",", "sortby", ")", ":", "mgr", "=", "SoftLayer", ".", "NetworkManager", "(", "env", ".", "client", ")", "table", "=", "formatting", ".", "Table", "(", "COLUMNS", ")", "table", ".", "sortby", "=", "sortby", "mask", "=", "(", "'''networkComponentBindings[\n networkComponentId,\n networkComponent[\n id,\n port,\n guest[\n id,\n hostname,\n primaryBackendIpAddress,\n primaryIpAddress\n ]\n ]\n ]'''", ")", "secgroup", "=", "mgr", ".", "get_securitygroup", "(", "securitygroup_id", ",", "mask", "=", "mask", ")", "for", "binding", "in", "secgroup", ".", "get", "(", "'networkComponentBindings'", ",", "[", "]", ")", ":", "interface_id", "=", "binding", "[", "'networkComponentId'", "]", "try", ":", "interface", "=", "binding", "[", "'networkComponent'", "]", "vsi", "=", "interface", "[", "'guest'", "]", "vsi_id", "=", "vsi", "[", "'id'", "]", "hostname", "=", "vsi", "[", "'hostname'", "]", "priv_pub", "=", "'PRIVATE'", "if", "interface", "[", "'port'", "]", "==", "0", "else", "'PUBLIC'", "ip_address", "=", "(", "vsi", "[", "'primaryBackendIpAddress'", "]", "if", "interface", "[", "'port'", "]", "==", "0", "else", "vsi", "[", "'primaryIpAddress'", "]", ")", "except", "KeyError", ":", "vsi_id", "=", "\"N/A\"", "hostname", "=", "\"Not enough permission to view\"", "priv_pub", "=", "\"N/A\"", "ip_address", "=", "\"N/A\"", "table", ".", "add_row", "(", "[", "interface_id", ",", "vsi_id", ",", "hostname", ",", "priv_pub", ",", "ip_address", "]", ")", "env", ".", "fout", "(", "table", ")" ]

[ "List", "interfaces", "associated", "with", "security", "groups", "." ]

[ "def", "add", "(", "env", ",", "securitygroup_id", ",", "network_component", ",", "server", ",", "interface", ")", ":", "_validate_args", "(", "network_component", ",", "server", ",", "interface", ")", "mgr", "=", "SoftLayer", ".", "NetworkManager", "(", "env", ".", "client", ")", "component_id", "=", "_get_component_id", "(", "env", ",", "network_component", ",", "server", ",", "interface", ")", "ret", "=", "mgr", ".", "attach_securitygroup_component", "(", "securitygroup_id", ",", "component_id", ")", "if", "not", "ret", ":", "raise", "exceptions", ".", "CLIAbort", "(", "\"Could not attach network component\"", ")", "table", "=", "formatting", ".", "Table", "(", "REQUEST_COLUMNS", ")", "table", ".", "add_row", "(", "[", "ret", "[", "'requestId'", "]", "]", ")", "env", ".", "fout", "(", "table", ")" ]

[ "Attach", "an", "interface", "to", "a", "security", "group", "." ]

[ "def", "default_select", "(", "identifier", ",", "all_entry_points", ")", ":", "# pylint: disable=inconsistent-return-statements", "if", "len", "(", "all_entry_points", ")", "==", "0", ":", "raise", "PluginMissingError", "(", "identifier", ")", "elif", "len", "(", "all_entry_points", ")", "==", "1", ":", "return", "all_entry_points", "[", "0", "]", "elif", "len", "(", "all_entry_points", ")", ">", "1", ":", "raise", "AmbiguousPluginError", "(", "all_entry_points", ")" ]

[ "Raise", "an", "exception", "when", "we", "have", "ambiguous", "entry", "points", "." ]

[ "def", "_load_class_entry_point", "(", "cls", ",", "entry_point", ")", ":", "class_", "=", "entry_point", ".", "load", "(", ")", "setattr", "(", "class_", ",", "'plugin_name'", ",", "entry_point", ".", "name", ")", "return", "class_" ]

[ "Load", "entry_point", "and", "set", "the", "entry_point", ".", "name", "as", "the", "attribute", "plugin_name", "on", "the", "loaded", "object" ]

[ "def", "load_class", "(", "cls", ",", "identifier", ",", "default", "=", "None", ",", "select", "=", "None", ")", ":", "identifier", "=", "identifier", ".", "lower", "(", ")", "key", "=", "(", "cls", ".", "entry_point", ",", "identifier", ")", "if", "key", "not", "in", "PLUGIN_CACHE", ":", "if", "select", "is", "None", ":", "select", "=", "default_select", "all_entry_points", "=", "list", "(", "pkg_resources", ".", "iter_entry_points", "(", "cls", ".", "entry_point", ",", "name", "=", "identifier", ")", ")", "for", "extra_identifier", ",", "extra_entry_point", "in", "cls", ".", "extra_entry_points", ":", "if", "identifier", "==", "extra_identifier", ":", "all_entry_points", ".", "append", "(", "extra_entry_point", ")", "try", ":", "selected_entry_point", "=", "select", "(", "identifier", ",", "all_entry_points", ")", "except", "PluginMissingError", ":", "if", "default", "is", "not", "None", ":", "return", "default", "raise", "PLUGIN_CACHE", "[", "key", "]", "=", "cls", ".", "_load_class_entry_point", "(", "selected_entry_point", ")", "return", "PLUGIN_CACHE", "[", "key", "]" ]

[ "Load", "a", "single", "class", "specified", "by", "identifier", "." ]

[ "def", "load_classes", "(", "cls", ",", "fail_silently", "=", "True", ")", ":", "all_classes", "=", "itertools", ".", "chain", "(", "pkg_resources", ".", "iter_entry_points", "(", "cls", ".", "entry_point", ")", ",", "(", "entry_point", "for", "identifier", ",", "entry_point", "in", "cls", ".", "extra_entry_points", ")", ",", ")", "for", "class_", "in", "all_classes", ":", "try", ":", "yield", "(", "class_", ".", "name", ",", "cls", ".", "_load_class_entry_point", "(", "class_", ")", ")", "except", "Exception", ":", "# pylint: disable=broad-except", "if", "fail_silently", ":", "log", ".", "warning", "(", "'Unable to load %s %r'", ",", "cls", ".", "__name__", ",", "class_", ".", "name", ",", "exc_info", "=", "True", ")", "else", ":", "raise" ]

[ "Load", "all", "the", "classes", "for", "a", "plugin", "." ]

[ "def", "register_temp_plugin", "(", "cls", ",", "class_", ",", "identifier", "=", "None", ",", "dist", "=", "'xblock'", ")", ":", "from", "mock", "import", "Mock", "if", "identifier", "is", "None", ":", "identifier", "=", "class_", ".", "__name__", ".", "lower", "(", ")", "entry_point", "=", "Mock", "(", "dist", "=", "Mock", "(", "key", "=", "dist", ")", ",", "load", "=", "Mock", "(", "return_value", "=", "class_", ")", ",", ")", "entry_point", ".", "name", "=", "identifier", "def", "_decorator", "(", "func", ")", ":", "# pylint: disable=C0111", "@", "functools", ".", "wraps", "(", "func", ")", "def", "_inner", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "# pylint: disable=C0111", "global", "PLUGIN_CACHE", "# pylint: disable=global-statement", "old", "=", "list", "(", "cls", ".", "extra_entry_points", ")", "old_cache", "=", "PLUGIN_CACHE", "cls", ".", "extra_entry_points", ".", "append", "(", "(", "identifier", ",", "entry_point", ")", ")", "PLUGIN_CACHE", "=", "{", "}", "try", ":", "return", "func", "(", "*", "args", ",", "*", "*", "kwargs", ")", "finally", ":", "cls", ".", "extra_entry_points", "=", "old", "PLUGIN_CACHE", "=", "old_cache", "return", "_inner", "return", "_decorator" ]

[ "Decorate", "a", "function", "to", "run", "with", "a", "temporary", "plugin", "available", "." ]

[ "def", "webob_to_django_response", "(", "webob_response", ")", ":", "from", "django", ".", "http", "import", "HttpResponse", "django_response", "=", "HttpResponse", "(", "webob_response", ".", "app_iter", ",", "content_type", "=", "webob_response", ".", "content_type", ",", "status", "=", "webob_response", ".", "status_code", ",", ")", "for", "name", ",", "value", "in", "webob_response", ".", "headerlist", ":", "django_response", "[", "name", "]", "=", "value", "return", "django_response" ]

[ "Returns", "a", "django", "response", "to", "the", "webob_response" ]

[ "def", "querydict_to_multidict", "(", "query_dict", ",", "wrap", "=", "None", ")", ":", "wrap", "=", "wrap", "or", "(", "lambda", "val", ":", "val", ")", "return", "MultiDict", "(", "chain", ".", "from_iterable", "(", "six", ".", "moves", ".", "zip", "(", "repeat", "(", "key", ")", ",", "(", "wrap", "(", "v", ")", "for", "v", "in", "vals", ")", ")", "for", "key", ",", "vals", "in", "six", ".", "iterlists", "(", "query_dict", ")", ")", ")" ]

[ "Returns", "a", "new", "webob", ".", "MultiDict", "from", "a", "django", ".", "http", ".", "QueryDict", "." ]

[ "def", "_meta_name", "(", "self", ",", "name", ")", ":", "name", "=", "name", ".", "upper", "(", ")", ".", "replace", "(", "'-'", ",", "'_'", ")", "if", "name", "not", "in", "self", ".", "UNPREFIXED_HEADERS", ":", "name", "=", "'HTTP_'", "+", "name", "return", "name" ]

[ "Translate", "HTTP", "header", "names", "to", "the", "format", "used", "by", "Django", "request", "objects", "." ]

[ "def", "_un_meta_name", "(", "self", ",", "name", ")", ":", "if", "name", ".", "startswith", "(", "'HTTP_'", ")", ":", "name", "=", "name", "[", "5", ":", "]", "return", "name", ".", "replace", "(", "'_'", ",", "'-'", ")", ".", "title", "(", ")" ]

[ "Reverse", "of", "_meta_name" ]

[ "def", "environ", "(", "self", ")", ":", "environ", "=", "dict", "(", "self", ".", "_request", ".", "META", ")", "environ", "[", "'PATH_INFO'", "]", "=", "self", ".", "_request", ".", "path_info", "return", "environ" ]

[ "Add", "path_info", "to", "the", "request", "s", "META", "dictionary", "." ]

[ "def", "_getfield", "(", "self", ",", "block", ",", "name", ")", ":", "# First, get the field from the class, if defined", "block_field", "=", "getattr", "(", "block", ".", "__class__", ",", "name", ",", "None", ")", "if", "block_field", "is", "not", "None", "and", "isinstance", "(", "block_field", ",", "Field", ")", ":", "return", "block_field", "# Not in the class, so name", "# really doesn't name a field", "raise", "KeyError", "(", "name", ")" ]

[ "Return", "the", "field", "with", "the", "given", "name", "from", "block", ".", "If", "no", "field", "with", "name", "exists", "in", "any", "namespace", "raises", "a", "KeyError", "." ]

[ "def", "get", "(", "self", ",", "block", ",", "name", ")", ":", "return", "self", ".", "_kvs", ".", "get", "(", "self", ".", "_key", "(", "block", ",", "name", ")", ")" ]

[ "Retrieve", "the", "value", "for", "the", "field", "named", "name", "." ]

[ "def", "set", "(", "self", ",", "block", ",", "name", ",", "value", ")", ":", "self", ".", "_kvs", ".", "set", "(", "self", ".", "_key", "(", "block", ",", "name", ")", ",", "value", ")" ]

[ "Set", "the", "value", "of", "the", "field", "named", "name" ]

[ "def", "delete", "(", "self", ",", "block", ",", "name", ")", ":", "self", ".", "_kvs", ".", "delete", "(", "self", ".", "_key", "(", "block", ",", "name", ")", ")" ]

[ "Reset", "the", "value", "of", "the", "field", "named", "name", "to", "the", "default" ]

[ "def", "has", "(", "self", ",", "block", ",", "name", ")", ":", "try", ":", "return", "self", ".", "_kvs", ".", "has", "(", "self", ".", "_key", "(", "block", ",", "name", ")", ")", "except", "KeyError", ":", "return", "False" ]

[ "Return", "whether", "or", "not", "the", "field", "named", "name", "has", "a", "non", "-", "default", "value" ]

[ "def", "set_many", "(", "self", ",", "block", ",", "update_dict", ")", ":", "updated_dict", "=", "{", "}", "# Generate a new dict with the correct mappings.", "for", "(", "key", ",", "value", ")", "in", "six", ".", "iteritems", "(", "update_dict", ")", ":", "updated_dict", "[", "self", ".", "_key", "(", "block", ",", "key", ")", "]", "=", "value", "self", ".", "_kvs", ".", "set_many", "(", "updated_dict", ")" ]

[ "Update", "the", "underlying", "model", "with", "the", "correct", "values", "." ]

[ "def", "create_aside", "(", "self", ",", "definition_id", ",", "usage_id", ",", "aside_type", ")", ":", "return", "(", "self", ".", "ASIDE_DEFINITION_ID", "(", "definition_id", ",", "aside_type", ")", ",", "self", ".", "ASIDE_USAGE_ID", "(", "usage_id", ",", "aside_type", ")", ",", ")" ]

[ "Create", "the", "aside", "." ]

[ "def", "create_usage", "(", "self", ",", "def_id", ")", ":", "usage_id", "=", "self", ".", "_next_id", "(", "\"u\"", ")", "self", ".", "_usages", "[", "usage_id", "]", "=", "def_id", "return", "usage_id" ]

[ "Make", "a", "usage", "storing", "its", "definition", "id", "." ]

[ "def", "get_definition_id", "(", "self", ",", "usage_id", ")", ":", "try", ":", "return", "self", ".", "_usages", "[", "usage_id", "]", "except", "KeyError", ":", "raise", "NoSuchUsage", "(", "repr", "(", "usage_id", ")", ")" ]

[ "Get", "a", "definition_id", "by", "its", "usage", "id", "." ]

[ "def", "create_definition", "(", "self", ",", "block_type", ",", "slug", "=", "None", ")", ":", "prefix", "=", "\"d\"", "if", "slug", ":", "prefix", "+=", "\"_\"", "+", "slug", "def_id", "=", "self", ".", "_next_id", "(", "prefix", ")", "self", ".", "_definitions", "[", "def_id", "]", "=", "block_type", "return", "def_id" ]

[ "Make", "a", "definition", "storing", "its", "block", "type", "." ]

[ "def", "get_block_type", "(", "self", ",", "def_id", ")", ":", "try", ":", "return", "self", ".", "_definitions", "[", "def_id", "]", "except", "KeyError", ":", "try", ":", "return", "def_id", ".", "aside_type", "except", "AttributeError", ":", "raise", "NoSuchDefinition", "(", "repr", "(", "def_id", ")", ")" ]

[ "Get", "a", "block_type", "by", "its", "definition", "id", "." ]

[ "def", "field_data", "(", "self", ",", "field_data", ")", ":", "warnings", ".", "warn", "(", "\"Runtime.field_data is deprecated\"", ",", "FieldDataDeprecationWarning", ",", "stacklevel", "=", "2", ")", "self", ".", "_deprecated_per_instance_field_data", "=", "field_data" ]

[ "Set", "field_data", "." ]

[ "def", "construct_xblock_from_class", "(", "self", ",", "cls", ",", "scope_ids", ",", "field_data", "=", "None", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "self", ".", "mixologist", ".", "mix", "(", "cls", ")", "(", "runtime", "=", "self", ",", "field_data", "=", "field_data", ",", "scope_ids", "=", "scope_ids", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]

[ "Construct", "a", "new", "xblock", "of", "type", "cls", "mixing", "in", "the", "mixins", "defined", "for", "this", "application", "." ]

[ "def", "get_block", "(", "self", ",", "usage_id", ",", "for_parent", "=", "None", ")", ":", "def_id", "=", "self", ".", "id_reader", ".", "get_definition_id", "(", "usage_id", ")", "try", ":", "block_type", "=", "self", ".", "id_reader", ".", "get_block_type", "(", "def_id", ")", "except", "NoSuchDefinition", ":", "raise", "NoSuchUsage", "(", "repr", "(", "usage_id", ")", ")", "keys", "=", "ScopeIds", "(", "self", ".", "user_id", ",", "block_type", ",", "def_id", ",", "usage_id", ")", "block", "=", "self", ".", "construct_xblock", "(", "block_type", ",", "keys", ",", "for_parent", "=", "for_parent", ")", "return", "block" ]

[ "Create", "an", "XBlock", "instance", "in", "this", "runtime", "." ]

[ "def", "get_aside", "(", "self", ",", "aside_usage_id", ")", ":", "aside_type", "=", "self", ".", "id_reader", ".", "get_aside_type_from_usage", "(", "aside_usage_id", ")", "xblock_usage", "=", "self", ".", "id_reader", ".", "get_usage_id_from_aside", "(", "aside_usage_id", ")", "xblock_def", "=", "self", ".", "id_reader", ".", "get_definition_id", "(", "xblock_usage", ")", "aside_def_id", ",", "aside_usage_id", "=", "self", ".", "id_generator", ".", "create_aside", "(", "xblock_def", ",", "xblock_usage", ",", "aside_type", ")", "keys", "=", "ScopeIds", "(", "self", ".", "user_id", ",", "aside_type", ",", "aside_def_id", ",", "aside_usage_id", ")", "block", "=", "self", ".", "create_aside", "(", "aside_type", ",", "keys", ")", "return", "block" ]

[ "Create", "an", "XBlockAside", "in", "this", "runtime", "." ]

[ "def", "parse_xml_string", "(", "self", ",", "xml", ",", "id_generator", "=", "None", ")", ":", "if", "id_generator", "is", "not", "None", ":", "warnings", ".", "warn", "(", "\"Passing an id_generator directly is deprecated \"", "\"in favor of constructing the Runtime with the id_generator\"", ",", "DeprecationWarning", ",", "stacklevel", "=", "2", ",", ")", "id_generator", "=", "id_generator", "or", "self", ".", "id_generator", "if", "isinstance", "(", "xml", ",", "six", ".", "binary_type", ")", ":", "io_type", "=", "BytesIO", "else", ":", "io_type", "=", "StringIO", "return", "self", ".", "parse_xml_file", "(", "io_type", "(", "xml", ")", ",", "id_generator", ")" ]

[ "Parse", "a", "string", "of", "XML", "returning", "a", "usage", "id", "." ]

[ "def", "parse_xml_file", "(", "self", ",", "fileobj", ",", "id_generator", "=", "None", ")", ":", "root", "=", "etree", ".", "parse", "(", "fileobj", ")", ".", "getroot", "(", ")", "usage_id", "=", "self", ".", "_usage_id_from_node", "(", "root", ",", "None", ",", "id_generator", ")", "return", "usage_id" ]

[ "Parse", "an", "open", "XML", "file", "returning", "a", "usage", "id", "." ]

[ "def", "_usage_id_from_node", "(", "self", ",", "node", ",", "parent_id", ",", "id_generator", "=", "None", ")", ":", "if", "id_generator", "is", "not", "None", ":", "warnings", ".", "warn", "(", "\"Passing an id_generator directly is deprecated \"", "\"in favor of constructing the Runtime with the id_generator\"", ",", "DeprecationWarning", ",", "stacklevel", "=", "3", ",", ")", "id_generator", "=", "id_generator", "or", "self", ".", "id_generator", "block_type", "=", "node", ".", "tag", "# remove xblock-family from elements", "node", ".", "attrib", ".", "pop", "(", "'xblock-family'", ",", "None", ")", "# TODO: a way for this node to be a usage to an existing definition?", "def_id", "=", "id_generator", ".", "create_definition", "(", "block_type", ")", "usage_id", "=", "id_generator", ".", "create_usage", "(", "def_id", ")", "keys", "=", "ScopeIds", "(", "None", ",", "block_type", ",", "def_id", ",", "usage_id", ")", "block_class", "=", "self", ".", "mixologist", ".", "mix", "(", "self", ".", "load_block_type", "(", "block_type", ")", ")", "# pull the asides out of the xml payload", "aside_children", "=", "[", "]", "for", "child", "in", "node", ".", "iterchildren", "(", ")", ":", "# get xblock-family from node", "xblock_family", "=", "child", ".", "attrib", ".", "pop", "(", "'xblock-family'", ",", "None", ")", "if", "xblock_family", ":", "xblock_family", "=", "self", ".", "_family_id_to_superclass", "(", "xblock_family", ")", "if", "issubclass", "(", "xblock_family", ",", "XBlockAside", ")", ":", "aside_children", ".", "append", "(", "child", ")", "# now process them & remove them from the xml payload", "for", "child", "in", "aside_children", ":", "self", ".", "_aside_from_xml", "(", "child", ",", "def_id", ",", "usage_id", ",", "id_generator", ")", "node", ".", "remove", "(", "child", ")", "block", "=", "block_class", ".", "parse_xml", "(", "node", ",", "self", ",", "keys", ",", "id_generator", ")", "block", ".", "parent", "=", "parent_id", "block", ".", "save", "(", ")", "return", "usage_id" ]

[ "Create", "a", "new", "usage", "id", "from", "an", "XML", "dom", "node", "." ]

[ "def", "_aside_from_xml", "(", "self", ",", "node", ",", "block_def_id", ",", "block_usage_id", ",", "id_generator", ")", ":", "id_generator", "=", "id_generator", "or", "self", ".", "id_generator", "aside_type", "=", "node", ".", "tag", "aside_class", "=", "self", ".", "load_aside_type", "(", "aside_type", ")", "aside_def_id", ",", "aside_usage_id", "=", "id_generator", ".", "create_aside", "(", "block_def_id", ",", "block_usage_id", ",", "aside_type", ")", "keys", "=", "ScopeIds", "(", "None", ",", "aside_type", ",", "aside_def_id", ",", "aside_usage_id", ")", "aside", "=", "aside_class", ".", "parse_xml", "(", "node", ",", "self", ",", "keys", ",", "id_generator", ")", "aside", ".", "save", "(", ")" ]

[ "Create", "an", "aside", "from", "the", "xml", "and", "attach", "it", "to", "the", "given", "block" ]

[ "def", "add_node_as_child", "(", "self", ",", "block", ",", "node", ",", "id_generator", "=", "None", ")", ":", "usage_id", "=", "self", ".", "_usage_id_from_node", "(", "node", ",", "block", ".", "scope_ids", ".", "usage_id", ",", "id_generator", ")", "block", ".", "children", ".", "append", "(", "usage_id", ")" ]

[ "Called", "by", "XBlock", ".", "parse_xml", "to", "treat", "a", "child", "node", "as", "a", "child", "block", "." ]

[ "def", "export_to_xml", "(", "self", ",", "block", ",", "xmlfile", ")", ":", "root", "=", "etree", ".", "Element", "(", "\"unknown_root\"", ",", "nsmap", "=", "XML_NAMESPACES", ")", "tree", "=", "etree", ".", "ElementTree", "(", "root", ")", "block", ".", "add_xml_to_node", "(", "root", ")", "# write asides as children", "for", "aside", "in", "self", ".", "get_asides", "(", "block", ")", ":", "if", "aside", ".", "needs_serialization", "(", ")", ":", "aside_node", "=", "etree", ".", "Element", "(", "\"unknown_root\"", ",", "nsmap", "=", "XML_NAMESPACES", ")", "aside", ".", "add_xml_to_node", "(", "aside_node", ")", "block", ".", "append", "(", "aside_node", ")", "tree", ".", "write", "(", "xmlfile", ",", "xml_declaration", "=", "True", ",", "pretty_print", "=", "True", ",", "encoding", "=", "'utf-8'", ")" ]

[ "Export", "the", "block", "to", "XML", "writing", "the", "XML", "to", "xmlfile", "." ]

[ "def", "add_block_as_child_node", "(", "self", ",", "block", ",", "node", ")", ":", "child", "=", "etree", ".", "SubElement", "(", "node", ",", "\"unknown\"", ")", "block", ".", "add_xml_to_node", "(", "child", ")" ]

[ "Export", "block", "as", "a", "child", "node", "of", "node", "." ]

[ "def", "render", "(", "self", ",", "block", ",", "view_name", ",", "context", "=", "None", ")", ":", "# Set the active view so that :function:`render_child` can use it", "# as a default", "old_view_name", "=", "self", ".", "_view_name", "self", ".", "_view_name", "=", "view_name", "try", ":", "view_fn", "=", "getattr", "(", "block", ",", "view_name", ",", "None", ")", "if", "view_fn", "is", "None", ":", "view_fn", "=", "getattr", "(", "block", ",", "\"fallback_view\"", ",", "None", ")", "if", "view_fn", "is", "None", ":", "raise", "NoSuchViewError", "(", "block", ",", "view_name", ")", "view_fn", "=", "functools", ".", "partial", "(", "view_fn", ",", "view_name", ")", "frag", "=", "view_fn", "(", "context", ")", "# Explicitly save because render action may have changed state", "block", ".", "save", "(", ")", "updated_frag", "=", "self", ".", "wrap_xblock", "(", "block", ",", "view_name", ",", "frag", ",", "context", ")", "return", "self", ".", "render_asides", "(", "block", ",", "view_name", ",", "updated_frag", ",", "context", ")", "finally", ":", "# Reset the active view to what it was before entering this method", "self", ".", "_view_name", "=", "old_view_name" ]

[ "Render", "a", "block", "by", "invoking", "its", "view", "." ]

[ "def", "render_child", "(", "self", ",", "child", ",", "view_name", "=", "None", ",", "context", "=", "None", ")", ":", "return", "child", ".", "render", "(", "view_name", "or", "self", ".", "_view_name", ",", "context", ")" ]

[ "A", "shortcut", "to", "render", "a", "child", "block", "." ]

[ "def", "render_children", "(", "self", ",", "block", ",", "view_name", "=", "None", ",", "context", "=", "None", ")", ":", "results", "=", "[", "]", "for", "child_id", "in", "block", ".", "children", ":", "child", "=", "self", ".", "get_block", "(", "child_id", ")", "result", "=", "self", ".", "render_child", "(", "child", ",", "view_name", ",", "context", ")", "results", ".", "append", "(", "result", ")", "return", "results" ]

[ "Render", "a", "block", "s", "children", "returning", "a", "list", "of", "results", "." ]

[ "def", "wrap_xblock", "(", "self", ",", "block", ",", "view", ",", "frag", ",", "context", ")", ":", "# pylint: disable=W0613", "if", "hasattr", "(", "self", ",", "'wrap_child'", ")", ":", "log", ".", "warning", "(", "\"wrap_child is deprecated in favor of wrap_xblock and wrap_aside %s\"", ",", "self", ".", "__class__", ")", "return", "self", ".", "wrap_child", "(", "block", ",", "view", ",", "frag", ",", "context", ")", "# pylint: disable=no-member", "extra_data", "=", "{", "'name'", ":", "block", ".", "name", "}", "if", "block", ".", "name", "else", "{", "}", "return", "self", ".", "_wrap_ele", "(", "block", ",", "view", ",", "frag", ",", "extra_data", ")" ]

[ "Creates", "a", "div", "which", "identifies", "the", "xblock", "and", "writes", "out", "the", "json_init_args", "into", "a", "script", "tag", "." ]

[ "def", "wrap_aside", "(", "self", ",", "block", ",", "aside", ",", "view", ",", "frag", ",", "context", ")", ":", "# pylint: disable=unused-argument", "return", "self", ".", "_wrap_ele", "(", "aside", ",", "view", ",", "frag", ",", "{", "'block_id'", ":", "block", ".", "scope_ids", ".", "usage_id", ",", "'url_selector'", ":", "'asideBaseUrl'", ",", "}", ")" ]

[ "Creates", "a", "div", "which", "identifies", "the", "aside", "points", "to", "the", "original", "block", "and", "writes", "out", "the", "json_init_args", "into", "a", "script", "tag", "." ]

[ "def", "_wrap_ele", "(", "self", ",", "block", ",", "view", ",", "frag", ",", "extra_data", "=", "None", ")", ":", "wrapped", "=", "Fragment", "(", ")", "data", "=", "{", "'usage'", ":", "block", ".", "scope_ids", ".", "usage_id", ",", "'block-type'", ":", "block", ".", "scope_ids", ".", "block_type", ",", "}", "data", ".", "update", "(", "extra_data", ")", "if", "frag", ".", "js_init_fn", ":", "data", "[", "'init'", "]", "=", "frag", ".", "js_init_fn", "data", "[", "'runtime-version'", "]", "=", "frag", ".", "js_init_version", "json_init", "=", "\"\"", "# TODO/Note: We eventually want to remove: hasattr(frag, 'json_init_args')", "# However, I'd like to maintain backwards-compatibility with older XBlock", "# for at least a little while so as not to adversely effect developers.", "# pmitros/Jun 28, 2014.", "if", "hasattr", "(", "frag", ",", "'json_init_args'", ")", "and", "frag", ".", "json_init_args", "is", "not", "None", ":", "json_init", "=", "(", "'<script type=\"json/xblock-args\" class=\"xblock_json_init_args\">'", "'{data}</script>'", ")", ".", "format", "(", "data", "=", "json", ".", "dumps", "(", "frag", ".", "json_init_args", ")", ")", "block_css_entrypoint", "=", "block", ".", "entry_point", ".", "replace", "(", "'.'", ",", "'-'", ")", "css_classes", "=", "[", "block_css_entrypoint", ",", "'{}-{}'", ".", "format", "(", "block_css_entrypoint", ",", "view", ")", ",", "]", "html", "=", "\"<div class='{}'{properties}>{body}{js}</div>\"", ".", "format", "(", "markupsafe", ".", "escape", "(", "' '", ".", "join", "(", "css_classes", ")", ")", ",", "properties", "=", "\"\"", ".", "join", "(", "\" data-%s='%s'\"", "%", "item", "for", "item", "in", "list", "(", "data", ".", "items", "(", ")", ")", ")", ",", "body", "=", "frag", ".", "body_html", "(", ")", ",", "js", "=", "json_init", ")", "wrapped", ".", "add_content", "(", "html", ")", "wrapped", ".", "add_fragment_resources", "(", "frag", ")", "return", "wrapped" ]

[ "Does", "the", "guts", "of", "the", "wrapping", "the", "same", "way", "for", "both", "xblocks", "and", "asides", ".", "Their", "wrappers", "provide", "other", "info", "in", "extra_data", "which", "gets", "put", "into", "the", "dom", "data", "-", "attrs", "." ]

[ "def", "get_asides", "(", "self", ",", "block", ")", ":", "aside_instances", "=", "[", "self", ".", "get_aside_of_type", "(", "block", ",", "aside_type", ")", "for", "aside_type", "in", "self", ".", "applicable_aside_types", "(", "block", ")", "]", "return", "[", "aside_instance", "for", "aside_instance", "in", "aside_instances", "if", "aside_instance", ".", "should_apply_to_block", "(", "block", ")", "]" ]

[ "Return", "instances", "for", "all", "of", "the", "asides", "that", "will", "decorate", "this", "block", "." ]

[ "def", "get_aside_of_type", "(", "self", ",", "block", ",", "aside_type", ")", ":", "# TODO: This function will need to be extended if we want to allow:", "# a) XBlockAsides to statically indicated which types of blocks they can comment on", "# b) XBlockRuntimes to limit the selection of asides to a subset of the installed asides", "# c) Optimize by only loading asides that actually decorate a particular view", "if", "self", ".", "id_generator", "is", "None", ":", "raise", "Exception", "(", "\"Runtimes must be supplied with an IdGenerator to load XBlockAsides.\"", ")", "usage_id", "=", "block", ".", "scope_ids", ".", "usage_id", "aside_cls", "=", "self", ".", "load_aside_type", "(", "aside_type", ")", "definition_id", "=", "self", ".", "id_reader", ".", "get_definition_id", "(", "usage_id", ")", "aside_def_id", ",", "aside_usage_id", "=", "self", ".", "id_generator", ".", "create_aside", "(", "definition_id", ",", "usage_id", ",", "aside_type", ")", "scope_ids", "=", "ScopeIds", "(", "self", ".", "user_id", ",", "aside_type", ",", "aside_def_id", ",", "aside_usage_id", ")", "return", "aside_cls", "(", "runtime", "=", "self", ",", "scope_ids", "=", "scope_ids", ")" ]

[ "Return", "the", "aside", "of", "the", "given", "aside_type", "which", "might", "be", "decorating", "this", "block", "." ]