Merged PR 821: Adding GetHostInfo to UtilityFunctions

Python does provide methods for the platform to pass information to the Python environment through the platform module, but it is important that the way this information is parsed is consistent.
To address this issue this function will parse the information into the 3 pieces we care about:
1) Linux or Windows
2) 32 or 64 bit
3)  x86 or ARM

MuPythonLibrary/MuAnsiHandler.py

@@ -27,7 +27,7 @@
 ##
 import logging
 import re
-import os
+from MuPythonLibrary.UtilityFunctions import GetHostInfo
 try:
     # try to import windows types from winDLL
     import ctypes
@@ -248,7 +248,7 @@ class ColoredStreamHandler(logging.StreamHandler):
 
     def __init__(self, stream=None, strip=None, convert=None):
         logging.StreamHandler.__init__(self, stream)
-        self.on_windows = os.name == 'nt'
+        self.on_windows = GetHostInfo().os == "Windows"
         # We test if the WinAPI works, because even if we are on Windows
         # we may be using a terminal that doesn't support the WinAPI
         # (e.g. Cygwin Terminal). In this case it's up to the terminal

MuPythonLibrary/UtilityFunctions.py

@@ -13,6 +13,8 @@
 import threading
 import subprocess
 import sys
+import platform
+from collections import namedtuple
 
 ####
 # Helper to allow Enum type to be used which allows better code readability
@@ -93,7 +95,7 @@ def reader(filepath, outstream, stream):
 def GetNugetCmd():
     file = "NuGet.exe"
     cmd = []
-    if (os.name == "posix"):
+    if (GetHostInfo().os == "Linux"):
         cmd += ["mono"]
         found = False
         for env_var in os.getenv("PATH").split(os.pathsep):
@@ -109,6 +111,37 @@ def GetNugetCmd():
     return cmd
 
 
+####
+# Returns a namedtuple containing information about host machine.
+#
+# @return namedtuple Host(os=OS Type, arch=System Architecture, bit=Highest Order Bit)
+####
+def GetHostInfo():
+    Host = namedtuple('Host', 'os arch bit')
+    host_info = platform.uname()
+    os = host_info.system
+    processor_info = host_info.machine
+    logging.debug("Getting host info for host: {0}".format(str(host_info)))
+
+    arch = None
+    bit = None
+
+    if ("x86" in processor_info) or ("AMD" in processor_info) or ("Intel" in processor_info):
+        arch = "x86"
+    elif ("ARM" in processor_info) or ("AARCH" in processor_info):
+        arch = "ARM"
+
+    if "32" in processor_info:
+        bit = "32"
+    elif "64" in processor_info:
+        bit = "64"
+
+    if (arch is None) or (bit is None):
+        raise EnvironmentError("Host info could not be parsed: {0}".format(str(host_info)))
+
+    return Host(os=os, arch=arch, bit=bit)
+
+
 ####
 # Run a shell commmand and print the output to the log file
 # This is the public function that should be used to run commands from the shell in python environment

MuPythonLibrary/feature_GetHostInfo.md

@@ -0,0 +1,30 @@
+# GetHostInfo
+
+This document details the utility function called GetHostInfo. This function was written because NuGet needed a way to determine attributes about the host system to determine what parts of a dependency to use.
+
+## How to Use
+```python
+from MuPythonLibrary.UtilityFunctions import GetHostInfo
+
+host_info = GetHostInfo()
+```
+
+## Usage info
+
+GetHostInfo() will return a namedtuple with 3 attributes describing the host machine. Below for each is the name of the field, description of the field and possible contents therein.
+
+### 1. os - OS Name
+
+  Windows, Linux, or Java
+
+### 2. arch - Processor architecture
+
+  ARM or x86
+
+### 3. bit - Highest order bit
+
+  32 or 64
+
+## Purpose
+
+  Since there are multiple different ways one could derive these values, it is necessary provide a common implementation of that logic to ensure it is uniform.

README.rst

@@ -19,7 +19,10 @@ Version History
 
 0.4.3-dev
 -----
+
 Main Changes:
+
+- Added GetHostInfo to UtilityFunctions. This function will parse the platform module to provide information about the host.
 - Added colors for progress and section labels.
 
 0.4.2