summaryrefslogtreecommitdiff
path: root/src/leap/common/check.py
diff options
context:
space:
mode:
authorkali <kali@leap.se>2013-03-14 07:08:31 +0900
committerkali <kali@leap.se>2013-03-15 01:02:11 +0900
commitd0dfad6ac2af360de6421ce74a6831b5b81ad019 (patch)
treea0a79d4fb328e09ab85f53d826d65f5d7f874f0c /src/leap/common/check.py
parentb76461efe13d24950cb389735432024c26e1e768 (diff)
namespace leap + leap.common split
leap is a namespace package from here on. common folder will be deleted and moved to leap_pycommon repository.
Diffstat (limited to 'src/leap/common/check.py')
-rw-r--r--src/leap/common/check.py61
1 files changed, 61 insertions, 0 deletions
diff --git a/src/leap/common/check.py b/src/leap/common/check.py
new file mode 100644
index 00000000..9787341a
--- /dev/null
+++ b/src/leap/common/check.py
@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+# check.py
+# Copyright (C) 2013 LEAP
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Set of functions to help checking situations
+"""
+import logging
+import inspect
+import traceback
+
+
+logger = logging.getLogger(__name__)
+
+
+def leap_assert(condition, message=""):
+ """
+ Asserts the condition and displays the message if that's not
+ met. It also logs the error and its backtrace.
+
+ @param condition: condition to check
+ @type condition: bool
+ @param message: message to display if the condition isn't met
+ @type message: str
+ """
+ if not condition:
+ logger.error("Bug: %s" % (message,))
+ try:
+ frame = inspect.currentframe()
+ stack_trace = traceback.format_stack(frame)
+ logger.error(''.join(stack_trace))
+ except Exception as e:
+ logger.error("Bug in leap_assert: %r" % (e,))
+ assert condition, message
+
+
+def leap_assert_type(var, expectedType):
+ """
+ Helper assert check for a variable's expected type
+
+ @param var: variable to check
+ @type var: any
+ @param expectedType: type to check agains
+ @type expectedType: type
+ """
+ leap_assert(isinstance(var, expectedType),
+ "Expected type %r instead of %r" %
+ (expectedType, type(var)))