Initial commit

Author: j4c0bs

.gitignore

@@ -1,3 +1,5 @@
+.DS_Store
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -1,2 +1,2 @@
-# boto3-type
+# boto3-type [WIP]
 Pseudo type check for boto3 service resource instances

boto3_type/__init__.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+__author__ = "Jeremy Jacobs"
+__version__ = "0.0.1"
+
+
+from boto3_type import client
+from boto3_type import resource
+from boto3_type import s3

boto3_type/client.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import botocore
+
+from .util import compare
+
+
+def istype(client, service_name):
+    """Return whether a client is an instance of the reference service name.
+
+    An iterable may be provided to check against multiple services. This is equivalent
+    to ``istype(x, A) or istype(x, B)``.
+
+    Args:
+        client: botocore.client.BaseClient
+        service_name: str | iterable
+            - the service client name(s)
+
+    Returns:
+        bool
+    """
+
+    if isinstance(client, botocore.client.BaseClient):
+        return compare(client.meta.service_model.service_name, service_name)
+    return False

boto3_type/resource.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import boto3
+
+from .util import compare
+
+
+def istype(resource, service_name):
+    """Return whether a resource service is an instance of the reference service name.
+
+    An iterable may be provided to check against multiple services. This is equivalent
+    to ``istype(x, A) or istype(x, B)``.
+
+    Args:
+        client: boto3.resources.base.ServiceResource
+        service_name: str | iterable
+            - the service client name(s)
+
+    Returns:
+        bool
+    """
+
+    if isinstance(resource, boto3.resources.base.ServiceResource):
+        return compare(resource.meta.service_name, service_name)
+    return False

boto3_type/s3.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import boto3
+
+from .util import compare
+
+
+def istype(subresource, name):
+    """Return whether an S3 subresource is an instance of the reference name.
+
+    An iterable may be provided to check against multiple services. This is equivalent
+    to ``istype(x, A) or istype(x, B)``.
+
+    Args:
+        client: boto3.resources.base.ServiceResource
+        service_name: str | iterable
+            - the subresource name(s)
+
+    Returns:
+        bool
+    """
+    if isinstance(subresource, boto3.resources.base.ServiceResource):
+        return compare(subresource.meta.resource_model.name, name)
+    return False

boto3_type/util.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+
+def compare(resource_service, service_names):
+
+    resource_service = resource_service.lower()
+
+    if isinstance(service_names, str):
+        service_names = [service_names]
+
+    return any((resource_service == name.lower() for name in service_names))