Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SI Python Examples #5

Merged
merged 2 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added python/advanced/example.db
Binary file not shown.
Binary file added python/advanced/icon.ico
Binary file not shown.
67 changes: 67 additions & 0 deletions python/advanced/just.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Simple HTML Page</title>
<style>
body {
font-family: Arial, sans-serif;
margin: 0;
padding: 0;
}
header {
background-color: #333;
color: #fff;
text-align: center;
padding: 10px 0;
}
nav {
background-color: #f4f4f4;
padding: 10px;
}
nav ul {
list-style-type: none;
margin: 0;
padding: 0;
text-align: center;
}
nav ul li {
display: inline;
margin-right: 10px;
}
.content {
padding: 20px;
}
.box {
background-color: #f9f9f9;
border: 1px solid #ccc;
padding: 10px;
margin: 10px;
}
</style>
</head>
<body>
<header>
<h1>Simple HTML Page</h1>
</header>
<nav>
<ul>
<li><a href="#">Home</a></li>
<li><a href="#">About</a></li>
<li><a href="#">Services</a></li>
<li><a href="#">Contact</a></li>
</ul>
</nav>
<div class="content">
<div class="box">
<h2>First Div</h2>
<p>This is the content of the first div.</p>
</div>
<div class="box">
<h2>Second Div</h2>
<p>This is the content of the second div.</p>
</div>
</div>
</body>
</html>
1 change: 1 addition & 0 deletions python/advanced/just.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Hello from just.txt
198 changes: 198 additions & 0 deletions python/advanced/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
import datetime
import sqlite3
import threading
import time
from fractions import Fraction

from smartinspect.common.color import Color
from smartinspect.common.level import Level
from smartinspect.common.context import ViewerContext
from smartinspect.common.viewer_id import ViewerId
from smartinspect.packets import LogEntryType, ProcessFlowType, WatchType
from smartinspect.common.source_id import SourceId
from smartinspect import SmartInspect


# Description:
#
# This example demonstrates advanced usage of SmartInspect by exposing variety of methods.


class DummyFather:
__parent_class_private = 0
_parent_class_protected = 1
parent_class_public = 2

def __init__(self):
self.__derived_private = 0
self._derived_protected = 0
self.derived_public = 0

def do_something(self):
pass


class Dummy(DummyFather):
__class_private = 3
_class_protected = 4
class_public = 5

def __init__(self):
super().__init__()
self.__instance_private = 6
self._instance_protected = 7
self.instance_public = 8

def do_something(self):
pass

def do_another_thing(self):
pass

def __repr__(self):
return self.__class__.__name__


dummy = Dummy()

if __name__ == '__main__':

si = SmartInspect('Python Client')
si.set_connections("tcp()")
si.set_enabled(True)
session = si.add_session("Session name", True)
session.clear_all()

session.enter_process("Enter process {}", "name")
session.log_separator()
session.reset_call_stack()
session.enter_method("Called method with {kwarg}, arg {} and {}", "arg1", 2, instance=dummy, kwarg="kwargs")
session.leave_method("Leaving method with {} and arg {}", "arg1", 2, instance=dummy)
session.reset_call_stack()
session.enter_thread("Entering thread with {} and arg {}", "arg1", 2)
session.leave_thread("Leaving thread with {} and arg {}", "arg1", 2)
session.leave_process("Leave process {}", "name")

session.enter_process("Enter another process {}", "name")
session.enter_thread("Entering thread with {} and arg {}", "arg1", 2)

session.log_colored(Color.BLACK, "Text with {}", "args")

session.level = Level.DEBUG
session.log_debug("Logging {}", "debug")
session.level = Level.VERBOSE
session.log_verbose("Logging {}", "verbose")
session.level = Level.MESSAGE
session.log_message("Logging {}", "message")
session.level = Level.WARNING
session.log_warning("Logging {}", "warning")
session.level = Level.ERROR
session.log_error("Logging {}", "error")
session.level = Level.FATAL
session.log_fatal("Logging {}", "fatal")

session.level = Level.MESSAGE
session.add_checkpoint("Checkpoint", "initiating checkpoint")
session.add_checkpoint("Checkpoint", "incrementing")
session.add_checkpoint("Checkpoint", "incrementing")
session.reset_checkpoint("Checkpoint")
session.add_checkpoint("Checkpoint", "after reset")

a, b = 1, 2
session.log_assert(a > b, "{} > {} is {}", a, b, a > b)

session.log_is_none("Am I None", None)
session.log_conditional(a > b, "Log {} > {}", a, b)
session.log_conditional(a < b, "Log {} < {}", a, b)

session.log_separator()
session.log_bool("Bool", True)
session.log_str("Str", "string")
session.log_bytes("Byte with hex", b"string123456", include_hex=True)
session.log_bytes("Byte without hex", b"string123456")
session.log_bytearray("Bytearray with hex", bytearray(b"string123456"), include_hex=True)
session.log_bytearray("Bytearray without hex", bytearray(b"string123456"))
session.log_int("Int with hex", 123456, include_hex=True)
session.log_int("Int without hex", 123456)
session.log_float("Float", 3.123456)
session.log_object_value("Object", dummy)
session.log_time("Time", datetime.time(12, 30, 31))
session.log_datetime("DateTime", datetime.datetime(2023, 2, 23, 12, 30, 31))
session.log_list("List", [1, 2, 3, 4, 5, 6])
session.log_tuple("Tuple", (1, 2, 3, 4, 5, 6))
session.log_set("Set", {1, 2, 3, 4, 5, 6})
session.log_dict_value("Dict", {1: True, 4: "5.6", 7: 8.9, 10: dummy})
session.log_complex("Complex", complex(3, 2))
session.log_fraction("Fraction", Fraction(1, 3))
session.log("Fraction again", Fraction(1, 3))

context = ViewerContext(ViewerId.INSPECTOR)
session.log_custom_context("Custom Context", LogEntryType.WARNING, context)

session.log_custom_text("Custom Text", "is custom text", LogEntryType.MEMORY_STATISTIC, ViewerId.DATA)
session.log_custom_file("just.txt", LogEntryType.DEBUG, ViewerId.DATA, "just a file")
session.log_text("Logging text", "text")
session.log_text_file("just.txt", "Logging text file")
session.log_html("Html code", "<b>Ht</b>ml")
session.log_html_file("just.html", "Html file")
session.log_binary("Binary", b"binary", 3)
session.log_binary_file("just.txt", "File")

session.log_ico_file("icon.ico")
session.log_sql("SQL statement", "SELECT name, age FROM users WHERE age = 1")
session.log_source("Python source", "def python_me():\n\tpass", SourceId.PYTHON)
session.log_source("Javascript source", "function JS_me(p1, p2) {\n\treturn p1 * p2;\n}", SourceId.JAVASCRIPT)
session.log_object("Dummy object without private fields", dummy)
session.log_object("Dummy object with private fields", dummy, include_non_public_fields=True)
session.log_exception(ValueError("I am ValueError"), "ValueError")
session.log_current_thread("Current thread")

another_thread = threading.Thread(target=time.sleep, args=(.5,))
another_thread.start()
session.log_thread("Another thread", another_thread)

iterables = [[1, dummy, [1, 2, 3]],
(1, 2, 3),
{1, 2, 3},
{1: True, 3: "Four", 5: None},

]
for terrible in iterables:
session.log_iterable(terrible, "Iterable")
lst = [1, 2, 3]
lst.append(lst)
lst.append(5)
session.log_iterable(lst, "Iterable with cycle")

dic = {1: True, 3: dummy, 5: None}
dic[6] = dic
session.log_dict(dic, "Dictionary with cycle")
session.log_current_stacktrace()
session.log_system()

conn = sqlite3.connect('example.db')
cursor = conn.cursor()
cursor.execute('SELECT * FROM users')
session.log_cursor_data(cursor, "Cursor data")
session.log_cursor_metadata(cursor, "Cursor metadata")
session.log_string("String", "Stringy string")

for _ in range(4):
session.inc_counter("Counter")
time.sleep(.5)
session.reset_counter("Counter")
for _ in range(4):
session.inc_counter("Counter")
time.sleep(.5)
for _ in range(8):
session.dec_counter("Counter")
time.sleep(.5)

session.send_custom_log_entry("Custom LogEntry", LogEntryType.WARNING, ViewerId.DATA, b"Some data")
session.send_custom_watch("Custom Watch", str(42), WatchType.INT)
session.send_custom_process_flow("Custom Process Flow", ProcessFlowType.ENTER_PROCESS)
session.watch("Str", "str")
session.watch("Int", 1)
session.watch("Object", dummy)

si.dispose()
Binary file added python/advanced/sample.wmf
Binary file not shown.
41 changes: 41 additions & 0 deletions python/cloud/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
from smartinspect.connections import ConnectionStringBuilder
from smartinspect import SmartInspect

# Description:
#
# This example demonstrates the usage of SmartInspect with the Cloud.
# You can use a ConnectionStringBuilder instance to build a connection string.
# You will need a write key to log to the Cloud.


WRITE_KEY = "INSERT_WRITE_KEY_HERE"

if __name__ == "__main__":

si = SmartInspect("Python cloud example")

conn_string = ConnectionStringBuilder().add_cloud_protocol() \
.set_region("eu-central-1") \
.set_write_key(WRITE_KEY) \
.add_custom_label("User", "Bob") \
.add_custom_label("Version", "0.0.1") \
.end_protocol().build()

si.set_connections(conn_string)
si.set_enabled(True)

session = si.add_session("cloud", True)
session.enter_process("PythonCloudExample")
session.log_message("Project started")

print("Type messages to send them to SmartInspect")
print("Type \"exit\" to close the app")
msg = input("Message:")

while msg != "exit":
session.log_message(msg)
msg = input("Message:")

session.leave_process()

si.dispose()
26 changes: 26 additions & 0 deletions python/logging_handler/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import logging
from smartinspect.common.color import Color
from smartinspect.smartinspect_handler import SmartInspectHandler

# Description:
#
# This example demonstrates the usage of SmartInspectHandler to dispatch log messages from logging Logger
# as well as from the underlying SmartInspect instance.


if __name__ == "__main__":
# summon a logging Logger
logger = logging.getLogger(__name__)

# instantiate SmartInspectHandler, set format and add handler to the Logger instance
handler = SmartInspectHandler("Client app", "tcp()")
handler.setFormatter(logging.Formatter("%(threadName)s, %(asctime)s: %(module)s @ %(funcName)s: %(message)s"))
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)

logger.debug("Message")

# You can use the underlying SmartInspect instance as well
si = handler.get_si()
session = si.add_session("Before", True)
session.log_colored(Color.BLUE, "Logging from SI")
30 changes: 30 additions & 0 deletions python/objects/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
from smartinspect.common.color import Color
from smartinspect import SmartInspect

# Description:
#
# This example demonstrates the usage of multiple
# session objects with one SmartInspect object.
# Each session object is assigned a different
# session name and color for easier identification
# and filtering in the SmartInspect console.

if __name__ == "__main__":
# create a SamrtInspect instance and add two Session objects
si = SmartInspect("Python objects example")
blue = si.add_session("Blue")
green = si.add_session("Green")

# supply a connection string and enable SmartInspect
si.set_connections("tcp()")
si.set_enabled(True)

# assign each session a color
blue.color = Color.BLUE
green.color = Color.GREEN

# log the messages
blue.log_message("This message is blue!")
green.log_message("This message is green!")

si.dispose()