ciocore 6.3.2rc1__py2.py3-none-any.whl → 6.4.0__py2.py3-none-any.whl

ciocore/VERSION

@@ -1 +1 @@
-6.3.2-rc.1
+6.4.0

ciocore/__about__.py

@@ -2,26 +2,9 @@ import os
 
 __all__ = ["__version__"]
 
-# Get the version from the VERSION file
-# The VERSION file may be in the current directory or (in dev) one directory up
-
 try:
-    with open(
-        os.path.join(os.path.abspath(os.path.dirname(__file__)), "VERSION"),
-        "r",
-        encoding="utf-8",
-    ) as version_file:
+    with open(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'VERSION')) as version_file:
         __version__ = version_file.read().strip()
-
+        
 except IOError:
-    try:
-        with open(
-            os.path.join(
-                os.path.abspath(os.path.dirname(os.path.dirname(__file__))), "VERSION"
-            ),
-            "r",
-            encoding="utf-8",
-        ) as version_file:
-            __version__ = version_file.read().strip()
-    except IOError:
-        __version__ = "dev"
+    __version__ = 'dev'

ciocore/api_client.py

@@ -1,7 +1,3 @@
-"""
-The api_client module is used to make requests to the Conductor API.
-"""
-
 import base64
 import importlib
 import json
@@ -18,7 +14,7 @@ try:
     from urllib import parse
 except ImportError:
     import urlparse as parse
-
+    
 import ciocore
 
 from ciocore import config
@@ -44,28 +40,45 @@ except AttributeError:
     )
 
 
+
 # TODO: appspot_dot_com_cert = os.path.join(common.base_dir(),'auth','appspot_dot_com_cert2') load
 # appspot.com cert into requests lib verify = appspot_dot_com_cert
 
 
 class ApiClient:
-    """
-    The ApiClient class is a wrapper around the requests library that handles authentication and retries.
-    """
-
     http_verbs = ["PUT", "POST", "GET", "DELETE", "HEAD", "PATCH"]
-
+    
     USER_AGENT_TEMPLATE = "client {client_name}/{client_version} (ciocore {ciocore_version}; {runtime} {runtime_version}; {platform} {platform_details}; {hostname} {pid}; {python_path})"
     USER_AGENT_MAX_PATH_LENGTH = 1024
-
+    
     user_agent_header = None
 
     def __init__(self):
-        """
-        Initialize the ApiClient object.
-        """
         logger.debug("")
 
+    def _make_request(self, verb, conductor_url, headers, params, data, raise_on_error=True):
+        response = requests.request(
+            method=verb, url=conductor_url, headers=headers, params=params, data=data
+        )
+
+        logger.debug("verb: %s", verb)
+        logger.debug("conductor_url: %s", conductor_url)
+        logger.debug("headers: %s", headers)
+        logger.debug("params: %s", params)
+        logger.debug("data: %s", data)
+
+        # If we get 300s/400s debug out the response. TODO(lws): REMOVE THIS
+        if response.status_code and 300 <= response.status_code < 500:
+            logger.debug("*****  ERROR!!  *****")
+            logger.debug("Reason: %s" % response.reason)
+            logger.debug("Text: %s" % response.text)
+
+        # trigger an exception to be raised for 4XX or 5XX http responses
+        if raise_on_error:
+            response.raise_for_status()
+
+        return response
+
     def make_prepared_request(
         self,
         verb,
@@ -79,31 +92,30 @@ class ApiClient:
         raise_on_error=True,
         tries=5,
     ):
+
         """
-        Make a request to the Conductor API.
-
-        Deprecated:
-            Primarily used to removed enforced headers by requests.Request. Requests 2.x will add
-            Transfer-Encoding: chunked with file like object that is 0 bytes, causing s3 failures (501)
-            - https://github.com/psf/requests/issues/4215#issuecomment-319521235
-
-            To get around this bug make_prepared_request has functionality to remove the enforced header
-            that would occur when using requests.request(...). Requests 3.x resolves this issue, when
-            client is built to use Requests 3.x this function can be removed.
-
-        Returns:
-            requests.Response: The response object.
-
-        Args:
-            verb (str): The HTTP verb to use.
-            url (str): The URL to make the request to.
-            headers (dict): A dictionary of headers to send with the request.
-            params (dict): A dictionary of query parameters to send with the request.
-            json (dict): A JSON payload to send with the request.
-            stream (bool): Whether or not to stream the response.
-            remove_headers_list (list): A list of headers to remove from the request.
-            raise_on_error (bool): Whether or not to raise an exception if the request fails.
-            tries (int): The number of times to retry the request.
+        Primarily used to removed enforced headers by requests.Request. Requests 2.x will add
+        Transfer-Encoding: chunked with file like object that is 0 bytes, causing s3 failures (501)
+        - https://github.com/psf/requests/issues/4215#issuecomment-319521235
+
+        To get around this bug make_prepared_request has functionality to remove the enforced header
+        that would occur when using requests.request(...). Requests 3.x resolves this issue, when
+        client is built to use Requests 3.x this function can be deprecated.
+
+        args:
+            verb: (str) of HTTP verbs
+            url: (str) url
+            headers: (dict)
+            params: (dict)
+            json: (dict)
+            data: (varies)
+            stream: (bool)
+            remove_headers_list: list of headers to remove i.e ["Transfer-Encoding"]
+            raise_on_error: (bool)
+            tries: (int) number of attempts to perform request
+
+
+        return: request.Response
         """
 
         req = requests.Request(
@@ -121,11 +133,9 @@ class ApiClient:
                 prepped.headers.pop(header, None)
 
         # Create a retry wrapper function
-        retry_wrapper = common.DecRetry(
-            retry_exceptions=CONNECTION_EXCEPTIONS, tries=tries
-        )
+        retry_wrapper = common.DecRetry(retry_exceptions=CONNECTION_EXCEPTIONS, tries=tries)
 
-        # requests sessions potentially not thread-safe, but need to removed enforced
+        # requests sessions potentially not thread-safe, but need to potentially removed enforced
         # headers by using a prepared request.create which can only be done through an
         # request.Session object. Create Session object per call of make_prepared_request, it will
         # not benefit from connection pooling reuse. https://github.com/psf/requests/issues/1871
@@ -158,24 +168,10 @@ class ApiClient:
         conductor_url=None,
         raise_on_error=True,
         tries=5,
-        use_api_key=False,
+        use_api_key=False
     ):
         """
-        Make a request to the Conductor API.
-
-        Args:
-            uri_path (str): The path to the resource to request.
-            headers (dict): A dictionary of headers to send with the request.
-            params (dict): A dictionary of query parameters to send with the request.
-            data (dict): A dictionary of data to send with the request.
-            verb (str): The HTTP verb to use.
-            conductor_url (str): The Conductor URL.
-            raise_on_error (bool): Whether or not to raise an exception if the request fails.
-            tries (int): The number of times to retry the request.
-            use`_api_key (bool): Whether or not to use the API key for authentication.
-
-        Returns:
-            tuple(str, int): The response text and status code.
+        verb: PUT, POST, GET, DELETE, HEAD, PATCH
         """
         cfg = config.config().config
         # TODO: set Content Content-Type to json if data arg
@@ -188,10 +184,10 @@ class ApiClient:
             raise Exception("Error: Could not get conductor credentials!")
 
         headers["Authorization"] = "Bearer %s" % bearer_token
-
+        
         if not ApiClient.user_agent_header:
             self.register_client("ciocore")
-
+        
         headers["User-Agent"] = ApiClient.user_agent_header
 
         # Construct URL
@@ -207,9 +203,7 @@ class ApiClient:
         assert verb in self.http_verbs, "Invalid http verb: %s" % verb
 
         # Create a retry wrapper function
-        retry_wrapper = common.DecRetry(
-            retry_exceptions=CONNECTION_EXCEPTIONS, tries=tries
-        )
+        retry_wrapper = common.DecRetry(retry_exceptions=CONNECTION_EXCEPTIONS, tries=tries)
 
         # wrap the request function with the retry wrapper
         wrapped_func = retry_wrapper(self._make_request)
@@ -220,155 +214,99 @@ class ApiClient:
         )
 
         return response.text, response.status_code
-
+    
     @classmethod
     def _get_user_agent_header(cls, client_name, client_version=None):
-        """
-        Generates the http User Agent header that includes helpful debug info.
-
+        '''
+        Generates the http User Agent header that includes helpful debug info. 
+        
         The final component is the path to the python executable (MD5 hex).
-
-        Example:
-        'ciomaya/0.3.7 (ciocore 4.3.2; python 3.9.5; linux 3.10.0-1160.53.1.el7.x86_64; 0ee7123c2365d7a0d126de5a70f19727)'
-
+        
+        ex: 'ciomaya/0.3.7 (ciocore 4.3.2; python 3.9.5; linux 3.10.0-1160.53.1.el7.x86_64; 0ee7123c2365d7a0d126de5a70f19727)'
+        
         :param client_name: The name of the client to be used in the header. If it's importable it
                             will be queried for its __version__ (unless client_version is supplied)
         :type client_name: str
-
+        
         :param client_version: The version to use in the header if client_name can't be queried for
                                __version__ (or it needs to be overridden)
         :type client_version: str [default = None]
-
+        
         :return: The value for the User Agent header
-        :rtype: str
-        """
-
+        :rtype: str        
+        '''
+        
         try:
             client_module = importlib.import_module(client_name)
-
+                    
         except ImportError:
-            logger.warning(
-                "Unable to import module '{}'. Won't query for version details."
-            )
-            client_version = "unknown"
-
+            logger.warning("Unable to import module '{}'. Won't query for version details.")
+            client_version = 'unknown'
+        
         if not client_version:
             try:
                 client_version = client_module.__version__
-
+                
             except AttributeError:
-                logger.warning(
-                    "Module '{}' has no __version__ attribute. Setting version to 'N/A' in the user agent"
-                )
-                client_version = "unknown"
-
+                logger.warning("Module '{}' has no __version__ attribute. Setting version to 'N/A' in the user agent")
+                client_version = 'unknown'
+        
         ciocore_version = ciocore.__version__
-
+        
         python_path = sys.executable
-
+        
         # If the length of the path is longer than allowed, truncate the middle
         if len(python_path) > cls.USER_AGENT_MAX_PATH_LENGTH:
-            first_half = int(cls.USER_AGENT_MAX_PATH_LENGTH / 2)
-            second_half = len(python_path) - int(cls.USER_AGENT_MAX_PATH_LENGTH / 2)
-
+            
+            first_half = int(cls.USER_AGENT_MAX_PATH_LENGTH/2)
+            second_half = len(python_path) - int(cls.USER_AGENT_MAX_PATH_LENGTH/2)
+            
             print(first_half, second_half)
-            python_path = "{}...{}".format(
-                python_path[0:first_half], python_path[second_half:-1]
-            )
-
-        python_path_encoded = base64.b64encode(python_path.encode("utf-8")).decode(
-            "utf-8"
-        )
-
+            python_path = "{}...{}".format(python_path[0:first_half], python_path[second_half:-1])
+        
+        python_path_encoded = base64.b64encode(python_path.encode('utf-8')).decode('utf-8')
+        
         if platform.system() == "Linux":
             platform_details = platform.release()
-
+            
         elif platform.system() == "Windows":
             platform_details = platform.version()
-
+            
         elif platform.system() == "Darwin":
             platform_details = platform.mac_ver()[0]
-
+            
         else:
             raise ValueError("Unrecognized platform '{}'".format(platform.release()))
-
-        pid = base64.b64encode(str(os.getpid()).encode("utf-8")).decode("utf-8")
-        hostname = base64.b64encode(socket.gethostname().encode("utf-8")).decode(
-            "utf-8"
-        )
-
-        return cls.USER_AGENT_TEMPLATE.format(
-            client_name=client_name,
-            client_version=client_version,
-            ciocore_version=ciocore_version,
-            runtime="python",
-            runtime_version=platform.python_version(),
-            platform=sys.platform,
-            platform_details=platform_details,
-            pid=pid,
-            hostname=hostname,
-            python_path=python_path_encoded,
-        )
-
+        
+        pid = base64.b64encode(str(os.getpid()).encode('utf-8')).decode('utf-8')
+        hostname = base64.b64encode(socket.gethostname().encode('utf-8')).decode('utf-8')
+
+        return cls.USER_AGENT_TEMPLATE.format(client_name=client_name,
+                                              client_version=client_version,
+                                              ciocore_version=ciocore_version,
+                                              runtime='python',
+                                              runtime_version=platform.python_version(),
+                                              platform=sys.platform,
+                                              platform_details=platform_details,
+                                              pid=pid,
+                                              hostname=hostname, 
+                                              python_path=python_path_encoded
+                                              )
+        
     @classmethod
     def register_client(cls, client_name, client_version=None):
         cls.user_agent_header = cls._get_user_agent_header(client_name, client_version)
-
-    ## PRIVATE METHODS ##
-    def _make_request(
-        self, verb, conductor_url, headers, params, data, raise_on_error=True
-    ):
-        """
-        Make a request to the Conductor API.
-
-        Args:
-            verb (str): The HTTP verb to use.
-            conductor_url (str): The URL to make the request to.
-            headers (dict): A dictionary of headers to send with the request.
-            params (dict): A dictionary of query parameters to send with the request.
-            data (dict): A dictionary of data to send with the request.
-            raise_on_error (bool): Whether or not to raise an exception if the request fails.
-        """
-
-        response = requests.request(
-            method=verb, url=conductor_url, headers=headers, params=params, data=data
-        )
-
-        logger.debug("verb: %s", verb)
-        logger.debug("conductor_url: %s", conductor_url)
-        logger.debug("headers: %s", headers)
-        logger.debug("params: %s", params)
-        logger.debug("data: %s", data)
-
-        # If we get 300s/400s debug out the response. TODO(lws): REMOVE THIS
-        if response.status_code and 300 <= response.status_code < 500:
-            logger.debug("*****  ERROR!!  *****")
-            logger.debug("Reason: %s" % response.reason)
-            logger.debug("Text: %s" % response.text)
-
-        # trigger an exception to be raised for 4XX or 5XX http responses
-        if raise_on_error:
-            response.raise_for_status()
-
-        return response
-
+        
+        
 
 def read_conductor_credentials(use_api_key=False):
     """
-    Read the conductor credentials file.
-    
-    If the credentials file exists, it will contain a bearer token from either
-    the user or the API key (if that's desired).
-    
-    If the credentials file doesn't exist, or is
-    expired, or is from a different domain, we try to fetch a new one in the API key scenario or
-    prompt the user to log in. 
-    
-    Args: 
-        use_api_key (bool): Whether or not to try to use the API key
+    Read the conductor credentials file, if it exists. This will contain a bearer token from either
+    the user or the API key (if that's desired). If the credentials file doesn't exist, or is
+    expired, or is from a different domain, try and fetch a new one in the API key scenario or
+    prompt the user to log in. Args: use_api_key: Whether or not to use the API key
 
-    Returns: 
-        A Bearer token in the event of a success or None.
+    Returns: A Bearer token in the event of a success or None if things couldn't get figured out
 
     """
 
@@ -428,15 +366,6 @@ def read_conductor_credentials(use_api_key=False):
 
 
 def get_api_key_bearer_token(creds_file=None):
-    """
-    Get a bearer token from the API key.
-    
-    Args:
-        creds_file (str): The path to the credentials file. If not provided, the bearer token will not be written to disk.
-        
-    Returns:
-        A dictionary containing the bearer token and other information.
-    """
     cfg = config.config().config
     url = "{}/api/oauth_jwt".format(cfg["url"])
     response = requests.get(
@@ -469,15 +398,7 @@ def get_api_key_bearer_token(creds_file=None):
 
 
 def get_creds_path(api_key=False):
-    """
-    Get the path to the credentials file.
-    
-    Args:
-        api_key (bool): Whether or not to use the API key.
-        
-    Returns:
-        str: The path to the credentials file.
-    """
+
     creds_dir = os.path.join(os.path.expanduser("~"), ".config", "conductor")
     if api_key:
         creds_file = os.path.join(creds_dir, "api_key_credentials")
@@ -490,24 +411,12 @@ def get_bearer_token(refresh=False):
     """
     Return the bearer token.
 
-    Args:
-        refresh (bool): Whether or not to refresh the token.
-        
     TODO: Thread safe multiproc caching, like it used to be pre-python3.7.
     """
     return read_conductor_credentials(True)
 
 
 def creds_same_domain(creds):
-    """
-    Check if the creds are for the same domain as the config.
-    
-    Args:
-        creds (dict): The credentials dictionary.
-        
-    Returns:
-        bool: Whether or not the creds are for the same domain as the config.
-    """
     cfg = config.config().config
     """Ensure the creds file refers to the domain in config"""
     token = creds.get("access_token")
@@ -525,12 +434,6 @@ def creds_same_domain(creds):
 def account_id_from_jwt(token):
     """
     Fetch the accounts id from a jwt token value.
-    
-    Args:
-        token (str): The jwt token.
-    
-    Returns:
-        str: The account id.
     """
     payload = jwt.decode(token, verify=False)
     return payload.get("account")
@@ -539,12 +442,6 @@ def account_id_from_jwt(token):
 def account_name_from_jwt(token):
     """
     Fetch the accounts name from a jwt token value.
-    
-    Args:
-        token (str): The jwt token.
-        
-    Returns:
-        str: The account name.
     """
     cfg = config.config().config
     account_id = account_id_from_jwt(token)
@@ -560,12 +457,6 @@ def account_name_from_jwt(token):
 def request_instance_types(as_dict=False):
     """
     Get the list of available instances types.
-    
-    Args:
-        as_dict (bool): Whether or not to return the instance types as a dictionary.
-    
-    Returns:
-        list: The list of instance types.
     """
     api = ApiClient()
     response, response_code = api.make_request(
@@ -580,21 +471,13 @@ def request_instance_types(as_dict=False):
     logger.debug("Found available instance types: %s", instance_types)
 
     if as_dict:
-        return dict(
-            [(instance["description"], instance) for instance in instance_types]
-        )
+        return dict([(instance["description"], instance) for instance in instance_types])
     return instance_types
 
 
 def request_projects(statuses=("active",)):
     """
-    Query Conductor for all client Projects that are in the given status(es).
-    
-    Args:
-        statuses (tuple): The statuses to filter for.
-    
-    Returns:
-        list: The list of project names.
+    Query Conductor for all client Projects that are in the given state(s)
     """
     api = ApiClient()
 
@@ -623,9 +506,6 @@ def request_projects(statuses=("active",)):
 def request_software_packages():
     """
     Query Conductor for all software packages for the currently available sidecar.
-    
-    Returns:
-        list: The list of software packages.
     """
     api = ApiClient()
 

ciocore/cli/__init__.py

@@ -0,0 +1,3 @@
+"""
+Commandline tools.
+"""